Skip to content

Commit 248e6fa

Browse files
authored
Merge pull request #264 from tigergraph/k8s-operator/1.7.0
Publish the user documentation for Operator version 1.7.0 & 1.7.1;
2 parents f833385 + c31ba7d commit 248e6fa

83 files changed

Lines changed: 10672 additions & 857 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

k8s/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Understanding the intricate synergy between TigerGraph, TigerGraph Operator, and
1515

1616
| TigerGraph Operator version | TigerGraph version | Kubernetes version |
1717
|----------|----------|----------|
18+
| 1.7.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.3.0|1.27, 1.28, 1.29, 1.30, 1.31|
1819
| 1.6.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.2.2|1.27, 1.28, 1.29, 1.30, 1.31|
1920
| 1.5.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.2.0|1.26, 1.27, 1.28, 1.29, 1.30|
2021
| 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
6970
- [Configure Cross-Region Replication on Kubernetes](docs/03-deploy/configure-crr-on-k8s.md)
7071
- [Upgrade the TigerGraph Cluster Using the TigerGraph Operator](docs/04-manage/tigergraph-upgrade.md)
7172
- [Enable TigerGraph Operator monitoring with Prometheus and Grafana](docs/05-monitor/tigergraph-monitor-with-prometheus-grafana.md)
73+
- [TigerGraph Metrics Reference](docs/05-monitor/tigergraph-metrics-reference.md)
7274
- [Customize the backoff retries for cluster job operations](docs/04-manage/backoff-retries-for-cluster-job-operations.md)
7375
- [Node Repaving for TigerGraph on Kubernetes](docs/08-reference/node-repaving-for-tigergraph-on-k8s.md)
7476
- [Configure SSL Certificate for Ingress Service](docs/03-deploy/configure-ssl-certificate-for-ingress-service.md)
77+
- [Running Custom Bash Scripts in a TigerGraph Cluster via Kubernetes Jobs](docs/04-manage/running-custom-bash-scripts-via-kubernetes-jobs.md)
78+
- [Configure Nginx TLS](docs/03-deploy/configure-nginx-tls.md)
79+
- [Scale Up and Scale Down](docs/04-manage/scale-up-and-down.md)
80+
- [Scale In and Scale Out](docs/04-manage/scale-in-and-out.md)
7581

7682
In case issues arise and your cluster requires diagnosis, you have two valuable resources:
7783

@@ -87,7 +93,7 @@ For detailed information about the features, improvements, and bug fixes introdu
8793

8894
When reporting issues, please provide the following details:
8995

90-
- **Setup Information**: Include details as specified in the [issue template](../06-FAQs/issue_report_template.md)
96+
- **Setup Information**: Include details as specified in the [issue template](docs/07-FAQs/issue_report_template.md)
9197
- **Reproduction Steps**: Describe the scenario where the issue occurred, along with clear steps to reproduce it.
9298
- **Errors and Logs**: Share any relevant error messages or log outputs from the involved software.
9399
- **Additional Context**: Include any other details that might help in diagnosing the issue.

k8s/docs/01-introduction/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ TigerGraph Operator stands as an automated operations system meticulously design
1313
1414
Understanding the intricate synergy between TigerGraph, TigerGraph Operator, and Kubernetes versions is pivotal. This relationship is as follows:
1515

