Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@gjeanmart
gjeanmart committed Jul 26, 2024
1 parent ecf32d9 commit 2880ae9
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 47 deletions.
2 changes: 1 addition & 1 deletion charts/safe-client-gateway/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 | <pre><code>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"</code></pre> |
| `ingress.annotations` | Ingress annotations | <code>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"</code> |

### Redis parameters

Expand Down
45 changes: 1 addition & 44 deletions charts/safe-config-service/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"<br>nginx.ingress.kubernetes.io/enable-cors: "false"` |
| `ingress.annotations` | Ingress annotations | <code>nginx.ingress.kubernetes.io/force-ssl-redirect: "true"<br>nginx.ingress.kubernetes.io/enable-cors: "false"</code> |

### Database parameters

Expand All @@ -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 | `[email protected] ` |
| `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

-
2 changes: 1 addition & 1 deletion charts/safe-transaction-service/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"<br>nginx.ingress.kubernetes.io/enable-cors: "false"` |
| `ingress.annotations` | Ingress annotations | <code>nginx.ingress.kubernetes.io/force-ssl-redirect: "true"<br>nginx.ingress.kubernetes.io/enable-cors: "false"</code> |

### Ganache (testing node) parameters

Expand Down
2 changes: 1 addition & 1 deletion charts/safe-wallet-web/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"<br>nginx.ingress.kubernetes.io/enable-cors: "false"` |
| `ingress.annotations` | Ingress annotations | <code>nginx.ingress.kubernetes.io/force-ssl-redirect: "true"<br>nginx.ingress.kubernetes.io/enable-cors: "false"</code> |


## Troubleshooting
Expand Down

0 comments on commit 2880ae9

Please sign in to comment.