diff --git a/charts/greptimedb-operator/README.md b/charts/greptimedb-operator/README.md index d242497..bf98c95 100644 --- a/charts/greptimedb-operator/README.md +++ b/charts/greptimedb-operator/README.md @@ -1,6 +1,6 @@ # Overview -Helm chart for GreptimeDB [operator](https://github.com/GreptimeTeam/greptimedb-operator). +Helm chart for [greptimedb-operator](https://github.com/GreptimeTeam/greptimedb-operator). ## How to install @@ -26,3 +26,24 @@ helm install greptimedb-operator greptime/greptimedb-operator -n default --versi ```console helm uninstall greptimedb-operator -n default ``` + +## Parameters + +### Common parameters + +| Name | Description | Value | +|------------------------------|-------------------------------------------------|--------------------------------| +| `image.registry` | GreptimeDB operator image registry | `docker.io` | +| `image.repository` | GreptimeDB operator image name | `greptime/greptimedb-operator` | +| `image.tag` | GreptimeDB operator image tag | `0.1.0-alpha.17` | +| `image.imagePullPolicy` | GreptimeDB operator image pull policy | `IfNotPresent` | +| `image.pullSecrets` | Docker registry secret names as an array | `[]` | +| `resources.limits` | The resources limits for the container | `{}` | +| `resources.requests` | The requested resources for the container | `{}` | +| `replicas` | GreptimeDB operator replicas | `1` | +| `serviceAccount.create` | Create greptimedb operator service account | `true` | +| `serviceAccount.annotations` | GreptimeDB operator service account annotations | `{}` | +| `serviceAccount.name` | GreptimeDB operator service account name | `""` | +| `rbac.create` | Create rbac | `true` | +| `nodeSelector` | GreptimeDB operator node selector | `{}` | + diff --git a/charts/greptimedb-operator/values.yaml b/charts/greptimedb-operator/values.yaml index 71469f6..8e5d0b2 100644 --- a/charts/greptimedb-operator/values.yaml +++ b/charts/greptimedb-operator/values.yaml @@ -33,7 +33,7 @@ resources: memory: 128Mi rbac: - # install Role Based Access Control + # Install Role Based Access Control create: true nameOverride: "" diff --git a/charts/greptimedb-standalone/Chart.yaml b/charts/greptimedb-standalone/Chart.yaml index cb7dfd2..3ed6707 100644 --- a/charts/greptimedb-standalone/Chart.yaml +++ b/charts/greptimedb-standalone/Chart.yaml @@ -2,5 +2,5 @@ apiVersion: v2 name: greptimedb-standalone description: A Helm chart for deploying standalone greptimedb. type: application -version: 0.1.0-alpha.2 +version: 0.1.0-alpha.3 appVersion: 0.4.1 diff --git a/charts/greptimedb-standalone/README.md b/charts/greptimedb-standalone/README.md index fb34dbd..4fe52f3 100644 --- a/charts/greptimedb-standalone/README.md +++ b/charts/greptimedb-standalone/README.md @@ -18,3 +18,37 @@ helm install greptimedb-standalone greptime/greptimedb-standalone -n default --d ```console helm uninstall greptimedb-standalone -n default ``` + +## Parameters + +### Common parameters + +| Name | Description | Value | +|------------------------------|-------------------------------------------|-----------------------| +| `image.registry` | GreptimeDB image registry | `docker.io` | +| `image.repository` | GreptimeDB image name | `greptime/greptimedb` | +| `image.tag` | GreptimeDB image tag | `v0.4.1` | +| `image.pullPolicy` | GreptimeDB image pull policy | `IfNotPresent` | +| `image.pullSecrets` | Docker registry secret names as an array | `[]` | +| `resources.limits` | The resources limits for the container | `{}` | +| `resources.requests` | The requested resources for the container | `{}` | +| `serviceAccount.create` | Create greptimedb service account | `true` | +| `serviceAccount.annotations` | GreptimeDB service account annotations | `{}` | +| `serviceAccount.name` | GreptimeDB service account name | `""` | +| | | | +| | | | +| | | | +| | | | +| | | | + +### Volume parameters + + +### Metrics parameters + +| Name | Description | Value | +|-------------------------------|---------------------------------|---------| +| `monitoring.enabled` | Enable prometheus podmonitor | `false` | +| `monitoring.annotations` | HTTP path to scrape for metrics | `{}` | +| `monitoring.labels` | Prometheus podmonitor labels | `{}` | +| `monitoring.interval` | Scraped interval | `30s` | diff --git a/charts/greptimedb-standalone/values.yaml b/charts/greptimedb-standalone/values.yaml index bc40c75..5e8b461 100644 --- a/charts/greptimedb-standalone/values.yaml +++ b/charts/greptimedb-standalone/values.yaml @@ -157,7 +157,7 @@ monitoring: # PodMonitor labels labels: {} # PodMonitor scrape interval - interval: 15s + interval: 30s httpPort: 4000 grpcPort: 4001 diff --git a/charts/greptimedb/Chart.yaml b/charts/greptimedb/Chart.yaml index 5fbb76e..07a6fab 100644 --- a/charts/greptimedb/Chart.yaml +++ b/charts/greptimedb/Chart.yaml @@ -2,5 +2,5 @@ apiVersion: v2 name: greptimedb description: A Helm chart for deploying GreptimeDB cluster in Kubernetes type: application -version: 0.1.1-alpha.18 +version: 0.1.1-alpha.19 appVersion: 0.4.1 diff --git a/charts/greptimedb/README.md b/charts/greptimedb/README.md index 7ed43fa..28ed280 100644 --- a/charts/greptimedb/README.md +++ b/charts/greptimedb/README.md @@ -10,11 +10,19 @@ Helm chart for [GreptimeDB](https://github.com/GreptimeTeam/greptimedb) cluster. # Add charts repo. helm repo add greptime https://greptimeteam.github.io/helm-charts/ helm repo update +``` +``` # Optional: Install etcd cluster. # You also can use your own etcd cluster. -helm install etcd greptime/greptimedb-etcd -n default --devel +helm install etcd oci://registry-1.docker.io/bitnamicharts/etcd \ +--set replicaCount=3 \ +--set auth.rbac.create=false \ +--set auth.rbac.token.enabled=false \ +-n default +``` +``` # Install greptimedb in default namespace. helm install greptimedb greptime/greptimedb -n default --devel ``` @@ -24,3 +32,89 @@ helm install greptimedb greptime/greptimedb -n default --devel ```console helm uninstall greptimedb -n default ``` + +## Parameters + +### Common parameters + +| Name | Description | Value | +|------------------------------------|-------------------------------------------------------------|-----------------------------------| +| `image.registry` | GreptimeDB image registry | `docker.io` | +| `image.repository` | GreptimeDB image name | `greptime/greptimedb` | +| `image.tag` | GreptimeDB image tag | `v0.4.1` | +| `image.pullSecrets` | Docker registry secret names as an array | `[]` | +| `resources.limits` | The resources limits for the container | `{}` | +| `resources.requests` | The requested resources for the container | `{}` | +| `initializer.registry` | Initializer image registry | `docker.io` | +| `initializer.repository` | Initializer image repository | `greptime/greptimedb-initializer` | +| `initializer.tag` | Initializer image tag | `0.1.0-alpha.17` | +| `httpServicePort` | GreptimeDB http port | `4000` | +| `grpcServicePort` | GreptimeDB grpc port | `4001` | +| `mysqlServicePort` | GreptimeDB mysql port | `4002` | +| `postgresServicePort` | GreptimeDB postgres port | `4003` | +| `openTSDBServicePort` | GreptimeDB opentsdb port | `4242` | + + +### Frontend parameters + +| Name | Description | Value | +|-------------------------------------------------------------|------------------------------------------|---------| +| `frontend.replicas` | Frontend replicas | `1` | +| `frontend.service` | Frontend service | `{}` | +| `frontend.componentSpec` | Frontend componentSpec | `{}` | +| `frontend.tls.certificates.secretName` | Frontend tls certificates secret name | `""` | +| `frontend.tls.certificates.secretCreation.enabled` | Create frontend tls certificates secret | `true` | +| `frontend.tls.certificates.secretCreation.enableEncryption` | Encrypt frontend tls certificates secret | `false` | +| `frontend.tls.certificates.secretCreation.data.ca.crt` | Frontend tls certificates ca.crt | `""` | +| `frontend.tls.certificates.secretCreation.data.tls.crt` | Frontend tls certificates tls.crt | `""` | +| `frontend.tls.certificates.secretCreation.data.tls.key` | Frontend tls certificates tls.key | `""` | + +### Meta parameters + +| Name | Description | Value | +|----------------------|---------------------|------------------------------------------| +| `meta.replicas` | Meta replicas | `1` | +| `meta.etcdEndpoints` | Meta etcd endpoints | `etcd.default.svc.cluster.local:2379` | +| `meta.componentSpec` | Meta componentSpec | `{}` | + +### Datanode parameters + +| Name | Description | Value | +|---------------------------------|------------------------------------------------------|----------| +| `datanode.replicas` | Datanode replicas | `1` | +| `datanode.componentSpec` | Datanode componentSpec | `{}` | +| `datanode.storageClassName` | Storage class for datanode persistent volume | `null` | +| `datanode.storageSize` | Storage size for datanode persistent volume | `10Gi` | +| `datanode.storageRetainPolicy` | Storage retain policy for datanode persistent volume | `Retain` | + +### Storage parameters + +| Name | Description | Value | +|-------------------------------------------------------------|------------------------------------------|-------------------| +| `storage.credentials.secretName` | Storage credentials secret name | `credentials` | +| `storage.credentials.secretCreation.enabled` | Create frontend tls certificates secret | `true` | +| `storage.credentials.secretCreation.enableEncryption` | Encrypt frontend tls certificates secret | `false` | +| `storage.credentials.secretCreation.data.access-key-id` | Storage credentials access key id | `""` | +| `storage.credentials.secretCreation.data.secret-access-key` | Storage credentials secret access key | `""` | +| `storage.local.directory` | Local storage directory | `/tmp/greptimedb` | +| `storage.s3.bucket` | S3 storage bucket name | `""` | +| `storage.s3.region` | S3 storage bucket region | `""` | +| `storage.s3.root` | S3 storage bucket root | `""` | +| `storage.s3.endpoint` | S3 storage bucket endpoint | `""` | +| `storage.s3.secretName` | S3 storage credentials secret | `""` | +| `storage.oss.bucket` | OSS storage bucket name | `""` | +| `storage.oss.region` | OSS storage bucket region | `""` | +| `storage.oss.root` | OSS storage bucket root | `""` | +| `storage.oss.endpoint` | OSS storage bucket endpoint | `""` | +| `storage.oss.secretName` | OSS storage bucket credentials secret | `""` | + +### Metrics parameters + +| Name | Description | Value | +|------------------------------------|-------------------------------------------------------------|------------| +| `prometheusMonitor.enabled` | Enable prometheus podmonitor | `false` | +| `prometheusMonitor.path` | HTTP path to scrape for metrics | `/metrics` | +| `prometheusMonitor.port` | Target metrics port | `http` | +| `prometheusMonitor.interval` | Scraped interval | `30s` | +| `prometheusMonitor.honorLabels` | Chooses the metrics labels on collisions with target labels | `true` | +| `prometheusMonitor.labelsSelector` | Prometheus podmonitor labels | `{}` | diff --git a/charts/greptimedb/templates/cluster.yaml b/charts/greptimedb/templates/cluster.yaml index 626b2bc..aec9553 100644 --- a/charts/greptimedb/templates/cluster.yaml +++ b/charts/greptimedb/templates/cluster.yaml @@ -30,9 +30,9 @@ spec: {{- end }} meta: replicas: {{ .Values.meta.replicas }} - {{- if .Values.etcdEndpoints }} + {{- if .Values.meta.etcdEndpoints }} etcdEndpoints: - - {{ .Values.etcdEndpoints }} + - {{ .Values.meta.etcdEndpoints }} {{- end }} {{- if .Values.meta.componentSpec }} template: {{- toYaml .Values.meta.componentSpec | nindent 6 }} diff --git a/charts/greptimedb/values.yaml b/charts/greptimedb/values.yaml index b3fb844..2aa25e2 100644 --- a/charts/greptimedb/values.yaml +++ b/charts/greptimedb/values.yaml @@ -33,6 +33,8 @@ frontend: meta: replicas: 1 + # The etcdEndpoints need be modified to the actual etcd cluster. + etcdEndpoints: "etcd.default.svc.cluster.local:2379" componentSpec: {} datanode: @@ -51,9 +53,6 @@ initializer: repository: greptime/greptimedb-initializer tag: 0.1.0-alpha.17 -# The etcdEndpoints need be modified to the actual etcd cluster. -etcdEndpoints: "etcd.default.svc.cluster.local:2379" - httpServicePort: 4000 grpcServicePort: 4001 mysqlServicePort: 4002 @@ -62,7 +61,7 @@ openTSDBServicePort: 4242 # configure to prometheus podmonitor prometheusMonitor: {} -# enabled: true +# enabled: false # path: "/metrics" # port: "http" # interval: "30s"