Install the Run:ai Control Plane (Backend)¶
Create a Control Plane Configuration¶
Create a configuration file to install the Run:ai control plane:
Generate a values file by running:
runai-adm generate-values
--external-ips <ip> \ # (1)
--domain <dns-record> \ # (2)
--tls-cert <file-name> --tls-key <file-name> \ # (3)
--nfs-server <nfs-server-address> --nfs-path <path-in-nfs> # (4)
- An available, IP Address that is accessible from Run:ai Users' machines. Typically (but not always) the IP of one of the nodes.
- DNS A record such as
runai.<company-name>
or similar. The A record should point to the IP address above. - TLS certificate and private key for the above domain.
- NFS server location where Run:ai can create files. For using alternative storage mechanisms see optional values below
Generate a values file by running the following under the deploy
folder:
runai-adm generate-values
--external-ips <ip> \ # (1)
--domain <dns-record> \ # (2)
--tls-cert <file-name> --tls-key <file-name> \ # (3)
--nfs-server <nfs-server-address> --nfs-path <path-in-nfs> \ # (4)
--airgapped
- An available, IP Address that is accessible from Run:ai Users' machines. Typically (but not always) the IP of one of the nodes.
- DNS A record such as
runai.<company-name>
or similar. The A record should point to the IP address above. - TLS certificate and private key for the above domain.
- NFS server location where Run:ai can create files. For using alternative storage mechanisms see optional values below
Note
In cloud environments, the flag --external-ips
should contain both the internal and external IPs (comma separated)
A file called runai-backend-values.yaml
will be created.
(Optional) Edit Configuration File¶
There may be cases where you need to change properties in the values file as follows:
Key | Change | Description |
---|---|---|
backend.initTenant.promProxy and grafana.datasources.datasources.yaml.datasources.url | When using an existing Promethues service, replace this URL with the URL of the existing Prometheus service (obtain by running kubectl get svc on the Prometheus namespace) | Internal URL to Promethues server |
pspEnabled | <true/false> | Set to true if using PodSecurityPolicy |
nginx-ingress.podSecurityPolicy | Set to true if using PodSecurityPolicy | |
postgresql.persistence | PostgreSQL permanent storage via a Persistent Volume. | You can either use storageClassName to create a PV automatically or set nfs.server and nfs.path to provide the network file storage for the PV. The folder in the path should be pre-created and have full access rights. This key is now covered under the runai-adm flags above |
nginx-ingress.controller.externalIPs | <RUNAI_IP_ADDRESS> | IP address allocated for Run:ai. This key is now covered under the runai-adm flags above |
backend.https | replace key and crt with public and private keys for runai.<company-name> . This key is now covered under the runai-adm flags above | |
thanos.receive.persistence | Permanent storage for Run:ai metrics | See Postgresql persistence above. Can use the same location. This key is now covered under the runai-adm flags above |
backend.initTenant.admin | Change password for admin@run.ai | This user is the master Control Plane administrator |
Install the Control Plane (Backend)¶
Run the helm command below:
Tip
Use the --dry-run
flag to gain an understanding of what is being installed before the actual installation.
Connect to Run:ai User Interface¶
Go to: runai.<company-name>
. Log in using the default credentials: User: test@run.ai
, Password: password
(Optional) Enable "Forgot password"¶
In order to support the “Forgot password” functionality, follow the steps below.
- Go to
runai.<company-name>/auth
and Log in. - Under
Realm settings
, select theLogin
tab and enable theForgot password
feature. - Under the
Email
tab, define an SMTP server, as explained here
Next Steps¶
Continue with installing a Run:ai Cluster.