Skip to content

Commit

Permalink
feat: add more parameter description
Browse files Browse the repository at this point in the history
  • Loading branch information
@daviderli614
daviderli614 committed Oct 19, 2023
1 parent c4482f3 commit 0437437
Show file tree
Hide file tree
Showing 7 changed files with 86 additions and 60 deletions.
2 changes: 1 addition & 1 deletion charts/greptimedb-cluster/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ apiVersion: v2
name: greptimedb-cluster
description: A Helm chart for deploying GreptimeDB cluster in Kubernetes
type: application
version: 0.1.0
version: 0.1.1
appVersion: 0.4.1
36 changes: 20 additions & 16 deletions charts/greptimedb-cluster/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +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
```

```console
# Optional: Install etcd cluster.
# You also can use your own etcd cluster.
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
```

```console
# Install greptimedb in default namespace.
helm install greptimedb-cluster greptime/greptimedb-cluster -n default --devel
```
Expand All @@ -33,22 +37,22 @@ helm uninstall greptimedb-cluster -n default

### 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` |
| Name | Description | Value |
|------------------------------------|-------------------------------------------|-----------------------------------|
| `image.registry` | Image registry | `docker.io` |
| `image.repository` | Image name | `greptime/greptimedb` |
| `image.tag` | 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
Expand Down
4 changes: 2 additions & 2 deletions charts/greptimedb-cluster/templates/cluster.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
6 changes: 2 additions & 4 deletions charts/greptimedb-cluster/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ frontend:

meta:
replicas: 1
etcdEndpoints: "etcd.default.svc.cluster.local:2379"
componentSpec: {}

datanode:
Expand All @@ -51,9 +52,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
Expand All @@ -62,7 +60,7 @@ openTSDBServicePort: 4242

# configure to prometheus podmonitor
prometheusMonitor: {}
# enabled: true
# enabled: false
# path: "/metrics"
# port: "http"
# interval: "30s"
Expand Down
32 changes: 17 additions & 15 deletions charts/greptimedb-operator/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,21 @@ helm uninstall greptimedb-operator -n default

### 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 | `{}` |
| Name | Description | Value |
|------------------------------|----------------------------------------------------|---------------------------------|
| `nameOverride` | String to partially override release template name | `""` |
| `fullnameOverride` | String to fully override release template name | `""` |
| `image.registry` | Image registry | `docker.io` |
| `image.repository` | Image name | `greptime/greptimedb-operator` |
| `image.tag` | Image tag | `0.1.0-alpha.17` |
| `image.imagePullPolicy` | 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` | The operator replicas | `1` |
| `serviceAccount.create` | Create service account | `true` |
| `serviceAccount.annotations` | Service account annotations | `{}` |
| `serviceAccount.name` | Service account name | `""` |
| `rbac.create` | Create rbac | `true` |
| `nodeSelector` | The operator node selector | `{}` |

60 changes: 41 additions & 19 deletions charts/greptimedb-standalone/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,52 @@ 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 | `""` |
| | | |
| | | |
| | | |
| | | |
| | | |
| Name | Description | Value |
|---------------------------------|---------------------------------------------------------------------|-----------------------|
| `nameOverride` | String to partially override release template name | `""` |
| `fullnameOverride` | String to fully override release template name | `""` |
| `image.registry` | Image registry | `docker.io` |
| `image.repository` | Image name | `greptime/greptimedb` |
| `image.tag` | Image tag | `v0.4.1` |
| `image.pullPolicy` | 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 service account | `true` |
| `serviceAccount.annotations` | Service account annotations | `{}` |
| `serviceAccount.name` | Service account name | `""` |
| `command` | Container command | `[]` |
| `args` | Container args | `[]` |
| `env` | Environment variables | `[]` |
| `envFrom` | Maps all the keys on a configmap or secret as environment variables | `{}` |
| `podAnnotations` | Extra pod annotations to add | `{}` |
| `podLabels` | Extra pod labels to add | `{}` |
| `podSecurityContext` | Security context to apply to the pod | `{}` |
| `annotations` | Container args | `{}` |
| `securityContext` | Security context to apply to the container | `{}` |
| `nodeSelector` | NodeSelector to apply pod | `{}` |
| `tolerations` | Tolerations to apply pod | `{}` |
| `affinity` | Affinity configuration for pod | `{}` |
| `dnsConfig` | DNS configuration for pod | `{}` |
| `terminationGracePeriodSeconds` | Amount of time given to the pod to shutdown normally | `30` |
| `httpPort` | GreptimeDB http port | `4000` |
| `grpcPort` | GreptimeDB grpc port | `4001` |
| `mysqlPort` | GreptimeDB mysql port | `4002` |
| `postgresPort` | GreptimeDB postgres port | `4003` |
| `service.type` | Service type | `ClusterIP` |
| `service.annotations` | Service annotations | `{}` |

### Volume parameters

| Name | Description | Value |
|----------------------------------------------|----------------------------------------------------------------------------------|---------|
| `persistence.enabled` | Create persistent volume claim | `true` |
| `persistence.enableStatefulSetAutoDeletePVC` | Whether to enable automatic deletion of stale PVCs due to a scale down operation | `false` |
| `persistence.size` | PVC storage Request for data volume | `10Gi` |
| `persistence.storageClass` | Persistent volume storage class | `null` |
| `persistence.selector` | Selector to match an existing persistent volume | `null` |

### Metrics parameters

| Name | Description | Value |
|-------------------------------|---------------------------------|---------|
| `monitoring.enabled` | Enable prometheus podmonitor | `false` |
Expand Down
6 changes: 3 additions & 3 deletions charts/greptimedb-standalone/templates/statefulset.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ spec:
- name: {{ . }}
{{- end }}
{{- end }}
{{- if .Values.securityContext }}
{{- if .Values.podSecurityContext }}
securityContext:
{{- toYaml .Values.securityContext | nindent 8 }}
{{- toYaml .Values.podSecurityContext | nindent 8 }}
{{- end }}
terminationGracePeriodSeconds: {{ .Values.terminationGracePeriodSeconds }}
containers:
Expand Down Expand Up @@ -88,7 +88,7 @@ spec:
envFrom:
{{- toYaml . | nindent 12 }}
{{- end }}
{{- with .Values.podSecurityContext }}
{{- with .Values.securityContext }}
securityContext:
{{- toYaml . | nindent 12 }}
{{- end }}
Expand Down

0 comments on commit 0437437

Please sign in to comment.