chore: apply suggestions from CR

GreptimeTeam · Aug 30, 2024 · 1365a17 · 1365a17
1 parent 5246d82
commit 1365a17
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 23 deletions.
diff --git a/...s/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md b/...s/deploy-on-kubernetes/manage-greptimedb-operator/deploy-greptimedb-operator.md
@@ -11,10 +11,8 @@ The GreptimeDB Kubernetes Operator simplifies deploying GreptimeDB on both priva
 
 GreptimeDB provides a Helm-compatible repository for easy deployment. Follow these steps to install the Operator using Helm:
 
-### 1. Add the GreptimeDB Operator Repository
+### Add the GreptimeDB Operator repository
 First, add the GreptimeDB Operator Helm repository:
-
-1. Add the GreptimeDB Operator Repo to Helm
 ```bash
 helm repo add greptime https://greptimeteam.github.io/helm-charts/
 ```
@@ -30,16 +28,16 @@ NAME                        	CHART VERSION	APP VERSION   	DESCRIPTION
 greptime/greptimedb-operator	0.2.3        	0.1.0-alpha.29	The greptimedb-operator Helm chart for Kubernetes.
 ```
 
-### 2. Install the Operator
+### Install the Operator
 To install the Operator, run the following `helm install` command. This command also creates a dedicated namespace `greptimedb-operator` for the installation. It's recommended to use a dedicated namespace for the Operator:
 ```bash
 helm install \
+  operator greptime/greptimedb-operator \
   --create-namespace \
-  greptimedb-operator greptime/greptimedb-operator \
   -n greptimedb-operator
 ```
 
-### 3. Verify the Operator installation
+### Verify the Operator installation
 After installation, check the contents of the `greptimedb-operator` namespace to confirm that all pods and services are running correctly:
 ```bash
 kubectl get all -n greptimedb-operator
@@ -48,11 +46,11 @@ kubectl get all -n greptimedb-operator
 You should see output similar to this:
 ```bash
 NAME                                       READY   STATUS    RESTARTS   AGE
-pod/greptimedb-operator-8495fcb545-jpz2m   1/1     Running   0          17s
+pod/operator-8495fcb545-jpz2m              1/1     Running   0          17s
 
 NAME                                  READY   UP-TO-DATE   AVAILABLE   AGE
-deployment.apps/greptimedb-operator   1/1     1            1           17s
+deployment.apps/operator              1/1     1            1           17s
 
 NAME                                             DESIRED   CURRENT   READY   AGE
-replicaset.apps/greptimedb-operator-8495fcb545   1         1         1       17s
+replicaset.apps/operator-8495fcb545              1         1         1       17s
 ```
diff --git a/.../deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md b/.../deploy-on-kubernetes/manage-greptimedb-operator/upgrade-greptimedb-operator.md
@@ -1,7 +1,7 @@
 # Upgrade GreptimeDB Operator
-You can upgrade the GreptimeDB Operator at any time without impacting your managed GreptimeDB instances. This guide details the steps to upgrade an existing GreptimeDB Operator installation using Helm, specifically from version 0.2.1 to 0.2.3.
+You can upgrade the GreptimeDB Operator at any time without impacting your managed GreptimeDB instances. This guide details the steps to upgrade an existing GreptimeDB Operator installation using Helm, specifically from version 0.2.1 to the lastest version.
 
-### 1. Verify the existing Operator installation.
+### Verify the existing Operator installation.
 
 First, verify the health and status of all Operator pods and services using:
 
@@ -20,10 +20,10 @@ helm list -n greptimedb-operator
 You should see output similar to this:
 ```
 NAME               	NAMESPACE          	REVISION	UPDATED                                	STATUS  	CHART                    	APP VERSION
-greptimedb-operator	greptimedb-operator	1       	2024-08-30 08:04:53.388756424 +0000 UTC	deployed	greptimedb-operator-0.2.1	0.1.0-alpha.28
+operator	        greptimedb-operator	1       	2024-08-30 08:04:53.388756424 +0000 UTC	deployed	greptimedb-operator-0.2.1	0.1.0-alpha.28
 ```
 
-### 2. Update the Operator Repository
+### Update the Operator Repository
 
 Update the GreptimeDB Operator Helm repository to fetch the latest charts:
 
@@ -49,7 +49,7 @@ NAME                        	CHART VERSION	APP VERSION   	DESCRIPTION
 greptime/greptimedb-operator	0.2.3        	0.1.0-alpha.29	The greptimedb-operator Helm chart for Kubernetes.
 ```
 
-### 3. Run helm upgrade
+### Upgrade the Operator version
 
 Use Helm to upgrade the GreptimeDB Operator to the latest version:
 ```bash
@@ -61,14 +61,9 @@ If the Operator is installed in a different namespace, specify it with the `-n`
 
 The command should return a successful upgrade with an incremented `REVISION` value.
 
-### 4. Validate the Operator upgrade
+### Verify the Operator upgrade
 
-To confirm the upgrade, run the same helm list command as before:
+To confirm the upgrade, run the following command:
 ```bash
-helm list -n greptimedb-operator
-```
-
-You should see output similar to this:
-```
-NAME               	NAMESPACE          	REVISION	UPDATED                                	STATUS  	CHART                    	APP VERSION
-greptimedb-operator	greptimedb-operator	2       	2024-08-30 08:18:14.115248532 +0000 UTC	deployed	greptimedb-operator-0.2.3	0.1.0-alpha.29```
+kubectl get pod -l 'app.kubernetes.io/name=operator' -n greptimedb-operator -o json | jq '.items[0].spec.containers[0].image'
+```