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: installer/README.md
+24-4Lines changed: 24 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,8 @@ A Linux based system, with internet access, will be used to execute the script t
30
30
|`jq`|`jq` will be used to parse the Karavi Authorization configuration file during installation|
31
31
32
32
## Installation script
33
-
The installation script is located at https://github.com/dell/karavi-observability/blob/main/installer/karavi-observability-install.sh. The script performs the current steps during installation of Karavi Observability:
33
+
34
+
The installation script is located at <https://github.com/dell/karavi-observability/blob/main/installer/karavi-observability-install.sh>. The script performs the current steps during installation of Karavi Observability:
34
35
35
36
- Verify that Karavi Observability is not yet installed
36
37
- Verify the Kubernetes/Openshift versions are supported
@@ -47,12 +48,14 @@ The installation script is located at https://github.com/dell/karavi-observabili
47
48
- Wait for the Karavi Observability pods to become ready
48
49
49
50
If Karavi Authorization is enabled for the CSI drivers installed in the same Kubernetes cluster, the installation script will perform the current steps to enable Karavi Observability to use the same Karavi Authorization instance:
51
+
50
52
- Verify the `karavictl` binary is available.
51
53
- Verify the appropriate Secret exists in the CSI driver namespace.
52
54
- Query the CSI driver environment to get references to the Karavi Authorization sidecar-proxy Docker image and URL of the proxy server.
53
55
- Updates the Karavi Observability deployment to use the existing Karavi Authorization instance.
@@ -153,8 +159,8 @@ The following instructions can be followed when a Helm chart will be installed i
153
159
154
160
Multiple Linux based systems may be required to create and process an offline bundle for use.
155
161
156
-
* One Linux based system, with internet access, will be used to create the bundle. This involves the user invoking a script that utilizes `docker` to pull and save container images to file.
157
-
* One Linux based system, with access to an image registry, to invoke a script that uses `docker` to restore container images from file and push them to a registry
162
+
- One Linux based system, with internet access, will be used to create the bundle. This involves the user invoking a script that utilizes `docker` to pull and save container images to file.
163
+
- One Linux based system, with access to an image registry, to invoke a script that uses `docker` to restore container images from file and push them to a registry
158
164
159
165
If one Linux system has both internet access and access to an internal registry, that system can be used for both steps.
160
166
@@ -254,37 +260,43 @@ or
254
260
### Perform Helm installation
255
261
256
262
1. Change directory to `helm` which contains the updated Helm chart directory:
263
+
257
264
```
258
265
[user@anothersystem /home/user/offline-karavi-observability-bundle]# cd helm
3. The vxflexos-config Secret from the namespace where CSI Driver for Dell PowerFlex is installed must be copied to the namespace where Karavi Observability is to be installed.
267
275
268
276
Example command to copy the Secret from the vxflexos namespace to the karavi namespace.
277
+
269
278
```
270
279
[user@anothersystem /home/user/offline-karavi-observability-bundle/helm]# kubectl get secret vxflexos-config -n vxflexos -o yaml | sed 's/namespace: vxflexos/namespace: karavi/' | kubectl create -f -
271
280
```
272
281
273
282
4. The powerstore-config Secret from the namespace where CSI Driver for Dell PowerStore is installed must be copied to the namespace where Karavi Observability is to be installed.
274
283
275
284
Example command to copy the Secret from the csi-powerstore namespace to the karavi namespace.
285
+
276
286
```
277
287
[user@anothersystem /home/user/offline-karavi-observability-bundle/helm]# kubectl get secret powerstore-config -n csi-powerstore -o yaml | sed 's/namespace: csi-powerstore/namespace: karavi/' | kubectl create -f -
278
288
```
279
289
280
290
5. The isilon-creds Secret from the namespace where CSI Driver for Dell PowerScale is installed must be copied to the namespace where Karavi Observability is to be installed.
281
291
282
292
Example command to copy the Secret from the isilon namespace to the karavi namespace.
293
+
283
294
```
284
295
[user@anothersystem /home/user/offline-karavi-observability-bundle/helm]# kubectl get secret isilon-creds -n isilon -o yaml | sed 's/namespace: isilon/namespace: karavi/' | kubectl create -f -
285
296
```
286
297
287
298
6. The powermax-reverseproxy-config Configmap and corresponding Secreta from the namespace where CSI Driver for Dell PowerMax is installed must be copied to the namespace where Karavi Observability is to be installed.
299
+
288
300
```
289
301
[user@anothersystem /home/user/offline-karavi-observability-bundle/helm]# kubectl get configmap powermax-reverseproxy-config -n powermax -o yaml | sed 's/namespace: powermax/namespace: karavi/' | kubectl create -f -
290
302
[user@anothersystem /home/user/offline-karavi-observability-bundle/helm]# for secret in\
@@ -294,13 +306,15 @@ Example command to copy the Secret from the isilon namespace to the karavi names
294
306
```
295
307
296
308
# TODO
309
+
297
310
7. (Optional) The following steps can be performed to enable Karavi Observability for PowerFlex/PowerScale/PowerMax to use an existing instance of Karavi Authorization for accessing the REST API for the given storage systems.
298
311
You need to provide your own configurations. A sample values.yaml file is located [here](https://github.com/dell/helm-charts/blob/main/charts/karavi-observability/values.yaml).
299
312
300
313
In your own configuration values.yaml, you need to enable PowerFlex/PowerScale/PowerMax Authorization, and provide the location of the sidecar-proxy Docker image and URL of the Karavi Authorization proxyHost address.
301
314
302
315
PowerFlex:
303
316
Copy the vxflexos-config-params Configmap, and Copy karavi-authorization-config, proxy-server-root-certificate and proxy-authz-tokens Secrets into the Karavi Observability namespace:
317
+
304
318
```
305
319
[user@anothersystem /home/user/offline-karavi-observability-bundle/helm]# kubectl get configmap vxflexos-config-params -n vxflexos -o yaml | sed 's/namespace: vxflexos/namespace: karavi/' | kubectl create -f -
306
320
@@ -309,11 +323,13 @@ Copy the vxflexos-config-params Configmap, and Copy karavi-authorization-config,
309
323
310
324
PowerScale:
311
325
Copy the isilon-config-params Configmap, and Copy karavi-authorization-config, proxy-server-root-certificate and proxy-authz-tokens Secrets into the Karavi Observability namespace:
326
+
312
327
```
313
328
[user@anothersystem /home/user/offline-karavi-observability-bundle/helm]# kubectl get configmap isilon-config-params -n isilon -o yaml | sed 's/namespace: isilon/namespace: karavi/' | kubectl create -f -
314
329
315
330
[user@anothersystem /home/user/offline-karavi-observability-bundle/helm]# kubectl get secret karavi-authorization-config proxy-server-root-certificate proxy-authz-tokens -n isilon -o yaml | sed 's/namespace: isilon/namespace: karavi/' | sed 's/name: karavi-authorization-config/name: isilon-karavi-authorization-config/' | sed 's/name: proxy-server-root-certificate/name: isilon-proxy-server-root-certificate/' | sed 's/name: proxy-authz-tokens/name: isilon-proxy-authz-tokens/' | kubectl create -f -
316
331
```
332
+
317
333
PowerMax:
318
334
Copy the powermax-config-params Configmap, and Copy karavi-authorization-config, proxy-server-root-certificate and proxy-authz-tokens Secrets into the Karavi Observability namespace:
319
335
@@ -356,19 +372,23 @@ To perform an offline installation of a helm chart, the following steps should b
Follow [Offline Karavi Observability Helm Chart Installer](#unpack-the-offline-bundle), Copy and Unpack the Offline Bundle to another Linux system, and Push Docker images to the internal Docker registry.
363
381
364
382
### Perform Helm upgrade
365
383
366
384
1. Change directory to `helm` which contains the updated Helm chart directory:
385
+
367
386
```
368
387
[user@anothersystem /home/user/offline-karavi-observability-bundle]# cd helm
0 commit comments