A Helm chart for gen3 Guppy Service
| Repository | Name | Version |
|---|---|---|
| file://../common | common | 0.1.11 |
| Key | Type | Default | Description |
|---|---|---|---|
| affinity | map | {"podAntiAffinity":{"preferredDuringSchedulingIgnoredDuringExecution":[{"podAffinityTerm":{"labelSelector":{"matchExpressions":[{"key":"app","operator":"In","values":["guppy"]}]},"topologyKey":"kubernetes.io/hostname"},"weight":100}]}} |
Affinity to use for the deployment. |
| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution | map | [{"podAffinityTerm":{"labelSelector":{"matchExpressions":[{"key":"app","operator":"In","values":["guppy"]}]},"topologyKey":"kubernetes.io/hostname"},"weight":100}] |
Option for scheduling to be required or preferred. |
| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0] | int | {"podAffinityTerm":{"labelSelector":{"matchExpressions":[{"key":"app","operator":"In","values":["guppy"]}]},"topologyKey":"kubernetes.io/hostname"},"weight":100} |
Weight value for preferred scheduling. |
| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0] | list | {"key":"app","operator":"In","values":["guppy"]} |
Label key for match expression. |
| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].operator | string | "In" |
Operation type for the match expression. |
| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.labelSelector.matchExpressions[0].values | list | ["guppy"] |
Value for the match expression key. |
| affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[0].podAffinityTerm.topologyKey | string | "kubernetes.io/hostname" |
Value for topology key label. |
| arboristUrl | string | "http://arborist-service" |
Arborist service URL. |
| authFilterField | string | "auth_resource_path" |
The field used for access control and authorization filters |
| automountServiceAccountToken | bool | false |
Automount the default service account token |
| autoscaling | map | {"enabled":false,"maxReplicas":100,"minReplicas":1,"targetCPUUtilizationPercentage":80} |
Configuration for autoscaling the number of replicas |
| autoscaling.enabled | bool | false |
Whether autoscaling is enabled |
| autoscaling.maxReplicas | int | 100 |
The maximum number of replicas to scale up to |
| autoscaling.minReplicas | int | 1 |
The minimum number of replicas to scale down to |
| autoscaling.targetCPUUtilizationPercentage | int | 80 |
The target CPU utilization percentage for autoscaling |
| commonLabels | map | nil |
Will completely override the commonLabels defined in the common chart's _label_setup.tpl |
| configIndex | string | "dev_case-array-config" |
The Elasticsearch configuration index |
| criticalService | string | "true" |
Valid options are "true" or "false". If invalid option is set- the value will default to "false". |
| dataDog | bool | {"enabled":false,"env":"dev"} |
Whether Datadog is enabled. |
| datadogLogsInjection | bool | true |
If enabled, the Datadog Agent will automatically inject Datadog-specific metadata into your application logs. |
| datadogProfilingEnabled | bool | true |
If enabled, the Datadog Agent will collect profiling data for your application using the Continuous Profiler. This data can be used to identify performance bottlenecks and optimize your application. |
| datadogTraceSampleRate | int | 1 |
A value between 0 and 1, that represents the percentage of requests that will be traced. For example, a value of 0.5 means that 50% of requests will be traced. |
| dbRestore | bool | false |
Whether or not to restore elasticsearch indices from a snapshot in s3 |
| enableEncryptWhitelist | bool | true |
Whether or not to enable encryption for specified fields |
| encryptWhitelist | string | "test1" |
A comma-separated list of fields to encrypt |
| esEndpoint | string | "gen3-elasticsearch-master:9200" |
Elasticsearch endpoint. |
| global.aws | map | {"awsAccessKeyId":null,"awsSecretAccessKey":null,"enabled":false} |
AWS configuration |
| global.aws.awsAccessKeyId | string | nil |
Credentials for AWS stuff. |
| global.aws.awsSecretAccessKey | string | nil |
Credentials for AWS stuff. |
| global.aws.enabled | bool | false |
Set to true if deploying to AWS. Controls ingress annotations. |
| global.ddEnabled | bool | false |
Whether Datadog is enabled. |
| global.dev | bool | true |
Whether the deployment is for development purposes. |
| global.dictionaryUrl | string | "https://s3.amazonaws.com/dictionary-artifacts/datadictionary/develop/schema.json" |
URL of the data dictionary. |
| global.dispatcherJobNum | int | "10" |
Number of dispatcher jobs. |
| global.environment | string | "default" |
Environment name. This should be the same as vpcname if you're doing an AWS deployment. Currently this is being used to share ALB's if you have multiple namespaces. Might be used other places too. |
| global.hostname | string | "localhost" |
Hostname for the deployment. |
| global.kubeBucket | string | "kube-gen3" |
S3 bucket name for Kubernetes manifest files. |
| global.logsBucket | string | "logs-gen3" |
S3 bucket name for log files. |
| global.minAvialable | int | 1 |
The minimum amount of pods that are available at all times if the PDB is deployed. |
| global.netPolicy | bool | true |
Whether network policies are enabled. |
| global.pdb | bool | false |
If the service will be deployed with a Pod Disruption Budget. Note- you need to have more than 2 replicas for the pdb to be deployed. |
| global.portalApp | string | "gitops" |
Portal application name. |
| global.postgres.dbCreate | bool | true |
Whether the database should be created. |
| global.postgres.externalSecret | string | "" |
Name of external secret. Disabled if empty |
| global.postgres.master | map | {"host":null,"password":null,"port":"5432","username":"postgres"} |
Master credentials to postgres. This is going to be the default postgres server being used for each service, unless each service specifies their own postgres |
| global.postgres.master.host | string | nil |
hostname of postgres server |
| global.postgres.master.password | string | nil |
password for superuser in postgres. This is used to create or restore databases |
| global.postgres.master.port | string | "5432" |
Port for Postgres. |
| global.postgres.master.username | string | "postgres" |
username of superuser in postgres. This is used to create or restore databases |
| global.publicDataSets | bool | true |
Whether public datasets are enabled. |
| global.revproxyArn | string | "arn:aws:acm:us-east-1:123456:certificate" |
ARN of the reverse proxy certificate. |
| global.tierAccessLevel | string | "libre" |
Access level for tiers. |
| global.tierAccessLimit | int | "1000" |
Only relevant if tireAccessLevel is set to "regular". Summary charts below this limit will not appear for aggregated data. |
| image | map | {"pullPolicy":"Always","repository":"quay.io/cdis/guppy","tag":""} |
Docker image information. |
| image.pullPolicy | string | "Always" |
Docker pull policy. |
| image.repository | string | "quay.io/cdis/guppy" |
Docker repository. |
| image.tag | string | "" |
Overrides the image tag whose default is the chart appVersion. |
| indices | list | [{"index":"dev_case","type":"case"},{"index":"dev_file","type":"file"}] |
Elasticsearch index configurations |
| partOf | string | "Explorer-Tab" |
Label to help organize pods and their use. Any value is valid, but use "_" or "-" to divide words. |
| release | string | "production" |
Valid options are "production" or "dev". If invalid option is set- the value will default to "dev". |
| replicaCount | int | 1 |
Number of replicas for the deployment. |
| resources | map | {"limits":{"cpu":1,"memory":"2Gi"},"requests":{"cpu":0.1,"memory":"500Mi"}} |
Resource requests and limits for the containers in the pod |
| resources.limits | map | {"cpu":1,"memory":"2Gi"} |
The maximum amount of resources that the container is allowed to use |
| resources.limits.cpu | string | 1 |
The maximum amount of CPU the container can use |
| resources.limits.memory | string | "2Gi" |
The maximum amount of memory the container can use |
| resources.requests | map | {"cpu":0.1,"memory":"500Mi"} |
The amount of resources that the container requests |
| resources.requests.cpu | string | 0.1 |
The amount of CPU requested |
| resources.requests.memory | string | "500Mi" |
The amount of memory requested |
| revisionHistoryLimit | int | 2 |
Number of old revisions to retain |
| secrets | map | {"awsAccessKeyId":null,"awsSecretAccessKey":null} |
Secret information to access the db restore job S3 bucket. |
| secrets.awsAccessKeyId | str | nil |
AWS access key ID. Overrides global key. |
| secrets.awsSecretAccessKey | str | nil |
AWS secret access key ID. Overrides global key. |
| selectorLabels | map | nil |
Will completely override the selectorLabels defined in the common chart's _label_setup.tpl |
| service | map | {"port":[{"name":"http","port":80,"protocol":"TCP","targetPort":8000}],"type":"ClusterIP"} |
Kubernetes service information. |
| service.port | int | [{"name":"http","port":80,"protocol":"TCP","targetPort":8000}] |
The port number that the service exposes. |
| service.type | string | "ClusterIP" |
Type of service. Valid values are "ClusterIP", "NodePort", "LoadBalancer", "ExternalName". |
| strategy | map | {"rollingUpdate":{"maxSurge":1,"maxUnavailable":0},"type":"RollingUpdate"} |
Rolling update deployment strategy |
| strategy.rollingUpdate.maxSurge | int | 1 |
Number of additional replicas to add during rollout. |
| strategy.rollingUpdate.maxUnavailable | int | 0 |
Maximum amount of pods that can be unavailable during the update. |
| volumeMounts | list | [{"mountPath":"/guppy/guppy_config.json","name":"guppy-config","readOnly":true,"subPath":"guppy_config.json"}] |
Volumes to mount to the container. |
| volumes | list | [{"configMap":{"items":[{"key":"guppy_config.json","path":"guppy_config.json"}],"name":"manifest-guppy"},"name":"guppy-config"}] |
Volumes to attach to the pod. |