diff --git a/docs/enterprise/deployments/deploy-on-kubernetes/installation.md b/docs/enterprise/deployments/deploy-on-kubernetes/installation.md index 548bc3d72..a47e59287 100644 --- a/docs/enterprise/deployments/deploy-on-kubernetes/installation.md +++ b/docs/enterprise/deployments/deploy-on-kubernetes/installation.md @@ -1,8 +1,52 @@ --- -keywords: [Installation] -description: Deploy GreptimeDB on Kubernetes +keywords: [Kubernetes deployment, GreptimeDB Enterprise, install GreptimeDB, start GreptimeDB, private docker registry, helm chart] +description: Steps to install GreptimeDB Enterprise on Kubernetes, including obtaining images and starting GreptimeDB. --- -# Installation +# Deploy GreptimeDB Cluster -TODO \ No newline at end of file +GreptimeDB Enterprise is released as docker images. +We provide each customer with a separate private docker registry hosted on Cloud, +which you can pull directly using the docker pull command or configure in helm charts. + +## Get GreptimeDB Enterprise + +Upon receiving GreptimeDB Enterprise, +you will be provided with the docker registry address, username, and password via email. +Please store this information securely! + +Each release of GreptimeDB Enterprise has a unique `tag` identifier. +With this `tag`, plus the registry address `registry`, username `username`, and password `password` provided by our staff, +you can pull the GreptimeDB Enterprise image: + +- Login to docker registry: `docker login --username= --password= ` +- Pull docker image: `docker pull :` + +Then configure GreptimeDB Enterprise in the helm chart: + +First, create a pull secret for the image registry in k8s +(for detailed methods and instructions, please refer to the [k8s official documentation](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/)). + +```bash +kubectl create secret docker-registry regcred --docker-server= --docker-username= --docker-password= +``` + +For example: + +![k8s_pull_secret](/k8s-pull-secret.jpg) + +Then add this secret to the helm chart's `values.yaml`: + +```yaml +image: + registry: + repository: + tag: + pullSecrets: [ regcred ] +``` + +Where `` is the part after `:` in ``; `` is the unique identifier for the GreptimeDB Enterprise image. + +## Installation and Startup + +Please refer to the [Deploy GreptimeDB Cluster on Kubernetes](/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md) documentation. diff --git a/docs/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md b/docs/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md index dfa484c2b..9f27b4eec 100644 --- a/docs/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md +++ b/docs/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md @@ -186,20 +186,65 @@ http://etcd-2.etcd-headless.etcd-cluster.svc.cluster.local:2379 is healthy: succ ``` -## Install the GreptimeDB cluster with self-monitoring +## Setup `values.yaml` -Now that the GreptimeDB Operator and etcd cluster are installed, you can deploy a minimum GreptimeDB cluster with self-monitoring and Flow enabled: +The `values.yaml` file contains parameters and configurations for GreptimeDB and is the key to defining the Helm chart. +For example, a minimal GreptimeDB cluster with self-monitoring configuration is as follows: -:::warning -The default configuration for the GreptimeDB cluster is not recommended for production use. +```yaml +image: + registry: docker.io + # Image repository: + # Use `greptime/greptimedb` for OSS GreptimeDB, + # consult staff for Enterprise GreptimeDB + repository: + # Image tag: + # use database version for OSS GreptimeDB, for example, `VAR::greptimedbVersion` + # consult staff for Enterprise GreptimeDB + tag: + pullSecrets: [ regcred ] + +initializer: + registry: docker.io + repository: greptime/greptimedb-initializer + +monitoring: + # Enable monitoring + enabled: true + +grafana: + # Enable grafana deployment. + # It needs to enable monitoring `monitoring.enabled: true` first. + enabled: true + +frontend: + replicas: 1 + +meta: + replicas: 1 + backendStorage: + etcd: + endpoints: "etcd.etcd-cluster.svc.cluster.local:2379" + +datanode: + replicas: 1 +``` + +The configuration above for the GreptimeDB cluster is not recommended for production use. You should adjust the configuration according to your requirements. -::: +You can refer to the [configuration documentation](/user-guide/deployments-administration/deploy-on-kubernetes/common-helm-chart-configurations.md) for the complete `values.yaml` configuration options. + + +## Install the GreptimeDB cluster with self-monitoring + +Now that the GreptimeDB Operator and etcd cluster are installed, +and `values.yaml` is configured, +you can deploy a minimal GreptimeDB cluster with self-monitoring and Flow enabled: ```bash -helm install mycluster \ - --set monitoring.enabled=true \ - --set grafana.enabled=true \ +helm upgrade --install mycluster \ greptime/greptimedb-cluster \ + --values /path/to/values.yaml \ -n default ``` @@ -235,7 +280,11 @@ We will deploy a GreptimeDB standalone instance named `${cluster}-monitor` in th We will deploy a [Grafana](https://grafana.com/) instance and configure it to use the GreptimeDB standalone instance as a data source (using both Prometheus and MySQL protocols), allowing us to visualize the GreptimeDB cluster's monitoring data out of the box. By default, Grafana will use `mycluster` and `default` as the cluster name and namespace to create data sources. If you want to monitor clusters with different names or namespaces, you'll need to create different data source configurations based on the cluster names and namespaces. You can create a `values.yaml` file like this: ```yaml +monitoring: + enabled: true + grafana: + enabled: true datasources: datasources.yaml: datasources: diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments/deploy-on-kubernetes/installation.md b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments/deploy-on-kubernetes/installation.md index 1a0859567..d31709987 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments/deploy-on-kubernetes/installation.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments/deploy-on-kubernetes/installation.md @@ -3,7 +3,7 @@ keywords: [Kubernetes 部署, GreptimeDB 企业版, 安装 GreptimeDB, 启动 Gr description: 在 Kubernetes 上安装 GreptimeDB 企业版的步骤，包括获取镜像、安装 GreptimeDB Operator 和 etcd 集群、配置 values.yaml 和启动 GreptimeDB。 --- -# 安装 +# 部署 GreptimeDB 集群 GreptimeDB 企业版以 docker 镜像发布。我们为每位国内的客户提供了一个单独的、托管在阿里云上的私有 docker 仓库，你可以使用 docker pull 命令直接拉取，或在 helm chart 中配置。 @@ -40,138 +40,7 @@ image: 其中 `` 是 `` 中 `：` 之后的部分；`` 是 GreptimeDB 企业版镜像的单独标识。 -## 启动 - -我们建议你使用 helm chart 启动 GreptimeDB 企业版。 - -### 添加 Greptime Helm 仓库 - -:::tip NOTE -如你有网络访问问题，可跳过本步骤并直接参考下一步中使用阿里云 OCI 镜像仓库的方式。采用阿里云 OCI 镜像仓库的方式无需手动添加 Helm 仓库。 -::: - -我们提供了 GreptimeDB Operator 和 GreptimeDB 集群的[官方 Helm 仓库](https://github.com/GreptimeTeam/helm-charts)。你可以通过运行以下命令来添加仓库： - -```bash -helm repo add greptime https://greptimeteam.github.io/helm-charts/ -helm repo update -``` - -### 安装 GreptimeDB Operator - -[GreptimeDB Operator](https://github.com/GrepTimeTeam/greptimedb-operator) 是一个用于管理 GreptimeDB 集群生命周期的 Kubernetes operator。 -让我们在 greptimedb-admin 命名空间中安装最新版本的 GreptimeDB Operator： - -```shell -helm install greptimedb-operator greptime/greptimedb-operator -n greptimedb-admin --create-namespace -``` - -:::tip NOTE -如你有网络访问问题，可直接使用阿里云 OCI 镜像仓库的方式安装 GreptimeDB Operator： -```bash -helm install greptimedb-operator \ - oci://greptime-registry.cn-hangzhou.cr.aliyuncs.com/charts/greptimedb-operator \ - --set image.registry=greptime-registry.cn-hangzhou.cr.aliyuncs.com \ - -n greptimedb-admin \ - --create-namespace -``` -此时我们也将镜像仓库设置为了 Greptime 官方的阿里云镜像仓库。 -::: - -### 验证 GreptimeDB Operator 的安装 - -检查 GreptimeDB Operator 的状态： - -```bash -kubectl get pods -n greptimedb-admin -l app.kubernetes.io/instance=greptimedb-operator -``` - -若有类似以下的预期输出，表示 GreptimeDB Operator 安装成功： - -```bash -NAME READY STATUS RESTARTS AGE -greptimedb-operator-68d684c6cf-qr4q4 1/1 Running 0 4m8s -``` - -可参考 [GreptimeDB Operator 的管理文档](/user-guide/deployments-administration/deploy-on-kubernetes/greptimedb-operator-management.md) 来了解 GreptimeDB Operator 的更多功能。 - -### 安装 etcd 集群 - -GreptimeDB 集群需要一个 etcd 集群来存储元数据。让我们使用 Bitnami 的 [etcd Helm chart](https://github.com/bitnami/charts/tree/main/bitnami/etcd) 来安装一个 etcd 集群： - -```bash -helm install etcd \ - oci://registry-1.docker.io/bitnamicharts/etcd \ - --version 10.2.12 \ - --set replicaCount=3 \ - --set auth.rbac.create=false \ - --set auth.rbac.token.enabled=false \ - --create-namespace \ - -n etcd-cluster -``` - -:::tip NOTE -如你有网络访问问题，可直接使用阿里云 OCI 镜像仓库的方式安装 etcd 集群： - -```bash -helm install etcd \ - oci://greptime-registry.cn-hangzhou.cr.aliyuncs.com/charts/etcd \ - --set image.registry=greptime-registry.cn-hangzhou.cr.aliyuncs.com \ - --set image.tag=3.5.12 \ - --set replicaCount=3 \ - --set auth.rbac.create=false \ - --set auth.rbac.token.enabled=false \ - --create-namespace \ - -n etcd-cluster -``` - -::: - -### 配置 `values.yaml` - -:::tip NOTE -chart 版本之间的配置结构已发生变化: - -- 旧版本: `meta.etcdEndpoints` -- 新版本: `meta.backendStorage.etcd.endpoints` - -请参考 chart 仓库中配置 [values.yaml](https://github.com/GreptimeTeam/helm-charts/blob/main/charts/greptimedb-cluster/values.yaml) 以获取最新的结构。 -::: - -`values.yaml` 文件设置了 GreptimeDB 的一些参数和配置，是定义 helm chart 的关键。例如一个最小规模的 GreptimeDB 集群定义如下： - -```yaml -image: - registry: greptime-registry.cn-hangzhou.cr.aliyuncs.com - repository: - tag: - pullSecrets: [ regcred ] - -initializer: - registry: greptime-registry.cn-hangzhou.cr.aliyuncs.com - repository: greptime/greptimedb-initializer - -frontend: - replicas: 1 - -meta: - replicas: 1 - backendStorage: - etcd: - endpoints: "etcd.etcd-cluster.svc.cluster.local:2379" - -datanode: - replicas: 1 -``` - -可参考[配置文档](/user-guide/deployments-administration/deploy-on-kubernetes/common-helm-chart-configurations.md)获取完整的 `values.yaml` 的配置项。 - -### 启动 GreptimeDB - -在上述步骤都完成后，就可以用 helm 拉起 GreptimeDB 了： - -```bash -helm upgrade --install my-greptimedb greptime/greptimedb-cluster --values /path/to/values.yaml -``` +## 安装及启动 +请参考[部署 GreptimeDB 集群](/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md)文档。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md index 17d767743..717d0f41a 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/deploy-greptimedb-cluster.md @@ -216,39 +216,115 @@ http://etcd-2.etcd-headless.etcd-cluster.svc.cluster.local:2379 is healthy: succ ``` -## 安装带有自监控的 GreptimeDB 集群 +## 配置 `values.yaml` -目前我们已经准备好了 GreptimeDB Operator 和 etcd 集群，现在我们可以部署一个带自监控并启用 Flow 功能的最小 GreptimeDB 集群： +`values.yaml` 文件设置了 GreptimeDB 的一些参数和配置，是定义 helm chart 的关键。 +例如一个带有自监控的最小规模 GreptimeDB 集群定义如下： -:::warning -本文档中的默认配置不适用于生产环境，你应该根据自己的需求调整配置。 -::: +```yaml +image: + registry: docker.io + # 镜像仓库： + # OSS GreptimeDB 使用 `greptime/greptimedb`， + # Enterprise GreptimeDB 请咨询工作人员 + repository: + # 镜像标签： + # OSS GreptimeDB 使用数据库版本，例如 `VAR::greptimedbVersion` + # Enterprise GreptimeDB 请咨询工作人员 + tag: + pullSecrets: [ regcred ] + +initializer: + registry: docker.io + repository: greptime/greptimedb-initializer + +monitoring: + # 启用监控 + enabled: true -```bash -helm install mycluster \ - --set monitoring.enabled=true \ - --set grafana.enabled=true \ - greptime/greptimedb-cluster \ - -n default +grafana: + # 用于监控面板 + # 需要先启用监控 `monitoring.enabled: true` 选项 + enabled: true + +frontend: + replicas: 1 + +meta: + replicas: 1 + backendStorage: + etcd: + endpoints: "etcd.etcd-cluster.svc.cluster.local:2379" + +datanode: + replicas: 1 ``` :::note -中国大陆用户如有网络访问问题，可直接使用阿里云 OCI 镜像仓库的方式来安装 GreptimeDB 集群： +中国大陆用户如有网络访问问题，可直接使用阿里云 OCI 镜像仓库： + +```yaml +image: + registry: greptime-registry.cn-hangzhou.cr.aliyuncs.com + # 镜像仓库： + # OSS GreptimeDB 使用 `greptime/greptimedb`， + # Enterprise GreptimeDB 请咨询工作人员 + repository: + # 镜像标签： + # OSS GreptimeDB 使用数据库版本，例如 `VAR::greptimedbVersion` + # Enterprise GreptimeDB 请咨询工作人员 + tag: + pullSecrets: [ regcred ] + +initializer: + registry: greptime-registry.cn-hangzhou.cr.aliyuncs.com + repository: greptime/greptimedb-initializer + +monitoring: + # 启用监控 + enabled: true + vector: + # 监控需要使用 Vector + registry: greptime-registry.cn-hangzhou.cr.aliyuncs.com + +grafana: + # 用于监控面板 + # 需要先启用监控 `monitoring.enabled: true` 选项 + enabled: true + image: + registry: greptime-registry.cn-hangzhou.cr.aliyuncs.com + +frontend: + replicas: 1 + +meta: + replicas: 1 + backendStorage: + etcd: + endpoints: "etcd.etcd-cluster.svc.cluster.local:2379" + +datanode: + replicas: 1 +``` +::: + +上述配置不适用于严肃的生产环境，请根据自己的需求调整配置。 +可参考[配置文档](/user-guide/deployments-administration/deploy-on-kubernetes/common-helm-chart-configurations.md)获取完整的 `values.yaml` 的配置项。 + + +## 安装带有自监控的 GreptimeDB 集群 + +在上述步骤中我们已经准备好了 GreptimeDB Operator，etcd 集群以及 GreptimeDB 集群相应的配置， +现在部署一个带自监控并启用 Flow 功能的最小 GreptimeDB 集群： ```bash -helm install mycluster \ - oci://greptime-registry.cn-hangzhou.cr.aliyuncs.com/charts/greptimedb-cluster \ - --set image.registry=greptime-registry.cn-hangzhou.cr.aliyuncs.com \ - --set initializer.registry=greptime-registry.cn-hangzhou.cr.aliyuncs.com \ - --set grafana.enabled=true \ - --set grafana.image.registry=greptime-registry.cn-hangzhou.cr.aliyuncs.com \ - --set monitoring.enabled=true \ - --set monitoring.vector.registry=greptime-registry.cn-hangzhou.cr.aliyuncs.com \ +helm upgrade --install mycluster \ + greptime/greptimedb-cluster \ + --values /path/to/values.yaml \ -n default ``` 如果你使用了不同的集群名称和命名空间，请将 `mycluster` 和 `default` 替换为你的配置。 -:::
预期输出 @@ -282,7 +358,11 @@ The greptimedb-cluster is starting, use `kubectl get pods -n default` to check i 我们也将会部署一个 Grafana 实例，并配置 [Grafana](https://grafana.com/) 使用 GreptimeDB standalone 实例作为数据源（分别使用 Prometheus 和 MySQL 协议），从而我们开箱即可使用 Grafana 来可视化 GreptimeDB 集群的监控数据。默认地，Grafana 将会使用 `mycluster` 和 `default` 作为集群名称和命名空间来创建数据源。如果你想要监控具有不同名称或不同命名空间的集群，那就需要基于不同的集群名称和命名空间来创建不同的数据源配置。你可以创建一个如下所示的 `values.yaml` 文件： ```yaml +monitoring: + enabled: true + grafana: + enabled: true datasources: datasources.yaml: datasources: @@ -309,8 +389,6 @@ grafana: ```bash helm install ${cluster} \ - --set monitoring.enabled=true \ - --set grafana.enabled=true \ greptime/greptimedb-cluster \ -f values.yaml \ -n ${namespace}