Skip to content

Commit 4fd7993

Browse files
Markdown and other corrections
1 parent cf4e59d commit 4fd7993

File tree

2 files changed

+72
-53
lines changed

2 files changed

+72
-53
lines changed

docs/admin/runai-setup/self-hosted/k8s/backend.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11

22
# Install the Run:ai Control Plane
33

4-
## Prerequisites and preperations
5-
Make sure you have followed the Control Plane [prerequisites](./prerequisites.md) and [preperations](./preperations.md).
4+
## Prerequisites and preparations
5+
6+
Make sure you have followed the Control Plane [prerequisites](./prerequisites.md) and [preparations](./preparations.md).
67

78
## Helm install
9+
810
Run the helm command below:
911

1012
=== "Connected"
@@ -36,20 +38,20 @@ Run the helm command below:
3638
!!! Tip
3739
Use the `--dry-run` flag to gain an understanding of what is being installed before the actual installation.
3840

39-
4041
## Additional Run:ai configurations (optional)
42+
4143
There may be cases where you need to set additional properties,
42-
To apply the changes run `helm upgrade` and use `--set` to set specific confiogurations, and restart the relevant Run:ai pods so they can fetch the new configurations.
44+
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.
4345

4446
| Key | Change | Description |
45-
|----------|----------|-------------|
47+
|----------|----------|-------------|
4648
| `global.ingress.ingressClass` | Ingress class | Run:ai default is using NGINX. If your cluster has a different ingress controller, you can configure the ingress class to be created by Run:ai |
4749
| `global.ingress.tlsSecretName` | TLS secret name | Run:ai requires the creation of a secret with domain certificate. See [above](#domain-certificate). If the `runai-backend` namespace already had such a secret, you can set the secret name here |
48-
| `<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 and 3rd party services' resources |
50+
| `<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 and 3rd party services' resources |
4951
|<div style="width:200px"></div>| | |
5052

51-
5253
## Additional 3rd party configurations (optional)
54+
5355
The Run:ai Control Plane chart, includes multiple sub-charts of 3rd party components:
5456

5557
* [PostgreSQL](https://artifacthub.io/packages/helm/bitnami/postgresql){target=_blank} - Data store
@@ -62,15 +64,16 @@ The Run:ai Control Plane chart, includes multiple sub-charts of 3rd party compon
6264
!!! Tip
6365
Click on any component, to view it's chart values and configurations
6466

65-
If you have opted to connect to an [external PostgreSQL database](preperations.md#external-postgres-database-optional), refer to the additional configurations table below. Adjust the following parameters based on your connection details:
67+
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:
6668

6769
1. Disable PostgreSQL deployment - `postgresql.enabled`
6870
2. Run:ai connection details - `global.postgresql.auth`
6971
3. Grafana connection details - `grafana.dbUser`, `grafana.dbPassword`
7072

7173
### PostgreSQL
74+
7275
| Key | Change | Description |
73-
|----------|----------|-------------|
76+
|----------|----------|-------------|
7477
| `postgresql.enabled`| PostgreSQL installation | If set to `false` the PostgreSQL will not be installed |
7578
| `global.postgresql.auth.host` | PostgreSQL host | Hostname or IP address of the PostgreSQL server |
7679
| `global.postgresql.auth.port` | PostgreSQL port | Port number on which PostgreSQL is running |
@@ -82,21 +85,24 @@ If you have opted to connect to an [external PostgreSQL database](preperations.m
8285
| `postgresql.primary.persistence.storageClass` | Storage class | The installation to work with a specific storage class rather than the default one |
8386

8487
### Thanos
88+
8589
| Key | Change | Description |
86-
|----------|----------|-------------|
90+
|----------|----------|-------------|
8791
| `thanos.receive.persistence.storageClass` | Storage class | The installation to work with a specific storage class rather than the default one |
8892

8993
### Keycloakx
94+
9095
| Key | Change | Description |
91-
|----------|----------|-------------|
92-
| `keycloakx.adminUser` | User name of the internal identity provider administrator | This user is the administrator of Keycloak |
93-
| `keycloakx.adminPassword` | Password of the internal identity provider administrator | This password is for the administrator of Keycloak |
96+
|----------|----------|-------------|
97+
| `keycloakx.adminUser` | User name of the internal identity provider administrator | This user is the administrator of Keycloak |
98+
| `keycloakx.adminPassword` | Password of the internal identity provider administrator | This password is for the administrator of Keycloak |
9499
| `keycloakx.existingSecret` | Keycloakx Credentials (secret) | Existing secret name with authentication credentials |
95100
| `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 |
96101

97102
### Grafana
103+
98104
| Key | Change | Description |
99-
|----------|----------|-------------|
105+
|----------|----------|-------------|
100106
| `grafana.db.existingSecret` | Grafana database connection credentials (secret) | Existing secret name with authentication credentials |
101107
| `grafana.dbUser` | Grafana database username | Username for accessing the Grafana database |
102108
| `grafana.dbPassword` | Grafana database password | Password for the Grafana database user |
@@ -105,8 +111,9 @@ If you have opted to connect to an [external PostgreSQL database](preperations.m
105111
| `grafana.adminPassword` | Grafana password | Override the Run:ai default password for accessing Grafana |
106112

107113
### Redis
114+
108115
| Key | Change | Description |
109-
|----------|----------|-------------|
116+
|----------|----------|-------------|
110117
| `redisCache.auth.password` | Redis (Runai internal cache mechanism) applicative password | Override the default password |
111118
| `redisCache.auth.existingSecret` | Redis credentials (secret) | Existing secret name with authentication credentials |
112119

0 commit comments

Comments
 (0)