16-
| TigerGraph Operator version | TigerGraph version | Kubernetes version |
16+
| TigerGraph Operator version | TigerGraph version | Kubernetes Validated version |
1717
|----------|----------|----------|
18+
| 1.7.1 | TigerGraph >= 3.6.0 && TigerGraph <= 4.3.0|1.30, 1.31, 1.32, 1.33, 1.34|
19+
| 1.7.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.3.0|1.27, 1.28, 1.29, 1.30, 1.31|
1820
| 1.6.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.2.2|1.27, 1.28, 1.29, 1.30, 1.31|
1921
| 1.5.0 | TigerGraph >= 3.6.0 && TigerGraph <= 4.2.0|1.26, 1.27, 1.28, 1.29, 1.30|
2022
| 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
6971
- [Configure Cross-Region Replication on Kubernetes](../03-deploy/configure-crr-on-k8s.md)
7072
- [Upgrade the TigerGraph Cluster Using the TigerGraph Operator](../04-manage/tigergraph-upgrade.md)
7173
- [Enable TigerGraph Operator monitoring with Prometheus and Grafana](../05-monitor/tigergraph-monitor-with-prometheus-grafana.md)
74+
- [TigerGraph Metrics Reference](../05-monitor/tigergraph-metrics-reference.md)
7275
- [Customize the backoff retries for cluster job operations](../04-manage/backoff-retries-for-cluster-job-operations.md)
7376
- [Node Repaving for TigerGraph on Kubernetes](../08-reference/node-repaving-for-tigergraph-on-k8s.md)
7477
- [Configure SSL Certificate for Ingress Service](../03-deploy/configure-ssl-certificate-for-ingress-service.md)
78+
- [Running Custom Bash Scripts in a TigerGraph Cluster via Kubernetes Jobs](../04-manage/running-custom-bash-scripts-via-kubernetes-jobs.md)
79+
- [Configure Nginx TLS](../03-deploy/configure-nginx-tls.md)
80+
- [Scale Up and Scale Down](../04-manage/scale-up-and-down.md)
81+
- [Scale In and Scale Out](../04-manage/scale-in-and-out.md)
7582

7683
In case issues arise and your cluster requires diagnosis, you have two valuable resources:
7784

@@ -87,7 +94,7 @@ For detailed information about the features, improvements, and bug fixes introdu
8794

8895
When reporting issues, please provide the following details:
8996

90-
- **Setup Information**: Include details as specified in the [issue template](../06-FAQs/issue_report_template.md)
97+
- **Setup Information**: Include details as specified in the [issue template](../07-FAQs/issue_report_template.md)
9198
- **Reproduction Steps**: Describe the scenario where the issue occurred, along with clear steps to reproduce it.
9299
- **Errors and Logs**: Share any relevant error messages or log outputs from the involved software.
93100
- **Additional Context**: Include any other details that might help in diagnosing the issue.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ Before installing the kubectl-tg plugin, make sure you meet the following requir
178178
> If you are using Windows, please run the commands in a WSL environment.
179179
> Please refer to [Windows Subsystem for Linux Documentation](https://learn.microsoft.com/en-us/windows/wsl/) for more information.
180180
181-
Here's an example of installing the latest kubectl-tg, you can change the latest to your desired version, such as 1.6.0:
181+
Here's an example of installing the latest kubectl-tg, you can change the latest to your desired version, such as 1.7.1:
182182

183183
```bash
184184
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
204204
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:
205205

206206
```bash
207-
kubectl apply -f https://dl.tigergraph.com/k8s/latest/tg-operator-crd.yaml
207+
kubectl apply --server-side -f https://dl.tigergraph.com/k8s/latest/tg-operator-crd.yaml
208208
```
209209

210210
### Install TigerGraph Operator
@@ -245,7 +245,7 @@ Examples:
245245
# install the operator in the specified namespace, with specified helm repo and image pull secret
246246
kubectl tg init --namespace tg-tenant1 --helm-repo https://yourhelmrepo.com --image-pull-secret yoursecret
247247
# install the operator in the specified namespace, with specified operator version, watch name namespace, cpu and memory
248-
kubectl tg init --version OPERATOR_VERSION --operator-size 3 --operator-watch-namespace tigergraph --operator-cpu 1000m --operator-memory 1024Mi --namespace tg-tenant1
248+
kubectl tg init --operator-version OPERATOR_VERSION --operator-size 3 --operator-watch-namespace tigergraph --operator-cpu 1000m --operator-memory 1024Mi --namespace tg-tenant1
249249

250250
Usage:
251251
kubectl tg init [options]
@@ -377,7 +377,7 @@ You must also provide your license key with the `--license` command. Contact Tig
377377
- Create TigerGraph cluster with kubectl-tg plugin
378378

379379
```bash
380-
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} \
380+
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} \
381381
--storage-class standard --storage-size 10G --cpu 2000m --memory 6Gi --namespace ${YOUR_NAMESPACE}
382382
```
383383

@@ -399,7 +399,7 @@ You must also provide your license key with the `--license` command. Contact Tig
399399
> ```
400400
> Then, when creating the TigerGraph cluster, use the `--license-secret` option to set the license:
401401
> ```bash
402-
> kubectl tg create --cluster-name ${YOUR_CLUSTER_NAME} --private-key-secret ${YOUR_SSH_KEY_SECRET_NAME} --size 4 --ha 2 --version 4.2.1 \
402+
> kubectl tg create --cluster-name ${YOUR_CLUSTER_NAME} --private-key-secret ${YOUR_SSH_KEY_SECRET_NAME} --size 4 --ha 2 --version 4.2.2 \
403403
> --license-secret ${YOUR_CLUSTER_NAME}-license --storage-class standard --storage-size 10G --cpu 2000m --memory 6Gi --namespace ${YOUR_NAMESPACE}
404404
> ```
405405

