github.com/hellofresh/janus@v0.0.0-20230925145208-ce8de8183c67/janus/README.md (about)

     1  ## Prerequisites
     2  
     3  - Kubernetes 1.12+
     4  - Helm 2.11+
     5  
     6  ## Installing the Chart
     7  
     8  To install the chart with the release name `my-release`:
     9  
    10  ```console
    11  $ helm install --name my-release janus
    12  ```
    13  
    14  The command deploys Janus on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
    15  
    16  > **Tip**: List all releases using `helm list`
    17  
    18  ## Uninstalling the Chart
    19  
    20  To uninstall/delete the `my-release` deployment:
    21  
    22  ```console
    23  $ helm delete my-release
    24  ```
    25  
    26  The command removes all the Kubernetes components associated with the chart and deletes the release.
    27  
    28  ## Parameters
    29  
    30  The following table lists the configurable parameters of the Janus chart and their default values.
    31  
    32  | Parameter                           | Description                                                   | Default                                                  |
    33  |-------------------------------------|---------------------------------------------------------------|----------------------------------------------------------|
    34  | `image.repository`                  | Janus Image name                                              | `hellofreshtech/janus`                               |
    35  | `image.tag`                         | Janus Image tag                                               | `latest`                                                 |
    36  | `image.pullPolicy`                  | Janus pull policy                                             | `IfNotPresent`                                           |
    37  | `image.pullSecrets`                 | Specify docker-registry secret names as an array              | `[]` (does not add image pull secrets to deployed pods)  |
    38  | `nameOverride`                      | String to partially override janus.fullname template with a string (will prepend the release name) | `nil`               |
    39  | `fullnameOverride`                  | String to fully override janus.fullname template with a string                                     | `nil`               |
    40  | `allowEmptyPassword`                | Allow DB blank passwords                                      | `yes`                                                    |
    41  | `deployment.replicaCount`           | Number of Janus pod replicas                                  | `2`                                                      |
    42  | `deployment.minAvailable`           | Creates PDB is min available (must be less than replicaCount) | `1`                                                      |
    43  | `deployment.valuesFrom`             | Add needed env vars from Kubernetes metadata                  | `POD_NAME`                                               |
    44  | `deployment.labels`                 | Add custom labels to the deployment                           | `app: janus`                                             |
    45  | `deployment.databaseDSN`            | Database connection string                                    | `mongodb://janus-database:27017/janus`                   |
    46  | `service.type`                      | Kubernetes Service type                                       | `LoadBalancer`                                           |
    47  | `service.name`                      | Override service name                                         | ``                                                       |
    48  | `service.ports[0].protocol`         | Service HTTP protocol                                         | `TCP`                                                    |
    49  | `service.ports[0].port`             | Service HTTP port                                             | `80`                                                     |
    50  | `service.ports[0].targetPort`       | Service HTTP target container port                            | `8080`                                                   |
    51  | `service.ports[0].name`             | Service HTTP port name                                        | `http`                                                   |
    52  | `ingress.enabled`                   | Enable ingress controller resource                            | `false`                                                  |
    53  | `ingress.annotations`               | Ingress annotations                                           | `[]`                                                     |
    54  | `ingress.name`                      | Override ingress name                                         | ``                                                       |
    55  | `ingress.hosts[0].name`             | Hostname to your Janus installation                           | `janus.local`                                            |
    56  | `ingress.hosts[0].paths[0].port`    | Port to service                                               | `80`                                                     |
    57  | `ingress.hosts[0].paths[0].path`    | Path within the url structure                                 | `/`                                                      |
    58  | `resources`                         | CPU/Memory resource requests/limits                           | Default values of the cluster                            |
    59  | `affinity`                          | Map of node/pod affinities                                    | `{}`                                                     |