Publish the user documentation for Operator version 1.7.0 & 1.7.1;

k8s/README.md

@@ -15,6 +15,7 @@ Understanding the intricate synergy between TigerGraph, TigerGraph Operator, and
 
 | TigerGraph Operator version | TigerGraph version  | Kubernetes version |
 |----------|----------|----------|
+| 1.7.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.3.0|1.27, 1.28, 1.29, 1.30, 1.31|
 | 1.6.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.2.2|1.27, 1.28, 1.29, 1.30, 1.31|
 | 1.5.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.2.0|1.26, 1.27, 1.28, 1.29, 1.30|
 | 1.4.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.1.3|1.25, 1.26, 1.27, 1.28, 1.29|
@@ -69,9 +70,14 @@ Once your deployment is complete, refer to the following documents for guidance
 - [Configure Cross-Region Replication on Kubernetes](docs/03-deploy/configure-crr-on-k8s.md)
 - [Upgrade the TigerGraph Cluster Using the TigerGraph Operator](docs/04-manage/tigergraph-upgrade.md)
 - [Enable TigerGraph Operator monitoring with Prometheus and Grafana](docs/05-monitor/tigergraph-monitor-with-prometheus-grafana.md)
+- [TigerGraph Metrics Reference](docs/05-monitor/tigergraph-metrics-reference.md)
 - [Customize the backoff retries for cluster job operations](docs/04-manage/backoff-retries-for-cluster-job-operations.md)
 - [Node Repaving for TigerGraph on Kubernetes](docs/08-reference/node-repaving-for-tigergraph-on-k8s.md)
 - [Configure SSL Certificate for Ingress Service](docs/03-deploy/configure-ssl-certificate-for-ingress-service.md)
+- [Running Custom Bash Scripts in a TigerGraph Cluster via Kubernetes Jobs](docs/04-manage/running-custom-bash-scripts-via-kubernetes-jobs.md)
+- [Configure Nginx TLS](docs/03-deploy/configure-nginx-tls.md)
+- [Scale Up and Scale Down](docs/04-manage/scale-up-and-down.md)
+- [Scale In and Scale Out](docs/04-manage/scale-in-and-out.md)
 
 In case issues arise and your cluster requires diagnosis, you have two valuable resources:
 
@@ -87,7 +93,7 @@ For detailed information about the features, improvements, and bug fixes introdu
 
 When reporting issues, please provide the following details:
 
-- **Setup Information**: Include details as specified in the [issue template](../06-FAQs/issue_report_template.md)
+- **Setup Information**: Include details as specified in the [issue template](docs/07-FAQs/issue_report_template.md)
 - **Reproduction Steps**: Describe the scenario where the issue occurred, along with clear steps to reproduce it.
 - **Errors and Logs**: Share any relevant error messages or log outputs from the involved software.
 - **Additional Context**: Include any other details that might help in diagnosing the issue.

k8s/docs/01-introduction/README.md

@@ -13,8 +13,10 @@ TigerGraph Operator stands as an automated operations system meticulously design
 
 Understanding the intricate synergy between TigerGraph, TigerGraph Operator, and Kubernetes versions is pivotal. This relationship is as follows:
 
-| TigerGraph Operator version | TigerGraph version  | Kubernetes version |
+| TigerGraph Operator version | TigerGraph version  | Kubernetes Validated version |
 |----------|----------|----------|
+| 1.7.1 | TigerGraph >= 3.6.0 && TigerGraph <= 4.3.0|1.30, 1.31, 1.32, 1.33, 1.34|
+| 1.7.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.3.0|1.27, 1.28, 1.29, 1.30, 1.31|
 | 1.6.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.2.2|1.27, 1.28, 1.29, 1.30, 1.31|
 | 1.5.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.2.0|1.26, 1.27, 1.28, 1.29, 1.30|
 | 1.4.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.1.3|1.25, 1.26, 1.27, 1.28, 1.29|
