diff --git a/charts/safe-client-gateway/README.md b/charts/safe-client-gateway/README.md index 0102b76..1949ef2 100644 --- 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
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
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"
nginx.ingress.kubernetes.io/enable-cors: "true"
nginx.ingress.kubernetes.io/cors-allow-methods: "OPTIONS, GET, HEAD, DELETE, PUT, POST"
nginx.ingress.kubernetes.io/cors-allow-origin: "https://*.minikube.net"
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"
nginx.ingress.kubernetes.io/enable-cors: "true"
nginx.ingress.kubernetes.io/cors-allow-methods: "OPTIONS, GET, HEAD, DELETE, PUT, POST"
nginx.ingress.kubernetes.io/cors-allow-origin: "https://*.minikube.net"
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. diff --git a/charts/safe-config-service/README.md b/charts/safe-config-service/README.md index 8cb4e9a..dee92d4 100644 --- a/charts/safe-config-service/README.md +++ b/charts/safe-config-service/README.md @@ -38,10 +38,10 @@ The command deploys safe-config-service 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. @@ -69,64 +69,64 @@ helm show values safe-config-service | Parameter | Description | Default | |---|---|---| -| nameOverride | Provide a name in place of safe-config-service for `app:` labels | "" | -| fullnameOverride | Provide a name to substitute for the full names of resources | "" | +| `nameOverride` | Provide a name in place of safe-config-service 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-config-service-web | 1 | -| image.repository | safe-config-service image name | safeglobal/safe-config-service | -| image.tag | safe-config-service image tag | latest | -| image.pullPolicy | Image pull policy | Always | -| extraEnv | Specify additional environment variables | [] | +| `replicaCount` | Number of instance for safe-config-service-web | `1` | +| `image.repository` | safe-config-service image name | `safeglobal/safe-config-service` | +| `image.tag` | safe-config-service 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.secretKey | Django secret key | "" | -| config.csrf.trustedOrigins | Trusted origins should refer to safe-wallet-web URL | "" | -| config.clientGateway.url | URL of the Client-Gateway | "" | -| config.clientGateway.token | Client-Gateway flush token | "" | -| config.database.runMigration | Run Database migration on startup | true | -| config.database.host | Database Host
if `safe-config-service-postgresql.enabled=false` | "" | -| config.database.port | Database Port
if `safe-config-service-postgresql.enabled=false` | "" | -| config.database.user | Database Username
if `safe-config-service-postgresql.enabled=false` | "" | -| config.database.password | Database Password
if `safe-config-service-postgresql.enabled=false` | "" | -| config.database.db | Database DB
if `safe-config-service-postgresql.enabled=false` | "" | -| config.admin.auth.enabled | Autoconfigure Django admin panel on startup | true | -| config.admin.auth.username | Django admin panel username | root | -| config.admin.auth.password | Django admin panel password | root123 | -| config.admin.auth.email | Django admin panel email | root@example.com | +| `config.debug` | Enable debug mode | `true` | +| `config.secretKey` | Django secret key | `""` | +| `config.csrf.trustedOrigins` | Trusted origins should refer to safe-wallet-web URL | `""` | +| `config.clientGateway.url` | URL of the Client-Gateway | `""` | +| `config.clientGateway.token` | Client-Gateway flush token | `""` | +| `config.database.runMigration` | Run Database migration on startup | `true` | +| `config.database.host` | Database Host
if `safe-config-service-postgresql.enabled=false` | `""` | +| `config.database.port` | Database Port
if `safe-config-service-postgresql.enabled=false` | `""` | +| `config.database.user` | Database Username
if `safe-config-service-postgresql.enabled=false` | `""` | +| `config.database.password` | Database Password
if `safe-config-service-postgresql.enabled=false` | `""` | +| `config.database.db` | Database DB
if `safe-config-service-postgresql.enabled=false` | `""` | +| `config.admin.auth.enabled` | Autoconfigure Django admin panel on startup | `true` | +| `config.admin.auth.username` | Django admin panel username | `root` | +| `config.admin.auth.password` | Django admin panel password | `root123` | +| `config.admin.auth.email` | Django admin panel email | `root@example.com` | ### 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"
nginx.ingress.kubernetes.io/enable-cors: "false" | +| `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"
nginx.ingress.kubernetes.io/enable-cors: "false"` | ### Database parameters | Parameter | Description | Default | |---|---|---| -| safe-config-service-postgresql.enabled | Spin up a PostgreSQL instance | true | +| `safe-config-service-postgresql.enabled` | Spin up a PostgreSQL instance | `true` | Refer to [bitnami/postgresql](https://artifacthub.io/packages/helm/bitnami/postgresql) for configuration. @@ -136,43 +136,43 @@ Refer to [bitnami/postgresql](https://artifacthub.io/packages/helm/bitnami/postg | Parameter | Description | Default | |---------------------------------------------|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| -| nameOverride | Provide a name in place of safe-config-service for `app:` labels | "" | -| fullnameOverride | Provide a name to substitute for the full names of resources | "" | -| imagePullSecrets | Reference to one or more secrets to be used when pulling images | "" | -| replicaCount | Number of instance for safe-config-service-web | 1 | -| image.repository | safe-config-service image name | safeglobal/safe-config-service | -| image.tag | safe-config-service image tag | latest | -| image.pullPolicy | Image pull policy | Always | -| extraEnv | Specify additional environment variables | [] | -| config.debug | Enable debug mode | true | -| config.secretKey | Django secret key | "" | -| config.csrf.trustedOrigins | Trusted origins should refer to safe-wallet-web URL | "" | -| config.clientGateway.url | URL of the Client-Gateway | "" | -| config.clientGateway.token | Client-Gateway flush token | "" | -| config.database.runMigration | Run Database migration on startup | true | -| config.database.useExisting | Use an existing PostgreSQL instance (or spin up one) | false | -| config.database.url | Database Url (plsql://...) when config.database.useExisting=true | "" | -| config.database.port | Database port when config.database.useExisting=false | 5432 | -| config.database.user | Database username when config.database.useExisting=false | postgres | -| config.database.password | Database password when config.database.useExisting=false | postgres | -| config.database.db | Database name when config.database.useExisting=false | cfg | -| config.database.persistence.storageClass | Database persistence class when config.database.useExisting=false | standard | -| config.database.persistence.size | Database persistence size when config.database.useExisting=false | 100Mi | -| config.admin.auth.enabled | Autoconfigure Django admin panel on startup | true | -| config.admin.auth.username | Django admin panel username | root | -| config.admin.auth.password | Django admin panel password | root123 | -| config.admin.auth.email | Django admin panel email | root@example.com | -| web.nodeSelector | | {} | -| web.affinity | | {} | -| web.tolerations | | {} | -| web.securityContext | | {} | -| web.podSecurityContext | | {} | -| web.resources | | {} | -| ingress.enabled | Enable ingress | true | -| ingress.ingressClassName | Ingress class name | nginx | -| ingress.host | Ingress host | cfg-service.minikube.net | -| ingress.annotations | Ingress annotations | nginx.ingress.kubernetes.io/force-ssl-redirect : "true" nginx.ingress.kubernetes.io/enable-cors : "false" | -| | | | +| `nameOverride ` | Provide a name in place of safe-config-service for `app:` labels | `"" ` | +| `fullnameOverride ` | Provide a name to substitute for the full names of resources | `"" ` | +| `imagePullSecrets ` | Reference to one or more secrets to be used when pulling images | `"" ` | +| `replicaCount ` | Number of instance for safe-config-service-web | `1 ` | +| `image.repository ` | safe-config-service image name | `safeglobal/safe-config-service ` | +| `image.tag ` | safe-config-service image tag | `latest ` | +| `image.pullPolicy ` | Image pull policy | `Always ` | +| `extraEnv ` | Specify additional environment variables | `[] ` | +| `config.debug ` | Enable debug mode | `true ` | +| `config.secretKey ` | Django secret key | `"" ` | +| `config.csrf.trustedOrigins ` | Trusted origins should refer to safe-wallet-web URL | `"" ` | +| `config.clientGateway.url ` | URL of the Client-Gateway | `"" ` | +| `config.clientGateway.token ` | Client-Gateway flush token | `"" ` | +| `config.database.runMigration ` | Run Database migration on startup | `true ` | +| `config.database.useExisting ` | Use an existing PostgreSQL instance (or spin up one) | `false ` | +| `config.database.url ` | Database Url (plsql://...) when config.database.useExisting=true | `"" ` | +| `config.database.port ` | Database port when config.database.useExisting=false | `5432 ` | +| `config.database.user ` | Database username when config.database.useExisting=false | `postgres ` | +| `config.database.password ` | Database password when config.database.useExisting=false | `postgres ` | +| `config.database.db ` | Database name when config.database.useExisting=false | `cfg ` | +| `config.database.persistence.storageClass ` | Database persistence class when config.database.useExisting=false | `standard ` | +| `config.database.persistence.size ` | Database persistence size when config.database.useExisting=false | `100Mi ` | +| `config.admin.auth.enabled ` | Autoconfigure Django admin panel on startup | `true ` | +| `config.admin.auth.username ` | Django admin panel username | `root ` | +| `config.admin.auth.password ` | Django admin panel password | `root123 ` | +| `config.admin.auth.email ` | Django admin panel email | `root@example.com ` | +| `web.nodeSelector ` | | `{} ` | +| `web.affinity ` | | `{} ` | +| `web.tolerations ` | | `{} ` | +| `web.securityContext ` | | `{} ` | +| `web.podSecurityContext ` | | `{} ` | +| `web.resources ` | | `{} ` | +| `ingress.enabled ` | Enable ingress | `true ` | +| `ingress.ingressClassName ` | Ingress class name | `nginx ` | +| `ingress.host ` | Ingress host | `cfg-service.minikube.net ` | +| `ingress.annotations ` | Ingress annotations | `nginx.ingress.kubernetes.io/force-ssl-redirect : "true" nginx.ingress.kubernetes.io/enable-cors : "false"` | +| ` ` | | ` ` | ## Troubleshooting diff --git a/charts/safe-stack/README.md b/charts/safe-stack/README.md index 5d05d19..e29978f 100644 --- a/charts/safe-stack/README.md +++ b/charts/safe-stack/README.md @@ -43,10 +43,10 @@ The command deploys safe-stack on the Kubernetes cluster in the default configur ## 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. @@ -74,15 +74,15 @@ helm show values safe/safe-stack | Parameter | Description | Default | |---|---|---| -| nameOverride | Provide a name in place of safe-transaction-service for `app:` labels | "" | -| fullnameOverride | Provide a name to substitute for the full names of resources | "" | +| `nameOverride` | Provide a name in place of safe-transaction-service for `app:` labels | `""` | +| `fullnameOverride` | Provide a name to substitute for the full names of resources | `""` | ### safe-transaction-service parameters | Parameter | Description | Default | |---|---|---| -| safe-transaction-service.enabled | Spin up safe-transaction-service | true | +| `safe-transaction-service.enabled` | Spin up safe-transaction-service | `true` | Refer to [safe-global/safe-transaction-service](../safe-transaction-service/) for configuration. @@ -90,7 +90,7 @@ Refer to [safe-global/safe-transaction-service](../safe-transaction-service/) fo | Parameter | Description | Default | |---|---|---| -| safe-config-service.enabled | Spin up safe-config-service | true | +| `safe-config-service.enabled` | Spin up safe-config-service | `true` | Refer to [safe-global/safe-config-service](../safe-config-service/) for configuration. @@ -98,7 +98,7 @@ Refer to [safe-global/safe-config-service](../safe-config-service/) for configur | Parameter | Description | Default | |---|---|---| -| safe-client-gateway.enabled | Spin up safe-client-gateway | true | +| `safe-client-gateway.enabled` | Spin up safe-client-gateway | `true` | Refer to [safe-global/safe-client-gateway](../safe-client-gateway/) for configuration. @@ -106,7 +106,7 @@ Refer to [safe-global/safe-client-gateway](../safe-client-gateway/) for configur | Parameter | Description | Default | |---|---|---| -| safe-wallet-web.enabled | Spin up safe-wallet-web | true | +| `safe-wallet-web.enabled` | Spin up safe-wallet-web | `true` | Refer to [safe-global/safe-wallet-web](../safe-wallet-web/) for configuration. diff --git a/charts/safe-transaction-service/README.md b/charts/safe-transaction-service/README.md index 51efcee..804e7ef 100644 --- a/charts/safe-transaction-service/README.md +++ b/charts/safe-transaction-service/README.md @@ -75,89 +75,89 @@ helm show values safe/safe-transaction-service | Parameter | Description | Default | |---|---|---| -| nameOverride | Provide a name in place of safe-transaction-service for `app:` labels | "" | -| fullnameOverride | Provide a name to substitute for the full names of resources | "" | +| `nameOverride` | Provide a name in place of safe-transaction-service 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-transaction-service-web | 1 | -| image.repository | safe-transaction-service image name | safeglobal/safe-transaction-service | -| image.tag | safe-transaction-service image tag | latest | -| image.pullPolicy | Image pull policy | Always | -| extraEnv | Specify additional environment variables | [] | +| `replicaCount` | Number of instance for safe-transaction-service-web | `1` | +| `image.repository` | safe-transaction-service image name | `safeglobal/safe-transaction-service` | +| `image.tag` | safe-transaction-service 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.queues | Worker queues to enabled | default,indexing,contracts,tokens,notifications,webhooks | -| config.secretKey | Django secret key | "" | -| config.csrf.trustedOrigins | Trusted origins should refer to safe-wallet-web URL | "" | -| config.node.url | URL of the Ethereum RPC endpoint | "" | -| config.node.useGanacheNode | Specify if you want to use a testing Ganache node | false | -| config.database.runMigration | Run Database migration on startup | true | -| config.database.url | Database URL
if `safe-transaction-service-postgresql.enabled=false`
e.g `plsql://user:pw@host:port/db` | "" | -| config.redis.url | Redis URL
if `safe-transaction-service-redis.enabled=false`
e.g `redis://user:pw@host:port/0` | "" | -| config.rabbitmq.url | RabbitMQ URL
if `safe-transaction-service-rabbitmq.enabled=false`
e.g `amqp://` | "" | -| config.admin.auth.enabled | Autoconfigure Django admin panel on startup | true | -| config.admin.auth.username | Django admin panel username | root | -| config.admin.auth.password | Django admin panel password | root123 | -| config.admin.auth.email | Django admin panel email | root@example.com | +| `config.debug` | Enable debug mode | `true` | +| `config.queues` | Worker queues to enabled | `default,indexing,contracts,tokens,notifications,webhooks` | +| `config.secretKey` | Django secret key | `""` | +| `config.csrf.trustedOrigins` | Trusted origins should refer to safe-wallet-web URL | `""` | +| `config.node.url` | URL of the Ethereum RPC endpoint | `""` | +| `config.node.useGanacheNode` | Specify if you want to use a testing Ganache node | `false` | +| `config.database.runMigration` | Run Database migration on startup | `true` | +| `config.database.url` | Database URL
if `safe-transaction-service-postgresql.enabled=false`
e.g `plsql://user:pw@host:port/db` | `""` | +| `config.redis.url` | Redis URL
if `safe-transaction-service-redis.enabled=false`
e.g `redis://user:pw@host:port/0` | `""` | +| `config.rabbitmq.url` | RabbitMQ URL
if `safe-transaction-service-rabbitmq.enabled=false`
e.g `amqp://` | `""` | +| `config.admin.auth.enabled` | Autoconfigure Django admin panel on startup | `true` | +| `config.admin.auth.username` | Django admin panel username | `root` | +| `config.admin.auth.password` | Django admin panel password | `root123` | +| `config.admin.auth.email` | Django admin panel email | `root@example.com` | ### Pod parameters | Parameter | Description | Default | |---|---|---| -| scheduler.nodeSelector | | {} | -| scheduler.affinity | | {} | -| scheduler.tolerations | | {} | -| scheduler.securityContext | | {} | -| scheduler.podSecurityContext | | {} | -| scheduler.resources | | {} | -| indexer.nodeSelector | | {} | -| indexer.affinity | | {} | -| indexer.tolerations | | {} | -| indexer.securityContext | | {} | -| indexer.podSecurityContext | | {} | -| indexer.resources | | {} | -| web.nodeSelector | | {} | -| web.affinity | | {} | -| web.tolerations | | {} | -| web.securityContext | | {} | -| web.podSecurityContext | | {} | -| web.resources | | {} | +| `scheduler.nodeSelector` | | `{}` | +| `scheduler.affinity` | | `{}` | +| `scheduler.tolerations` | | `{}` | +| `scheduler.securityContext` | | `{}` | +| `scheduler.podSecurityContext` | | `{}` | +| `scheduler.resources` | | `{}` | +| `indexer.nodeSelector` | | `{}` | +| `indexer.affinity` | | `{}` | +| `indexer.tolerations` | | `{}` | +| `indexer.securityContext` | | `{}` | +| `indexer.podSecurityContext` | | `{}` | +| `indexer.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 | txs-service.minikube.net | -| ingress.annotations | Ingress annotations | nginx.ingress.kubernetes.io/force-ssl-redirect: "true"
nginx.ingress.kubernetes.io/enable-cors: "false" | +| `ingress.enabled` | Enable ingress | `true` | +| `ingress.ingressClassName` | Ingress class name | `nginx` | +| `ingress.host` | Ingress host | `txs-service.minikube.net` | +| `ingress.annotations` | Ingress annotations | `nginx.ingress.kubernetes.io/force-ssl-redirect: "true"
nginx.ingress.kubernetes.io/enable-cors: "false"` | ### Ganache (testing node) parameters | Parameter | Description | Default | |---|---|---| -| ganacheNode.enabled | Enable a Ganache (testing) node | true | -| ganacheNode.config.mnemonic | Ganache mnemonic used to deploy Safe contracts | "test test test test test test test test test test test junk" | -| ganacheNode.config.chainId | Ganache Chain ID | 1337 | -| ganacheNode.config.persistence.storageClass | Ganache persistence class | standard | -| ganacheNode.config.persistence.size | Ganache persistence size | 100Mi | -| ganacheNode.ingress.enabled | Enable ingress to expose the node | true | -| ganacheNode.ingress.ingressClassName | Node ingress class | nginx | -| ganacheNode.ingress.host | Node ingress host | node.minikube.net | -| ganacheNode.ingress.annotations | Node ingress annotation | {} | +| `ganacheNode.enabled` | Enable a Ganache (testing) node | `true` | +| `ganacheNode.config.mnemonic` | Ganache mnemonic used to deploy Safe contracts | `"test test test test test test test test test test test junk"` | +| `ganacheNode.config.chainId` | Ganache Chain ID | `1337` | +| `ganacheNode.config.persistence.storageClass` | Ganache persistence class | `standard` | +| `ganacheNode.config.persistence.size` | Ganache persistence size | `100Mi` | +| `ganacheNode.ingress.enabled` | Enable ingress to expose the node | `true` | +| `ganacheNode.ingress.ingressClassName` | Node ingress class | `nginx` | +| `ganacheNode.ingress.host` | Node ingress host | `node.minikube.net` | +| `ganacheNode.ingress.annotations` | Node ingress annotation | `{}` | ### Database parameters | Parameter | Description | Default | |---|---|---| -| safe-transaction-service-postgresql.enabled | Spin up a PostgreSQL instance | true | +| `safe-transaction-service-postgresql.enabled` | Spin up a PostgreSQL instance | `true` | Refer to [bitnami/postgresql](https://artifacthub.io/packages/helm/bitnami/postgresql) for configuration. @@ -165,7 +165,7 @@ Refer to [bitnami/postgresql](https://artifacthub.io/packages/helm/bitnami/postg | Parameter | Description | Default | |---|---|---| -| safe-transaction-service-redis.enabled | Spin up a Redis instance | true | +| `safe-transaction-service-redis.enabled` | Spin up a Redis instance | `true` | Refer to [bitnami/redis](https://artifacthub.io/packages/helm/bitnami/redis) for configuration. @@ -173,7 +173,7 @@ Refer to [bitnami/redis](https://artifacthub.io/packages/helm/bitnami/redis) for | Parameter | Description | Default | |---|---|---| -| safe-transaction-service-rabbitMQ.enabled | Spin up a RabbitMQ instance | true | +| `safe-transaction-service-rabbitMQ.enabled` | Spin up a RabbitMQ instance | `true` | Refer to [bitnami/rabbitmq](https://artifacthub.io/packages/helm/bitnami/rabbitmq) for configuration. diff --git a/charts/safe-wallet-web/README.md b/charts/safe-wallet-web/README.md index e4e5bec..64218ac 100644 --- a/charts/safe-wallet-web/README.md +++ b/charts/safe-wallet-web/README.md @@ -35,10 +35,10 @@ The command deploys safe-wallet-web on the Kubernetes cluster in the default con ## 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. @@ -67,47 +67,47 @@ helm show values safe-wallet-web | Parameter | Description | Default | |---|---|---| -| nameOverride | Provide a name in place of safe-wallet-web for `app:` labels | "" | -| fullnameOverride | Provide a name to substitute for the full names of resources | "" | +| `nameOverride` | Provide a name in place of safe-wallet-web 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-wallet-web | 1 | -| image.repository | safe-wallet-web image name | safeglobal/safe-wallet-web | -| image.tag | safe-wallet-web image tag | latest | -| image.pullPolicy | Image pull policy | Always | -| extraEnv | Specify additional environment variables | [] | +| `replicaCount` | Number of instance for safe-wallet-web | `1` | +| `image.repository` | safe-wallet-web image name | `safeglobal/safe-wallet-web` | +| `image.tag` | safe-wallet-web 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.clientGateway.url | URL of the Client-Gateway | "" | -| config.walletConnect.projectId | Wallet-Connect project ID | "" | -| config.walletConnect.bridge | Wallet-Connect Bridge | "" | +| `config.debug` | Enable debug mode | `true` | +| `config.clientGateway.url` | URL of the Client-Gateway | `""` | +| `config.walletConnect.projectId` | Wallet-Connect project ID | `""` | +| `config.walletConnect.bridge` | Wallet-Connect Bridge | `""` | ### 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"
nginx.ingress.kubernetes.io/enable-cors: "false" | +| `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"
nginx.ingress.kubernetes.io/enable-cors: "false"` | ## Troubleshooting