From 2880ae9266969588c5783918ed339df04edeb869 Mon Sep 17 00:00:00 2001 From: Greg Jeanmart Date: Fri, 26 Jul 2024 14:01:36 +0200 Subject: [PATCH] update README --- charts/safe-client-gateway/README.md | 2 +- charts/safe-config-service/README.md | 45 +---------------------- charts/safe-transaction-service/README.md | 2 +- charts/safe-wallet-web/README.md | 2 +- 4 files changed, 4 insertions(+), 47 deletions(-) diff --git a/charts/safe-client-gateway/README.md b/charts/safe-client-gateway/README.md index 4e6c1e4..c984858 100644 --- a/charts/safe-client-gateway/README.md +++ b/charts/safe-client-gateway/README.md @@ -113,7 +113,7 @@ helm show values safe-client-gateway | `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.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 diff --git a/charts/safe-config-service/README.md b/charts/safe-config-service/README.md index dee92d4..5d6df70 100644 --- a/charts/safe-config-service/README.md +++ b/charts/safe-config-service/README.md @@ -120,7 +120,7 @@ helm show values safe-config-service | `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.annotations` | Ingress annotations | nginx.ingress.kubernetes.io/force-ssl-redirect: "true"
nginx.ingress.kubernetes.io/enable-cors: "false" | ### Database parameters @@ -132,49 +132,6 @@ 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"` | -| ` ` | | ` ` | - - ## Troubleshooting - \ No newline at end of file diff --git a/charts/safe-transaction-service/README.md b/charts/safe-transaction-service/README.md index 804e7ef..722e19b 100644 --- a/charts/safe-transaction-service/README.md +++ b/charts/safe-transaction-service/README.md @@ -137,7 +137,7 @@ helm show values safe/safe-transaction-service | `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.annotations` | Ingress annotations | nginx.ingress.kubernetes.io/force-ssl-redirect: "true"
nginx.ingress.kubernetes.io/enable-cors: "false" | ### Ganache (testing node) parameters diff --git a/charts/safe-wallet-web/README.md b/charts/safe-wallet-web/README.md index 64218ac..abe1121 100644 --- a/charts/safe-wallet-web/README.md +++ b/charts/safe-wallet-web/README.md @@ -107,7 +107,7 @@ helm show values safe-wallet-web | `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.annotations` | Ingress annotations | nginx.ingress.kubernetes.io/force-ssl-redirect: "true"
nginx.ingress.kubernetes.io/enable-cors: "false" | ## Troubleshooting