@@ -69,9 +71,14 @@ Once your deployment is complete, refer to the following documents for guidance
 - [Configure Cross-Region Replication on Kubernetes](../03-deploy/configure-crr-on-k8s.md)
 - [Upgrade the TigerGraph Cluster Using the TigerGraph Operator](../04-manage/tigergraph-upgrade.md)
 - [Enable TigerGraph Operator monitoring with Prometheus and Grafana](../05-monitor/tigergraph-monitor-with-prometheus-grafana.md)
+- [TigerGraph Metrics Reference](../05-monitor/tigergraph-metrics-reference.md)
 - [Customize the backoff retries for cluster job operations](../04-manage/backoff-retries-for-cluster-job-operations.md)
 - [Node Repaving for TigerGraph on Kubernetes](../08-reference/node-repaving-for-tigergraph-on-k8s.md)
 - [Configure SSL Certificate for Ingress Service](../03-deploy/configure-ssl-certificate-for-ingress-service.md)
+- [Running Custom Bash Scripts in a TigerGraph Cluster via Kubernetes Jobs](../04-manage/running-custom-bash-scripts-via-kubernetes-jobs.md)
+- [Configure Nginx TLS](../03-deploy/configure-nginx-tls.md)
+- [Scale Up and Scale Down](../04-manage/scale-up-and-down.md)
+- [Scale In and Scale Out](../04-manage/scale-in-and-out.md)
 
 In case issues arise and your cluster requires diagnosis, you have two valuable resources:
 
@@ -87,7 +94,7 @@ For detailed information about the features, improvements, and bug fixes introdu
 
 When reporting issues, please provide the following details:
 
-- **Setup Information**: Include details as specified in the [issue template](../06-FAQs/issue_report_template.md)
+- **Setup Information**: Include details as specified in the [issue template](../07-FAQs/issue_report_template.md)
 - **Reproduction Steps**: Describe the scenario where the issue occurred, along with clear steps to reproduce it.
 - **Errors and Logs**: Share any relevant error messages or log outputs from the involved software.
 - **Additional Context**: Include any other details that might help in diagnosing the issue.

k8s/docs/02-get-started/get_started.md

