Skip to content

Commit

Permalink
docs(stable): replace specific version of releases with stable (#678)
Browse files Browse the repository at this point in the history
  • Loading branch information
powerfooI authored Dec 18, 2024
1 parent bccbcd0 commit 27945cc
Show file tree
Hide file tree
Showing 22 changed files with 56 additions and 60 deletions.
6 changes: 3 additions & 3 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ob-operator 是满足 Kubernetes Operator 扩展范式的自动化工具,可
ob-operator 依赖 [cert-manager](https://cert-manager.io/docs/), cert-manager 的安装可以参考对应的[安装文档](https://cert-manager.io/docs/installation/),如果您无法访问官方制品托管在 `quay.io` 镜像站的镜像,可通过下面的指令安装我们转托在 `docker.io` 中的制品:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/cert-manager.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/cert-manager.yaml
```

本例子中的 OceanBase 集群存储依赖 [local-path-provisioner](https://github.com/rancher/local-path-provisioner) 提供, 需要提前进行安装并确保其存储目的地有足够大的磁盘空间。如果您计划在生产环境部署,推荐使用其他的存储解决方案。我们在[存储兼容性](#存储兼容性)一节提供了我们测试过的存储兼容性结果。
Expand All @@ -29,7 +29,7 @@ kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_r
- 稳定版本

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```

- 开发版本
Expand Down Expand Up @@ -97,7 +97,7 @@ kubectl create secret generic root-password --from-literal=password='root_passwo
通过以下命令即可在 K8s 集群中部署 OceanBase:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/quickstart/obcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/quickstart/obcluster.yaml
```

一般初始化集群需要 2 分钟左右的时间,执行以下命令,查询集群状态,当集群状态变成 running 之后表示集群创建和初始化成功:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ob-operator relies on [cert-manager](https://cert-manager.io/docs/) for certific
If you have trouble accessing `quay.io` image registry, our mirrored cert-manager manifests can be applied through following command:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/cert-manager.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/cert-manager.yaml
```

Storage of OceanBase cluster in this example relies on [local-path-provisioner](https://github.com/rancher/local-path-provisioner), which should be installed beforehand. You should confirm that there is enough disk space in storage destination of local-path-provisioner. If you decide to deploy OceanBase cluster in production environment, it is recommended to use other storage solutions. We have provided a compatible table for storage solutions that we tested in section [Storage Compatibility](#storage-compatibility).
Expand All @@ -30,7 +30,7 @@ You can deploy ob-operator in a Kubernetes cluster by executing the following co
- Stable

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```

- Development
Expand Down Expand Up @@ -98,7 +98,7 @@ kubectl create secret generic root-password --from-literal=password='root_passwo
You can deploy OceanBase in a Kubernetes cluster by executing the following command:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/quickstart/obcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/quickstart/obcluster.yaml
```

It generally takes around 2 minutes to bootstrap a cluster. Execute the following command to check the status of the cluster. Once the cluster status changes to "running," it indicates that the cluster has been successfully created and bootstrapped:
Expand Down
6 changes: 3 additions & 3 deletions docsite/docs/dashboard/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem'

# OceanBase Dashboard Quick Start

OceanBase Dashboard is a white-screen operation and maintenance tool that is compatible with ob-operator. As of the latest version 0.2.1, it has functions such as cluster management, tenant management, backup management, performance monitoring, and terminal connection. It is the preferred tool for monitoring OceanBase cluster performance metrics in a K8s environment.
OceanBase Dashboard is a white-screen operation and maintenance tool that is compatible with ob-operator. As of the latest version 0.3.2, it has functions such as cluster management, tenant management, backup management, performance monitoring, and terminal connection. It is the preferred tool for monitoring OceanBase cluster performance metrics in a K8s environment.

## Deploy OceanBase Dashboard

Expand All @@ -16,13 +16,13 @@ It's recommended to install OceanBase Dashboard using [Helm](https://github.com/
```bash
helm repo add ob-operator https://oceanbase.github.io/ob-operator/
helm repo update ob-operator
helm install oceanbase-dashboard ob-operator/oceanbase-dashboard --version=0.2.1
helm install oceanbase-dashboard ob-operator/oceanbase-dashboard
```

If you want to install it in another namespace, you can replace the last installation command with the following command (`<namespace>` is the target namespace you want to install). If the namespace does not exist, you can add `--create-namespace` to create it.

```bash
helm install oceanbase-dashboard ob-operator/oceanbase-dashboard --version=0.2.1 -n <namespace> --create-namespace
helm install oceanbase-dashboard ob-operator/oceanbase-dashboard -n <namespace> --create-namespace
```

If the installation command is executed successfully, the following notes will be displayed.
Expand Down
4 changes: 2 additions & 2 deletions docsite/docs/developer/deploy-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ Tips: Perform `minikube dashboard` to open kubernetes dashboard, everything in t
ob-operator depends on `cert-manager` to enable TLS functionalities, so we should install it first.

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/cert-manager.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/cert-manager.yaml
```

### 4. Install ob-operator

For robustness, default memory limit of ob-operator container is set to `1Gi` which is too large for us developing locally. We recommend fetching the manifests to local and configure it. wget tool could be useful here, while opening the URL and copying the contents to local file is more straight.

https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml

Search the pattern `/manager`, find the target container, configure the memory limit to `400Mi` and cpu limit to `400m`.

Expand Down
4 changes: 1 addition & 3 deletions docsite/docs/developer/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,11 @@ Parameters:

* namespace: Namespace, can be customized. It is recommended to use "oceanbase-system" as the namespace.

* version: ob-operator version number. It is recommended to use the latest version `2.3.1`.

## 2.2 Deploying with Configuration Files

* Stable
```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```
* Development
```shell
Expand Down
4 changes: 2 additions & 2 deletions docsite/docs/manual/200.quick-start-of-ob-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Run the following command to deploy ob-operator in the Kubernetes cluster:
- Deploy the stable version of ob-operator

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```

- Deploy the developing version of ob-operator
Expand Down Expand Up @@ -61,7 +61,7 @@ Perform the following steps to deploy an OceanBase cluster in the Kubernetes clu
Run the following command to deploy an OceanBase cluster in the Kubernetes cluster:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/quickstart/obcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/quickstart/obcluster.yaml
```

In general, it takes about 2 minutes to create a cluster. Run the following command to check the cluster status:
Expand Down
2 changes: 1 addition & 1 deletion docsite/docs/manual/300.deploy-ob-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You can deploy ob-operator by using the configuration file for the stable or dev
* Deploy the stable version of ob-operator

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```

* Deploy the developing version of ob-operator
Expand Down
2 changes: 1 addition & 1 deletion docsite/docs/manual/400.ob-operator-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you upgrade ob-operator by using configuration files, you only need to reappl
- Deploy the stable version of ob-operator

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```

- Deploy the developing version of ob-operator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Before you create a tenant, make sure the following conditions are met:

## Create a tenant by using the configuration file

You can create a tenant by using the configuration file of the tenant. For more information about the configuration file, visit [GitHub](https://github.com/oceanbase/ob-operator/blob/2.3.1_release/example/tenant/tenant.yaml).
You can create a tenant by using the configuration file of the tenant. For more information about the configuration file, visit [GitHub](https://github.com/oceanbase/ob-operator/blob/stable/example/tenant/tenant.yaml).

Run the following command to create a tenant. This command creates an OceanBase Database tenant with custom resources in the current Kubernetes cluster.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This topic describes how to use ob-operator to delete a tenant from a Kubernetes

## Procedure

You can delete the specified tenant resources from the cluster by using the configuration file `tenant.yaml`. For more information about the configuration file, visit [GitHub](https://github.com/oceanbase/ob-operator/blob/2.3.1_release/example/tenant/tenant.yaml).
You can delete the specified tenant resources from the cluster by using the configuration file `tenant.yaml`. For more information about the configuration file, visit [GitHub](https://github.com/oceanbase/ob-operator/blob/stable/example/tenant/tenant.yaml).

Run the following command to delete a tenant. This command deletes an OceanBase Database tenant with custom resources in the current Kubernetes cluster.

Expand Down
20 changes: 10 additions & 10 deletions docsite/docs/manual/900.appendix/100.example.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In this example, the following components are deployed:
Create a namespace:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/namespace.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/namespace.yaml
```

View the created namespace:
Expand All @@ -46,7 +46,7 @@ oceanbase Active 98s
Create secrets for the cluster and tenants:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/secret.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/secret.yaml
```

View the created secrets:
Expand All @@ -73,7 +73,7 @@ ob-configserver allows you to register, store, and query metadata of the RootSer
Run the following command to deploy ob-configserver and create the corresponding service:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/configserver.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/configserver.yaml
```

Check the pod status:
Expand Down Expand Up @@ -101,7 +101,7 @@ When you deploy an OceanBase cluster, add environment variables and set the syst
Deploy the OceanBase cluster:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/obcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/obcluster.yaml
```

Run the following command to query the status of the OceanBase cluster until the status becomes `running`:
Expand All @@ -121,7 +121,7 @@ You can start ODP by using ob-configserver or specifying the RS list. To maximiz
Run the following command to deploy ODP and create the ODP service:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/obproxy.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/obproxy.yaml
```

When you query the pod status of ODP, you can see two ODP pods.
Expand Down Expand Up @@ -165,7 +165,7 @@ You can create a dedicated tenant for each type of business for better resource
Run the following command to create a tenant:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/tenant.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/tenant.yaml
```

Run the following command to query the status of the tenant until the status becomes `running`:
Expand Down Expand Up @@ -201,7 +201,7 @@ create database dev;
Run the following command to deploy the application:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/oceanbase-todo.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/oceanbase-todo.yaml
```

After the deployment process is completed, run the following command to view the application status:
Expand Down Expand Up @@ -254,7 +254,7 @@ When you deploy the OceanBase cluster, an OBAgent sidecar container is created i
Run the following command to deploy Prometheus:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/prometheus.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/prometheus.yaml
```

Run the following command to view the deployment status:
Expand All @@ -276,7 +276,7 @@ Grafana displays the metrics of OceanBase Database by using Prometheus as a data
Run the following command to deploy Grafana:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/webapp/grafana.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/webapp/grafana.yaml
```

Run the following command to view the deployment status:
Expand All @@ -302,4 +302,4 @@ This topic describes how to deploy OceanBase Database and related components suc

## Note

You can find all configuration files used in this topic in the [webapp](https://github.com/oceanbase/ob-operator/tree/2.3.1_release/example/webapp) directory.
You can find all configuration files used in this topic in the [webapp](https://github.com/oceanbase/ob-operator/tree/stable/example/webapp) directory.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem'

# OceanBase Dashboard 快速上手

OceanBase Dashboard 是与 ob-operator 配套的白屏运维工具,截止目前最新的 0.2.1 版本具有集群管理、租户管理、备份管理、性能监控和终端直连等功能,是在 K8s 环境中配合 ob-operator 监控 OceanBase 集群性能指标的首选工具。
OceanBase Dashboard 是与 ob-operator 配套的白屏运维工具,截止目前最新的 0.3.2 版本具有集群管理、租户管理、备份管理、性能监控和终端直连等功能,是在 K8s 环境中配合 ob-operator 监控 OceanBase 集群性能指标的首选工具。

## 部署 OceanBase Dashboard

Expand All @@ -16,13 +16,13 @@ OceanBase Dashboard 是与 ob-operator 配套的白屏运维工具,截止目
```bash
helm repo add ob-operator https://oceanbase.github.io/ob-operator/
helm repo update ob-operator
helm install oceanbase-dashboard ob-operator/oceanbase-dashboard --version=0.2.1
helm install oceanbase-dashboard ob-operator/oceanbase-dashboard
```

如果要在其他命名空间安装,可将最后一条安装命令替换成为下面的命令(`<namespace>`部分为您需要安装的目标命名空间),如果该命名空间原本不存在,可添加`--create-namespace`进行创建。

```bash
helm install oceanbase-dashboard ob-operator/oceanbase-dashboard --version=0.2.1 -n <namespace> --create-namespace
helm install oceanbase-dashboard ob-operator/oceanbase-dashboard -n <namespace> --create-namespace
```

若安装命令执行完后在终端内打印类似下面内容的提示则说明部署成功。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ Tips: Perform `minikube dashboard` to open kubernetes dashboard, everything in t
ob-operator depends on `cert-manager` to enable TLS functionalities, so we should install it first.

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/cert-manager.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/cert-manager.yaml
```

### 4. Install ob-operator

For robustness, default memory limit of ob-operator container is set to `1Gi` which is too large for us developing locally. We recommend fetching the manifests to local and configure it. wget tool could be useful here, while opening the URL and copying the contents to local file is more straight.

https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml

Search the pattern `/manager`, find the target container, configure the memory limit to `400Mi` and cpu limit to `400m`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,11 @@ helm install ob-operator ob-operator/ob-operator --namespace=oceanbase-system --

* namespace:命名空间,可自定义,一般建议使用 oceanbase-system。

* version:ob-operator 版本号,建议使用最新的版本 `2.3.1`

## 2.2 使用配置文件部署

* Stable
```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```
* Development
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ sidebar_position: 2
- 稳定版本

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```

- 开发版本
Expand Down Expand Up @@ -61,7 +61,7 @@ oceanbase-controller-manager-86cfc8f7bf-4hfnj 2/2 Running 0 1m
使用以下命令在 Kubernetes 集群上部署 OceanBase 集群:

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/example/quickstart/obcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/example/quickstart/obcluster.yaml
```

集群创建通常需要约 2 分钟。执行以下命令检查集群状态:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ helm install ob-operator ob-operator/ob-operator --namespace=oceanbase-system --
* 稳定版本

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```

* 开发版本
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sidebar_position: 4
- 稳定版本

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.3.1_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/stable/deploy/operator.yaml
```

- 开发版本
Expand Down
Loading

0 comments on commit 27945cc

Please sign in to comment.