Chapter 2. Creating a model registry
You can create a model registry to store, share, version, deploy, and track your models.
Prerequisites
- You have logged in to OpenShift AI as a user with OpenShift AI administrator privileges.
- A cluster administrator has configured and enabled the model registry component in your OpenShift AI deployment. For more information, see Configuring the model registry component.
- The model registry component is enabled for your OpenShift AI deployment.
You have access to an external MySQL database which uses at least MySQL version 5.x. However, Red Hat recommends that you use MySQL version 8.x.
NoteThe
mysql_native_passwordauthentication plugin is required for the ML Metadata component to successfully connect to your database.mysql_native_passwordis disabled by default in MySQL 8.4 and later. If your database uses MySQL 8.4 or later, you must update your MySQL deployment to enable themysql_native_passwordplugin.For more information about enabling the
mysql_native_passwordplugin, see Native Pluggable Authentication in the MySQL documentation.By default, the OpenShift MySQL template uses the
caching_sha2_passwordauthentication plugin. If you used the OpenShift template for MySQL, you must manually update it to usemysql_native_passwordfor the model registry to connect to your database instance successfully. For more information, see the Model registry fails to connect to MySQL database due to an authentication plugin mismatch Knowledgebase solution.
Procedure
-
From the OpenShift AI dashboard, click Settings
Model registry settings. Click Create model registry.
The Create model registry dialog opens.
- In the Name field, enter a name for the model registry.
Optional: Click Edit resource name, and then enter a specific resource name for the model registry in the Resource name field. By default, the resource name will match the name of the model registry.
ImportantResource names are what your resources are labeled as in OpenShift. Your resource name cannot exceed 253 characters, must consist of lowercase alphanumeric characters or -, and must start and end with an alphanumeric character. Resource names are not editable after creation.
The resource name must not match the name of any other model registry resource in your OpenShift cluster.
- Optional: In the Description field, enter a description for the model registry.
In the Connect to external MySQL database section, enter the information for the external database where your model data is stored.
In the Host field, enter the database’s host name.
-
If the database is running in the
rhoai-model-registriesnamespace, enter only the hostname for the database. -
If the database is running in a different namespace from
rhoai-model-registries, enter the database hostname details in<host name>.<namespace>.svc.cluster.localformat.
-
If the database is running in the
- In the Port field, enter the port number for the database.
- In the Username field, enter the default user name that is connected to the database.
- In the Password field, enter the password for the default user account.
- In the Database field, enter the database name.
Optional: Select the Add CA certificate to secure database connection to use a certificate with your database connection.
-
Click Use cluster-wide CA bundle to use the
ca-bundle.crtbundle in theodh-trusted-ca-bundleConfigMap. -
Click Use Red Hat OpenShift AI CA bundle to use the
odh-ca-bundle.crtbundle in theodh-trusted-ca-bundleConfigMap. Click Choose from existing certificates to select an existing certificate. You can select the key of any ConfigMap or secret in the
rhoai-model-registriesnamespace.- From the Resource list, select a ConfigMap or secret.
- From the Key list, select a key.
Click Upload new certificate to upload a new certificate as a ConfigMap.
Drag and drop the PEM file for your certificate into the Certificate field, or click Upload to select a file from your local machine’s file system.
NoteUploading a certificate creates the
db-credentialConfigMap with theca.crtkey.To upload a certificate as a secret, you must create a secret in the OpenShift
rhoai-model-registriesnamespace, and then select it as an existing certificate when you create your model registry.For more information about creating secrets in OpenShift, see Providing sensitive data to pods by using secrets.
-
Click Use cluster-wide CA bundle to use the
- Click Create.
To find the resource name or type of a model registry, click the help icon
beside the registry name. Resource names and types are used to find your resources in OpenShift.
Verification
- The new model registry appears on the Model registry settings page.
- You can edit the model registry by clicking the action menu (⋮) beside it, and then clicking Edit model registry.
- You can register a model with the model registry from the Model registry tab. For more information about working with model registries, see Working with model registries.