Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gjeanmart committed Jul 26, 2024
1 parent b364aaa commit 0d84579
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions charts/safe-config-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,75 @@ See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_h
helm show values safe-config-service
```

### Common parameters

| 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 | "" |

### 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 | [] |

### 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<br>if `safe-config-service-postgresql.enabled=false` | "" |
| config.database.port | Database Port<br>if `safe-config-service-postgresql.enabled=false` | "" |
| config.database.user | Database Username<br>if `safe-config-service-postgresql.enabled=false` | "" |
| config.database.password | Database Password<br>if `safe-config-service-postgresql.enabled=false` | "" |
| config.database.db | Database DB<br>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 | [email protected] |

### Pod parameters

| Parameter | Description | Default |
|---|---|---|
| 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: "false" |

### Database parameters

| Parameter | Description | Default |
|---|---|---|
| safe-config-service-postgresql.enabled | Spin up a PostgreSQL instance | true |

Refer to [bitnami/postgresql](https://artifacthub.io/packages/helm/bitnami/postgresql) for configuration.





| Parameter | Description | Default |
|---------------------------------------------|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| nameOverride | Provide a name in place of safe-config-service for `app:` labels | "" |
Expand Down

0 comments on commit 0d84579

Please sign in to comment.