@@ -567,10 +567,10 @@ kubectl tg update --cluster-name ${YOUR_CLUSTER_NAME} --ha ${NEW_HA} --namespace
567567

568568
Upgrading a TigerGraph cluster is supported from a lower version to a higher version.
569569

570-
Assuming the current version of the cluster is 4.1.3, you can upgrade it to version 4.2.1 with the following command:
570+
Assuming the current version of the cluster is 4.1.3, you can upgrade it to version 4.2.2 with the following command:
571571

572572
```bash
573-
kubectl tg update --cluster-name ${YOUR_CLUSTER_NAME} --version 4.2.1 --namespace ${YOUR_NAMESPACE}
573+
kubectl tg update --cluster-name ${YOUR_CLUSTER_NAME} --version 4.2.2 --namespace ${YOUR_NAMESPACE}
574574
```
575575

576576
To ensure the successful upgrade of the TigerGraph cluster, use these commands:

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ metadata:
121121
name: test-cluster
122122
spec:
123123
replicas: 3
124-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
124+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
125125
imagePullPolicy: IfNotPresent
126126
privateKeyName: ssh-key-secret
127127
listener:
@@ -167,7 +167,7 @@ metadata:
167167
name: test-nodeselector
168168
spec:
169169
replicas: 3
170-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
170+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
171171
imagePullPolicy: IfNotPresent
172172
privateKeyName: ssh-key-secret
173173
listener:
@@ -235,7 +235,7 @@ metadata:
235235
name: test-nodeaffinity
236236
spec:
237237
replicas: 3
238-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
238+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
239239
imagePullPolicy: IfNotPresent
240240
privateKeyName: ssh-key-secret
241241
listener:
@@ -319,7 +319,7 @@ metadata:
319319
name: test-nodeaffinity
320320
spec:
321321
replicas: 3
322-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
322+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
323323
imagePullPolicy: IfNotPresent
324324
privateKeyName: ssh-key-secret
325325
listener:
@@ -504,7 +504,7 @@ metadata:
504504
name: test-cluster
505505
spec:
506506
replicas: 3
507-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
507+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
508508
imagePullPolicy: IfNotPresent
509509
privateKeyName: ssh-key-secret
510510
listener:
@@ -563,7 +563,7 @@ metadata:
563563
name: test-cluster
564564
spec:
565565
replicas: 3
566-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
566+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
567567
imagePullPolicy: IfNotPresent
568568
privateKeyName: ssh-key-secret
569569
listener:
@@ -638,7 +638,7 @@ metadata:
638638
name: test-cluster
639639
spec:
640640
replicas: 3
641-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
641+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
642642
imagePullPolicy: IfNotPresent
643643
privateKeyName: ssh-key-secret
644644
listener:
@@ -720,7 +720,7 @@ metadata:
720720
name: test-cluster
721721
spec:
722722
replicas: 3
723-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
723+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
724724
imagePullPolicy: IfNotPresent
725725
privateKeyName: ssh-key-secret
726726
listener:
@@ -758,7 +758,7 @@ metadata:
758758
name: test-toleration
759759
spec:
760760
replicas: 3
761-
image: docker.io/tigergraph/tigergraph-k8s:4.2.1
761+
image: docker.io/tigergraph/tigergraph-k8s:4.2.2
762762
imagePullPolicy: IfNotPresent
763763
privateKeyName: ssh-key-secret
764764
listener:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Then we can use following command to create a TG cluster with the rules we write
7171

7272
```bash
7373
kubectl tg create --cluster-name test-cluster --size 4 --ha 2 --namespace NAMESPACE \
74-
--version 4.2.1 --storage-class standard --storage-size 10G \
74+
--version 4.2.2 --storage-class standard --storage-size 10G \
7575
--private-key-secret ssh-key-secret \
7676
--affinity tg-affinity.yaml
7777
```

0 commit comments

Comments
 (0)