Browse Source

update charts parameters and docs

pull/220/head
xyctruth 4 years ago
parent
commit
773aadbc34
  1. 56
      charts/README.md
  2. 12
      charts/values.yaml

56
charts/README.md

@ -1,35 +1,53 @@
# DTM # DTM charts
## Usage ## Usage
To install the dtm chart: Install the dtm chart:
helm install --create-namespace -n dtm-system dtm . ```bash
helm install --create-namespace -n dtm-system dtm ./charts
```
To install the dtm chart: Upgrade the dtm chart:
helm upgrade -n dtm-system dtm . ```bash
helm upgrade -n dtm-system dtm ./charts
```
To uninstall the chart: Uninstall the chart:
helm delete -n dtm-system dtm ```bash
helm delete -n dtm-system dtm
```
## Parameters ## Parameters
### Configuration parameters ### Configuration parameters
| Key | Description | Value | | Key | Description | Value |
| ------------- | -------------------------------------------------- | ----- | |-----------------|---------------------------------------------------------------------------------------------------------------------------------------|-------|
| configuration | DTM configuration. Specify content for config.yaml | "" | | `configuration` | DTM configuration. Specify content for `config.yaml`, ref: [sample config](https://github.com/dtm-labs/dtm/blob/main/conf.sample.yml) | `""` |
### Autoscaling Parameters
| Name | Description | Value |
|-------------------------------------------------|-------------------------------------------|---------|
| `autoscaling.enabled` | Enable Horizontal POD autoscaling for DTM | `false` |
| `autoscaling.minReplicas` | Minimum number of DTM replicas | `1` |
| `autoscaling.maxReplicas` | Maximum number of DTM replicas | `10` |
| `autoscaling.targetCPUUtilizationPercentage` | Target CPU utilization percentage | `80` |
| `autoscaling.targetMemoryUtilizationPercentage` | Target Memory utilization percentage | `80` |
### Ingress parameters ### Ingress parameters
| Key | Description | Value | | Key | Description | Value |
| ---------------------------- | ------------------------------------------------------------------------------- | ----------------- | |--------------------------------|----------------------------------------------------------------------------------|---------------------|
| ingress.enabled | Enable ingress record generation for DTM | false | | `ingress.enabled` | Enable ingress record generation for DTM | `false` |
| ingress.className | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | "nginx" | | `ingress.className` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `"nginx"` |
| ingress.annotations | To enable certificate autogeneration, place here your cert-manager annotations. | {} | | `ingress.annotations` | To enable certificate auto generation, place here your cert-manager annotations. | `{}` |
| ingress.hosts.host | Default host for the ingress record. | "your-domain.com" | | `ingress.hosts.host` | Default host for the ingress record. | `"your-domain.com"` |
| ingress.hosts.paths.path | Default path for the ingress record | "/" | | `ingress.hosts.paths.path` | Default path for the ingress record | `"/"` |
| ingress.hosts.paths.pathType | Ingress path type | "Prefix" | | `ingress.hosts.paths.pathType` | Ingress path type | `"Prefix"` |
| ingress.tls | Enable TLS configuration for the host defined at ingress.hostname parameter | [] | | `ingress.tls` | Enable TLS configuration for the host defined at ingress.hostname parameter | `[]` |

12
charts/values.yaml

@ -26,12 +26,10 @@ imagePullSecrets: []
nameOverride: "" nameOverride: ""
fullnameOverride: "" fullnameOverride: ""
podSecurityContext: podSecurityContext: {}
{}
# fsGroup: 2000 # fsGroup: 2000
securityContext: securityContext: {}
{}
# capabilities: # capabilities:
# drop: # drop:
# - ALL # - ALL
@ -47,9 +45,9 @@ resources:
autoscaling: autoscaling:
enabled: false enabled: false
minReplicas: 1 minReplicas: 1
maxReplicas: 100 maxReplicas: 10
targetCPUUtilizationPercentage: 80 targetCPUUtilizationPercentage: 80
# targetMemoryUtilizationPercentage: 80 targetMemoryUtilizationPercentage: 80
nodeSelector: {} nodeSelector: {}
@ -64,7 +62,7 @@ service:
grpc: 36790 grpc: 36790
ingress: ingress:
enabled: false enabled: true
className: "nginx" className: "nginx"
annotations: annotations:
{} {}

Loading…
Cancel
Save