@@ -178,7 +178,7 @@ Before installing the kubectl-tg plugin, make sure you meet the following requir
 > If you are using Windows, please run the commands in a WSL environment.
 > Please refer to [Windows Subsystem for Linux Documentation](https://learn.microsoft.com/en-us/windows/wsl/) for more information.
 
-Here's an example of installing the latest kubectl-tg, you can change the latest to your desired version, such as 1.6.0:
+Here's an example of installing the latest kubectl-tg, you can change the latest to your desired version, such as 1.7.1:
 
 ```bash
 wget https://dl.tigergraph.com/k8s/latest/kubectl-tg -O kubectl-tg
@@ -204,7 +204,7 @@ This step is optional and can be skipped if you have privileged permissions in y
 CustomResourceDefinitions (CRDs) are non-namespaced entities accessible across all namespaces. Installing CRDs requires privileged permissions from the Kubernetes cluster. If you prefer to install CRDs independently from the Operator installation, use the following commands:
 
 ```bash
-kubectl apply -f https://dl.tigergraph.com/k8s/latest/tg-operator-crd.yaml
+kubectl apply --server-side -f https://dl.tigergraph.com/k8s/latest/tg-operator-crd.yaml
 ```
 
 ### Install TigerGraph Operator
@@ -245,7 +245,7 @@ Examples:
   # install the operator in the specified namespace, with specified helm repo and image pull secret
   kubectl tg init --namespace tg-tenant1 --helm-repo https://yourhelmrepo.com --image-pull-secret yoursecret
   # install the operator in the specified namespace, with specified operator version, watch name namespace, cpu and memory
-  kubectl tg init --version OPERATOR_VERSION --operator-size 3 --operator-watch-namespace tigergraph --operator-cpu 1000m  --operator-memory 1024Mi --namespace tg-tenant1
+  kubectl tg init --operator-version OPERATOR_VERSION --operator-size 3 --operator-watch-namespace tigergraph --operator-cpu 1000m  --operator-memory 1024Mi --namespace tg-tenant1
 
 Usage:
   kubectl tg init [options]
@@ -377,7 +377,7 @@ You must also provide your license key with the `--license` command. Contact Tig
 - Create TigerGraph cluster with kubectl-tg plugin
 
   ```bash
-  kubectl tg create --cluster-name ${YOUR_CLUSTER_NAME} --private-key-secret ${YOUR_SSH_KEY_SECRET_NAME} --size 4 --ha 2 --version 4.2.1 --license ${LICENSE} \
+  kubectl tg create --cluster-name ${YOUR_CLUSTER_NAME} --private-key-secret ${YOUR_SSH_KEY_SECRET_NAME} --size 4 --ha 2 --version 4.2.2 --license ${LICENSE} \
   --storage-class standard --storage-size 10G --cpu 2000m --memory 6Gi --namespace ${YOUR_NAMESPACE}
   ```
 
@@ -399,7 +399,7 @@ You must also provide your license key with the `--license` command. Contact Tig
 > ```
 > Then, when creating the TigerGraph cluster, use the `--license-secret` option to set the license:
 > ```bash
-> kubectl tg create --cluster-name ${YOUR_CLUSTER_NAME} --private-key-secret ${YOUR_SSH_KEY_SECRET_NAME} --size 4 --ha 2 --version 4.2.1 \
+> kubectl tg create --cluster-name ${YOUR_CLUSTER_NAME} --private-key-secret ${YOUR_SSH_KEY_SECRET_NAME} --size 4 --ha 2 --version 4.2.2 \
 > --license-secret ${YOUR_CLUSTER_NAME}-license --storage-class standard --storage-size 10G --cpu 2000m --memory 6Gi --namespace ${YOUR_NAMESPACE}
 > ```
 
@@ -567,10 +567,10 @@ kubectl tg update --cluster-name ${YOUR_CLUSTER_NAME} --ha ${NEW_HA} --namespace
 
 Upgrading a TigerGraph cluster is supported from a lower version to a higher version.
 
-Assuming the current version of the cluster is 4.1.3, you can upgrade it to version 4.2.1 with the following command:
+Assuming the current version of the cluster is 4.1.3, you can upgrade it to version 4.2.2 with the following command:
 
 ```bash
-kubectl tg update --cluster-name ${YOUR_CLUSTER_NAME} --version 4.2.1  --namespace ${YOUR_NAMESPACE}
+kubectl tg update --cluster-name ${YOUR_CLUSTER_NAME} --version 4.2.2  --namespace ${YOUR_NAMESPACE}
 ```
 
 To ensure the successful upgrade of the TigerGraph cluster, use these commands:

k8s/docs/03-deploy/affinity-use-cases.md

@@ -121,7 +121,7 @@ metadata:
   name: test-cluster
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:
@@ -167,7 +167,7 @@ metadata:
   name: test-nodeselector
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:
@@ -235,7 +235,7 @@ metadata:
   name: test-nodeaffinity
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:
@@ -319,7 +319,7 @@ metadata:
   name: test-nodeaffinity
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:
@@ -504,7 +504,7 @@ metadata:
   name: test-cluster
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:
@@ -563,7 +563,7 @@ metadata:
   name: test-cluster
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:
@@ -638,7 +638,7 @@ metadata:
   name: test-cluster
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:
@@ -720,7 +720,7 @@ metadata:
   name: test-cluster
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:
@@ -758,7 +758,7 @@ metadata:
   name: test-toleration
 spec:
   replicas: 3
-  image: docker.io/tigergraph/tigergraph-k8s:4.2.1
+  image: docker.io/tigergraph/tigergraph-k8s:4.2.2
   imagePullPolicy: IfNotPresent
   privateKeyName: ssh-key-secret
   listener:

k8s/docs/03-deploy/configure-affinity-by-kubectl-tg.md

@@ -71,7 +71,7 @@ Then we can use following command to create a TG cluster with the rules we write
 
 ```bash
 kubectl tg create --cluster-name test-cluster --size 4 --ha 2 --namespace NAMESPACE \
-  --version 4.2.1 --storage-class standard --storage-size 10G  \
+  --version 4.2.2 --storage-class standard --storage-size 10G  \
   --private-key-secret ssh-key-secret \
   --affinity tg-affinity.yaml
 ```