Skip to content

Latest commit

 

History

History
122 lines (93 loc) · 11.5 KB

README.md

File metadata and controls

122 lines (93 loc) · 11.5 KB
Raw

2GIS License service

Read more about the On-Premise solution here.

Note:

All On-Premise services are beta, and under development.

See the documentation to learn about:

  • Architecture of the service.

  • Installing the service.

  • Updating the service.

Values

Docker Registry settings

Name Description Value
dgctlDockerRegistry Docker Registry endpoint where On-Premise services' images reside. Format: host:port. ""

Deployment Artifacts Storage settings

Name Description Value
dgctlStorage.host S3 endpoint. Format: host:port. ""
dgctlStorage.secure If S3 uses https. false
dgctlStorage.bucket S3 bucket name. ""
dgctlStorage.accessKey S3 access key for accessing the bucket. ""
dgctlStorage.secretKey S3 secret key for accessing the bucket. ""

Common settings

Name Description Value
nameOverride Base name to use in all the Kubernetes entities deployed by this chart. ""
fullnameOverride Base fullname to use in all the Kubernetes entities deployed by this chart. ""
annotations Kubernetes annotations. {}
labels Kubernetes labels. {}
podAnnotations Kubernetes pod annotations. {}
podLabels Kubernetes pod labels. {}
serviceAccountOverride Kubernetes pod service account. Should include rule for watching pods in current namespace. If not defined it will be created automatically. Not needed for license type 1. ""
nodeSelector Kubernetes pod node selectors. {}
tolerations Kubernetes pod tolerations settings. []
affinity Kubernetes pod affinity settings. {}
imagePullSecrets Kubernetes image pull secrets. []

StatefulSet settings

Name Description Value
image.repository Repository. 2gis-on-premise/license
image.tag Tag. 2.2.1
image.pullPolicy Pull Policy. IfNotPresent

License service application settings

Name Description Value
license.type License type. Should be auto generated with dgctl pull --generate-values. ""
license.retryPeriod Duration how often service should try to fetch license from storage if previous attempts were failing. Duration format is any string supported by (time.ParseDuration)[https://pkg.go.dev/time#ParseDuration]. 30s
license.softBlockPeriod Duration until the license expiration time when license service should respond with 'soft' block status. For this duration additional time units 'd' for days and 'w' for weeks are supported. 2w

Service settings

Name Description Value
service.type Kubernetes service type. ClusterIP
service.statusPort Service port for status page and api/v1 (HTTP). 80
service.apiPort Service port for api/v2 (HTTPS). 443
service.annotations Kubernetes service annotations. {}
service.labels Kubernetes service labels. {}

Kubernetes Ingress settings

Name Description Value
ingress.enabled If Ingress is enabled for the service. false
ingress.className Name of the Ingress controller class. nginx
ingress.hosts[0].host Hostname for the Ingress service. license.example.com
ingress.hosts[0].paths[0].path Path of the host for the Ingress service. /
ingress.hosts[0].paths[0].pathType Type of the path for the Ingress service. Prefix
ingress.tls TLS configuration []

Limits

Name Description Value
resources.requests.cpu A CPU request. 500m
resources.requests.memory A memory request. 128Mi
resources.limits.cpu A CPU limit. 1
resources.limits.memory A memory limit. 512Mi

Persistence settings

Name Description Value
persistence.host S3 endpoint. Format: host:port. ""
persistence.secure If S3 uses https. false
persistence.bucket S3 bucket name. ""
persistence.root Root directory in S3 bucket. ""
persistence.accessKey S3 access key for accessing the bucket. ""
persistence.secretKey S3 secret key for accessing the bucket. ""

TPM-related settings for license type 2

Name Description Value
tpm.mountTPMDevice If TPM device should be mounted to the main container. Required if no TPM device plugin is used. Adds privileged access for the main container. false
tpm.pvcBind Kubernetes PVC used to bind pod to the kubernetes node
tpm.pvcBind.enable If PVC should be used to bind pod to the kubernetes node. false
tpm.pvcBind.storageClassName Storage class name. ""

Custom Certificate Authority

Name Description Value
customCAs.bundle Custom CA text representation of the X.509 PEM public-key certificate ""
customCAs.certsPath Custom CA bundle mount directory in the container. ""