Skip to content

Commit

Permalink
Fix versions in Doc and Update helm charts (#332)
Browse files Browse the repository at this point in the history
  • Loading branch information
powerfooI authored Apr 25, 2024
1 parent 76c2044 commit 0883884
Show file tree
Hide file tree
Showing 19 changed files with 90 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release-obproxy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ jobs:
platforms: linux/amd64,linux/arm64
file: ./distribution/obproxy/Dockerfile
push: true
tags: ${{ vars.DOCKER_PUSH_BASE }}/obproxy:${{ steps.set_version_vars.outputs.version }}
tags: ${{ vars.DOCKER_PUSH_BASE }}/obproxy-ce:${{ steps.set_version_vars.outputs.version }}
build-args: |
VERSION=${{ steps.set_version_vars.outputs.version }}
33 changes: 33 additions & 0 deletions charts/ob-operator/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
_ _
___ | |__ ___ _ __ ___ _ __ __ _| |_ ___ _ __
/ _ \| '_ \ _____ / _ \| '_ \ / _ \ '__/ _` | __/ _ \| '__|
| (_) | |_) |_____| (_) | |_) | __/ | | (_| | || (_) | |
\___/|_.__/ \___/| .__/ \___|_| \__,_|\__\___/|_|
|_|

Welcome to ob-operator! We are so happy to see you here! Once ob-operator is installed, you can explore OceanBase database on your Kubernetes cluster with ease.

The following steps will guide you through the OceanBase database deployment:

1. Quick Start - Deploy a single-node OceanBase database for testing

https://oceanbase.github.io/ob-operator/docs/manual/quick-start-of-ob-operator

2. Advanced - Create an OceanBase database with customized configurations

https://oceanbase.github.io/ob-operator/docs/manual/ob-operator-user-guide/cluster-management-of-ob-operator/create-cluster

3. Tenants - Create and manage tenants in OceanBase database

https://oceanbase.github.io/ob-operator/docs/manual/ob-operator-user-guide/tenant-management-of-ob-operator/tenant-management-intro

4. High availability - Enable high availability for OceanBase on K8s

https://oceanbase.github.io/ob-operator/docs/manual/ob-operator-user-guide/high-availability/high-availability-intro

5. Get help from the community

Feel free to ask questions or report issues on GitHub: https://github.com/oceanbase/ob-operator/issues
Other ways to get help: https://oceanbase.github.io/ob-operator/#getting-help

For more information, please visit our website: https://oceanbase.github.io/ob-operator
6 changes: 6 additions & 0 deletions charts/oceanbase-cluster/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
___ ____ ____ _ _
/ _ \ ___ ___ __ _ _ __ | __ ) __ _ ___ ___ / ___| |_ _ ___| |_ ___ _ __
| | | |/ __/ _ \/ _` | '_ \| _ \ / _` / __|/ _ \ | | | | | | / __| __/ _ \ '__|
| |_| | (_| __/ (_| | | | | |_) | (_| \__ \ __/ | |___| | |_| \__ \ || __/ |
\___/ \___\___|\__,_|_| |_|____/ \__,_|___/\___| \____|_|\__,_|___/\__\___|_|

Welcome to OceanBase Cluster!

After installing OBCluster chart, you need to wait for the cluster bootstrapped. Bootstrap progress will cost approximately 2~3 minutes which may vary depends on the machine.
Expand Down
14 changes: 13 additions & 1 deletion charts/oceanbase-dashboard/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
Welcome to OceanBase dashboard
___ ____
/ _ \ ___ ___ __ _ _ __ | __ ) __ _ ___ ___
| | | |/ __/ _ \/ _` | '_ \| _ \ / _` / __|/ _ \
| |_| | (_| __/ (_| | | | | |_) | (_| \__ \ __/
\___/ \___\___|\__,_|_| |_|____/ \__,_|___/\___|

____ _ _ _
| _ \ __ _ ___| |__ | |__ ___ __ _ _ __ __| |
| | | |/ _` / __| '_ \| '_ \ / _ \ / _` | '__/ _` |
| |_| | (_| \__ \ | | | |_) | (_) | (_| | | | (_| |
|____/ \__,_|___/_| |_|_.__/ \___/ \__,_|_| \__,_|

Welcome to OceanBase dashboard!

1. After installing the dashboard chart, you can use `port-forward` to expose the dashboard outside like:

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.1.1_release/deploy/cert-manager.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.1_release/deploy/operator.yaml
https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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: 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.1.0_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/example/quickstart/obcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/deploy/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/2.2.0_release/deploy/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.1.0_release/deploy/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/2.2.0_release/deploy/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
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ sidebar_position: 1

ob-operator ensures the high availability of data by using the following features of OceanBase Database.

* Node fault recovery. The distributed architecture of OceanBase Database allows you to restore the service when a minority of nodes fail. By relying on certain network plugins, you can even restore the service from majority nodes failure. For more information, see [Restore service from faults](300.disaster-recovery-of-ob-operator.md).
* Node fault recovery. The distributed architecture of OceanBase Database allows you to restore the service when a minority of nodes fail. By relying on certain network plugins, you can even restore the service from majority nodes failure. For more information, see [Recover from node failure](300.disaster-recovery-of-ob-operator.md).
* Backup and restore of tenant data. The backup and restore feature of OceanBase Database allows you to back up tenant data to different storage media to ensure data safety. For more information, see [Back up a tenant](400.tenant-backup-of-ob-operator.md).
* Primary and standby tenants. OceanBase Database allows you to create a standby tenant for the primary tenant. When a fault occurs to the primary tenant, you can quickly switch your business to the standby tenant to reduce the business interruption. For more information, see [Physical standby database](600.standby-tenant-of-ob-operator.md).
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.1.0_release/example/webapp/namespace.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/example/webapp/secret.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/example/webapp/configserver.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/example/webapp/obcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/example/webapp/obproxy.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/example/webapp/tenant.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/example/webapp/tenant.yaml
```

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

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.1.0_release/example/webapp/ocp.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/example/webapp/ocp.yaml
```

After the deployment process is completed, run the following command to view the application status:
Expand Down Expand Up @@ -237,7 +237,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.1.0_release/example/webapp/prometheus.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/example/webapp/prometheus.yaml
```

Run the following command to view the deployment status:
Expand All @@ -259,7 +259,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.1.0_release/example/webapp/grafana.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/example/webapp/grafana.yaml
```

Run the following command to view the deployment status:
Expand All @@ -285,4 +285,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.1.0_release/example/webapp) directory.
You can find all configuration files used in this topic in the [webapp](https://github.com/oceanbase/ob-operator/tree/2.2.0_release/example/webapp) directory.
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.1.1_release/deploy/cert-manager.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.1_release/deploy/operator.yaml
https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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 @@ -21,7 +21,7 @@ sidebar_position: 2
- 稳定版本

```shell
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.1.0_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/example/quickstart/obcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/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.1.0_release/deploy/operator.yaml
kubectl apply -f https://raw.githubusercontent.com/oceanbase/ob-operator/2.2.0_release/deploy/operator.yaml
```

- 开发版本
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ sidebar_position: 2

## 使用配置文件创建租户

通过应用租户配置文件创建租户。配置文件内容可参考 [GitHub](https://github.com/oceanbase/ob-operator/blob/2.1.0_release/deploy/tenant.yaml)
通过应用租户配置文件创建租户。配置文件内容可参考 [GitHub](https://github.com/oceanbase/ob-operator/blob/2.2.0_release/deploy/tenant.yaml)

创建租户的命令如下,该命令会在当前 Kubernetes 集群中创建一个 OBTenant 租户的资源。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 4

## 具体操作

通过配置文件 tenant.yaml 在集群中删除指定的租户资源。配置文件可参考 [GitHub](https://github.com/oceanbase/ob-operator/blob/2.1.0_release/deploy/tenant.yaml)
通过配置文件 tenant.yaml 在集群中删除指定的租户资源。配置文件可参考 [GitHub](https://github.com/oceanbase/ob-operator/blob/2.2.0_release/deploy/tenant.yaml)

删除租户的命令如下,该命令会在当前 Kubernetes 集群中删除对应租户的 OBTenant 资源。

Expand Down
Loading

0 comments on commit 0883884

Please sign in to comment.