update charts parameters and docs

charts/README.md

@@ -1,35 +1,53 @@
-# DTM
+# DTM charts
 
 ## 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
 
 ### Configuration parameters
 
-| Key           | Description                                        | Value |
-| ------------- | -------------------------------------------------- | ----- |
-| configuration | DTM configuration. Specify content for config.yaml | ""    |
+| Key             | Description                                                                                                                           | Value |
+|-----------------|---------------------------------------------------------------------------------------------------------------------------------------|-------|
+| `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
 
-| Key                          | Description                                                                     | Value             |
-| ---------------------------- | ------------------------------------------------------------------------------- | ----------------- |
-| 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.annotations          | To enable certificate autogeneration, place here your cert-manager annotations. | {}                |
-| 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.pathType | Ingress path type                                                               | "Prefix"          |
-| ingress.tls                  | Enable TLS configuration for the host defined at ingress.hostname parameter     | []                |
+| Key                            | Description                                                                      | Value               |
+|--------------------------------|----------------------------------------------------------------------------------|---------------------|
+| `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.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.paths.path`     | Default path for the ingress record                                              | `"/"`               |
+| `ingress.hosts.paths.pathType` | Ingress path type                                                                | `"Prefix"`          |
+| `ingress.tls`                  | Enable TLS configuration for the host defined at ingress.hostname parameter      | `[]`                |

charts/values.yaml

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