Skip to content

Publish the user documentation for Operator version 1.7.0; #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jerryyangtg wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Publish the user documentation for Operator version 1.7.0; #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
abce194
Publish the user documentation for Operator version 1.7.0;
jerryyangtg Sep 22, 2025
00028c6
Update the user documentation for TigerGraph upgrades and Operator up…
jerryyangtg Sep 26, 2025
48a92d6
Fix the incorrect storageclass in the deployment doc for aks and eks;
jerryyangtg Oct 11, 2025
9fe0af3
Add detailed user documentation for scale-in and scale-out operations;
jerryyangtg Oct 28, 2025
c00ba65
Fix the YAML formatting issue;
jerryyangtg Oct 30, 2025
51c2a0f
Update some minor issues in operator docs;
jerryyangtg Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion k8s/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.1|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.2|1.25, 1.26, 1.27, 1.28, 1.29|
Expand Down Expand Up @@ -68,9 +69,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:

Expand All @@ -86,7 +92,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.
Expand Down
8 changes: 7 additions & 1 deletion k8s/docs/01-introduction/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.1|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.2|1.25, 1.26, 1.27, 1.28, 1.29|
Expand Down Expand Up @@ -69,9 +70,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:

Expand All @@ -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](../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.
Expand Down
6 changes: 3 additions & 3 deletions k8s/docs/02-get-started/get_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 0.0.9:

```bash
wget https://dl.tigergraph.com/k8s/latest/kubectl-tg -O kubectl-tg
Expand All @@ -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
Expand Down Expand Up @@ -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]
Expand Down
Loading
Loading