Preparing for a Run:ai Kubernetes installation¶

The following section provides IT with the information needed to prepare for a Run:ai installation.

Prerequisites¶

Follow the prerequisites as explained in Self-Hosted installation over Kubernetes.

Software artifacts¶

kubectl create namespace runai-backend
kubectl apply -f runai-reg-creds.yaml

tar xvf runai-airgapped-package-<VERSION>.tar.gz

kubectl create namespace runai-backend

export REGISTRY_URL=<Docker Registry address>

sudo -E ./prepare_installation.sh

Private Docker Registry (optional)¶

To access the organization's docker registry it is required to set the registry's credentials (imagePullSecret)

Create the secret named runai-reg-creds based on your existing credentials. For more information, see Pull an Image from a Private Registry.

Configure your environment¶

Domain Certificate¶

The Run:ai control plane requires a domain name (FQDN). You must supply a domain name as well as a trusted certificate for that domain.

• When installing the first Run:ai cluster on the same Kubernetes cluster as the control plane, the Run:ai cluster URL will be the same as the control-plane URL.
• When installing the Run:ai cluster on a separate Kubernetes cluster, follow the Run:ai Domain name requirement.
• If your network is air-gapped, you will need to provide the Run:ai control-plane and cluster with information about the local certificate authority.

You must provide the domain's private key and crt as a Kubernetes secret in the runai-backend namespace. Run:

kubectl create secret tls runai-backend-tls -n runai-backend \
    --cert /path/to/fullchain.pem --key /path/to/private.pem

Local Certificate Authority (air-gapped only)¶

In air-gapped environments, you must prepare the public key of your local certificate authority as described here. It will need to be installed in Kubernetes for the installation to succeed.

Mark Run:ai system workers (optional)¶

You can optionally set the Run:ai control plane to run on specific nodes. Kubernetes will attempt to schedule Run:ai pods to these nodes. If lacking resources, the Run:ai nodes will move to another, non-labeled node.

To set system worker nodes run:

kubectl label node <NODE-NAME> node-role.kubernetes.io/runai-system=true

External Postgres database (optional)¶

If you have opted to use an external PostgreSQL database, you need to perform initial setup to ensure successful installation. Follow these steps:

1. Create a SQL script file, edit the parameters below, and save it locally:

   • Replace <DATABASE_NAME> with a dedicate database name for RunAi in your PostgreSQL database.
   • Replace <ROLE_NAME> with a dedicated role name (user) for RunAi database.
   • Replace <ROLE_PASSWORD> with a password for the new PostgreSQL role.
   • Replace <GRAFANA_PASSWORD> with the password to be set for Grafana integration.

   -- Create a new database for runai
   CREATE DATABASE <DATABASE_NAME>; 
   
   -- Create the role with login and password
   CREATE ROLE <ROLE_NAME>  WITH LOGIN PASSWORD '<ROLE_PASSWORD>'; 
   
   -- Grant all privileges on the database to the role
   GRANT ALL PRIVILEGES ON DATABASE <DATABASE_NAME> TO <ROLE_NAME>; 
   
   -- Connect to the newly created database
   \c <DATABASE_NAME> 
   
   -- grafana
   CREATE ROLE grafana WITH LOGIN PASSWORD '<GRAFANA_PASSWORD>'; 
   CREATE SCHEMA grafana authorization grafana;
   ALTER USER grafana set search_path='grafana';
   -- Exit psql
   \q
   

2. Run the following command on a machine where PostgreSQL client (pgsql) is installed:

   psql --host <POSTGRESQL_HOST> \ # (1)
   --user <POSTGRESQL_USER> \ # (2)
   --port <POSTGRESQL_PORT> \ # (3)
   --dbname <POSTGRESQL_DB> \ # (4)
   -a -f <SQL_FILE> \ # (5)
   

   1. Replace <POSTGRESQL_HOST> with the PostgreSQL ip address or hostname.
   2. Replace <POSTGRESQL_USER> with the PostgreSQL username.
   3. Replace <POSTGRESQL_PORT> with the port number where PostgreSQL is running.
   4. Replace <POSTGRESQL_DB> with the name of your PostgreSQL database.
   5. Replace <POSTGRESQL_DB> with the name of your PostgreSQL database.
   6. Replace <SQL_FILE> with the path to the SQL script created in the previous step.

Additional permissions¶

As part of the installation, you will be required to install the Run:ai Control Plane and Cluster Helm Charts. The Helm Charts require Kubernetes administrator permissions. You can review the exact permissions provided by using the --dry-run on both helm charts.

Validate Prerequisites¶

Once you believe that the Run:ai prerequisites and preperations are met, we highly recommend installing and running the Run:ai pre-install diagnostics script. The tool:

• Tests the below requirements as well as additional failure points related to Kubernetes, NVIDIA, storage, and networking.
• Looks at additional components installed and analyze their relevance to a successful Run:ai installation.

To use the script download the latest version of the script and run:

chmod +x preinstall-diagnostics-<platform>
./preinstall-diagnostics-<platform> --domain <dns-entry>

If the script fails, or if the script succeeds but the Kubernetes system contains components other than Run:ai, locate the file runai-preinstall-diagnostics.txt in the current directory and send it to Run:ai technical support.

For more information on the script including additional command-line flags, see here.

Next steps¶

Continue with installing the Run:ai Control Plane.