diff --git a/.gitignore b/.gitignore index 7011910bcc09a177a337782ef6b4671280cf0905..89a1fdc46635c402d054db0db5ef91956fa7895a 100644 --- a/.gitignore +++ b/.gitignore @@ -77,3 +77,5 @@ yarn-error.log /scripts/doc.md .lycheecache lychee_out.md + +.idea \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/architecture/assets/ha.png b/product/zh/docs-mogdb-stack/v2.0/architecture/assets/ha.png new file mode 100644 index 0000000000000000000000000000000000000000..4ed27e49fb5da99feb4e043888ee5bd92c1e385b Binary files /dev/null and b/product/zh/docs-mogdb-stack/v2.0/architecture/assets/ha.png differ diff --git a/product/zh/docs-mogdb-stack/v2.0/architecture/backup-management.md b/product/zh/docs-mogdb-stack/v2.0/architecture/backup-management.md new file mode 100644 index 0000000000000000000000000000000000000000..05ef0cb43a1352fd1beda95e741fb80770e25ad7 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/architecture/backup-management.md @@ -0,0 +1,82 @@ +--- +title: 备份 +summary: 备份 +author: Ji Yabin, hhhhhzhen +date: 2022-12-30 +--- + +# 备份管理 + +MogDB Operator 提供了全量备份和增量备份。 + +MogDB Operator 提供了物理备份与逻辑备份两种备份方式。 + +MogDB Operator 提供了 posix 和 s3 两种备份存储方式。 + +
+ +## 备份配置 + +如果您需要自定义备份配置，则需要修改 MogDB cluster manifest backup spec，具体请参考 [backup spec](../references/server/crd-references.md#MogdbClusterspecBackup)。 + +**注意**：此处备份相关配置为该集群的全局备份配置，部分配置可以单独在 backup CR 中指定，具体请参考 [backup CRD References](../references/server/crd-references.md#MogdbBackup)。 + +有关物理备份的配置内容如下，具体请参考 [GSBaseBackup](../references/server/crd-references.md#MogdbClusterspecBackupGSBaseBackup)： + +```yaml +apiVersion: mogdb.enmotech.io/v1 +kind: MogdbCluster +spec: + backup: + # 物理备份 + GSBaseBackup: + # 备份策略 + backupSchedule: "0 */1 * * * ?" + # 保留历史最大数量 + backupScheduleHistoryLimit: 5 + # 默认情况下以 posix 方式存储备份 + # 如果要开启 s3 方式存储备份，则填充以下配置 + s3: + region: "" + bucket: "" + provider: "" + endPoint: "" + secretName: "" +``` + +有关逻辑备份的配置内容如下，具体请参考 [GSDumpAll](../references/server/crd-references.md#MogdbClusterspecBackupGSDumpAll)： + +```yaml +apiVersion: mogdb.enmotech.io/v1 +kind: MogdbCluster +spec: + backup: + # 逻辑备份 + GSDumpAll: + # 备份策略 + backupSchedule: "0 */1 * * * ?" + # 保留历史最大数量 + backupScheduleHistoryLimit: 5 + # 默认情况下以 posix 方式存储备份 + # 如果要开启 s3 方式存储备份，则填充以下配置 + s3: + region: "" + bucket: "" + provider: "" + endPoint: "" + secretName: "" +``` + +
+ +## backup CR + +为了对 Kubernetes 上的 MogDB 集群进行备份，用户可以依据 [backup CRD References](../references/server/crd-references.md#MogdbBackup) 创建一个自定义的 backup CR 对象来描述一次备份。 + +我们也为您提供了 [backup CR Demo](../references/server/mogdbbackup-sample.md) 以供参考。 + +
+ +## 架构 + +![deploy-arch](https://cdn-mogdb.enmotech.com/docs-media/mogdb-stack/v1.0.0/backup-management.png) diff --git a/product/zh/docs-mogdb-stack/v2.0/architecture/client.md b/product/zh/docs-mogdb-stack/v2.0/architecture/client.md new file mode 100644 index 0000000000000000000000000000000000000000..e1826c7edf536dec39377b1cf241e6d5a570dc43 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/architecture/client.md @@ -0,0 +1,76 @@ +--- +title: 客户端 +summary: 客户端 +author: Wang Dong, hhhhhzhen +date: 2022-12-30 +--- + +# mgo 客户端 + +MogDB Operator Client，简称 mgo，是与 MogDB Operator 交互的最便捷方式。mgo 通过一系列简单的命令，为创建、管理和删除 MogDB 集群提供了许多便捷的方法。 +MogDB Operator 提供了于 mgo 客户端连接的接口，并通过 RBAC 和 TLS 进行验证管理。 + +![deploy-arch](https://cdn-mogdb.enmotech.com/docs-media/mogdb-stack/v1.0.0/single-idc-operator-arch.png) + +mgo 客户端可用于 Linux、macOS，您可以从[发布版本](../release.md)中选择您所需的 mgo 客户端，注意，mgo 客户端的版本**必须**与 MogDB Operator 的版本匹配。。 + +
+ +## 使用 mgo 客户端的一般注意事项 + +如果您使用[快速入门](../quick-start.md)指南安装 MogDB Operator，您会将 MogDB Operator 安装到名为 `mogdb-operator-system` 命名空间下。 + +为方便起见，我们建议设置 `mogdb-operator-system` 为环境变量 `MGO_NAMESPACE` 的值。在您将执行 mgo 命令的 shell 中，运行以下命令： + +```shell +export MGO_NAMESPACE=mogdb-operator-system +``` + +如果您不想设置此环境变量，或者处于无法使用环境变量的环境中，则必须对大多数命令使用 --namespace(or -n) 标志，例如： + +```shell +mgo version -n mogdb-operator-system +``` + +
+ +## 语法 + +有关 mgo 客户端的命令的详细阐述，请参考[命令行](../references/client/mgo.md)相关内容。 + +mgo 的语法类似于您使用 kubectl 一样简单，MogDB Operator 项目的目标之一是允许在支持 Kubernetes 的环境中无缝管理 MogDB 集群，并且通过遵循用户熟悉的命令模式，使学习曲线变得更加容易。 + +要了解 mgo 命令的顶层可用内容，请执行： + +```shell +mgo +``` + +mgo 命令的语法通常遵循以下格式： + +```shell +pgo [command] ([TYPE] [NAME]) [flags] +``` + +其中 command 是一个动词，例如： + +- create +- show +- delete + +type 是一种资源类型，例如： + +- cluster +- mgorole +- mgouser + +name 是资源类型的名称，例如： + +- cluster1 +- admin + +有些全局 flag 作用于每个 mgo 命令，有些特殊 flag 作用于指定 mgo 命令，要获取命令可用的所有选项和 flag的列表，您可以使用 --help flag。例如，要查看 mgo create cluster 命令可用的所有选项，您可以运行以下命令： + +```shell +mgo create cluster --help +``` diff --git a/product/zh/docs-mogdb-stack/v2.0/architecture/high-availability.md b/product/zh/docs-mogdb-stack/v2.0/architecture/high-availability.md new file mode 100644 index 0000000000000000000000000000000000000000..c0be514d0e3615ae618b92ebb72ffe03ec27eeb7 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/architecture/high-availability.md @@ -0,0 +1,156 @@ +--- +title: 高可用 +summary: 高可用 +author: Ji Yabin, hhhhhzhen +date: 2022-12-30 +--- + +# 高可用 + +## 概述 + +> 注意：不同于 1.0 版本中的 sidecar 方式，自 2.0 版本开始，HA 以哨兵模式运行。 +> +> +> +> 我们为什么这样做： +> +> 1.为跨机房场景做准备； +> +> 2.以 sidecar 方式运行时，在数据库故障的某些场景下需要对数据库进行重启，导致 MogDB 进程变为 HA 进程的子进程； + +高可用是 MogDB Stack 体系中的一个功能组件，以哨兵模式运行，并实时监测 MogDB 集群的运行状态，当监测到集群出现故障时，触发修复逻辑。 + +发生切换的场景包括： + +- 机架掉电 +- 主库网络不可达 +- 数据库发生故障宕机 +- 数据库磁盘故障或者某些硬件故障 + +![ha](assets/ha.png) + +
+ +## 开启高可用组件 + +> HA 自身使用 dcs 保证高可用，当前仅支持 etcd，因此在启动组件时，需要准备一个高可用 etcd 集群，并将连接信息配置到 HA 中。 + +### 1.前置条件 + +- 已安装 kustomize v3+； +- 已安装 MogDB Operator； +- 若您需要正式开始高可用组件，而非进行高可用体验，请准备高可用 etcd 集群； + +
+ +### 2.获取安装包 + +在GitHub上fork [MogDB Stack examples](https://github.com/enmotech/mogdb-stack-examples)仓库: + + + +fork仓库之后，您可以通过类似如下的命令下载至本地: + +```shell +YOUR_GITHUB_UN="" +git clone --depth 1 "git@github.com:${YOUR_GITHUB_UN}/mogdb-stack-examples.git" +cd mogdb-stack-examples +``` + +
+ +### 3.部署高可用组件 + +HA 组件安装目录位于安装包中的 `kustomize/mogha` 目录下。 + +**特别注意：默认情况下我们使用简易安装模式，即将 `etcd` 与 `ha` 部署在同一 pod 中，以供体验组件服务。若要正式使用该组件，请注意跟随 `kustomization.yaml` 文件中的指示注释掉 `patches/deployment-container-etcd.yaml` 一行，并修改 `patches/deployment-container-mogha.yaml` 文件，以传递您准备好的高可用 `etcd` 集群连接信息，该文件还允许您传递其它参数，具体参数列表请参考[参数列表](#参数列表)**。 + +确保您编辑好高可用组件参数后，以下命令将部署高可用组件： + +```shell +kustomize build kustomize/mogha | kubectl apply -f - +``` + +预期输出： + +```shell +namespace/mogha created +serviceaccount/mogdb-ha created +clusterrole.rbac.authorization.k8s.io/mogdb-ha-role created +clusterrolebinding.rbac.authorization.k8s.io/mogdb-ha-rolebinding created +service/mogdb-ha created +deployment.apps/mogdb-ha created +``` + +
+ +### 4.检查安装 + +ha 组件默认安装在 `mogha` 命名空间中： + +```shell +kubectl get pods,svc -n mogha +``` + +预期输出： + +```shell +NAME READY STATUS RESTARTS AGE +pod/mogdb-ha-55cdbc7855-xfb8g 2/2 Running 0 44s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/mogdb-ha ClusterIP 10.107.90.105 6544/TCP 44s +``` + +
+ +### 5.注册高可用组件 + +在高可用组件部署成功后，需要将其注册至 MogDB Operator 中，以便正常使用高可用组件的功能。 + +在[4.检查安装](#4检查安装)中，我们得到 mogdb-ha 服务的 endpoints，现在将其注册到 MogDB Operator 中，MogDB Operator 默认安装在 `mogdb-operator-system` 命名空间中： + +```shell +kubectl edit configmap mogdb-operator-global-config -n mogdb-operator-system +``` + +之后修改 `.data.config.json` 中的 `haServices` 部分，将 endpoints 填入其中，并保存退出。 + +> tips: +> +> 在 kubernetes 中，我们一般不推荐使用 cluster-ip:port 的方式，因为 cluster-ip 并不是一个定值，我们推荐使用 kubernetes 的域名解析，其中 service 的 endpoints 遵循结构 `http://namespace.service-name.kubernetes-domain-name`。 +> +> 在本例中，namespace 为 mogha，service-name 为 mogdb-ha，kubernetes-domain-name 为 svc.cluster.local，因此 endpoints 为 `http://mogha.mogdb-ha.svc.cluster.local:6544`。 + +
+ +### 6.使用高可用组件 + +如果之后创建的 MogDB 集群要使用高可用组件，则需要您在 MogDB manifest 中将 .spec.enableHa 配置为 true。 + +```yaml +... +sepc: + enableHa: true +... +``` + +
+ +## 参数列表 + +| 参数 | 含义 | 类型 | 默认值 | +| -------------------------- | --------------------------------------- | ------ | --------------------- | +| debug | 是否开启 debug 模式 | 布尔值 | true | +| etcd-key | 存储相关信息时使用的 base path | 字符串 | "mogha" | +| etcd-username | 连接 etcd 集群的用户 | 字符串 | "" | +| etcd-password | 连接 etcd 集群的密码 | 字符串 | "" | +| etcd-endpoints | 连接 etcd 集群的地址 | 字符串 | "127.0.0.1:2379" | +| etcd-dial-timeout | 连接 etcd 集群的超时时间 | 整型 | 5 | +| observe-period | 探测 mogdb 集群的间隔时间 | 整型 | 60 | +| db-probe-period | 探测单个 mogdb 节点是否健康的间隔时间 | 整型 | 5 | +| db-probe-failure-threshold | 判断单个 mogdb 节点异常的探测次数阈值 | 整型 | 3 | +| mogdb-username | 连接 mogdb 集群的用户，一般情况不用指定 | 字符串 | operator 内置管理用户 | +| mogdb-password | 连接 mogdb 集群的密码，一般情况不用指定 | 字符串 | operator 内置管理用户 | + diff --git a/product/zh/docs-mogdb-stack/v2.0/architecture/monitor.md b/product/zh/docs-mogdb-stack/v2.0/architecture/monitor.md new file mode 100644 index 0000000000000000000000000000000000000000..e34910ad71a1014b3a2c5f02505cc8239a61a851 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/architecture/monitor.md @@ -0,0 +1,108 @@ +--- +title: 监控 +summary: 监控 +author: Ji Yabin, hhhhhzhen +date: 2022-12-30 +--- + +# 监控与告警 + +本文介绍如何对 Kubernetes 集群进行监控。在 MogDB 集群运行的过程中，需要对容器资源、宿主机、Kubernetes 组件等进行监控。对于这些组件或资源的监控，需要在整个 Kubernetes 集群维度部署监控系统来实现。 + +
+ +## 架构 + +监控告警共包含四个维度： + +- 宿主机指标 +- 容器指标 +- Kubernetes 资源状态 +- MogDB 集群状态 + +![deploy-arch](https://cdn-mogdb.enmotech.com/docs-media/mogdb-stack/v1.0.0/monitor.png) + +## 宿主机监控 + +通过 node exporter 对物理机指标进行采集，统一抓取到 prometheus 中。Node Exporter 是 Prometheus 官方提供的一个节点资源采集组件，可以用于收集服务器节点的数据，如 CPU 频率信息、磁盘 IO 统计、剩余可用内存等等。Node Exporter 会将收集到的信息转换为 Prometheus 可识别的 Metrics 数据。Prometheus 可以从 Node Exporter 中对这些指标进行收集与存储，并且可以根据这些数据的实时变化进行服务器节点资源监控。 + +
+ +## 容器监控 + +cAdvisor 是 Google 开源的容器资源监控和性能分析工具，它是专门为容器而生，在 Kubernetes 中，我们不需要单独去安装，cAdvisor 作为 kubelet 内置的一部分程序可以直接使用，也就是我们可以直接使用 cAdvisor 采集数据，可以采集到和容器运行相关的所有指标。 + +cadvisor 中获取到的典型监控指标如下： + +| 指标名称 | 类型 | 含义 | +|-----------------------------------------|----------|---------------------------| +| container_cpu_load_average_10s | gauge | 过去10秒容器CPU的平均负载 | +| container_cpu_usage_seconds_total | counter | 容器在每个CPU内核上的累积占用时间 (单位：秒) | +| container_cpu_system_seconds_total | counter | System CPU累积占用时间（单位：秒） | +| container_cpu_user_seconds_total | counter | User CPU累积占用时间（单位：秒） | +| container_fs_usage_bytes | gauge | 容器中文件系统的使用量(单位：字节) | +| container_fs_limit_bytes | gauge | 容器可以使用的文件系统总量(单位：字节) | +| container_fs_reads_bytes_total | counter | 容器累积读取数据的总量(单位：字节) | +| container_fs_writes_bytes_total | counter | 容器累积写入数据的总量(单位：字节) | +| container_memory_max_usage_bytes | gauge | 容器的最大内存使用量（单位：字节） | +| container_memory_usage_bytes | gauge | 容器当前的内存使用量（单位：字节） | +| container_spec_memory_limit_bytes | gauge | 容器的内存使用量限制 | +| machine_memory_bytes | gauge | 当前主机的内存总量 | +| container_network_receive_bytes_total | counter | 容器网络累积接收数据总量（单位：字节） | +| container_network_transmit_bytes_total | counter | 容器网络累积传输数据总量（单位：字节） | + +
+ +## 资源对象监控 + +kube-state-metrics 提供资源对象本身的监控，如 pod 运行状态、有多少 job 在运行中等等，它基于 client-go 开发，轮询 Kubernetes API，并将 Kubernetes 的结构化信息转换为 metrics。 + +指标类别包括： + +- CronJob Metrics + +- DaemonSet Metrics + +- Deployment Metrics + +- Job Metrics + +- LimitRange Metrics + +- Node Metrics + +- PersistentVolume Metrics + +- PersistentVolumeClaim Metrics + +- Pod Metrics + +- Pod Disruption Budget Metrics + +- ReplicaSet Metrics + +- ReplicationController Metrics + +- ResourceQuota Metrics + +- Service Metrics + +- StatefulSet Metrics + +- Namespace Metrics + +- Horizontal Pod Autoscaler Metrics + +- Endpoint Metrics + +- Secret Metrics + +- ConfigMap Metrics + +
+ +## MogDB 监控 + +为了获取 MogDB 自身的监控指标，需要配套的 MogDB exporter 采集相应的数据。 + +
diff --git a/product/zh/docs-mogdb-stack/v2.0/architecture/recovery-management.md b/product/zh/docs-mogdb-stack/v2.0/architecture/recovery-management.md new file mode 100644 index 0000000000000000000000000000000000000000..88acd7e90d3536fcebfa4213b3eec16ac5d911d4 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/architecture/recovery-management.md @@ -0,0 +1,58 @@ +--- +title: 恢复管理 +summary: 恢复管理 +author: Ji Yabin, hhhhhzhen +date: 2022-12-30 +--- + +# 恢复管理 + +MogDB Operator 提供了从备份中恢复集群的功能。 + + + +如果您需要自定义恢复配置，则需要修改 MogDB cluster manifest restore spec，具体请参考 [resotre spec](../references/server/crd-references.md#MogdbClusterspecRestore)： + +有关通过物理备份恢复的配置内容如下，具体请参考 [GSBaseBackupSource](../references/server/crd-references.md#MogdbClusterspecRestoreGSBaseBackupSource)： + +```yaml +apiVersion: mogdb.enmotech.io/v1 +kind: MogdbCluster +spec: + restore: + # 执行恢复的镜像 + image: + # 恢复标识ID + restoreId: + # 目标集群名称 + clusterName: + # 物理备份源 + GSBaseBackupSource: + type: + target: +``` + +有关通过物理逻辑恢复的配置内容如下，具体请参考 [GSDumpAllSource](../references/server/crd-references.md#MogdbClusterspecRestoreGSDumpAllSource)： + +```yaml +apiVersion: mogdb.enmotech.io/v1 +kind: MogdbCluster +spec: + restore: + # 执行恢复的镜像 + image: + # 恢复标识ID + restoreId: + # 目标集群名称 + clusterName: + # 逻辑备份源 + GSDumpAllSource: + type: + target: +``` + +
+ +## 架构 + +![deploy-arch](https://cdn-mogdb.enmotech.com/docs-media/mogdb-stack/v1.0.0/recovery-management.png) diff --git a/product/zh/docs-mogdb-stack/v2.0/faq.md b/product/zh/docs-mogdb-stack/v2.0/faq.md new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/product/zh/docs-mogdb-stack/v2.0/installation/helm.md b/product/zh/docs-mogdb-stack/v2.0/installation/helm.md new file mode 100644 index 0000000000000000000000000000000000000000..07cfd9e5a5532dca12b2acd400d2634733e86e7a --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/installation/helm.md @@ -0,0 +1,525 @@ +--- +title: helm方式安装 +summary: helm方式安装 +author: Wang Dong; Ji Yabin +date: 2022-12-30 +--- + +# MogDB Stack安装 + +## 第1步: 安装MogDB Operator + +部署MogDB Operator的过程分为两步: + +1. 安装MogDB Operator CRDs + +2. 安装MogDB Operator + +### 安装MogDB Operator CRDs + +MogDB Operator包含许多自定义的资源类型(CRDs)。执行以下命令安装CRD到Kubernetes集群中: + +```shell +kubectl apply -f https://raw.githubusercontent.com/enmotech/mogdb-stack-examples/main/helm/crd.yaml +``` + +期望输出: + +```text +customresourcedefinition.apiextensions.k8s.io/mogdbclusters.mogdb.enmotech.io created +customresourcedefinition.apiextensions.k8s.io/mogdbbackups.mogdb.enmotech.io created +``` + +### 安装MogDB Operator + +安装[Helm 3](https://helm.sh/docs/intro/install/)并使用Helm 3部署MogDB Operator + +1. 添加MogDB Stack仓库 + + ```shell + helm repo add mogdb-stack https://enmotech.github.io/mogdb-stack-examples/helm/charts + ``` + + 期望输出: + + ```text + "mogdb-stack" has been added to your repositories + ``` + + ```shell + helm search repo mogdb-stack + ``` + + 期望输出: + + ```text + NAME CHART VERSION APP VERSION DESCRIPTION + mogdb-stack/mogdb-apiserver 2.0.0 2.0.0 A Helm chart for Kubernetes + mogdb-stack/mogdb-cluster 2.0.0 2.0.0 A Helm chart for Kubernetes + mogdb-stack/mogdb-monitor 2.0.0 2.0.0 A Helm chart for Kubernetes + mogdb-stack/mogdb-operator 2.0.0 2.0.0 A Helm chart for Kubernetes + mogdb-stack/mogha 2.0.0 2.0.0 A Helm chart for Kubernetes + ``` + + 仓库含有五个chart包，分别是mogdb-operator、mogdb-apiserver、mogha、mogdb-monitor和mogdb-cluster。 + +2. 为MogDB Operator创建一个命名空间 + + ```shell + kubectl create namespace mogdb-operator-system + ``` + + 期望输出: + + ```text + namespace/mogdb-operator-system created + ``` + +3. 安装MogDB Operator + + ```shell + helm install myproject mogdb-stack/mogdb-operator --namespace mogdb-operator-system + ``` + + 期望输出: + + ```text + NAME: myproject + LAST DEPLOYED: Tue Jan 10 17:33:05 2023 + NAMESPACE: mogdb-operator-system + STATUS: deployed + REVISION: 1 + TEST SUITE: None + NOTES: + Thank you for deploying a MogDB Operator! + ``` + +检查MogDB Operator组建是否正常运行起来: + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +mogdb-operator-myproject-5cd5bb9d9-7xztz 1/1 Running 0 73s +``` + +当pod处于Running状态时，继续下一步。 + +## 第2步: 安装MogDB apiserver + +```shell +helm install myapiserver mogdb-stack/mogdb-apiserver --namespace mogdb-operator-system +``` + +期望输出: + +```text +NAME: myapiserver +LAST DEPLOYED: Tue Jan 10 17:43:50 2023 +NAMESPACE: mogdb-operator-system +STATUS: deployed +REVISION: 1 +TEST SUITE: None +NOTES: +Thank you for deploying a MogDB Operator Apiserver! +``` + +检查MogDB apiserver正常运行起来: + +```shell +NAME READY STATUS RESTARTS AGE +mogdb-apiserver-699c855d9b-878qj 1/1 Running 0 72s +mogdb-operator-myproject-5cd5bb9d9-7xztz 1/1 Running 0 11m +``` + +当pod处于Running状态时，继续下一步。 + +## 第3步: 安装 mgo 客户端 + +```shell +wget https://cdn-mogdb.enmotech.com/mogdb-stack/v2.0.0/client-setup.sh +chmod +x client-setup.sh +./client-setup.sh +``` + +这将下载mgo客户端并且提示您添加一些环境变量以供您在会话中设置，您可以使用以下命令执行此操作： + +```shell +export MGOUSER="${HOME?}/.mgo/mgouser" +export MGO_CA_CERT="${HOME?}/.mgo/client.crt" +export MGO_CLIENT_CERT="${HOME?}/.mgo/client.crt" +export MGO_CLIENT_KEY="${HOME?}/.mgo/client.key" +export MGO_APISERVER_URL='https://127.0.0.1:32444' +export MGO_NAMESPACE=mogdb-operator-system +``` + +如果您希望将这些变量永久添加到您的环境中，您可以运行以下命令： + +```shell +cat <> ~/.bashrc +export PATH="${HOME?}/.mgo:$PATH" +export MGOUSER="${HOME?}/.mgo/mgouser" +export MGO_CA_CERT="${HOME?}/.mgo/client.crt" +export MGO_CLIENT_CERT="${HOME?}/.mgo/client.crt" +export MGO_CLIENT_KEY="${HOME?}/.mgo/client.key" +export MGO_APISERVER_URL='https://127.0.0.1:32444' +export MGO_NAMESPACE=mogdb-operator-system +EOF + +source ~/.bashrc +``` + +> **注意：** 对于 macOS 用户，您使用文件是\~/.bash_profile而不是\~/.bashrc。 + +## 第4步: 安装Mogha + +1. 为Mogha创建一个命名空间 + + ```shell + kubectl create namespace mogha + ``` + + 期望输出: + + ```text + namespace/mogha created + ``` + +2. 安装Mogha + + ```shell + helm install mogdb-ha mogdb-stack/mogha --namespace mogha + ``` + + 期望输出: + + ```text + NAME: mogdb-ha + LAST DEPLOYED: Tue Jan 10 17:40:51 2023 + NAMESPACE: mogha + STATUS: deployed + REVISION: 1 + TEST SUITE: None + NOTES: + Thank you for deploying a Mogha! + ``` + +检查Mogha组建是否运行正常: + +```shell +kubectl get pods -n mogha +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +mogdb-ha-6d67c96476-6j42z 2/2 Running 0 49s +``` + +当pod处于Running状态时，继续下一步。 + +## 第5步: 安装监控与告警 + +1. 配置 + + ```shell + cat > myvalues.yaml <<-EOF + grafanaNodeport: 31043 # grafana 图形界面地址端口 + prometheusNodeport: 31042 # prometheus 图形界面地址端口 + alertmanagerNodeport: 31044 # alertmanager 图形界面地址端口 + + alertEmailHost: smtp.163.com # 告警邮箱server host + alertEmailSmtp: smtp.163.com:25 # 发送邮件的SMTP server，包括端口号 + alertEmailUsername: # 发送告警的邮箱 + alertEmailPassword: # 邮箱授权密码 + receiversEmail: # 接收报警的邮箱，多个用逗号隔开 + EOF + ``` + +2. 为监控创建一个命名空间 + + ```shell + kubectl create namespace monitor + ``` + + 期望输出: + + ```text + namespace/monitor created + ``` + +3. 安装监控与告警 + + ```shell + helm install -f myvalues.yaml monitor mogdb-stack/mogdb-monitor --namespace monitor + ``` + + 期望输出: + + ```text + NAME: monitor + LAST DEPLOYED: Tue Jan 10 18:00:45 2023 + NAMESPACE: monitor + STATUS: deployed + REVISION: 1 + TEST SUITE: None + ``` + +检查监控告警组件是否运行正常: + +```shell +kubectl get pods -n monitor +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +grafana-5548d85c77-v9x69 1/1 Running 0 77s +node-exporter-67ggw 1/1 Running 0 77s +node-exporter-6gf2c 1/1 Running 0 77s +node-exporter-qz4jk 1/1 Running 0 77s +prometheus-645fcdf654-q4q59 2/2 Running 0 77s +``` + +当所有pod处于Running状态时，继续下一步。 + +## 第6步: 创建集群 + +默认会创建一主一从两个节点，如果需要多个节点，可通过Helm设置replicaCount参数实现，最高可支持7个副本。 + +```shell +helm install mycluster mogdb-stack/mogdb-cluster --set enableHa=true --namespace mogdb-operator-system +``` + +期望输出: + +```text +NAME: mycluster +LAST DEPLOYED: Wed Jan 11 11:17:53 2023 +NAMESPACE: mogdb-operator-system +STATUS: deployed +REVISION: 1 +TEST SUITE: None +NOTES: +Thank you for deploying a MogDB Cluster! +``` + +检查pod是否运行正常 + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +cluster1-g3umz 2/2 Running 0 3m48s +cluster1-s8sti 2/2 Running 0 2m28s +mogdb-apiserver-699c855d9b-878qj 1/1 Running 0 17h +mogdb-operator-myproject-5cd5bb9d9-7xztz 1/1 Running 0 17h +``` + +当所有pod处于Running状态时，代表集群创建成功。 + +# 卸载 + +## 第1步: 删除集群 + +```shell +helm uninstall mycluster -n mogdb-operator-system +``` + +期望输出: + +```text +release "mycluster" uninstalled +``` + +检查集群pod是否被正确删除 + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +mogdb-apiserver-699c855d9b-878qj 1/1 Running 0 22h +mogdb-operator-myproject-5cd5bb9d9-7xztz 1/1 Running 0 22h +``` + +可以看到除了系统pod之外，MogDB Cluster相关的pod都被删除成功。成功删除后，继续下一步。 + +> 注意：系统中可能存在多套集群，必须一一删除之后，才可进入下一步操作。 + +## 第2步: 卸载监控告警 + +1. 删除资源对象 + + ```shell + helm uninstall monitor -n monitor + ``` + + 期望输出: + + ```text + release "monitor" uninstalled + ``` + + 检查相关Pod是否成功删除 + + ```shell + No resources found in monitor namespace. + ``` + + 可以看到monitor namespace下的所有Pod都被删除成功。 + +2. 删除namespace + + ```shell + kubectl delete namespace monitor + ``` + + 期望输出: + + ```text + namespace "monitor" deleted + ``` + +所有操作成功之后，继续下一步。 + +## 第3步: 卸载MogDB Operator + +1. 卸载MogDB Operator对象 + + ```shell + helm uninstall myproject -n mogdb-operator-system + ``` + + 期望输出: + + ```text + release "myproject" uninstalled + ``` + + 检查相关pod是否成功删除 + + ```shell + kubectl get pods -n mogdb-operator-system + ``` + + 期望输出: + + ```text + NAME READY STATUS RESTARTS AGE + mogdb-apiserver-699c855d9b-878qj 1/1 Running 0 22h + ``` + + 可以看到mogdb-operator-myproject-xxx删除成功。 + +2. 删除MogDB Operator CRDs + + MogDB Operator包含许多自定义的资源类型(CRDs)。执行以下命令从Kubernetes集群中删除CRD: + + ```shell + kubectl delete -f https://raw.githubusercontent.com/enmotech/mogdb-stack-examples/main/helm/crd.yaml + ``` + + 期望输出: + + ```text + customresourcedefinition.apiextensions.k8s.io/mogdbclusters.mogdb.enmotech.io created + customresourcedefinition.apiextensions.k8s.io/mogdbbackups.mogdb.enmotech.io created + ``` + +所有操作成功后，继续下一步。 + +## 第4步: 卸载MogDB apiserver + +1. 删除资源对象 + + ```shell + helm uninstall myapiserver -n mogdb-operator-system + ``` + + 期望输出: + + ```text + release "myapiserver" uninstalled + ``` + + 检查相关Pod是否成功删除 + + ```shell + kubectl get pods -n mogdb-operator-system + ``` + + 期望输出: + + ```text + No resources found in mogdb-operator-system namespace. + ``` + + 可以看到mogdb-apiserver-xxx删除成功。 + +2. 删除namespace + + ```shell + kubectl delete namespace mogdb-operator-system + ``` + + 期望输出: + + ```text + namespace "mogdb-operator-system" deleted + ``` + +所有操作成功之后，继续下一步。 + +## 第5步: 卸载Mogha + +1. 删除资源对象 + + ```shell + helm uninstall mogdb-ha --namespace mogha + ``` + + 期望输出: + + ```text + release "mogdb-ha" uninstalled + ``` + + 检查相关Pod是否成功删除 + + ```shell + kubectl get pods -n mogha + ``` + + 期望输出: + + ```text + No resources found in mogha namespace. + ``` + + 可以看到mogdb-ha-xxx删除成功。 + +2. 删除namespace + + ```shell + kubectl delete namespace mogha + ``` + + 期望输出: + + ```text + namespace "mogha" deleted + ``` diff --git a/product/zh/docs-mogdb-stack/v2.0/installation/kustomize.md b/product/zh/docs-mogdb-stack/v2.0/installation/kustomize.md new file mode 100644 index 0000000000000000000000000000000000000000..06bedda13b3775cd948595e3d90a1756ea394938 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/installation/kustomize.md @@ -0,0 +1,516 @@ +--- +title: kustomize方式安装 +summary: kustomize方式安装 +author: Ji Yabin +date: 2022-12-30 +--- + +## 前置条件 + +- 安装Kustomize v3+ + + ```shell + go install sigs.k8s.io/kustomize/kustomize/v3@v3.8.7 + ~/go/bin/kustomize version + ``` + + > 注意: kubectl 1.4+版本默认集成了Kustomize，无需单独安装。 + +- 下载MogDB Operator examples + + 首先，在GitHub上fork [MogDB Stack examples](https://github.com/enmotech/mogdb-stack-examples)仓库: + + + + fork仓库之后，您可以通过类似如下的命令下载至本地: + + ```shell + YOUR_GITHUB_UN="" + git clone --depth 1 "git@github.com:${YOUR_GITHUB_UN}/mogdb-stack-examples.git" + cd mogdb-stack-examples + ``` + + MogDB Operator安装项目在kustomize目录下。 + +- 安装的组件 + + - mogdb-operator + + - mogha + + - mogdb-monitor + + - mogdb-apiserver + + - mgo-client + + 其中，mgo-client运行在物理机下，其余组件都运行在k8s下 + +## 配置 + +默认的Kustomize可以工作在大部分Kubernetes环境中，也可以根据您的特殊需求定制。 + +例如，为MogDB Operator自定义镜像路径，该镜像在kustomize/mogdb-operator/default/kustomization.yaml文件中，可以修改为: + +```yaml +images: +- name: controller + newName: swr.cn-north-4.myhuaweicloud.com/mogdb-cloud/mogdb-operator + newTag: v2.0.0 +``` + +如果需要更改namespace名称，需要在kustomize/mogdb-operator/default/kustomization.yaml文件中修改如下配置。 + +```yaml +namespace: custom-namespace +``` + +## 安装 + +### 第1步: 安装 Mogha + +```shell +kubectl apply -k kustomize/mogha +``` + +期望输出: + +```text +namespace/mogha created +serviceaccount/mogdb-ha created +clusterrole.rbac.authorization.k8s.io/mogdb-ha-role created +clusterrolebinding.rbac.authorization.k8s.io/mogdb-ha-rolebinding created +secret/huawei-registry created +service/mogdb-ha created +deployment.apps/mogdb-ha created +``` + +检查相关组件是否运行正常: + +```shell +kubectl get pods -n mogha +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +mogdb-ha-5cf86cc667-r45vm 2/2 Running 0 66s +``` + +当Pod处于Running状态时，继续下一步。 + +### 第2步: 安装 MogDB Operator + +```shell +kubectl apply -k kustomize/mogdb-operator/default/ +``` + +期望输出: + +```text +namespace/mogdb-operator-system created +customresourcedefinition.apiextensions.k8s.io/mogdbbackups.mogdb.enmotech.io configured +customresourcedefinition.apiextensions.k8s.io/mogdbclusters.mogdb.enmotech.io configured +serviceaccount/mogdb-operator-controller-manager created +role.rbac.authorization.k8s.io/mogdb-operator-leader-election-role created +clusterrole.rbac.authorization.k8s.io/mogdb-operator-manager-role created +rolebinding.rbac.authorization.k8s.io/mogdb-operator-leader-election-rolebinding created +clusterrolebinding.rbac.authorization.k8s.io/mogdb-operator-manager-rolebinding created +configmap/mogdb-operator-global-config created +configmap/mogdb-operator-manager-config created +secret/mogdb-operator-huawei-registry created +deployment.apps/mogdb-operator-controller-manager created +``` + +检查相关组件是否运行正常: + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +mogdb-operator-controller-manager-fcf875446-ngknd 1/1 Running 0 45s +``` + +当Pod处于Running状态时，继续下一步。 + +### 第3步: 安装MogDB Apiserver + +```shell +kubectl apply -k kustomize/mogdb-apiserver/ +``` + +期望输出: + +```text +namespace/mogdb-operator-system unchanged +serviceaccount/mogdb-apiserver created +clusterrole.rbac.authorization.k8s.io/mgo-cluster-role created +clusterrolebinding.rbac.authorization.k8s.io/mgo-cluster-role created +secret/mgorole-admin created +secret/mgouser-admin created +service/mogdb-apiserver created +deployment.apps/mogdb-apiserver created +``` + +检查相关组件是否运行正常: + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +mogdb-apiserver-699c855d9b-zx4sm 1/1 Running 0 71s +mogdb-operator-controller-manager-fcf875446-ngknd 1/1 Running 0 18m +``` + +当Pod处于Running状态时，继续下一步。 + +### 第4步: 安装监控告警 + ++ 更改配置，编辑kustomize/mogdb-monitor/alertmanager/alertmanager-conf.yaml + + ```text + smtp_smarthost: 'smtp.163.com:25' # 告警邮箱server host + smtp_from: 'xxxx@163.com' # 发件人邮箱地址 + smtp_auth_username: 'xxxx@163.com' # 用户名 + smtp_auth_password: '<邮箱密码>' # 密码，开通smtp服务生成的授权码 + + - name: 'email' + email_configs: + - to: 'xxx@qq.com' # 接收报警的邮箱，多个用逗号隔开 + ``` + ++ 安装监控告警组件 + + ```shell + kubectl apply -k kustomize/mogdb-monitor + ``` + + 期望输出: + + ```text + namespace/monitor created + serviceaccount/kube-state-metrics created + serviceaccount/prometheus created + clusterrole.rbac.authorization.k8s.io/kube-state-metrics created + clusterrole.rbac.authorization.k8s.io/prometheus created + clusterrolebinding.rbac.authorization.k8s.io/kube-state-metrics created + clusterrolebinding.rbac.authorization.k8s.io/prometheus created + configmap/prometheus-config created + service/grafana created + service/kube-state-metrics created + service/node-exporter created + service/prometheus created + deployment.apps/grafana created + deployment.apps/kube-state-metrics created + deployment.apps/prometheus created + daemonset.apps/node-exporter created + ``` + +检查相关组件是否运行正常: + +```shell +kubectl get pods -n monitor +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +grafana-5548d85c77-m69fc 1/1 Running 0 8s +kube-state-metrics-77f9d6d895-hw5t5 0/1 Running 0 8s +node-exporter-8j78l 1/1 Running 0 7s +node-exporter-9ctt7 1/1 Running 0 7s +node-exporter-chlg5 1/1 Running 0 7s +prometheus-645fcdf654-d956p 2/2 Running 0 7s +``` + +当所有Pod处于Running状态时，继续下一步。 + +### 第5步: 安装 mgo 客户端 + +```shell +wget https://cdn-mogdb.enmotech.com/mogdb-stack/v2.0.0/client-setup.sh +chmod +x client-setup.sh +./client-setup.sh +``` + +这将下载mgo客户端并且提示您添加一些环境变量以供您在会话中设置，您可以使用以下命令执行此操作： + +```shell +export MGOUSER="${HOME?}/.mgo/mgouser" +export MGO_CA_CERT="${HOME?}/.mgo/client.crt" +export MGO_CLIENT_CERT="${HOME?}/.mgo/client.crt" +export MGO_CLIENT_KEY="${HOME?}/.mgo/client.key" +export MGO_APISERVER_URL='https://127.0.0.1:32444' +export MGO_NAMESPACE=mogdb-operator-system +``` + +如果您希望将这些变量永久添加到您的环境中，您可以运行以下命令： + +```shell +cat <> ~/.bashrc +export PATH="${HOME?}/.mgo:$PATH" +export MGOUSER="${HOME?}/.mgo/mgouser" +export MGO_CA_CERT="${HOME?}/.mgo/client.crt" +export MGO_CLIENT_CERT="${HOME?}/.mgo/client.crt" +export MGO_CLIENT_KEY="${HOME?}/.mgo/client.key" +export MGO_APISERVER_URL='https://127.0.0.1:32444' +export MGO_NAMESPACE=mogdb-operator-system +EOF + +source ~/.bashrc +``` + +> **注意：** 对于 macOS 用户，您使用文件是\~/.bash_profile而不是\~/.bashrc。 + +### 第6步: 创建MogDB 集群 + +有两种方式创建MogDB 集群 + +- mgo命令行创建 + +```shell +mgo create cluster cluster1 +``` + +期望输出： + +```text +created cluster: cluster1 +``` + +检查集群是否安装成功 + +```shell +mgo show cluster cluster1 +``` + +期望输出： + +```text +cluster : cluster1 + pod : cluster1-ib7zq (Running) on mogdb-k8s-001 (3/3) (primary) + pod : cluster1-rtwdz (Running) on mogdb-k8s-002 (3/3) (standby) + service : cluster1-svc-master - ClusterIP (10.1.149.4) - Ports (5432:30013/TCP) + service : cluster1-svc-replicas - ClusterIP (10.1.175.46) - Ports (5432:30012/TCP) +``` + +可以看到，集群创建了两个副本，以及两个service。 + +- kustomize创建 + +```shell +kubectl apply -k kustomize/mogdb-cluster/ +``` + +期望输出: + +```text +mogdbcluster.mogdb.enmotech.io/cluster1 created +``` + +检查集群Pod是否成功创建 + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +cluster1-m4sr3 2/2 Running 0 7m13s +cluster1-nebx9 2/2 Running 0 8m8s +mogdb-operator-controller-manager-fcf875446-gmmqp 1/1 Running 0 9m9s +``` + +至此，集群相关Pod都已成功创建。 + +## 卸载 + +> **注意**: +> +> 卸载之前，请确保系统所有的MogDB集群已经删除完整，否则无法卸载。 + +### 删除MogDB 集群 + +```shell +kubectl delete -k kustomize/mogdb-cluster/ +``` + +期望输出: + +```text +mogdbcluster.mogdb.enmotech.io "cluster1" deleted +``` + +检查所有Pod是否成功删除 + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +mogdb-operator-controller-manager-fcf875446-gmmqp 1/1 Running 0 13m +``` + +可以看到集群所有Pod已成功删除。 + +> 注意: 系统中有可能存在多个集群，请按照此步骤一一删除。 + +### 卸载 Mogha + +```shell +kubectl delete -k kustomize/mogha +``` + +期望输出: + +```text +namespace "mogha" deleted +serviceaccount "mogdb-ha" deleted +clusterrole.rbac.authorization.k8s.io "mogdb-ha-role" deleted +clusterrolebinding.rbac.authorization.k8s.io "mogdb-ha-rolebinding" deleted +secret "huawei-registry" deleted +service "mogdb-ha" deleted +deployment.apps "mogdb-ha" deleted +``` + +检查相关Pod是否成功删除 + +```shell +kubectl get pods -n mogha +``` + +期望输出: + +```text +No resources found in mogha namespace. +``` + +当所有相关Pod成功删除后，继续下一步。 + +### 卸载监控 + +```shell +kubectl delete -k kustomize/mogdb-monitor +``` + +期望输出: + +```text +namespace "monitor" deleted +serviceaccount "kube-state-metrics" deleted +serviceaccount "prometheus" deleted +clusterrole.rbac.authorization.k8s.io "kube-state-metrics" deleted +clusterrole.rbac.authorization.k8s.io "prometheus" deleted +clusterrolebinding.rbac.authorization.k8s.io "kube-state-metrics" deleted +clusterrolebinding.rbac.authorization.k8s.io "prometheus" deleted +configmap "alert-config" deleted +configmap "prometheus-config" deleted +service "grafana" deleted +service "kube-state-metrics" deleted +service "node-exporter" deleted +service "prometheus" deleted +deployment.apps "grafana" deleted +deployment.apps "kube-state-metrics" deleted +deployment.apps "prometheus" deleted +daemonset.apps "node-exporter" deleted +``` + +检查所有相关Pod是否成功删除 + +```shell +kubectl get pods -n monitor +``` + +期望输出: + +```text +No resources found in monitor namespace. +``` + +当所有相关Pod成功删除后，继续下一步。 + +### 卸载 MogDB Apiserver + +```shell +kubectl delete -k kustomize/mogdb-apiserver/ +``` + +期望输出: + +```text +namespace "mogdb-operator-system" deleted +serviceaccount "mogdb-apiserver" deleted +clusterrole.rbac.authorization.k8s.io "mgo-cluster-role" deleted +clusterrolebinding.rbac.authorization.k8s.io "mgo-cluster-role" deleted +secret "mgorole-admin" deleted +secret "mgouser-admin" deleted +service "mogdb-apiserver" deleted +deployment.apps "mogdb-apiserver" deleted +``` + +检查相关Pod是否成功删除 + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +mogdb-operator-controller-manager-fcf875446-2d525 1/1 Running 0 28s +``` + +当所有相关Pod成功删除后，继续下一步。 + +### 卸载 MogDB Operator + +```shell +kubectl delete -k kustomize/mogdb-operator/default +``` + +期望输出: + +```text +namespace "mogdb-operator-system" deleted +customresourcedefinition.apiextensions.k8s.io "mogdbbackups.mogdb.enmotech.io" deleted +customresourcedefinition.apiextensions.k8s.io "mogdbclusters.mogdb.enmotech.io" deleted +serviceaccount "mogdb-operator-controller-manager" deleted +role.rbac.authorization.k8s.io "mogdb-operator-leader-election-role" deleted +clusterrole.rbac.authorization.k8s.io "mogdb-operator-manager-role" deleted +rolebinding.rbac.authorization.k8s.io "mogdb-operator-leader-election-rolebinding" deleted +clusterrolebinding.rbac.authorization.k8s.io "mogdb-operator-manager-rolebinding" deleted +configmap "mogdb-operator-global-config" deleted +configmap "mogdb-operator-manager-config" deleted +secret "mogdb-operator-huawei-registry" deleted +deployment.apps "mogdb-operator-controller-manager" deleted +``` + +检查所有相关Pod是否成功删除 + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```text +No resources found in mogdb-operator-system namespace. +``` + +至此，所有的组件卸载完毕。 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/overview.md b/product/zh/docs-mogdb-stack/v2.0/overview.md new file mode 100644 index 0000000000000000000000000000000000000000..3991a58c078ade39032d3513f3e6a79b191f5dd7 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/overview.md @@ -0,0 +1,49 @@ +--- +title: MogDB Stack 简介 +summary: MogDB Stack 简介 +author: Ji Yabin +date: 2021-06-16 +--- + +# MogDB Stack 简介 + +MogDB Stack是Kubernetes上的MogDB集群自动运维系统，提供包括部署、高可用、扩缩容、监控、备份恢复的MogDB全生命周期管理。借助MogDB Stack，MogDB可以无缝运行在公有云或私有部署的Kubernetes集群上。 + +
+ +## MogDB Stack特性 + +- **简单便捷的自动部署/回收** + + 以Kubernetes作为原生的容器编排系统，以扩展资源的方式，轻松便捷地创建整套MogDB集群，并且根据用户的期望任意扩缩容。 + +- **稳定可靠的备份恢复能力** + + 支持基于SQL的备份方式，并且存储在远端分布式存储中，多副本保证备份的可靠性，指定point-in-time的恢复方式，恢复到指定的时间点。 + +- **企业级的高可用性** + + 自动故障探测、切换，并自动化的拉取数据快照恢复故障节点或重新调度新节点，实现系统的自愈能力，保证用户期望的副本数。 + +- **完善可靠的监控能力** + + 基于Prometheus实现多维度的统一监控，囊括了系统层、容器层、数据库层的完整的监控指标。 + +- **精细化的资源管控** + + 针对CPU、内存、存储等资源的限额，保证容器层的独立性，不会互相干扰，支持容器的亲和性、反亲和性调度。 + +
+ +## 系统架构 + +![deploy-arch](https://cdn-mogdb.enmotech.com/docs-media/mogdb-stack/v1.0.0/overview-arch.png) + +
+ +## 操作系统与平台支持 + +MogDB Stack 目前支持在如下操作系统和平台架构下运行： + +1. Linux x86_64 +2. Linux arm64 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/quick-start.md b/product/zh/docs-mogdb-stack/v2.0/quick-start.md new file mode 100644 index 0000000000000000000000000000000000000000..b8cef3ecab996bac385497299cb6977ae53db22a --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/quick-start.md @@ -0,0 +1,350 @@ +--- +title: 快速上手 +summary: 快速上手 +author: Wang Dong +date: 2022-12-14 +--- + +# 快速上手 + +本文介绍了如何创建一个简单的 Kubernetes 集群，部署 MogDB Operator，并使用 Mogdb Operator 部署 MogDB 集群。 + +> 本文中的部署说明仅用于测试目的，不要直接用于生产环境。如果要在生产环境部署，请参阅部署 > 部署 MogDB 集群章节。 + +基本步骤如下： + +[1. 创建Kubernetes测试集群](#创建kubernetes测试集群) + +[2. 部署MogDB Operator](#部署mogdb-operator) + +[3. 部署MogDB集群](#部署mogdb集群) + +[4. 连接MogDB集群](#连接mogdb集群) + +[5. 销毁MogDB集群](#销毁mogdb集群) + +
+ +## 创建Kubernetes测试集群 + +本节介绍如何使用 minikube 部署 Kubernetes 集群。 + +minikube 可以在虚拟机中创建一个 Kubernetes 集群，可在 macOS, Linux 和 Windows 上运行。 + +部署前，请确保满足以下要求： + +- minikube：版本 1.18.1+ + +- minikube 需要安装一个兼容的 hypervisor，详情见官方安装教程。 + +- kubectl: 版本 >= 1.18.1 + +安装完 minikube 后，可以执行下面命令启动一个 Kubernetes 集群： + +```shell +minikube start +``` + +如果一切运行正常，会看到类似下面的输出，根据操作系统和使用的 hypervisor 会有些许差异。 + +```shell +😄 minikube v1.10.1 on Darwin 10.15.4 +✨ Automatically selected the hyperkit driver. Other choices: docker, vmwarefusion +💾 Downloading driver docker-machine-driver-hyperkit: + > docker-machine-driver-hyperkit.sha256: 65 B / 65 B [---] 100.00% ? p/s 0s + > docker-machine-driver-hyperkit: 10.90 MiB / 10.90 MiB 100.00% 1.76 MiB p +🔑 The 'hyperkit' driver requires elevated permissions. The following commands will be executed: + + $ sudo chown root:wheel /Users/user/.minikube/bin/docker-machine-driver-hyperkit + $ sudo chmod u+s /Users/user/.minikube/bin/docker-machine-driver-hyperkit + + +💿 Downloading VM boot image ... + > minikube-v1.10.0.iso.sha256: 65 B / 65 B [-------------] 100.00% ? p/s 0s + > minikube-v1.10.0.iso: 174.99 MiB / 174.99 MiB [] 100.00% 6.63 MiB p/s 27s +👍 Starting control plane node minikube in cluster minikube +💾 Downloading Kubernetes v1.18.2 preload ... + > preloaded-images-k8s-v3-v1.18.2-docker-overlay2-amd64.tar.lz4: 525.43 MiB +🔥 Creating hyperkit VM (CPUs=2, Memory=4000MB, Disk=20000MB) ... +🐳 Preparing Kubernetes v1.18.2 on Docker 19.03.8 ... +🔎 Verifying Kubernetes components... +🌟 Enabled addons: default-storageclass, storage-provisioner +🏄 Done! kubectl is now configured to use "minikube" +``` + +对于中国大陆用户，可以使用国内 gcr.io mirror 仓库，例如 registry.cn-hangzhou.aliyuncs.com/google_containers。 + +```shell +minikube start --image-repository registry.cn-hangzhou.aliyuncs.com/google_containers +``` + +或者给 Docker 配置 HTTP/HTTPS 代理。 + +将下面命令中的 127.0.0.1:1086 替换为您自己的 HTTP/HTTPS 代理地址： + +```shell +minikube start --docker-env https_proxy=http://127.0.0.1:1086 \ + --docker-env http_proxy=http://127.0.0.1:1086 +``` + +> **注意:**
+> 由于 minikube（默认）通过虚拟机运行，127.0.0.1 指向虚拟机本身，所以在有些情况下可能需要将代理修改为您的主机的实际 IP。 + +参考 minikube setup 查看配置虚拟机和 Kubernetes 集群的更多选项。 + +你可以使用 minikube 的子命令 kubectl 来进行集群操作。要使 kubectl 命令生效，你需要在 shell 配置文件中添加以下别名设置命令，或者在打开一个新的 shell 后执行以下别名设置命令。 + +```shell +alias kubectl='minikube kubectl --' +``` + +执行以下命令检查集群状态，并确保可以通过 kubectl 访问集群: + +```shell +kubectl cluster-info +``` + +期望输出： + +```shell +Kubernetes master is running at https://192.168.64.2:8443 +KubeDNS is running at https://192.168.64.2:8443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy + +To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'. +``` + +现在就可以开始部署 MogDB Operator 了！ + +测试完成后，执行下面命令来销毁集群： + +```shell +minikube delete +``` + +
+ +## 部署MogDB Operator + +开始之前，确保以下要求已满足： + +- 可以使用 kubectl 访问的 Kubernetes 集群 +- 已安装 Kustomize v3+ + +**步骤1: 下载样例** + +在GitHub上fork [MogDB Stack examples](https://github.com/enmotech/mogdb-stack-examples)仓库: + + + +fork仓库之后，您可以通过类似如下的命令下载至本地: + +```shell +YOUR_GITHUB_UN="" +git clone --depth 1 "git@github.com:${YOUR_GITHUB_UN}/mogdb-stack-examples.git" +cd mogdb-stack-examples +``` + +**步骤2: 安装MogDB Operator** + +```shell +kustomize build kustomize/mogdb-operator/default | kubectl apply -f - +``` + +期望输出: + +```shell +namespace/mogdb-operator-system created +customresourcedefinition.apiextensions.k8s.io/mogdbbackups.mogdb.enmotech.io configured +customresourcedefinition.apiextensions.k8s.io/mogdbclusters.mogdb.enmotech.io configured +serviceaccount/mogdb-apiserver created +serviceaccount/mogdb-operator-controller-manager created +role.rbac.authorization.k8s.io/mogdb-operator-leader-election-role created +clusterrole.rbac.authorization.k8s.io/mgo-cluster-role created +clusterrole.rbac.authorization.k8s.io/mogdb-operator-manager-role created +rolebinding.rbac.authorization.k8s.io/mogdb-operator-leader-election-rolebinding created +clusterrolebinding.rbac.authorization.k8s.io/mgo-cluster-role created +clusterrolebinding.rbac.authorization.k8s.io/mogdb-operator-manager-rolebinding created +configmap/mogdb-operator-manager-config created +configmap/mogdb-operator-mgo-config created +secret/mgorole-admin created +secret/mgouser-admin created +secret/mogdb-operator-huawei-registry created +service/mogdb-apiserver created +deployment.apps/mogdb-apiserver created +deployment.apps/mogdb-operator-controller-manager created +``` + +
+ +## 部署MogDB集群 + +```shell +kubectl apply -k kustomize/mogdb-cluster/ +``` + +期望输出: + +```text +mogdbcluster.mogdb.enmotech.io/cluster1 created +``` + +### 查看pod状态 + +```shell +kubectl get pods -n mogdb-operator-system +``` + +期望输出: + +```shell +NAME READY STATUS RESTARTS AGE +cluster1-jl2kn 3/3 Running 0 4m18s +cluster1-zuveg 0/3 PodInitializing 0 108s +``` + +等待所有pod都处于running状态，然后进行下一步，连接到MogDB集群。 + +
+ +## 连接MogDB集群 + +### 安装gsql命令行工具 + +要连接到MogDB集群，您需要在使用kubectl的主机上安装MogDB客户端工具[gsql](../../docs-mogdb/v3.0/quick-start/mogdb-access/use-cli-to-access-mogdb/gsql.md#安装gsql客户端)安装与物理机匹配的命令行工具。 + +
+ +### 查看MogDB服务端口 + +首先，将端口从本地主机转发到 Kubernetes 中的 MogDB Service。 我们先获取 mogdb-operator-system 命名空间中的服务列表： + +```shell +kubectl get svc -n mogdb-operator-system +``` + +期望输出： + +```text +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +cluster1-svc-master NodePort 10.1.115.245 5432:30013/TCP 38m +cluster1-svc-replicas NodePort 10.1.41.187 5432:30012/TCP 38m +``` + +输出结果显示了，k8s集群内部通过5432端口，集群外部通过30013端口访问实际的MogDB集群。 + +
+ +### 连接集群 + +在连接之前，需要修改默认用户的密码。可以通过kubectl命令连接到容器，修改密码。 + +```shell +kubectl exec -it cluster1-xxxxx -c mogdb -n mogdb-operator-system -- /bin/bash +gsql -dpostgres +``` + +```sql +ALTER USER mogdb WITH PASSWORD 'new_password'; +``` + +```shell +gsql -h 10.1.115.245 -p 5432 -U mogdb -W +``` + +期望输出： + +```shell +gsql ((MogDB 3.1.0 build aef997f9) compiled at 2022-11-24 00:09:16 commit 0 last mr ) +Non-SSL connection (SSL connection is recommended when requiring high-security) +Type "help" for help. + +MogDB=# +``` + +以下是一些可以用来验证集群功能的命令。 + +- 查看MogDB版本 + +```sql +MogDB=#select version(); + version +--------------------------------------------------------------------------------------------------------------------------------------------------- +(MogDB 3.1.0 build aef997f9) compiled at 2022-11-24 00:09:16 commit 0 last mr on aarch64-unknown-linux-gnu, compiled by g++ (GCC) 7.3.0, 64-bit +(1 row) +``` + +- 创建t1表 + +```sql +MogDB=#create table t1(id int); +CREATE TABLE +``` + +- 插入数据 + +```sql +MogDB=#insert into t1(id) values(1),(2),(3); +INSERT 0 3 +``` + +- 查看数据 + +```sql +MogDB=#select * from t1; + id +---- + 1 + 2 + 3 +(3 rows) +``` + +
+ +## 销毁MogDB集群 + +完成测试后，您可能希望销毁MogDB集群。 + +### 删除MogDB集群 + +```shell +kubectl delete mogdbcluster cluster1 +``` + +期望输出: + +```text +mogdbcluster.mogdb.enmotech.io "cluster1" deleted +``` + +
+ +## 卸载MogDB Operator + +```shell +kustomize build ./kustomize/install/default | kubectl delete -f - +``` + +期望输出: + +```shell +namespace "mogdb-operator-system" deleted +customresourcedefinition.apiextensions.k8s.io "mogdbbackups.mogdb.enmotech.io" deleted +customresourcedefinition.apiextensions.k8s.io "mogdbclusters.mogdb.enmotech.io" deleted +serviceaccount "mogdb-apiserver" deleted +serviceaccount "mogdb-operator-controller-manager" deleted +role.rbac.authorization.k8s.io "mogdb-operator-leader-election-role" deleted +clusterrole.rbac.authorization.k8s.io "mgo-cluster-role" deleted +clusterrole.rbac.authorization.k8s.io "mogdb-operator-manager-role" deleted +rolebinding.rbac.authorization.k8s.io "mogdb-operator-leader-election-rolebinding" deleted +clusterrolebinding.rbac.authorization.k8s.io "mgo-cluster-role" deleted +clusterrolebinding.rbac.authorization.k8s.io "mogdb-operator-manager-rolebinding" deleted +configmap "mogdb-operator-manager-config" deleted +configmap "mogdb-operator-mgo-config" deleted +secret "mgorole-admin" deleted +secret "mgouser-admin" deleted +secret "mogdb-operator-huawei-registry" deleted +service "mogdb-apiserver" deleted +deployment.apps "mogdb-apiserver" deleted +deployment.apps "mogdb-operator-controller-manager" deleted +``` diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-addk8s.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-addk8s.md new file mode 100644 index 0000000000000000000000000000000000000000..412795ceb622c172f67d258c8d2f2992813547e9 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-addk8s.md @@ -0,0 +1,55 @@ +--- +title: mgo addk8s +summary: mgo添加k8s节点 +author: Wang Dong +date: 2022-12-14 +--- + +# 添加k8s节点 + +## 概览 + +添加一个k8s节点到集群中, 例： + +```shell +mgo addk8s myNode --node-id=xxx --apiserver=xxx --ca-cert=xxx --client-cert=xxx --client-key=xxx --disable-tls=false +``` + +```shell +mgo addk8s [flags] +``` + +
+ +## 选项 + +```text + --apiserver string k8s 节点 mogdb-apiserver 的host. + --ca-cert string 用于对新的k8s api服务器节点进行身份验证的CA证书base64编码内容. + --client-cert string 用于对新的k8s api服务器节点进行身份验证的客户端证书base64编码内容. + --client-key string 用于对新的k8s api服务器节点进行身份验证的客户端密钥base64编码内容. + -h, --help addk8s 帮助信息 + --node-id string k8s 节点 mogdb-apiserver 的 uuid. +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的MogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-backup-detail.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-backup-detail.md new file mode 100644 index 0000000000000000000000000000000000000000..7daf18ad1d8c51e4213b32cbdaf3af937c5d5565 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-backup-detail.md @@ -0,0 +1,48 @@ +--- +title: mgo-backup-detail +desription: mgo 获取备份详情 +author: Wang Dong +date: 2022-12-14 +--- + +## 获取备份详情 + +### 概览 + +获取备份详情。例如： + +```shell +mgo backup detail backupName +``` + +```shell +mgo backup detail [flags] +``` + +
+ +### 选项 + +```text + -h, --help detail 帮助信息 +``` + +
+ +### 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +### 另请参阅 + +* [mgo backup](mgo-backup.md) - mgo 进行手动备份 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-backup.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-backup.md new file mode 100644 index 0000000000000000000000000000000000000000..c2b2dd833199533b4c2f88216be13ff5df97d4bc --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-backup.md @@ -0,0 +1,60 @@ +--- +title: mgo-backup +desription: mgo 进行手动备份 +author: Wang Dong +date: 2022-12-14 +--- + +## 进行手动备份 + +### 概览 + +BACKUP 命令允许您进行集群的手动备份。例如： + +```shell +mgo backup mycluster --backup-type=basebackup --backup-level=incr +``` + +```shell +mgo backup [flags] +``` + +
+ +### 选项 + +```text + --backup-image string 备份镜像，默认latest版本. + --backup-level string 备份级别. 分为 "incr" or "full". (默认 "incr") 、 + --backup-s3-bucket string 当启用“S3”存储类型进行备份时，应用于集群的S3存储桶 + --backup-s3-endpoint string 当启用“S3”存储类型进行备份时，应用于集群的S3存储节点 + --backup-s3-key string 当启用“S3”存储类型进行备份时，应用于集群的S3节点访问的key + --backup-s3-key-secret string 当启用“S3”存储类型进行备份时，应用于集群的S3节点访问的key 密钥 + --backup-s3-region string 当启用“S3”存储类型进行备份时，应用于集群的S3region + --backup-storage-type string 备份存储类型. 分为 "posix" 和 "s3". (默认 "posix") + --backup-type string 备份类型. 分为 "basebackup" 和 "dumpall". (默认 "basebackup") + --dbName string 指定备份数据库名称 + -h, --help backup帮助信息 + --tbNames string 指定备份表格名称，多个用逗号隔开 +``` + +
+ +### 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +### 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 +* [mgo backup detail](mgo-backup-detail.md) - 获取备份详情 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-cluster.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-cluster.md new file mode 100644 index 0000000000000000000000000000000000000000..6208290868e71ea2c26bfcd3720f366780ee77c4 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-cluster.md @@ -0,0 +1,80 @@ +--- +title: mgo create cluster +summary: mgo创建集群 +author: Wang Dong +date: 2022-12-14 +--- + +# 创建 MogDB 集群 + +## 概览 + +后台创建由一个主节点和几个从节点组成的 MogDB 集群, 例： + +```shell +mgo create cluster mycluster +``` + +```shell +mgo create cluster [flags] +``` + +
+ +## 选项 + +```text + --access-modes int 设置数据卷的访问方式。1: ReadWriteOnce, 2: ReadOnlyMany, 3: ReadWriteMany. 默认值ReadWriteOnce + --auto-backup 是否开启自动备份 + --backup-level string 备份级别，"incr"或者"full". (默认 "incr") + --backup-s3-bucket string 当启用“S3”存储类型进行备份时，应用于集群的S3存储桶 + --backup-s3-endpoint string 当启用“S3”存储类型进行备份时，应用于集群的S3存储节点 + --backup-s3-key string 当启用“S3”存储类型进行备份时，应用于集群的S3节点访问的key + --backup-s3-key-secret string 当启用“S3”存储类型进行备份时，应用于集群的S3节点访问的key 密钥 + --backup-schedule string crontab格式的备份策略，默认为空 + --backup-schedule-history-limit int32 自动备份保留的数量最大限制，默认为0 + --backup-storage-size string 备份存储大小，默认为 128Mi + --backup-storage-type string 自动备份存储类型. 分为 "posix" 和 "s3". (默认 "posix") + --backup-type string 备份类型. 分为 "basebackup" 和 "dumpall". (默认 "basebackup") + --cpu string 设置要请求CPU的核数，e.g. "100m" or "0.1" + --cpu-limit string 为CPU设置要限制的核数，e.g. "100m" or "0.1" + --data-storage-size string 设置数据库数据卷大小。默认值128Mi + --exporter-image string 将用于MogDB exporter sidecar 容器的镜像。如果指定，将替代默认值 + --ha-image string 将用于MogDB ha sidecar 容器的镜像。如果指定，将替代默认值 + -h, --help help for cluster + --image string 将用于MogDB server 容器的镜像。如果指定，将替代默认值 + --init-image string 将用于MogDB 初始化容器的镜像。如果指定，将替代默认值 + --log-storage-size string 设置日志数据卷大小。默认值128Mi + --memory string 设置要请求的内存数量，e.g. 1GiB + --memory-limit string 设置限制的内存数量，e.g. 1GiB + --read-port int 设置 service 的读取端口 + --replicas int 设置创建集群的从节点数量，默认值为2 + --restore-backup-type string 执行还原以引导群集的备份类型. 分为 "basebackup" 和 "dumpall".(默认 "basebackup") 只有在 "restore-from" 值被指定时有效. + --restore-from string 引导新群集时要从中恢复的群集的名称 + --restore-object string 恢复的备份对象的名称. 只有在 "restore-from" 值被指定时有效. + --restore-type string 恢复的类型， 分为 "object" 和 "time". 只有在 "restore-from" 值被指定时有效. + --storage-class string 设置声明所需的StorageClass的名称。默认值是 local-path + --write-port int 设置 service 的写端口 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的MogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo create](mgo-create.md) - 创建 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-mgorole.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-mgorole.md new file mode 100644 index 0000000000000000000000000000000000000000..1e7491d0a8c964c47ca4a72328201f3f9a3d21fa --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-mgorole.md @@ -0,0 +1,51 @@ +--- +title: mgo create mgorole +summary: mgo创建角色 +author: Wang Dong +date: 2022-12-14 +--- + +# 创建 mgo 权限角色 + +## 概览 + +创建 mgo 权限角色。例如： + +```shell +mgo create mgorole somerole --permissions="Cat,Ls" +``` + +```shell +mgo create mgorole [flags] +``` + +
+ +## 选项 + +```text + -h, --help help for mgorole + --permissions string 指定mgo 权限角色的权限列表，用逗号隔开 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo create](mgo-create.md) - 创建 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-mgouser.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-mgouser.md new file mode 100644 index 0000000000000000000000000000000000000000..30274619f7b12bac7b9bbbbb1f6844150dc5a4d6 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create-mgouser.md @@ -0,0 +1,54 @@ +--- +title: mgo create mgouser +summary: mgo创建用户 +author: Wang Dong +date: 2022-12-14 +--- + +# 创建 mgo 用户 + +## 概览 + +创建一个 mgo 用户。例如： + +```shell +mgo create mgouser someuser +``` + +```shell +mgo create mgouser [flags] +``` + +
+ +## 选项 + +```text + --all-namespaces 指定此用户将有权访问所有命名空间 + -h, --help help for mgouser + --mgouser-namespaces string 为mgouser指定以逗号分隔的名称空间列表 + --mgouser-password string 指定mgouser的密码 + --mgouser-roles string 为mgouser指定以逗号分隔的角色列表 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo create](mgo-create.md) - 创建 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create.md new file mode 100644 index 0000000000000000000000000000000000000000..da154d16dcabc3c1ea887353e58d8cffc11682e4 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-create.md @@ -0,0 +1,53 @@ +--- +title: mgo-create +desription: mgo 创建命令 +author: Wang Dong +date: 2022-12-14 +--- + +## 创建 MogDB Operator resource + +### 概览 + +CREATE 命令允许您创建一个新的 Operator 资源。例如： + +```shell +mgo create cluster +mgo create mgouser +mgo create mgorole +``` + +```shell +mgo create [flags] +``` + +
+ +### 选项 + +```text + -h, --help create 的帮助信息 +``` + +
+ +### 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +### 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 +* [mgo create cluster](mgo-create-cluster.md) - 创建 MogDB 集群 +* [mgo create mgorole](mgo-create-mgorole.md) - 创建 mgo 权限角色 +* [mgo create mgouser](mgo-create-mgouser.md) - 创建 mgo 用户 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-backup.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-backup.md new file mode 100644 index 0000000000000000000000000000000000000000..74845b4c5d53107aa2d02c998f52ccd48f187ab7 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-backup.md @@ -0,0 +1,52 @@ +--- +title: mgo delete backup +desription: mgo 删除备份 +author: Wang Dong +date: 2022-12-14 +--- + +# 删除 mgo 备份 + +## 概览 + +删除指定的手动备份，例如： + +```shell +mgo delete backup mycluster --target=mybackup1,mybackup2 +``` + +```shell +mgo delete backup [flags] +``` + +
+ +## 选项 + +```text + --target string 指定删除备份的目标，多个用逗号隔开 + -h, --help delete k8s 的帮助信息 + --no-prompt 删除前没有命令行确认 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo delete](mgo-delete.md) - 删除 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-cluster.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-cluster.md new file mode 100644 index 0000000000000000000000000000000000000000..10600b29bd9dc1657754ea0fb91bcc8b2779746f --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-cluster.md @@ -0,0 +1,53 @@ +--- +title: mgo delete cluster +desription: mgo 删除集群 +author: Wang Dong +date: 2022-12-14 +--- + +# 删除 MogDB 集群 + +## 概览 + +删除指定的 MogDB 集群或所有 MogDB 集群。例如： + +```shell +mgo delete cluster --all +mgo delete cluster mycluster +``` + +```shell +mgo delete cluster [flags] +``` + +
+ +## 选项 + +```text + --all 删除所有的 MogDB 集群 + -h, --help delete cluster 的帮助信息 + --no-prompt 删除前没有命令行确认 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo delete](mgo-delete.md) - 删除 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-k8s.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-k8s.md new file mode 100644 index 0000000000000000000000000000000000000000..55d097090179dfa5e6ba9b6b7d7e57d17d7bb86a --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-k8s.md @@ -0,0 +1,52 @@ +--- +title: mgo delete k8s +desription: mgo 删除 k8s 节点 +author: Wang Dong +date: 2022-12-14 +--- + +# 删除 mgo k8s 节点 + +## 概览 + +删除指定的k8s 节点，例如： + +```shell +mgo delete k8s --node-id=xxx +``` + +```shell +mgo delete k8s [flags] +``` + +
+ +## 选项 + +```text + --node-id string k8s 节点uuid. + -h, --help delete k8s 的帮助信息 + --no-prompt 删除前没有命令行确认 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo delete](mgo-delete.md) - 删除 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-mgorole.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-mgorole.md new file mode 100644 index 0000000000000000000000000000000000000000..66844ca63353548ac5599ba0b42f729953c91a66 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-mgorole.md @@ -0,0 +1,52 @@ +--- +title: mgo delete mgorole +desription: mgo 删除角色 +author: Wang Dong +date: 2022-12-14 +--- + +# 删除 mgo 权限角色 + +## 概览 + +删除指定的角色或全部角色，例如： + +```shell +mgo delete mgorole somerole +``` + +```shell +mgo delete mgorole [flags] +``` + +
+ +## 选项 + +```text + --all 删除所有的 mgo 权限角色 + -h, --help delete mgorole 的帮助信息 + --no-prompt 删除前没有命令行确认 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo delete](mgo-delete.md) - 删除 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-mgouser.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-mgouser.md new file mode 100644 index 0000000000000000000000000000000000000000..99a6953df428c629d334ac89938c2e0b66ab5b19 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete-mgouser.md @@ -0,0 +1,51 @@ +--- +title: mgo delete mgouser +desription: mgo 删除用户 +author: Ji Yabin +date: 2022-06-30 +--- + +# 删除 mgo 用户 + +## 概览 + +删除指定的 mgo 用户或全部用户。例如： + +```shell +mgo delete mgouser someuser +``` + +```shell +mgo delete mgouser [flags] +``` + +
+ +## 选项 + +```text + --all 删除所有的 mgo 用户 + -h, --help delete mgouser 的帮助信息 + --no-prompt 删除前没有命令行确认 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo delete](mgo-delete.md) - 删除 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete.md new file mode 100644 index 0000000000000000000000000000000000000000..38ce092147cdef04d42d728b2cbad17b0d32079c --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-delete.md @@ -0,0 +1,56 @@ +--- +title: mgo-delete +desription: mgo 删除命令 +author: Wang Dong +date: 2022-12-14 +--- + +# 删除 MogDB Operator 资源 + +## 概览 + +delete 命令允许你删除一个 MogDB Operator 资源。例如： + +```shell +mgo delete cluster mycluster +mgo delete mgouser someuser +mgo delete mgorole somerole +mgo delete user --username=testuser --selector=name=mycluster +``` + +```shell +mgo delete [flags] +``` + +
+ +## 选项 + +```text + -h, --help delete 的帮助信息 +``` + +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 +* [mgo delete cluster](mgo-delete-cluster.md) - 删除 MogDB 集群 +* [mgo delete mgorole](mgo-delete-mgorole.md) - 删除 mgo 权限角色 +* [mgo delete mgouser](mgo-delete-mgouser.md) - 删除 mgo 用户 +* [mgo delete backup](mgo-delete-backup.md) - 删除 备份 +* [mgo delete k8s](mgo-delete-k8s.md) - 删除 k8s 节点 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-localk8s.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-localk8s.md new file mode 100644 index 0000000000000000000000000000000000000000..62354dec93bc7a8bb8e7afc7b77f817a25291fa5 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-localk8s.md @@ -0,0 +1,51 @@ +--- +title: mgo localk8s +summary: mgo设置本地k8s节点 +author: Wang Dong +date: 2022-12-14 +--- + +# 设置本地k8s节点 + +## 概览 + +设置本地k8s节点, 例： + +```shell +mgo localk8s myNodeName --apiserver=xxx +``` + +```shell +mgo localk8s [flags] +``` + +
+ +## 选项 + +```text + --apiserver string k8s 节点 mogdb-apiserver 的host. + -h, --help addk8s 帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的MogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-getf.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-getf.md new file mode 100644 index 0000000000000000000000000000000000000000..220fe36af6fb495b397e9ec7907a69830c622322 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-getf.md @@ -0,0 +1,51 @@ +--- +title: mgo minio object getf +summary: 使用minio下载s3存储对象 +author: Wang Dong +date: 2022-12-14 +--- + +# 使用minio查看s3下载s3存储对象 + +## 概览 + +MINIO OBJECT GEFT 命令允许你使用minio下载s3存储对象, 例： + +```shell +mgo minio object getf bucket-name object-name -p filepath +``` + +```shell +mgo minio object getf [flags] +``` + +
+ +## 选项 + +```text + -h, --help getf 的帮助信息 + -p, --path string 存储对象的目录路径 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的MogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo minio object](mgo-minio-object.md) - mgo 使用minio对3s存储对象操作 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-ls.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-ls.md new file mode 100644 index 0000000000000000000000000000000000000000..85881fa3dfe57e17af1569bd42c08058b58f303d --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-ls.md @@ -0,0 +1,51 @@ +--- +title: mgo minio object ls +summary: 使用minio查看s3存储对象列表 +author: Wang Dong +date: 2022-12-14 +--- + +# 使用minio查看s3存储对象列表 + +## 概览 + +MINIO OBJECT LS 命令允许你使用minio查看s3存储对象列表, 例： + +```shell +mgo minio object ls bucket-name --prefix prefix-name +``` + +```shell +mgo minio object ls [flags] +``` + +
+ +## 选项 + +```text + -h, --help ls帮助信息 + --prefix string 对象前缀，默认为空. +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的MogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo minio object](mgo-minio-object.md) - mgo 使用minio对3s存储对象操作 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-stat.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-stat.md new file mode 100644 index 0000000000000000000000000000000000000000..c8bfaee038e81bb4d02911b652dbdcb4e9ac0ba6 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object-stat.md @@ -0,0 +1,50 @@ +--- +title: mgo minio object stat +summary: 使用minio查看s3存储对象详细信息 +author: Wang Dong +date: 2022-12-14 +--- + +# 使用minio查看s3存储对象详细信息 + +## 概览 + +MINIO OBJECT STAT 命令允许你使用minio查看s3存储对象详细信息, 例： + +```shell +mgo minio object stat bucket-name object-name +``` + +```shell +mgo minio object stat [flags] +``` + +
+ +## 选项 + +```text + -h, --help stat 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的MogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo minio object](mgo-minio-object.md) - mgo 使用minio对3s存储对象操作 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object.md new file mode 100644 index 0000000000000000000000000000000000000000..0727ae1e016803d73cd213c643a1a687127e1471 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio-object.md @@ -0,0 +1,55 @@ +--- +title: mgo minio object +summary: 使用minio对3s存储对象操作 +author: Wang Dong +date: 2022-12-14 +--- + +# 使用minio对3s存储对象操作 + +## 概览 + +MINIO OBJECT 命令允许你使用minio对3s存储对象操作, 例： + +```shell +mgo minio object ls +mgo minio object stat +mgo minio object getf +``` + +```shell +mgo minio object [flags] +``` + +
+ +## 选项 + +```text + -h, --help object 帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的MogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo minio](mgo-minio.md) - mgo 使用minio +* [mgo minio object ls](mgo-minio-object-ls.md) - mgo 使用minio查看s3存储对象列表 +* [mgo minio object stat](mgo-minio-object-stat.md) - mgo 使用minio查看s3存储对象详细信息 +* [mgo minio object getf](mgo-minio-object-getf.md) - mgo 使用minio下载s3存储对象 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio.md new file mode 100644 index 0000000000000000000000000000000000000000..8c9447005d90d758c330944f77246894d413e386 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-minio.md @@ -0,0 +1,47 @@ +--- +title: mgo minio +summary: 使用minio +author: Wang Dong +date: 2022-12-14 +--- + +# 使用minio对3s存储操作 + +## 概览 + +MINIO 命令允许你使用minio, 例： + +```shell +mgo minio object +``` + +
+ +## 选项 + +```text + -h, --help minio 帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的MogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 +* [mgo minio object](mgo-minio-object.md) - mgo 使用minio对3s存储对象操作 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-restore.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-restore.md new file mode 100644 index 0000000000000000000000000000000000000000..8d78becc299353fb2eeb961784ceb81249849f5e --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-restore.md @@ -0,0 +1,52 @@ +--- +title: mgo restore +desription: mgo 备份恢复 +author: Wang Dong +date: 2022-12-14 +--- + +## 备份恢复 + +### 概览 + +RESTORE 命令允许您从一个备份中对Mogdb集群进行恢复。例如： + +```shell +mgo restore mycluster --RestoreType=file --RestoreFile=xxx +``` + +```shell +mgo restore [flags] +``` + +
+ +### 选项 + +```text + --backup-type string 要恢复的备份的类型. 分为 "basebackup" 和 "dumpall" (默认 "basebackup") + -h, --help restore帮助信息 + --recovery-time-point string 指定最后备份时间点 + --restore-object string 指定备份对象 + --restore-type string 备份类型, 分别为 "object" 和 "time". +``` + +
+ +### 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +### 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-scale.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-scale.md new file mode 100644 index 0000000000000000000000000000000000000000..17623886a502c41a9cd7725385f5528590811b09 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-scale.md @@ -0,0 +1,46 @@ +--- +title: mgo-scale +desription: mgo 扩容集群命令 +author: Wang Dong +date: 2022-12-14 +--- + +# 扩容 MogDB 集群 + +## 概览 + +scale命令允许您添加集群的副本配置。例如： + +```shell +mgo scale mycluster --replica-count=1 +``` + +```shell +mgo scale [flags] +``` + +
+ +## 选项 + +```text + -h, --help scale 的帮助信息 + --no-prompt 无命令行确认 + --replica-count int 要添加于群集的副本计数。(默认 1) +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-scaledown.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-scaledown.md new file mode 100644 index 0000000000000000000000000000000000000000..951711c0e95ff0ce9e58a92cf9e504ae81f978ab --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-scaledown.md @@ -0,0 +1,55 @@ +--- +title: mgo-scaledown +desription: mgo 缩容集群命令 +author: Wang Dong +date: 2022-12-14 +--- + +# 缩容 MogDB 集群 + +## 概览 + +scaledown 命令允许您缩小集群的副本配置。例如： + + 列出目标副节点： + + ```shell + mgo scaledown mycluster --query + ``` + + 缩容特定副节点： + + ```shell + mgo scaledown mycluster --target=mycluster-replica-xxxx + ``` + +```shell +mgo scaledown [flags] +``` + +
+ +## 选项 + +```text + -h, --help scaledown 的帮助信息 + --no-prompt 无命令行确认 + --query 打印目标副本候选列表 + --target string 缩容指定以逗号分隔的副节点列表 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-backup.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-backup.md new file mode 100644 index 0000000000000000000000000000000000000000..da6cc3e71713bec306630cb7e775f253e8ed8f44 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-backup.md @@ -0,0 +1,50 @@ +--- +title: mgo show backup +summary: mgo查看集群备份 +author: Wang Dong +date: 2022-12-14 +--- + +# 显示 MogDB 群集备份信息 + +## 概览 + +显示指定的 MogDB 群集备份信息。例如： + +```shell +mgo show backup mycluser +``` + +```shell +mgo show backup [flags] +``` + +
+ +## 选项 + +```text + -h, --help show backup 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo show](mgo-show.md) - 显示 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-cluster.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-cluster.md new file mode 100644 index 0000000000000000000000000000000000000000..a4c75fe3e896c43b840787a885cba0c8097be50b --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-cluster.md @@ -0,0 +1,55 @@ +--- +title: mgo show cluster +summary: mgo查看集群 +author: Wang Dong +date: 2022-12-14 +--- + +# 显示 MogDB 群集信息 + +## 概览 + +显示指定的 MogDB 群集信息或所有的集群信息。例如： + +```shell +mgo show cluster --all +mgo show cluster mycluster +mgo show cluster --all --all-k8s +``` + +```shell +mgo show cluster [flags] +``` + +
+ +## 选项 + +```text + --all 显示所有集群. + --all-k8s 所有k8s节点 + -h, --help show cluster 的帮助信息 + -s, --selector string 用于群集筛选的label +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo show](mgo-show.md) - 显示 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-k8s.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-k8s.md new file mode 100644 index 0000000000000000000000000000000000000000..26ef2fe8bf4d06f12515335ee7d940364d416c27 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-k8s.md @@ -0,0 +1,46 @@ +--- +title: mgo show k8s +summary: mgo查看所有k8s节点 +author: Wang Dong +date: 2022-12-14 +--- + +# 显示 查看所有k8s节点 + +## 概览 + +显示所有k8s节点信息。例如： + +```shell +mgo show k8s +``` + +
+ +## 选项 + +```text + -h, --help show k8s 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo show](mgo-show.md) - 显示 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-mgorole.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-mgorole.md new file mode 100644 index 0000000000000000000000000000000000000000..55910e767a309c4521b186b8ccc78934e8ac2bf5 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-mgorole.md @@ -0,0 +1,52 @@ +--- +title: mgo show mgorole +summary: mgo查看角色信息 +author: Wang Dong +date: 2022-12-14 +--- + +# 查看 mgo 角色信息 + +## 概览 + +查看指定的 mgo 角色信息或所有的角色信息。例如： + +```shell +mgo show mgorole somerole +``` + +```shell +mgo show mgorole [flags] +``` + +
+ +## 选项 + +```text + --all 显示所有的 mgo 角色信息 + --all-k8s 所有k8s节点 + -h, --help show mgorole 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo show](mgo-show.md) - 查看 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-mgouser.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-mgouser.md new file mode 100644 index 0000000000000000000000000000000000000000..55116e0dbe576f32ae8856407abceeff0985c4c0 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-mgouser.md @@ -0,0 +1,52 @@ +--- +title: mgo show mgouser +summary: mgo查看用户信息 +author: Wang Dong +date: 2022-12-14 +--- + +# 显示 mgo 用户信息 + +## 概览 + +显示指定的 mgo 用户信息或全部用户信息。例如： + +```shell +mgo show mgouser someuser +``` + +```shell +mgo show mgouser [flags] +``` + +
+ +## 选项 + +```text + --all 查看所有的 mgo 用户信息 + --all-k8s 所有k8s节点 + -h, --help help for mgouser +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo show](mgo-show.md) - 显示 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-restore.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-restore.md new file mode 100644 index 0000000000000000000000000000000000000000..81f91a7b3315904cc1a377195b21e6eaa3d2ffbd --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show-restore.md @@ -0,0 +1,50 @@ +--- +title: mgo show restore +summary: mgo查看集群备份恢复信息 +author: Wang Dong +date: 2022-12-14 +--- + +# 显示 MogDB 群集备份恢复信息 + +## 概览 + +显示指定的 MogDB 群集备份恢复信息。例如： + +```shell +mgo show restore mycluser +``` + +```shell +mgo show restore [flags] +``` + +
+ +## 选项 + +```text + -h, --help show restore 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo show](mgo-show.md) - 显示 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show.md new file mode 100644 index 0000000000000000000000000000000000000000..c20543824ba8d8b387378ef161faa9c5ae414864 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-show.md @@ -0,0 +1,61 @@ +--- +title: mgo-show +desription: mgo 展示命令 +author: Wang Dong +date: 2022-12-14 +--- + +# 查看 MogDB Operator 资源 + +## 概览 + +Show 命令允许您显示群集、备份、恢复、k8s节点、mgorole或mgouser的详细信息。例如： + +```shell +mgo show backup mycluser +mgo show k8s +mgo show cluster mycluster +mgo show mgouser someuser +mgo show mgorole somerole +mgo show restore mycluser +``` + +```shell +mgo show [flags] +``` + +
+ +## 选项 + +```text + -h, --help show 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 +* [mgo show backup](mgo-show-backup.md) - 查看集群备份信息 +* [mgo show cluster](mgo-show-cluster.md) - 查看集群信息 +* [mgo show k8s](mgo-show-k8s.md) - 查看k8s节点信息 +* [mgo show mgorole](mgo-show-mgorole.md) - 查看角色信息 +* [mgo show mgouser](mgo-show-mgouser.md) - 查看用户信息 +* [mgo show restore](mgo-show-restore.md) - 查看集群恢复备份信息 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-switch.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-switch.md new file mode 100644 index 0000000000000000000000000000000000000000..36bfaa774a7377806b9ef90257e7f163d43a745e --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-switch.md @@ -0,0 +1,44 @@ +--- +title: mgo-switch +desription: mgo 切换用户命令 +author: Wang Dong +date: 2022-12-14 +--- + +# 切换 mgo 用户 + +## 概览 + +switch 允许你切换 mgo 用户。例如： + +```shell +mgo switch mgouser someuser +``` + +```shell +mgo switch mgouser [flags] +``` + +
+ +## 选项 + +```text + -h, --help switch 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-cluster.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-cluster.md new file mode 100644 index 0000000000000000000000000000000000000000..1b53d8d011f64b28a9793306962f5a64a4222974 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-cluster.md @@ -0,0 +1,69 @@ +--- +title: mgo update cluster +desription: mgo 修改集群 +author: Wang Dong +date: 2022-12-14 +--- + +# 修改 MogDB 集群 + +## 概览 + +修改 MogDB 集群。例如： + +```shell +mgo update cluster mycluster --image=xxx +mgo update cluster mycluster myothercluster --image=xxx +mgo update cluster --all --image=xxx +``` + +```shell +mgo update cluster [flags] +``` + +
+ +## 选项 + +```text + --access-modes int 设置数据卷的访问方式。1: ReadWriteOnce, 2: ReadOnlyMany, 3: ReadWriteMany。默认值是 ReadWriteOnce + --all 修改所有 MogDB 集群。 + --backup-storage-size string 设置备份数据卷大小。默认值128Mi + --cpu string 设置要请求CPU的核数，e.g. "100m" or "0.1" + --cpu-limit string 为CPU设置要限制的核数，e.g. "100m" or "0.1" + --data-storage-size string 设置数据库数据卷大小。默认值128Mi + --exporter-image string 将用于MogDB exporter sidecar 容器的镜像。如果指定，将替代默认值 + --ha-image string 将用于MogDB ha sidecar 容器的镜像。如果指定，将替代默认值 + -h, --help update cluster 的帮助信息 + --image string 将用于MogDB server 容器的镜像。如果指定，将替代默认值 + --init-image string 将用于MogDB 初始化容器的镜像。如果指定，将替代默认值 + --log-storage-size string 设置日志数据卷大小。默认值128Mi + --memory string 设置要请求的内存数量，e.g. 1GiB + --memory-limit string 设置限制的内存数量，e.g. 1GiB + --read-port int 设置 service 的读取端口 + --sidecar-image string 将用于MogDB sidecar 容器的镜像。如果指定，将替代默认值 + --storage-class string 设置声明所需的StorageClass的名称。默认值是 local-path + --write-port int 设置 service 的写端口 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo update](mgo-update.md) - 修改 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-mgorole.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-mgorole.md new file mode 100644 index 0000000000000000000000000000000000000000..2f846c4b834d846164af024fc135314a5e04ab75 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-mgorole.md @@ -0,0 +1,52 @@ +--- +title: mgo update mgorole +desription: mgo 修改角色 +author: Wang Dong +date: 2022-12-14 +--- + +# 修改 mgo 权限角色 + +## 概览 + +update mgorole 命令允许修改 mgo 权限角色。例如： + +```shell +mgo update mgorole somerole --permissions="version,show,create" +``` + +```shell +mgo update mgorole [flags] +``` + +
+ +## 选项 + +```text + -h, --help update mgorole 的帮助信息 + --no-prompt 没有命令行提示 + --permissions string 为mgorole指定以逗号分隔的权限列表 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo update](mgo-update.md) - 修改 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-mgouser.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-mgouser.md new file mode 100644 index 0000000000000000000000000000000000000000..8485450e7ab5e3f66005ce47422db525e69a1bab --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update-mgouser.md @@ -0,0 +1,57 @@ +--- +title: mgo update mgouser +desription: mgo 修改用户 +author: Wang Dong +date: 2022-12-14 +--- + +# 修改 mgo 用户 + +## 概览 + +update mgouser 允许你修改 mgo 用户。例如： + +```shell +mgo update mgouser myuser --mgouser-roles=somerole +mgo update mgouser myuser --mgouser-password=somepassword --mgouser-roles=somerole +mgo update mgouser myuser --mgouser-password=somepassword --no-prompt +``` + +```shell +mgo update mgouser [flags] +``` + +
+ +## 选项 + +```text + --all-namespaces 指定此用户将有权访问所有命名空间 + -h, --help update mgouser 的帮助信息 + --mgouser-namespaces string 为mgouser指定以逗号分隔的名称空间列表 + --mgouser-password string 指定mgouser的密码 + --mgouser-roles string 为mgouser指定以逗号分隔的角色列表 + --no-prompt 无有命令行提示 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo update](mgo-update.md) - 修改 MogDB Operator 资源 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update.md new file mode 100644 index 0000000000000000000000000000000000000000..b23e1403dd336657483fc2870a715e43e2a9816d --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-update.md @@ -0,0 +1,58 @@ +--- +title: mgo-update +desription: mgo 修改命令 +author: Wang Dong +date: 2022-12-14 +--- + +# 修改 MogDB Operator 资源 + +## 概览 + +update 命令允许您修改 mgouser、mgorole 或者 cluster。例如： + +```shell +mgo update cluster --selector=name=mycluster --disable-autofail +mgo update cluster --all --enable-autofail +mgo update mgorole somerole --mgorole-permission="version" +mgo update mgouser someuser --mgouser-password=somenewpassword +mgo update mgouser someuser --mgouser-roles="role1,role2" +mgo update mgouser someuser --mgouser-namespaces="mgouser2" +``` + +```shell +mgo update [flags] +``` + +
+ +## 选项 + +```text + -h, --help update 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo](mgo.md) - mgo 命令行工具 +* [mgo update cluster](mgo-update-cluster.md) - 修改 MogDB 集群 +* [mgo update mgorole](mgo-update-mgorole.md) - 修改 mgo 权限角色 +* [mgo update mgouser](mgo-update-mgouser.md) - 修改 mgo 用户 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-version.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-version.md new file mode 100644 index 0000000000000000000000000000000000000000..ec344613a3541ea7a9e7c7cf74c826392c68536c --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo-version.md @@ -0,0 +1,44 @@ +--- +title: mgo-version +desription: mgo 版本命令 +author: Wang Dong +date: 2022-12-14 +--- + +# 显示 MogDB Operator 的版本信息 + +## 概览 + +version 命令允许您打印 MogDB Operator 的版本信息。例如： + +```shell +mgo version +``` + +```shell +mgo version [flags] +``` + +
+ +## 选项 + +```text + -h, --help version 的帮助信息 +``` + +
+ +## 从父命令继承的选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/client/mgo.md b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo.md new file mode 100644 index 0000000000000000000000000000000000000000..3c8a5756537dedc7dd600ee5db4076d331f08cb4 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/client/mgo.md @@ -0,0 +1,69 @@ +--- +title: mgo +desription: mgo 命令行工具参考 +author: Wang Dong +date: 2022-12-14 +--- + +# mgo命令 + +## 概览 + +mgo 命令行工具帮助您创建和管理MogDB集群。 + +
+ +## 选项 + +```text + --apiserver-url string 将处理来自mgo客户端的请求的mogDB Operator apiserver的URL。请注意，URL不应以“/”结尾 + --debug 启用debug输出以进行调试 + --disable-tls 关闭 MogDB Operator 的 TLS 认证 + --exclude-os-trust 从操作系统默认信任存储中排除CA证书 + -h, --help mgo 的帮助信息 + --k8s-node string 指点k8s节点, 默认本地k8s节点 + --mgo-ca-cert string 连接 MogDB Operator apiserver CA 证书文件路径. + --mgo-client-cert string 用于向 MogDB Operator apiserver 进行身份验证的客户端证书文件路径 + --mgo-client-key string 用于向 MogDB Operator apiserver 进行身份验证的客户端密钥文件路径 + -n, --namespace string 用于mgo请求的命名空间 +``` + +
+ +## 另请参阅 + +* [mgo version](mgo-version.md) - 打印 MogDB Operator 版本信息 +* [mgo show](mgo-show.md) - 显示 MogDB Operator 资源 +* [mgo show backup](mgo-show-backup.md) - 查看集群备份信息 +* [mgo show cluster](mgo-show-cluster.md) - 查看集群信息 +* [mgo show k8s](mgo-show-k8s.md) - 查看k8s节点信息 +* [mgo show mgorole](mgo-show-mgorole.md) - 查看角色信息 +* [mgo show mgouser](mgo-show-mgouser.md) - 查看用户信息 +* [mgo show restore](mgo-show-restore.md) - 查看集群恢复备份信息 +* [mgo create](mgo-create.md) - 创建 MogDB Operator 资源 +* [mgo create cluster](mgo-create-cluster.md) - 创建 MogDB Operator 集群 +* [mgo create mgorole](mgo-create-mgorole.md) - 创建 MogDB Operator 角色 +* [mgo create mgouser](mgo-create-mgouser.md) - 创建 MogDB Operator 用户 +* [mgo update](mgo-update.md) - 修改 MogDB Operator 资源 +* [mgo update cluster](mgo-update-cluster.md) - 更新 MogDB Operator 集群 +* [mgo update mgorole](mgo-update-mgorole.md) - 更新 MogDB Operator 角色 +* [mgo update mgouser](mgo-update-mgouser.md) - 更新 MogDB Operator 用户 +* [mgo delete](mgo-delete.md) - 删除 MogDB Operator 资源 +* [mgo delete cluster](mgo-delete-cluster.md) - 删除 MogDB Operator 集群 +* [mgo delete mgorole](mgo-delete-mgorole.md) - 删除 MogDB Operator 角色 +* [mgo delete mgouser](mgo-create-mgouser.md) - 删除 MogDB Operator 用户 +* [mgo delete backup](mgo-delete-backup.md) - 删除 备份 +* [mgo delete k8s](mgo-delete-k8s.md) - 删除 k8s 节点 +* [mgo scale](mgo-scale.md) - 扩容 MogDB 集群 +* [mgo scaledown](mgo-scaledown.md) - 缩容 MogDB 集群 +* [mgo switch](mgo-switch.md) - 切换 MogDB operator 用户 +* [mgo addk8s](mgo-addk8s.md) - 添加k8s节点 +* [mgo localk8s](mgo-localk8s.md) - 设置本地k8s节点 +* [mgo backup](mgo-backup.md) - 进行手动备份 +* [mgo backup detail](mgo-backup-detail.md) - 获取备份详情 +* [mgo restore](mgo-restore.md) - 备份恢复 +* [mgo minio](mgo-minio.md) - 使用minio +* [mgo minio object](mgo-minio-object.md) - mgo 使用minio对3s存储对象操作 +* [mgo minio object ls](mgo-minio-object-ls.md) - mgo 使用minio查看s3存储对象列表 +* [mgo minio object stat](mgo-minio-object-stat.md) - mgo 使用minio查看s3存储对象详细信息 +* [mgo minio object getf](mgo-minio-object-getf.md) - mgo 使用minio下载s3存储对象 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/server/crd-references.md b/product/zh/docs-mogdb-stack/v2.0/references/server/crd-references.md new file mode 100644 index 0000000000000000000000000000000000000000..9ab4bb9d683e78719f348d7c471d1380cb57e2aa --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/server/crd-references.md @@ -0,0 +1,373 @@ +--- +title: CRD 参考 +summary: CRD 参考 +author: Wang Dong +date: 2022-12-14 +--- + +# CRD 参考 + +## 资源类型 + ++ MogdbCluster ++ MogdbBackup + +
+ +## MogdbCluster + +MogdbCluster是MogdbCluster API的简单概要 + +| 名称 | 类型 | 描述 | 必选项 | +|------------|--------|------------------------------|----------| +| apiVersion | string | mogdb.enmotech.io/v1 | true | +| kind | string | MogdbCluster | true | +| metadata | object | 相关字段参考 Kubernetes API文档 | true | +| spec | object | 定义MogdbCluster期望的状态 | false | +| status | object | 定义MogdbCluster观测到的状态 | false | + +
+ +### MogdbCluster.spec + +MogdbClusterSpec 定义MogdbCluster期望的状态 + +| 名称 | 类型 | 描述 | 必选项 | +|---------------|---------|--------------------|----------| +| replicas | integer | MogdbCluster期望的副本数 | true | +| readPort | integer | 只读service端口 | true | +| writePort | integer | 读写service端口 | true | +| postgresConf | object | MogDB配置文件配置项 | false | +| podSpec | object | 集群pod期望的状态 | false | +| backup | object | 自动备份配置 | false | +| Restore | object | 备份恢复配置 | false | +| DataSource | object | 备份恢复数据源 | false | +| Paused | bool | 是否暂停 | false | +| EnableHa | bool | 是否开启ha | false | + +
+ +### MogdbCluster.spec.podSpec + +| 名称 | 类型 | 描述 | 必选项 | +|--------------------|-------------------|---------------|--------| +| mogdbVersion | string | MogDB数据库的版本 | false | +| image | string | MogDB镜像 | false | +| sidecarImage | string | sidecar镜像 | false | +| SidecarHaImage | string | sidecarha镜像 | false | +| initImage | string | init镜像 | false | +| volumeSpec | object | volume类型配置 | false | +| logVolumeSpec | object | 日志volume类型配置 | false | +| backupVolumeSpec | object | 备份volume类型配置 | false | +| imagePullPolicy | string | 镜像拉取策略 | false | +| imagePullSecrets | []string | 镜像拉取秘钥 | false | +| labels | map[string]string | 自定义label | false | +| annotations | map[string]string | 自定义注释 | false | +| resources | object | 资源限额 | false | +| affinity | object | 亲和性设置 | false | +| nodeSelector | map[string]string | 节点选择器 | false | +| priorityClassName | string | 优先级类名设置 | false | +| tolerations | []object | 容忍性设置 | false | +| serviceAccountName | string | 服务账户名称 | false | +| volumes | []object | 额外的volume设置 | false | +| volumeMounts | []object | volume挂载设置 | false | +| initContainers | []object | 额外的初始化容器设置 | false | +| containers | []object | 额外的容器设置 | false | +| sidecarResources | object | sidecar容器资源限额 | false | + +
+ +### MogdbCluster.spec.podSpec.volumeSpec + +| 名称 | 类型 | 描述 | 必选项 | +|------------------------|---------|--------------|--------| +| emptyDir | object | emptyDir类型的卷 | false | +| hostPath | object | hostPath类型的卷 | false | +| persistentVolumeClaim | object | pvc卷声明 | false | + +
+ +### MogdbCluster.spec.Backup + +| 名称 | 类型 | 描述 | 必选项 | +|-----------------|--------|------|--------| +| Image | string | 备份镜像 | false | +| GSBaseBackup | object | 逻辑备份 | false | +| GSDumpAll | object | 物理备份 | false | + +
+ +### MogdbCluster.spec.Backup.GSBaseBackup + +| 名称 | 类型 | 描述 | 必选项 | +|----------------------------|----------|----------|--------| +| Name | string | 备份容器名称 | false | +| BackupSchedules | object | 备份策略 | false | +| BackupScheduleHistoryLimit | integer | 保留历史自大数量 | false | +| S3 | object | s3存储配置 | false | + +
+ +### MogdbCluster.spec.Backup.GSBaseBackup.S3 + +| 名称 | 类型 | 描述 | 必选项 | +|-------------|----------|---------|-------| +| region | string | regin | false | +| secretName | string | 访问密钥 | true | +| provider | string | s3存储提供者 | true | +| endPoint | string | 节点 | true | +| bucket | string | 存储桶 | true | + +
+ +### MogdbCluster.spec.Backup.GSDumpAll + +| 名称 | 类型 | 描述 | 必选项 | +|----------------------------|-----------|------------|--------| +| Name | string | 备份容器名称 | false | +| BackupSchedules | object | 备份策略 | false | +| BackupScheduleHistoryLimit | integer | 保留历史自大数量 | false | +| S3 | object | s3存储配置 | false | + +
+ +### MogdbCluster.spec.Backup.GSDumpAll.S3 + +| 名称 | 类型 | 描述 | 必选项 | +|-------------|----------|---------|-------| +| region | string | regin | false | +| secretName | string | 访问密钥 | true | +| provider | string | s3存储提供者 | true | +| endPoint | string | 节点 | true | +| bucket | string | 存储桶 | true | + +
+ +### MogdbCluster.spec.Restore + +| 名称 | 类型 | 描述 | 必选项 | +|--------------------|--------|----------|--------| +| RestoreId | string | 恢复标识ID | false | +| Image | string | 镜像 | false | +| ClusterName | string | 目标集群名称 | false | +| GSBaseBackupSource | object | 恢复逻辑备份配置 | false | +| GSDumpAllSource | object | 恢复物理备份配置 | false | + +
+ +### MogdbCluster.spec.Restore.GSBaseBackupSource + +| 名称 | 类型 | 描述 | 必选项 | +|----------------|--------|------|--------| +| Type | string | 恢复类型 | false | +| Target | string | 恢复对象 | false | + +
+ +### MogdbCluster.spec.Restore.GSDumpAllSource + +| 名称 | 类型 | 描述 | 必选项 | +|----------------|--------|------|--------| +| Type | string | 恢复类型 | false | +| Target | string | 恢复对象 | false | + +
+ +### MogdbCluster.status + +| 名称 | 类型 | 描述 | 必选项 | +|-----------------|--------|--------------|-------| +| readyNodes | integer | 处于ready节点的个数 | true | +| conditions | []object | 集群状况 | true | +| nodes | []object | 节点状况 | true | +| RestoreStatus | object | 恢复状况 | true | +| BackupStatus | object | 备份状况 | true | +| StartupInstance | string | 开始实现 | true | +| FirstInstance | string | 第一次实现 | true | +| HaService | string | ha服务 | true | + +
+ +### MogdbCluster.status.conditions + +| 名称 | 类型 | 描述 | 必选项 | +|--------------------|---------|---------|-------| +| type | string | 状况类型 | true | +| status | string | 状况的状态 | true | +| lastTransitionTime | time | 状况发生的时间 | true | +| reason | string | 状况的原因 | true | +| message | string | 状况信息 | true | + +
+ +### MogdbCluster.status.RestoreStatus + +| 名称 | 类型 | 描述 | 必选项 | +|----------------|---------|--------|-------| +| id | string | 恢复ID | true | +| finished | bool | 是否已经结束 | true | +| startTime | time | 开始时间 | true | +| completionTime | time | 完成时间 | true | +| active | integer | 进行中数量 | true | +| succeeded | integer | 成功数量 | true | +| Failed | integer | 失败数量 | true | + +
+ +### MogdbCluster.status.BackupStatus + +| 名称 | 类型 | 描述 | 必选项 | +|---------------------------|----------|------|-------| +| ManualBackups | []object | 手动备份 | true | +| ScheduledBackups | []object | 自动备份 | true | + +
+ +### MogdbCluster.status.BackupStatus.ManualBackups + +| 名称 | 类型 | 描述 | 必选项 | +|-------------------|----------|---------|-------| +| name | string | 备份名称 | true | +| backupType | string | 备份类型 | true | +| backupLevel | string | 备份级别 | true | +| backupFile | string | 备份文件 | true | +| startTime | time | 开始时间 | true | +| completionTime | time | 结束时间动 | true | +| active | integer | 进行中数量 | true | +| succeeded | integer | 成功数量 | true | +| failed | integer | 失败数量 | true | +| finished | bool | 是否已经结束 | true | + +
+ +### MogdbCluster.status.BackupStatus.ScheduledBackups + +| 名称 | 类型 | 描述 | 必选项 | +|-------------------|----------|---------|-------| +| name | string | 备份名称 | true | +| backupType | string | 备份类型 | true | +| backupLevel | string | 备份级别 | true | +| backupFile | string | 备份文件 | true | +| startTime | time | 开始时间 | true | +| completionTime | time | 结束时间动 | true | +| active | integer | 进行中数量 | true | +| succeeded | integer | 成功数量 | true | +| failed | integer | 失败数量 | true | +| finished | bool | 是否已经结束 | true | + +
+ +### MogdbCluster.status.nodes + +| 名称 | 类型 | 描述 | 必选项 | +|-------------|-----------|-----------|-------| +| name | string | 集群节点状态的名称 | true | +| conditions | []object | 节点状况集合 | true | + +
+ +### MogdbCluster.status.nodes.conditions + +| 名称 | 类型 | 描述 | 必选项 | +|---------------------|--------|----------|-------| +| type | string | 状况类型 | true | +| status | string | 状况的状态 | true | +| lastTransitionTime | time | 状况发生的时间 | true | + +
+ +## MogdbBackup + +MogdbBackup是MogdbBackup API的简单概要 + +| 名称 | 类型 | 描述 | 必选项 | +|------------|---------|-------------------------|--------| +| apiVersion | string | mogdb.enmotech.io/v1 | true | +| kind | string | MogdbBackup | true | +| metadata | object | 相关字段参考 Kubernetes API文档 | true | +| spec | object | 定义MogdbBackup期望的状态 | false | +| status | object | 定义MogdbBackup观测到的状态 | false | + +
+ +### MogdbBackup.spec + +| 名称 | 类型 | 描述 | 必选项 | +|-------------|--------|-------------------|--------| +| clusterName | string | MogDB cluster集群名称 | true | +| image | string | 备份历史保留天数 | false | +| baseBackup | object | 逻辑配分配置 | false | +| dumpAll | object | 物理备份配置 | false | + +
+ +### MogdbBackup.spec.BaseBackup + +| 名称 | 类型 | 描述 | 必选项 | +|-------------|----------|----------|--------| +| name | string | 备份名称 | true | +| backupLevel | string | 备份级别 | false | +| fileName | string | 备份文件名称 | false | +| dbName | string | 指定备份数据库 | false | +| tbNames | []string | 指定备份表格 | false | +| s3 | object | s3对象存储配置 | false | + +
+ +### MogdbBackup.spec.BaseBackup.S3 + +| 名称 | 类型 | 描述 | 必选项 | +|-------------|----------|---------|-------| +| region | string | regin | false | +| secretName | string | 访问密钥 | true | +| provider | string | s3存储提供者 | true | +| endPoint | string | 节点 | true | +| bucket | string | 存储桶 | true | + +
+ +### MogdbBackup.spec.dumpAll + +| 名称 | 类型 | 描述 | 必选项 | +|-------------|----------|----------|--------| +| name | string | 备份名称 | true | +| backupLevel | string | 备份级别 | false | +| fileName | string | 备份文件名称 | false | +| dbName | string | 指定备份数据库 | false | +| tbNames | []string | 指定备份表格 | false | +| s3 | object | s3对象存储配置 | false | + +
+ +### MogdbBackup.spec.dumpAll.S3 + +| 名称 | 类型 | 描述 | 必选项 | +|-------------|----------|---------|-------| +| region | string | regin | false | +| secretName | string | 访问密钥 | true | +| provider | string | s3存储提供者 | true | +| endPoint | string | 节点 | true | +| bucket | string | 存储桶 | true | + +
+ +### MogdbBackup.status + +| 名称 | 类型 | 描述 | 必选项 | +|--------------------|-----------|---------|-------| +| completed | bool | 备份是否完成 | true | +| completedTimestamp | time | 备份完成的时间 | true | +| conditions | []object | 备份状况列表 | true | + +
+ +### MogdbBackup.status.conditions + +| 名称 | 类型 | 描述 | 必选项 | +|--------------------|---------|---------|-------| +| type | string | 状况类型 | true | +| status | string | 状况的状态 | true | +| lastTransitionTime | time | 状况发生的时间 | true | +| reason | string | 状况发生的原因 | true | +| message | string | 状况详情 | true | + diff --git a/product/zh/docs-mogdb-stack/v2.0/references/server/mogdbbackup-sample.md b/product/zh/docs-mogdb-stack/v2.0/references/server/mogdbbackup-sample.md new file mode 100644 index 0000000000000000000000000000000000000000..c29a9ae837681d982696e9447fa4e6696413e155 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/server/mogdbbackup-sample.md @@ -0,0 +1,33 @@ +--- +title: MogDB Backup CRD 样例 +summary: MogDB Backup CRD 样例 +author: Wang Dong +date: 2022-12-14 +--- + +# MogDB Backup CR 样例 + +如果您希望通过原生的kubectl命令创建一个MogDB Backup CR，可以通过编写简单的yaml文件，提交到k8s系统，如: + +```yaml +apiVersion: mogdb.enmotech.io/v1 +kind: MogdbBackup +metadata: + labels: + mogdb.enmotech.io/auto: "" + mogdb.enmotech.io/backup-level: incr + mogdb.enmotech.io/backup-type: basebackup + mogdb.enmotech.io/cluster: cluster1 + name: cluster1-manual-2022-12-16t09-20-56 + namespace: mogdb-operator-system +spec: + baseBackup: + backupLevel: incr + name: manual-base-backup + tbNames: + - "" + clusterName: cluster1 + image: swr.cn-north-4.myhuaweicloud.com/mogdb-cloud/mogdb-remoteclient:lastest +``` + +上述配置，指定了需要备份的集群，以及特定的库。 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/references/server/mogdbcluster-sample.md b/product/zh/docs-mogdb-stack/v2.0/references/server/mogdbcluster-sample.md new file mode 100644 index 0000000000000000000000000000000000000000..bee3265bbda2a8f047bf17fdf390d7c82a5ff4b9 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/references/server/mogdbcluster-sample.md @@ -0,0 +1,57 @@ +--- +title: MogDB Cluster CRD 样例 +summary: MogDB Cluster CRD 样例 +author: Wang Dong +date: 2022-12-14 +--- + +# MogDB Cluster CR 样例 + +如果您希望通过原生的kubectl命令创建一个MogDB Cluster CR，可以通过编写简单的yaml文件，提交到k8s系统，如: + +```yaml +apiVersion: mogdb.enmotech.io/v1 +kind: MogdbCluster +metadata: + labels: + mogdb.enmotech.io/cluster: cluster1 + name: cluster1 + name: cluster1 + namespace: mogdb-operator-system +spec: + podSpec: + backupVolumeSpec: + persistentVolumeClaim: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 128Mi + storageClassName: local-path + exporterImage: swr.cn-north-4.myhuaweicloud.com/mogdb-cloud/mogdb-exporter:latest + image: swr.cn-north-4.myhuaweicloud.com/mogdb-cloud/mogdb:3.1.0 + imagePullPolicy: IfNotPresent + initImage: swr.cn-north-4.myhuaweicloud.com/mogdb-cloud/mogdb-init:3.1.0 + logVolumeSpec: + persistentVolumeClaim: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 128Mi + storageClassName: local-path + volumeSpec: + persistentVolumeClaim: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 128Mi + storageClassName: local-path + readPort: 30012 + replicas: 2 + writePort: 30013 + +``` + +上述配置，分别制定了数据卷、日志卷、备份卷以及基本的镜像配置，还有副本数等，提交到系统将会创建一个MogDB 集群。 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/release.md b/product/zh/docs-mogdb-stack/v2.0/release.md new file mode 100644 index 0000000000000000000000000000000000000000..cb77ba7eab435752ae90b7f240cd2eb0f0bbcf55 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/release.md @@ -0,0 +1,38 @@ +--- +title: 发布记录 +summary: 发布记录 +author: Wang Dong +date: 2022-12-14 +--- + +# 发布记录 + +## v1.0.0 + +本次发布 mgo客户端 v1.0.0 和 MogDB operator v1.0.0 + +[MogDB operator](https://cdn-mogdb.enmotech.com/mogdb-stack/v1.0.0/mogdb-operator-examples.tar) + +mgo 客户端 + ++ [mgo_linux_x86_64](https://cdn-mogdb.enmotech.com/mogdb-stack/v1.0.0/mgo_linux_x86_64) ++ [mgo_linux_arm64](https://cdn-mogdb.enmotech.com/mogdb-stack/v1.0.0/mgo_linux_arm64) ++ [mgo_darwin_x86_64](https://cdn-mogdb.enmotech.com/mogdb-stack/v1.0.0/mgo_darwin_x86_64) ++ [mgo_darwin_arm64](https://cdn-mogdb.enmotech.com/mogdb-stack/v1.0.0/mgo_darwin_arm64) + +## v2.0.0 + +本次发布 mgo客户端 v2.0.0 和 MogDB operator v2.0.0 + +[MogDB operator](https://cdn-mogdb.enmotech.com/mogdb-stack/v2.0.0/mogdb-operator-examples.tar) + +mgo 客户端 + ++ [mgo_linux_x86_64](https://cdn-mogdb.enmotech.com/mogdb-stack/v2.0.0/mgo_linux_x86_64) ++ [mgo_linux_arm64](https://cdn-mogdb.enmotech.com/mogdb-stack/v2.0.0/mgo_linux_arm64) ++ [mgo_darwin_x86_64](https://cdn-mogdb.enmotech.com/mogdb-stack/v2.0.0/mgo_darwin_x86_64) ++ [mgo_darwin_arm64](https://cdn-mogdb.enmotech.com/mogdb-stack/v2.0.0/mgo_darwin_arm64) + +MogDB Stack Examples + ++ [mogdb-stack-examples](https://github.com/enmotech/mogdb-stack-examples) \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/toc.md b/product/zh/docs-mogdb-stack/v2.0/toc.md new file mode 100644 index 0000000000000000000000000000000000000000..01383d313d36719eaf3c7399a9c3d12bad8811bf --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/toc.md @@ -0,0 +1,66 @@ + + +# 文档 + +## MogDB Stack 文档目录 + ++ [关于MogDB Stack](/overview.md) ++ [快速上手](/quick-start.md) ++ 软件安装 + + [helm](/installation/helm.md) + + [kustomize](/installation/kustomize.md) ++ 使用手册 + + [开始](/tutorial/getting-started.md) + + [创建MogDB集群](/tutorial/create-a-mogdb-cluster.md) + + [连接MogDB集群](/tutorial/conntect-to-mogdb-cluster.md) + + [扩缩容](/tutorial/resize-a-mogdb-cluster.md) + + [定制MogDB集群](/tutorial/customize-a-mogdb-cluster.md) ++ 架构 + + [高可用](/architecture/high-availability.md) + + [监控](/architecture/monitor.md) + + [备份](/architecture/backup-management.md) + + [恢复](/architecture/recovery-management.md) + + [客户端](/architecture/client.md) ++ 参考 + + 命令行 + + [mgo](/references/client/mgo.md) + + [mgo create](/references/client/mgo-create.md) + + [mgo create mgorole](/references/client/mgo-create-mgorole.md) + + [mgo create mgouser](/references/client/mgo-create-mgouser.md) + + [mgo create cluster](/references/client/mgo-create-cluster.md) + + [mgo show](/references/client/mgo-show.md) + + [mgo show k8s](/references/client/mgo-show-k8s.md) + + [mgo show mgorole](/references/client/mgo-show-mgorole.md) + + [mgo show mgouser](/references/client/mgo-show-mgouser.md) + + [mgo show cluster](/references/client/mgo-show-cluster.md) + + [mgo show restore](/references/client/mgo-show-restore.md) + + [mgo delete](/references/client/mgo-delete.md) + + [mgo delete mgorole](/references/client/mgo-delete-mgorole.md) + + [mgo delete mgouser](/references/client/mgo-delete-mgouser.md) + + [mgo delete cluster](/references/client/mgo-delete-cluster.md) + + [mgo delete backup](/references/client/mgo-delete-backup.md) + + [mgo delete k8s](/references/client/mgo-delete-k8s.md) + + [mgo scale](/references/client/mgo-scale.md) + + [mgo scaledown](/references/client/mgo-scaledown.md) + + [mgo switch](/references/client/mgo-switch.md) + + [mgo update](/references/client/mgo-update.md) + + [mgo update mgorole](/references/client/mgo-update-mgorole.md) + + [mgo update mgouser](/references/client/mgo-update-mgouser.md) + + [mgo update cluster](/references/client/mgo-update-cluster.md) + + [mgo version](/references/client/mgo-version.md) + + [mgo addk8s](/references/client/mgo-addk8s.md) + + [mgo localk8s](/references/client/mgo-localk8s.md) + + [mgo backup](/references/client/mgo-backup.md) + + [mgo backup detail](/references/client/mgo-backup-detail.md) + + [mgo restore](/references/client/mgo-restore.md) + + [mgo minio](/references/client/mgo-minio.md) + + [mgo minio object](/references/client/mgo-minio-object.md) + + [mgo minio object ls](/references/client/mgo-minio-object-ls.md) + + [mgo minio object stat](/references/client/mgo-minio-object-stat.md) + + [mgo minio object getf](/references/client/mgo-minio-object-getf.md) + + 服务端 + + [CRD参考](/references/server/crd-references.md) + + [MogDB集群参考](/references/server/mogdbcluster-sample.md) + + [MogDB备份参考](/references/server/mogdbbackup-sample.md) ++ [FAQ](/faq.md) ++ [发布记录](/release.md) \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/tutorial/conntect-to-mogdb-cluster.md b/product/zh/docs-mogdb-stack/v2.0/tutorial/conntect-to-mogdb-cluster.md new file mode 100644 index 0000000000000000000000000000000000000000..56dcddb8183380064f78ef545cac7bd0aaba0f17 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/tutorial/conntect-to-mogdb-cluster.md @@ -0,0 +1,72 @@ +--- +title: 连接MogDB集群 +summary: 连接MogDB集群 +author: Wang Dong, hhhhhzhen +date: 2022-12-30 +--- + +# 连接到 MogDB 集群 + +在开始本章前，请确保您已正确依据[创建 MogDB 集群](create-a-mogdb-cluster.md)完成 MogDB 集群的安装。 + +## 修改密码 + +在连接之前，需要修改默认用户的密码。可以通过 kubectl 命令连接到主节点所在容器，修改密码。 + +```shell +kubectl exec -it pod/cluster1-nduk8 -c mogdb -n mogdb-operator-system -- /bin/bash +gsql -dpostgres +``` + +```sql +ALTER USER mogdb WITH PASSWORD 'P@55word!'; +``` + +## 连接到 MogDB + +### 1.安装 gsql 客户端 + +相关内容请参考 [gsql | MogDB Docs](https://docs.mogdb.io/zh/mogdb/v3.0/gsql)。 + +### 2.连接到 MogDB 集群 + +默认情况下，MogDB Operator 将创建两个有集群名称前缀的服务, 一个是主节点的 service，一个是从节点的 service。 + +以下命令将获取 `mogdb-operator-system` 命名空间中所有可用服务的列表： + +```shell +kubectl get svc -n mogdb-operator-system +``` + +预期输出： + +```text +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +cluster1-svc-master NodePort 10.96.158.193 5432:30013/TCP 13m +cluster1-svc-replicas NodePort 10.110.121.108 5432:30012/TCP 13m +mogdb-apiserver NodePort 10.99.235.65 8444:32444/TCP 33m +``` + +可以看到，主节点 service 开放端口为 30013，从节点 service 开放端口为 30012。您可以使用以下命令连接到数据库： + +```shell +gsql -h 127.0.0.1 -p 30013 -U mogdb -W P@55word! +``` + +然后应该会看到 mogdb 提示符： + +```text +gsql ((MogDB 3.1.0 build aef997f9) compiled at 2022-11-24 00:02:35 commit 0 last mr ) +Non-SSL connection (SSL connection is recommended when requiring high-security) +Type "help" for help. + +MogDB=> +``` + +
+ +### 3.在 Kubernetes 集群之外 + +由 MogDB Operator 创建两个带有集群名称前缀的 service，service 的类型 type 设置为 NodePort，可将 service 端口和主机端口映射起来。 + +只需要连接 “Host:Port” 即可。 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/tutorial/create-a-mogdb-cluster.md b/product/zh/docs-mogdb-stack/v2.0/tutorial/create-a-mogdb-cluster.md new file mode 100644 index 0000000000000000000000000000000000000000..d3670b60166dba69358b0bb4fd90a487b20971a3 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/tutorial/create-a-mogdb-cluster.md @@ -0,0 +1,209 @@ +--- +title: 创建MogDB集群 +summary: 创建MogDB集群 +author: Wang Dong, hhhhhzhen +date: 2022-12-30 +--- + +# 创建 MogDB 集群 + +在开始本章前，请确保您已正确依据[开始](getting-started.md)完成 MogDB Stack 的安装与配置。 + +我们提供了两种方式供您创建 MogDB 集群。包括使用 mgo 客户端，或者使用 manifest。 + +我们建议使用 mgo 客户端方式。 + +
+ +## 使用 mgo 客户端 + +### 1.创建 MogDB 集群 + +以下命令将在 **mgo 默认命名空间**中创建具有默认配置的 MogDB 集群，更多信息请参考 [mgo create cluster](../references/client/mgo-create-cluster.md)： + +```shell +mgo create cluster cluster1 +``` + +期望输出： + +```text +created cluster: cluster1 +``` + +此操作可能需要一些时间才能完成。 + +
+ +### 2.检查安装 + +以下命令将查询创建的集群的状态和信息，更多信息请参考 [mgo show cluster](../references/client/mgo-show-cluster.md)： + +```shell +mgo show cluster cluster1 +``` + +当集群创建完毕后，期望输出如下： + +```text +cluster : cluster1 + pod : cluster1-ib7zq (Running) on mogdb-k8s-001 (3/3) (primary) + pod : cluster1-rtwdz (Running) on mogdb-k8s-002 (3/3) (standby) + service : cluster1-svc-master - ClusterIP (10.1.149.4) - Ports (5432:30013/TCP) + service : cluster1-svc-replicas - ClusterIP (10.1.175.46) - Ports (5432:30012/TCP) +``` + +
+ +### 3.创建集群过程 + +首先，mgo 客户端在自定义资源 mogdbcluster 中创建一个条目，其中包含创建集群所需的属性。 +在上面的例子中，mogdb 集群利用了 MogDB Operator 配置中的许多默认值。例如，默认两个从节点。 + +我们将在本教程后面讨论有关 MogDB Operator 配置的更多信息。 + +
+ +## 使用 helm + +### 1. 添加MogDB Stack仓库 + +```shell +helm repo add mogdb-stack https://enmotech.github.io/mogdb-stack-examples/helm/charts +``` + +期望输出: + +```text +"mogdb-stack" has been added to your repositories +``` + +```shell +helm search repo mogdb-stack +``` + +期望输出: + +```text +NAME CHART VERSION APP VERSION DESCRIPTION +mogdb-stack/mogdb-apiserver 2.0.0 2.0.0 A Helm chart for Kubernetes +mogdb-stack/mogdb-cluster 2.0.0 2.0.0 A Helm chart for Kubernetes +mogdb-stack/mogdb-monitor 2.0.0 2.0.0 A Helm chart for Kubernetes +mogdb-stack/mogdb-operator 2.0.0 2.0.0 A Helm chart for Kubernetes +mogdb-stack/mogha 2.0.0 2.0.0 A Helm chart for Kubernetes +``` + +
+ +### 2.部署 MogDB Cluster 集群 + +```shell +helm install mycluster mogdb-stack/mogdb-cluster --namespace mogdb-operator-system +``` + +期望输出： + +```shell +mogdbcluster.mogdb.enmotech.io/cluster1 created +``` + +注意： + +- 关于 Helm 中详细的参数定义，请查看[values相关配置](https://raw.githubusercontent.com/enmotech/mogdb-stack-examples/main/helm/mogdb-cluster/values.yaml); +- 默认情况下使用您 kubernetes 集群中的 `local-path `存储类，以及 `30012` 和 `30013` 端口用于读写； +- 默认情况下不开启高可用，若要开启高可用，请确保您已经注册高可用组件，并设置 `enableHa` 为 `true`； +- 如果需要ha功能，需要提前安装ha模块，详细请参看installation/helm章节； + +
+ +### 3.检查安装 + +以下命令将检查 MogDB 节点是否正确运行： + +```shell +kubectl get pod,svc -n mogdb-operator-system --selector="mogdb.enmotech.io/cluster=cluster1" +``` + +预期输出： + +```shell +NAME READY STATUS RESTARTS AGE +pod/cluster1-lhomu 2/2 Running 0 3m +pod/cluster1-tygxc 2/2 Running 0 3m17s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/cluster1-svc-master NodePort 10.106.99.88 5432:30013/TCP 3m17s +service/cluster1-svc-replicas NodePort 10.96.219.62 5432:30012/TCP 3m17s +``` + +等待所有Pod资源处于Running状态，意味着集群创建成功。 + +## 使用 Kustomize + +### 前置条件 + +- 安装Kustomize v3+ + + ```shell + go install sigs.k8s.io/kustomize/kustomize/v3@v3.8.7 + ~/go/bin/kustomize version + ``` + + > 注意: kubectl 1.4+版本默认集成了Kustomize，无需单独安装。 + +- 下载MogDB Operator examples + + 首先，在GitHub上fork [MogDB Stack examples](https://github.com/enmotech/mogdb-stack-examples)仓库: + + + + fork仓库之后，您可以通过类似如下的命令下载至本地: + + ```shell + YOUR_GITHUB_UN="" + git clone --depth 1 "git@github.com:${YOUR_GITHUB_UN}/mogdb-stack-examples.git" + cd mogdb-stack-examples + ``` + + MogDB Operator安装项目在kustomize目录下。 + +### 1.创建 MogDB Cluster + +```shell +kubectl apply -k kustomize/mogdb-cluster +``` + +期望输出: + +```text +mogdbcluster.mogdb.enmotech.io/cluster1 created +``` + +注意： + +- 默认情况下使用您 kubernetes 集群中的 `local-path `存储类，以及 `30012` 和 `30013` 端口用于读写； +- 默认情况下不开启高可用，若要开启高可用，请确保您已经注册高可用组件，并设置 `enableHa` 为 `true`； +- 如果需要ha功能，需要提前安装ha模块，详细请参看installation/helm章节； +- 如果需要定制化，请查看kustomize目录下，有各种见场景的安装example； + +### 2.检查安装 + +以下命令将检查 MogDB 节点是否正确运行： + +```shell +kubectl get pod,svc -n mogdb-operator-system --selector="mogdb.enmotech.io/cluster=cluster1" +``` + +期望输出: + +```text +NAME READY STATUS RESTARTS AGE +pod/cluster1-8gkok 2/2 Running 0 3m8s +pod/cluster1-bqv8m 2/2 Running 0 4m + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/cluster1-svc-master NodePort 10.96.117.172 5432:30013/TCP 4m +service/cluster1-svc-replicas NodePort 10.96.103.146 5432:30012/TCP 4m +``` + +等待所有Pod资源处于Running状态，意味着集群创建成功。 diff --git a/product/zh/docs-mogdb-stack/v2.0/tutorial/customize-a-mogdb-cluster.md b/product/zh/docs-mogdb-stack/v2.0/tutorial/customize-a-mogdb-cluster.md new file mode 100644 index 0000000000000000000000000000000000000000..10fbd9f114d2cf62fcea1a3d60151490126cab81 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/tutorial/customize-a-mogdb-cluster.md @@ -0,0 +1,127 @@ +--- +title: 定制MogDB集群 +summary: 定制MogDB集群 +author: Wang Dong, hhhhhzhen +date: 2022-12-30 +--- + +# 定制 MogDB 集群 + +我们提供了两种方式供您创建 MogDB 集群。包括使用 mgo 客户端，或者使用 manifest。请按需选择。 + +我们建议使用 mgo 客户端方式。本章中我们将重点对 mgo 客户端方式进行阐述。 + +
+ +## 自定义 MogDB 集群 + ++ 指定 MogDB 版本 ++ 自定义 MogDB 配置 ++ 高可用性（如定制副本） ++ 资源分配（如内存、计算、存储） + +
+ +## 使用 mgo 客户端 + +自定义 MogDB 集群的配置有很多种。 您可以在 [mgo create cluster](../references/client/mgo-create-cluster.md) 中了解所有这些选项。 + +
+ +### 1.定义存储 + +MogDB 共定义了三种存储目录可用配置： + +- 数据目录：用于存储 MogDB 数据库的所有数据 +- 备份目录：用于存储 MogDB 数据库的备份内容 +- 日志目录：用于存储 MogDB 数据库的日志内容 + +数据库有各种不同的大小，而且这些大小肯定会随着时间而改变。因此能够指定要存储 MogDB 数据的 PVC 大小是很有帮助的。 + +
+ +#### 定义 MogDB 数据目录 + +mgo 允许您使用 `--data-storage-size` 标志选择 `MogDB 数据目录`的大小。PVC 大小应该使用标准的 Kubernetes 资源单元，例如 128Mi。 + +以下命令将创建一个具有 128Mi 大小数据目录的 MogDB 集群： + +```shell +mgo create cluster cluster1 --data-storage-size=20Gi +``` + +
+ +#### 定义 MogDB 备份目录 + +mgo 允许您使用 `--backup-storage-size` 标志选择 `MogDB 备份目录`的大小。其用于存储您的所有备份，因此您希望调整它的大小以满足您的备份保留策略。 + +以下命令将创建一个具有 1Gi 大小备份存储库的 MogDB 集群： + +```shell +mgo create cluster cluster1 --backup-storage-size=1Gi +``` + +
+ +#### 定义 MogDB 日志目录 + +mgo 允许您使用 `--log-storage-size` 标志选择 `MogDB 日志目录`的大小。因此您希望调整它的大小以满足您的日志保留策略。 + +以下命令将创建一个具有 1Gi 大小日志目录的 MogDB 集群： + +```shell +mgo create cluster cluster1 --log-storage-size=1Gi +``` + +
+ +### 2.定义内存/CPU + +数据库具有不同的 CPU 和内存要求，这通常取决于工作集中的数据量（即主动访问的数据）。Kubernetes 为 Pod 提供了几种管理 CPU 和内存资源的方法： + ++ Limits：该字段定义了 pod 所能使用资源的最大限额； ++ Requests：该字段定义了 pod 需要使用资源的最小限额，会影响 pod 的调度； + +一般的，我们可以理解为 pod 所使用的资源介于 [requests, limits] 的区间中。 + +**注意：如果 pod 使用的内存超出了 limits 限制，kubernetes 将尝试终止任何导致超出限制的进程。因此内存限制可能会影响 MogDB 的可用性，我们建议谨慎使用它们。** + +下面介绍如何自定义可用于 MogDB 节点的 CPU 和内存资源。自定义 CPU 和内存确实会为您的 MogDB 集群添加更多资源，但要充分利用额外资源，您将需要自定义 MogDB 配置并调整参数 shared_buffers 等。 + +#### 为 MogDB 定制内存/CPU + +mgo 提供了几个标志来帮助管理 MogDB 实例的资源： + ++ --cpu：指定 MogDB 实例的 CPU 请求 ++ --cpu-limit：指定 MogDB 实例的 CPU 限制 ++ --memory：指定 MogDB 实例的内存请求 ++ --memory-limit: 指定 MogDB 实例的内存限制 + +以下命令将创建一个 CPU 请求为 1.0，CPU 限制为 2.0，内存请求为 1Gi，内存限制为 2Gi 的 MogDB 集群： + +```shell +mgo create cluster cluster1 \ +--cpu=1.0 --cpu-limit=2.0 \ +--memory=1Gi --memory-limit=2Gi +``` + +
+ +### 3.创建高可用性 MogDB 集群 + +高可用性允许您部署具有冗余的 MogDB 集群，即使您的主实例发生停机事件，您的应用程序也可以访问它们。MogDB 集群使用 Kubernetes 附带的分布式共识存储系统，因此可用性与 Kubernetes 集群的可用性相关联。 + +要创建具有一个副节点的高可用性 MogDB 集群，您可以运行以下命令： + +```shell +mgo create cluster cluster1 --replicas=2 +``` + +您可以使用[mgo scale](../references/client/mgo-scale.md)和[mgo scaledown](../references/client/mgo-scaledown.md)命令扩展和缩容 MogDB 集群。 + +
+ +## 使用 manifest + +您可参照 [CRD 参考](../references/server/crd-references.md)以及[manifest demo](../references/server/mogdbcluster-sample.md)进行集群的定制。通过参照 CRD 字段说明，对 manifest 对应字段进行修改，即可完成对 MogDB 集群的高度定制。 \ No newline at end of file diff --git a/product/zh/docs-mogdb-stack/v2.0/tutorial/getting-started.md b/product/zh/docs-mogdb-stack/v2.0/tutorial/getting-started.md new file mode 100644 index 0000000000000000000000000000000000000000..9370757113eac8a2989d2383b7596f5116ac736f --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/tutorial/getting-started.md @@ -0,0 +1,37 @@ +--- +title: 开始 +summary: 开始 +author: Wang Dong, hhhhhzhen +date: 2022-12-30 +--- + +# 开始 + +如果您尚未安装 MogDB Stack，请参考[软件安装](../installation/helm.md)部分。 + +同样的，如果您尚未开启高可用组件，并且需要开启高可用组件，请参考[开启高可用组件](../architecture/high-availability.md#开启高可用组件)部分。 + +
+ +## [可选]设置mgo默认命名空间 + +许多 mgo 命令要求传递命名空间标志 (-n) 。您可以使用 `MGO_NAMESPACE` 环境变量来设置 mgo 命令的默认命名空间： + +```shell +export MGO_NAMESPACE=mogdb-operator-system +``` + +之后执行以下命令将显示部署到 `mogdb-operator-system` 命名空间的所有 MogDB 集群： + +```shell +mgo show cluster --all +``` + +这相当于： + +```shell +mgo show cluster -n mogdb-operator-system --all +``` + +（注：**-n**优先于**MGO_NAMESPACE**。） + diff --git a/product/zh/docs-mogdb-stack/v2.0/tutorial/resize-a-mogdb-cluster.md b/product/zh/docs-mogdb-stack/v2.0/tutorial/resize-a-mogdb-cluster.md new file mode 100644 index 0000000000000000000000000000000000000000..7c816e301c17acf53a338a6240c3378640c4e630 --- /dev/null +++ b/product/zh/docs-mogdb-stack/v2.0/tutorial/resize-a-mogdb-cluster.md @@ -0,0 +1,107 @@ +--- +title: 扩缩容 +summary: 扩缩容 +author: Wang Dong, hhhhhzhen +date: 2022-12-30 +--- + +# 扩缩容 MogDB 集群 + +在开始本章前，请确保您已正确依据[创建 MogDB 集群](create-a-mogdb-cluster.md)完成 MogDB 集群的安装。 + +由于我们提供了两种方式供您创建 MogDB 集群。包括使用 mgo 客户端，或者使用 manifest，因此该部分同样对两种方式进行说明，请依据您创建 MogDB 集群的方式进行选择。 + +我们建议使用 mgo 客户端方式。 + +
+ +## 使用 mgo 客户端 + +### 1.扩容 + +以下命令将对集群 cluster1 执行扩容，以向其添加副节点，更多信息请参考 [mgo scale](../references/client/mgo-scale.md)： + +```shell +mgo scale cluster1 +``` + +
+ +### 2.缩容 + +要缩容 MogDB 集群，您必须提供要缩减的实例的目标。 + +以下命令将获取集群 cluster1 可以缩容实例的目标列表，更多信息请参考 [mgo scaledown](../references/client/mgo-scaledown.md)： + +```shell +mgo scaledown cluster1 --query +``` + +期望输出： + +```text +PODNAME STATUS NODE +cluster1-rtwdz Running mogdb-k8s-002 +``` + +确定要缩容的实例后，执行以下命令进行缩容： + +```shell +mgo scaledown cluster1 --target=cluster1-rtwdz +``` + +
+ +## 使用 manifest + +通过 manifest 执行扩缩容的步骤相同，此处合并讲解。 + +### 1.修改 manifest + +确保 `.metadata.name` 与 `.metadata.namespace` 的内容与创建集群时保持一致后。修改 manifest 中 `.spec.replicas` 的数量到您期望的数量。 + +```yaml +apiVersion: mogdb.enmotech.io/v1 +kind: MogdbCluster +... +spec: + replicas: 3 +... +``` + +### 2.更新集群 + +以下命令将对已存在的 mogdb 集群进行更新： + +```shell +kubectl apply -f mogdb-cluster.yaml +``` + +期望输出： + +```shell +mogdbcluster.mogdb.enmotech.io/cluster1 configured +``` + +### 3.检查更新 + +以下命令将检查 MogDB 节点是否正确运行： + +```shell +kubectl get pod,svc -n mogdb-operator-system --selector="mogdb.enmotech.io/cluster=cluster1" +``` + +预期输出： + +```shell +NAME READY STATUS RESTARTS AGE +pod/cluster1-nduk8 2/2 Running 0 45m +pod/cluster1-wnev6 2/2 Running 0 45m +pod/cluster1-xwnkx 2/2 Running 0 71s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/cluster1-svc-master NodePort 10.96.158.193 5432:30013/TCP 44m +service/cluster1-svc-replicas NodePort 10.110.121.108 5432:30012/TCP 44m +``` + +其中 pod/cluster1-xwnkx 为新增节点。