Skip to content

Commit fc7750b

Browse files
ozRunAIozRunAI
authored
fixed duplicate content
1 parent 9d50e02 commit fc7750b

File tree

1 file changed

+1
-140
lines changed

1 file changed

+1
-140
lines changed

‎docs/admin/runai-setup/self-hosted/ocp/backend.md

Lines changed: 1 addition & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Run the helm command below:
4040
!!! Tip
4141
Use the `--dry-run` flag to gain an understanding of what is being installed before the actual installation.
4242

43-
### Additional configurations (optional)
43+
## Additional Run:ai configurations (optional)
4444

4545
There may be cases where you need to set additional properties,
4646
To apply the changes run `helm upgrade` and use `--set` to set specific configurations, and restart the relevant Run:ai pods so they can fetch the new configurations.
@@ -128,142 +128,3 @@ To support the *Forgot password* functionality, follow the steps below.
128128
### Install Run:ai Cluster
129129

130130
Continue with installing a [Run:ai Cluster](cluster.md).
131-
132-
# Install the Run:ai Control Plane
133-
134-
## Prerequisites and preparations
135-
136-
Make sure you have followed the Control Plane [prerequisites](./prerequisites.md) and [preparations](./preparations.md).
137-
138-
## Install the Control Plane
139-
140-
Run the helm command below:
141-
142-
=== "Connected"
143-
``` bash
144-
helm repo add runai-backend https://runai.jfrog.io/artifactory/cp-charts-prod
145-
helm repo update
146-
helm upgrade -i runai-backend -n runai-backend runai-backend/control-plane --version "~2.17.0" \
147-
--set global.domain=runai.apps.<OPENSHIFT-CLUSTER-DOMAIN> \ # (1)
148-
--set global.config.kubernetesDistribution=openshift
149-
```
150-
151-
1. The subdomain configured for the OpenShift cluster.
152-
153-
!!! Info
154-
To install a specific version, add `--version <version>` to the install command. You can find available versions by running `helm search repo -l runai-backend`.
155-
156-
=== "Airgapped"
157-
``` bash
158-
helm upgrade -i runai-backend ./control-plane-<version>.tgz -n runai-backend \
159-
--set global.domain=runai.apps.<OPENSHIFT-CLUSTER-DOMAIN> \ # (1)
160-
--set global.config.kubernetesDistribution=openshift \
161-
--set global.customCA.enabled=true \ # (2)
162-
-f custom-env.yaml # (3)
163-
```
164-
165-
1. The domain configured for the OpenShift cluster. To find out the OpenShift cluster domain, run `oc get routes -A`
166-
2. See the Local Certificate Authority instructions below
167-
3. `custom-env.yaml` should have been created by the _prepare installation_ script in the previous section.
168-
169-
(replace `<version>` with the control plane version)
170-
171-
!!! Tip
172-
Use the `--dry-run` flag to gain an understanding of what is being installed before the actual installation.
173-
174-
## Additional Run:ai configurations (optional)
175-
176-
There may be cases where you need to set additional properties as follows:
177-
178-
| Key | Change | Description |
179-
|----------|----------|-------------|
180-
| `<component>` <br> &ensp;`resources:` <br> &emsp; `limits:` <br> &emsp; &ensp; `cpu: 500m` <br> &emsp; &ensp; `memory: 512Mi` <br> &emsp; `requests:` <br> &emsp; &ensp; `cpu: 250m` <br> &emsp; &ensp; `memory: 256Mi` | Pod request and limits | Set Run:ai & 3rd party services' resources |
181-
|<div style="width:200px"></div>| | |
182-
183-
Use the `--set` syntax in the helm command above.
184-
185-
## Additional 3rd party configurations (optional)
186-
187-
The Run:ai Control Plane chart, includes multiple sub-charts of 3rd party components:
188-
189-
* [PostgreSQL](https://artifacthub.io/packages/helm/bitnami/postgresql){target=_blank} - Data store
190-
* [Thanos](https://artifacthub.io/packages/helm/bitnami/thanos
191-
){target=_blank} - Metrics Store
192-
* [Keycloakx](https://artifacthub.io/packages/helm/codecentric/keycloakx){target=_blank} - Identity & Access Management
193-
* [Grafana](https://artifacthub.io/packages/helm/grafana/grafana){target=_blank} - Analytics Dashboard
194-
* [Redis](https://artifacthub.io/packages/helm/bitnami/redis){target=_blank} - Caching (Disabled, by default)
195-
196-
!!! Tip
197-
Click on any component, to view it's chart values and configurations
198-
199-
If you have opted to connect to an [external PostgreSQL database](preparations.md#external-postgres-database-optional), refer to the additional configurations table below. Adjust the following parameters based on your connection details:
200-
201-
1. Disable PostgreSQL deployment - `postgresql.enabled`
202-
2. Run:ai connection details - `global.postgresql.auth`
203-
3. Grafana connection details - `grafana.dbUser`, `grafana.dbPassword`
204-
205-
### PostgreSQL
206-
207-
| Key | Change | Description |
208-
|----------|----------|-------------|
209-
| `postgresql.enabled`| PostgreSQL installation | If set to `false` the PostgreSQL will not be installed |
210-
| `global.postgresql.auth.host` | PostgreSQL host | Hostname or IP address of the PostgreSQL server |
211-
| `global.postgresql.auth.port` | PostgreSQL port | Port number on which PostgreSQL is running |
212-
| `global.postgresql.auth.username` | PostgreSQL username | Username for connecting to PostgreSQL |
213-
| `global.postgresql.auth.password` | PostgreSQL password | Password for the PostgreSQL user specified by `global.postgresql.auth.username` |
214-
| `global.postgresql.auth.postgresPassword` | PostgreSQL default admin password | Password for the built-in PostgreSQL superuser (`postgres`) |
215-
| `global.postgresql.auth.existingSecret` | Postgres Credentials (secret) | Existing secret name with authentication credentials |
216-
| `postgresql.primary.initdb.password` | PostgreSQL default admin password | Set the same password as in `global.postgresql.auth.postgresPassword` (if changed) |
217-
| `postgresql.primary.persistence.storageClass` | Storage class | The installation to work with a specific storage class rather than the default one |
218-
219-
### Thanos
220-
221-
| Key | Change | Description |
222-
|----------|----------|-------------|
223-
| `thanos.receive.persistence.storageClass` | Storage class | The installation to work with a specific storage class rather than the default one |
224-
225-
### Keycloakx
226-
227-
| Key | Change | Description |
228-
|----------|----------|-------------|
229-
| `keycloakx.adminUser` | User name of the internal identity provider administrator | This user is the administrator of Keycloak |
230-
| `keycloakx.adminPassword` | Password of the internal identity provider administrator | This password is for the administrator of Keycloak |
231-
| `keycloakx.existingSecret` | Keycloakx Credentials (secret) | Existing secret name with authentication credentials |
232-
| `global.keycloakx.host` | KeyCloak (Run:ai internal identity provider) host path | Override the DNS for Keycloak. This can be used to access Keycloak from outside the Run:ai Control Plane cluster via ingress |
233-
234-
### Grafana
235-
236-
| Key | Change | Description |
237-
|----------|----------|-------------|
238-
| `grafana.db.existingSecret` | Grafana database connection credentials (secret) | Existing secret name with authentication credentials |
239-
| `grafana.dbUser` | Grafana database username | Username for accessing the Grafana database |
240-
| `grafana.dbPassword` | Grafana database password | Password for the Grafana database user |
241-
| `grafana.admin.existingSecret` | Grafana admin default credentials (secret) | Existing secret name with authentication credentials |
242-
| `grafana.adminUser` | Grafana username | Override the Run:ai default user name for accessing Grafana |
243-
| `grafana.adminPassword` | Grafana password | Override the Run:ai default password for accessing Grafana |
244-
245-
### Redis
246-
247-
| Key | Change | Description |
248-
|----------|----------|-------------|
249-
| `redis.auth.password` | Redis (Runai internal cache mechanism) applicative password | Override the default password |
250-
251-
## Next steps
252-
253-
### Connect to Run:ai user interface
254-
255-
* Run: `oc get routes -n runai-backend` to find the Run:ai Administration User Interface URL.
256-
* Log in using the default credentials: User: `test@run.ai`, Password: `Abcd!234`.
257-
* Go to the Users area and change the password.
258-
259-
### Enable Forgot Password (optional)
260-
261-
To support the *Forgot password* functionality, follow the steps below.
262-
263-
* Go to `runai.<openshift-cluster-domain>/auth` and Log in.
264-
* Under `Realm settings`, select the `Login` tab and enable the `Forgot password` feature.
265-
* Under the `Email` tab, define an SMTP server, as explained [here](https://www.keycloak.org/docs/latest/server_admin/#_email){target=_blank}
266-
267-
### Install Run:ai Cluster
268-
269-
Continue with installing a [Run:ai Cluster](cluster.md).

0 commit comments

Comments
 (0)