github.com/unigraph-dev/dgraph@v1.1.1-0.20200923154953-8b52b426f765/contrib/config/kubernetes/helm/README.md (about)

     1  # Dgraph Helm Chart
     2  
     3  ## Installing the Chart
     4  
     5  To install the chart with the release name `my-release`:
     6  
     7  ```bash
     8  $ helm install --name my-release ./
     9  ```
    10  The above command will  install the latest available dgraph docker image. In order to install the older versions:
    11  ```bash
    12  $ helm install --name my-release ./ --set image.tag=XXX
    13  ```
    14  
    15  By default zero and alpha services are exposed only within the kubernetes cluster as kubernets service type "ClusterIP". In order to expose the alpha service to internet you can use kubernetes service type "LoadBalancer":
    16  
    17  ```bash
    18  $ helm install --name my-release ./ --set alpha.service.type="LoadBalancer"
    19  ```
    20  
    21  ## Deleting the Charts
    22  
    23  Delete the Helm deployment as normal
    24  
    25  ```
    26  $ helm delete my-release
    27  ```
    28  Deletion of the StatefulSet doesn't cascade to deleting associated PVCs. To delete them:
    29  
    30  ```
    31  $ kubectl delete pvc -l release=my-release,chart=dgraph
    32  ```
    33  
    34  ## Configuration
    35  
    36  The following table lists the configurable parameters of the dgraph chart and their default values.
    37  
    38  |              Parameter               |                             Description                             |                       Default                       |
    39  | ------------------------------------ | ------------------------------------------------------------------- | --------------------------------------------------- |
    40  | `image.registry`                     | Container registry name                                             | `docker.io`                                         |
    41  | `image.repository`                   | Container image name                                                | `dgraph/dgraph`                                     |
    42  | `image.tag`                          | Container image tag                                                 | `v1.0.13`                                           |
    43  | `image.pullPolicy`                   | Container pull policy                                               | `Always`                                            |
    44  | `zero.name`                          | Zero component name                                                 | `zero`                                              |
    45  | `zero.updateStrategy`                | Stratergy for upgrading zero nodes                                  | `RollingUpdate`                                     |
    46  | `zero.rollingUpdatePartition`        | Partition update strategy                                           | `nil`                                               |
    47  | `zero.podManagementPolicy`           | Pod management policy for zero nodes                                | `OrderedReady`                                      |
    48  | `zero.replicaCount`                  | Number of zero nodes                                                | `3`                                                 |
    49  | `zero.terminationGracePeriodSeconds` | Zero server pod termination grace period                            | `60`                                                |
    50  | `zero.antiAffinity`                  | Zero anti-affinity policy                                           | `soft`                                              |
    51  | `zero.podAntiAffinitytopologyKey`    | Anti affinity topology key for zero nodes                           | `kubernetes.io/hostname`                            |
    52  | `zero.nodeAffinity`                  | Zero node affinity policy                                           | `{}`                                                |
    53  | `zero.service.type`                  | Zero node service type                                              | `ClusterIP`                                         |
    54  | `zero.securityContext.enabled`       | Security context for zero nodes enabled                             | `false`                                             |
    55  | `zero.securityContext.fsGroup`       | Group id of the zero container                                      | `1001`                                              |
    56  | `zero.securityContext.runAsUser`     | User ID for the zero container                                      | `1001`                                              |
    57  | `zero.persistence.enabled`           | Enable persistence for zero using PVC                               | `true`                                              |
    58  | `zero.persistence.storageClass`      | PVC Storage Class for zero volume                                   | `nil`                                               |
    59  | `zero.persistence.accessModes`       | PVC Access Mode for zero volume                                     | `ReadWriteOnce`                                     |
    60  | `zero.persistence.size`              | PVC Storage Request for zero volume                                 | `8Gi`                                               |
    61  | `zero.nodeSelector`                  | Node labels for zero pod assignment                                 | `{}`                                                |
    62  | `zero.tolerations`                   | Zero tolerations                                                    | `[]`                                                |
    63  | `zero.resources`                     | Zero node resources requests & limits                               | `{}`                                                |
    64  | `zero.livenessProbe`                 | Zero liveness probes                                                | `See values.yaml for defaults`                      |
    65  | `zero.readinessProbe`                | Zero readiness probes                                               | `See values.yaml for defaults`                      |
    66  | `alpha.name`                         | Alpha component name                                                | `alpha`                                             |
    67  | `alpha.updateStrategy`               | Stratergy for upgrading alpha nodes                                 | `RollingUpdate`                                     |
    68  | `alpha.rollingUpdatePartition`       | Partition update strategy                                           | `nil`                                               |
    69  | `alpha.podManagementPolicy`          | Pod management policy for alpha nodes                               | `OrderedReady`                                      |
    70  | `alpha.replicaCount`                 | Number of alpha nodes                                               | `3`                                                 |
    71  | `alpha.terminationGracePeriodSeconds`| Alpha server pod termination grace period                           | `60`                                                |
    72  | `alpha.antiAffinity`                 | Alpha anti-affinity policy                                          | `soft`                                              |
    73  | `alpha.podAntiAffinitytopologyKey`   | Anti affinity topology key for zero nodes                           | `kubernetes.io/hostname`                            |
    74  | `alpha.nodeAffinity`                 | Alpha node affinity policy                                          | `{}`                                                |
    75  | `alpha.service.type`                 | Alpha node service type                                             | `ClusterIP`                                         |
    76  | `alpha.securityContext.enabled`      | Security context for alpha nodes enabled                            | `false`                                             |
    77  | `alpha.securityContext.fsGroup`      | Group id of the alpha container                                     | `1001`                                              |
    78  | `alpha.securityContext.runAsUser`    | User ID for the alpha container                                     | `1001`                                              |
    79  | `alpha.persistence.enabled`          | Enable persistence for alpha using PVC                              | `true`                                              |
    80  | `alpha.persistence.storageClass`     | PVC Storage Class for alpha volume                                  | `nil`                                               |
    81  | `alpha.persistence.accessModes`      | PVC Access Mode for alpha volume                                    | `ReadWriteOnce`                                     |
    82  | `alpha.persistence.size`             | PVC Storage Request for alpha volume                                | `8Gi`                                               |
    83  | `alpha.nodeSelector`                 | Node labels for alpha pod assignment                                | `{}`                                                |
    84  | `alpha.tolerations`                  | Alpha tolerations                                                   | `[]`                                                |
    85  | `alpha.resources`                    | Alpha node resources requests & limits                              | `{}`                                                |
    86  | `alpha.livenessProbe`                | Alpha liveness probes                                               | `See values.yaml for defaults`                      |
    87  | `alpha.readinessProbe`               | Alpha readiness probes                                              | `See values.yaml for defaults`                      |
    88  | `ratel.name`                         | Ratel component name                                                | `ratel`                                             |
    89  | `ratel.replicaCount`                 | Number of ratel nodes                                               | `1`                                                 |
    90  | `ratel.service.type`                 | Ratel service type                                                  | `ClusterIP`                                         |
    91  | `ratel.securityContext.enabled`      | Security context for ratel nodes enabled                            | `false`                                             |
    92  | `ratel.securityContext.fsGroup`      | Group id of the ratel container                                     | `1001`                                              |
    93  | `ratel.securityContext.runAsUser`    | User ID for the ratel container                                     | `1001`                                              |
    94  | `ratel.livenessProbe`                | Ratel liveness probes                                               | `See values.yaml for defaults`                      |
    95  | `ratel.readinessProbe`               | Ratel readiness probes                                              | `See values.yaml for defaults`                      |