update README

5afe · Jul 26, 2024 · b55dace · b55dace
1 parent d22016c
commit b55dace
Show file tree

Hide file tree

Showing 5 changed files with 183 additions and 183 deletions.
diff --git a/charts/safe-client-gateway/README.md b/charts/safe-client-gateway/README.md
@@ -40,10 +40,10 @@ The command deploys safe-client-gateway on the Kubernetes cluster in the default
 
 ## Uninstalling the Chart
 
-To uninstall/delete the `[RELEASE-NAME]` deployment:
+To uninstall the `[RELEASE-NAME]` deployment:
 
 ```bash
-helm delete [RELEASE-NAME]
+helm uninstall [RELEASE-NAME]
 ```
 
 The command removes all the Kubernetes components associated with the chart and deletes the release.
@@ -72,54 +72,54 @@ helm show values safe-client-gateway
 
 | Parameter | Description | Default |
 |---|---|---|
-| nameOverride | Provide a name in place of safe-client-gateway for `app:` labels | "" |
-| fullnameOverride | Provide a name to substitute for the full names of resources | "" |
+| `nameOverride` | Provide a name in place of safe-client-gateway for `app:` labels | `""` |
+| `fullnameOverride` | Provide a name to substitute for the full names of resources | `""` |
 
 ### Installation parameters
 
 | Parameter | Description | Default |
 |---|---|---|
-| replicaCount | Number of instance for safe-client-gateway-web | 1 |
-| image.repository | safe-client-gateway image name | safeglobal/safe-client-gateway-nest |
-| image.tag | safe-client-gateway image tag | latest |
-| image.pullPolicy | Image pull policy | Always |
-| extraEnv | Specify additional environment variables | [] |
+| `replicaCount` | Number of instance for safe-client-gateway-web | `1` |
+| `image.repository` | safe-client-gateway image name | `safeglobal/safe-client-gateway-nest` |
+| `image.tag` | safe-client-gateway image tag | `latest` |
+| `image.pullPolicy` | Image pull policy | `Always` |
+| `extraEnv` | Specify additional environment variables | `[]` |
 
 ### Configuration parameters
 
 | Parameter | Description | Default |
 |---|---|---|
-| config.debug | Enable debug mode | true |
-| config.cfgService.url | URL of the Config-Service | "" |
-| config.security.authToken | Authentication token | "" |
-| config.redis.host | Redis Host<br>if `safe-client-gateway-redis.enabled=false` | "" |
-| config.redis.port | Redis Port | 6379 |
+| `config.debug` | Enable debug mode | `true` |
+| `config.cfgService.url` | URL of the Config-Service | `""` |
+| `config.security.authToken` | Authentication token | `""` |
+| `config.redis.host` | Redis Host<br>if `safe-client-gateway-redis.enabled=false` | `""` |
+| `config.redis.port` | Redis Port | `6379` |
 
 ### Pod parameters
 
 | Parameter | Description | Default |
 |---|---|---|
-| web.nodeSelector |  | {} |
-| web.affinity |  | {} |
-| web.tolerations |  | {} |
-| web.securityContext |  | {} |
-| web.podSecurityContext |  | {} |
-| web.resources |  | {} |
+| `web.nodeSelector` |  | `{}` |
+| `web.affinity` |  | `{}` |
+| `web.tolerations` |  | `{}` |
+| `web.securityContext` |  | `{}` |
+| `web.podSecurityContext` |  | `{}` |
+| `web.resources` |  | `{}` |
 
 ### Ingress parameters
 
 | Parameter | Description | Default |
 |---|---|---|
-| ingress.enabled | Enable ingress | true |
-| ingress.ingressClassName | Ingress class name | nginx |
-| ingress.host | Ingress host | cgw-service.minikube.net |
-| ingress.annotations | Ingress annotations | nginx.ingress.kubernetes.io/force-ssl-redirect: "true"<br>nginx.ingress.kubernetes.io/enable-cors: "true"<br>nginx.ingress.kubernetes.io/cors-allow-methods: "OPTIONS, GET, HEAD, DELETE, PUT, POST"<br>nginx.ingress.kubernetes.io/cors-allow-origin: "https://*.minikube.net"<br>nginx.ingress.kubernetes.io/cors-allow-headers: "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization,Safe-Wallet-Signature,Safe-Wallet-Signature-Timestamp" |
+| `ingress.enabled` | Enable ingress | `true` |
+| `ingress.ingressClassName` | Ingress class name | `nginx` |
+| `ingress.host` | Ingress host | `cgw-service.minikube.net` |
+| `ingress.annotations` | Ingress annotations | `nginx.ingress.kubernetes.io/force-ssl-redirect: "true"<br>nginx.ingress.kubernetes.io/enable-cors: "true"<br>nginx.ingress.kubernetes.io/cors-allow-methods: "OPTIONS, GET, HEAD, DELETE, PUT, POST"<br>nginx.ingress.kubernetes.io/cors-allow-origin: "https://*.minikube.net"<br>nginx.ingress.kubernetes.io/cors-allow-headers: "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization,Safe-Wallet-Signature,Safe-Wallet-Signature-Timestamp"` |
 
 ### Redis parameters
 
 | Parameter | Description | Default |
 |---|---|---|
-| safe-client-gateway-redis.enabled | Spin up a Redis instance | true |
+| `safe-client-gateway-redis.enabled` | Spin up a Redis instance | `true` |
 
 Refer to [bitnami/redis](https://artifacthub.io/packages/helm/bitnami/redis) for configuration.