You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admin/runai-setup/self-hosted/k8s/backend.md
+22-15Lines changed: 22 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,12 @@
1
1
2
2
# Install the Run:ai Control Plane
3
3
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).
6
7
7
8
## Helm install
9
+
8
10
Run the helm command below:
9
11
10
12
=== "Connected"
@@ -36,20 +38,20 @@ Run the helm command below:
36
38
!!! Tip
37
39
Use the `--dry-run` flag to gain an understanding of what is being installed before the actual installation.
38
40
39
-
40
41
## Additional Run:ai configurations (optional)
42
+
41
43
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.
43
45
44
46
| Key | Change | Description |
45
-
|----------|----------|-------------|
47
+
|----------|----------|-------------|
46
48
|`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|
47
49
|`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>  `resources:` <br>  `limits:` <br>   `cpu: 500m` <br>   `memory: 512Mi` <br>  `requests:` <br>   `cpu: 250m` <br>   `memory: 256Mi`| Pod request and limits | Set Run:ai and 3rd party services' resources |
50
+
|`<component>` <br>  `resources:` <br>  `limits:` <br>   `cpu: 500m` <br>   `memory: 512Mi` <br>  `requests:` <br>   `cpu: 250m` <br>   `memory: 256Mi`| Pod request and limits | Set Run:ai and 3rd party services' resources |
49
51
|<divstyle="width:200px"></div>|||
50
52
51
-
52
53
## Additional 3rd party configurations (optional)
54
+
53
55
The Run:ai Control Plane chart, includes multiple sub-charts of 3rd party components:
54
56
55
57
*[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
62
64
!!! Tip
63
65
Click on any component, to view it's chart values and configurations
64
66
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:
|`postgresql.enabled`| PostgreSQL installation | If set to `false` the PostgreSQL will not be installed |
75
78
|`global.postgresql.auth.host`| PostgreSQL host | Hostname or IP address of the PostgreSQL server |
76
79
|`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
82
85
|`postgresql.primary.persistence.storageClass`| Storage class | The installation to work with a specific storage class rather than the default one |
83
86
84
87
### Thanos
88
+
85
89
| Key | Change | Description |
86
-
|----------|----------|-------------|
90
+
|----------|----------|-------------|
87
91
|`thanos.receive.persistence.storageClass`| Storage class | The installation to work with a specific storage class rather than the default one |
88
92
89
93
### Keycloakx
94
+
90
95
| 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 |
94
99
|`keycloakx.existingSecret`| Keycloakx Credentials (secret) | Existing secret name with authentication credentials |
95
100
|`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 |
96
101
97
102
### Grafana
103
+
98
104
| Key | Change | Description |
99
-
|----------|----------|-------------|
105
+
|----------|----------|-------------|
100
106
|`grafana.db.existingSecret`| Grafana database connection credentials (secret) | Existing secret name with authentication credentials |
101
107
|`grafana.dbUser`| Grafana database username | Username for accessing the Grafana database |
102
108
|`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
105
111
|`grafana.adminPassword`| Grafana password | Override the Run:ai default password for accessing Grafana |
0 commit comments