Skip to content
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.

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

DOC-2367 fix(doc): Update doc for AdminPortal; #64

Open
wants to merge 2 commits into
base: 3.11
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion modules/admin-portal/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
*** xref:monitoring/queries.adoc[]
*** xref:monitoring/log-viewer.adoc[]
** xref:management/README.adoc[]
*** xref:management/license.adoc[]
*** xref:management/user-management.adoc[]
*** xref:management/upgrade.adoc[]
*** xref:management/license.adoc[]
// *** xref:management/healthcheck.adoc[]
*** xref:components/README.adoc[]
**** xref:components/gpe.adoc[]
**** xref:components/gsql.adoc[]
Expand Down
43 changes: 43 additions & 0 deletions modules/admin-portal/pages/management/healthcheck.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
= Health Check
:experimental:

The Health Check tool in TigerGraph AdminPortal is designed to help you monitor and maintain the health of your TigerGraph database. By running health checks regularly, you can ensure optimal performance and stability for your database. This tool not only identifies potential issues but also provides recommendations for resolving them.

[CAUTION]
====
The Health Check tool is in preview mode and is not yet fully supported. Please use it with caution and report any issues to TigerGraph Support.
====

== Running a Health Check

=== Step 1: Access the Health Check Tool

1. Navigate to the `Health Check` page from the AdminPortal navigation menu.

2. Click the `Health-Check` button and select relevant categories to start the health check process.

+
[NOTE]
====
Some categories only apply to specific versions of TigerGraph. If a category is not applicable to your version, it will be disabled.
====

3. View Health Check Results:
- Once the health check is complete, the results will be displayed.
- The tool will provide a detailed report of the health status of your TigerGraph database.

4. Follow Recommendations:
- Review the recommendations provided by the tool for resolving any issues found.
- Implement the suggested actions to maintain or improve the health of your database.


== Benefits of Regular Health Checks

- **Performance Optimization:**
Regular health checks help identify performance bottlenecks and provide insights for optimization.

- **Stability Assurance:**
By addressing potential issues proactively, you ensure the stability and reliability of your TigerGraph database.

- **Preventive Maintenance:**
Health checks act as preventive maintenance, helping you avoid unexpected downtimes and data issues.
52 changes: 52 additions & 0 deletions modules/admin-portal/pages/management/upgrade.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
= Upgrade TigerGraph Suite
:experimental:

AdminPortal provides a convenient way to upgrade your entire TigerGraph Suite, including GraphStudio, Insights, AdminPortal, GSQL Shell, and GraphQL, without the need to re-install TigerGraph. You can choose between a manual upgrade or an online check for upgrade. This guide will walk you through both options.

[NOTE]
====
This feature only aviailable for non-TigerGraph Cloud deployments.
====

== Manual Upgrade

The manual upgrade option allows you to perform a manual installation by uploading a downloaded TigerGraph Suite package.

=== Steps for Manual Upgrade:

1. **Download the TigerGraph Suite Package:**
- Visit https://dl.tigergraph.com[TigerGraph Download Page], select the `Tools` tab and download the latest TigerGraph Suite package.
+
[NOTE]
====
Make sure to download the correct package for your TigerGraph Server version.
====

2. **Initiate Manual Upgrade:**
- In the AdminPortal, navigate to the upgrade page.
- Click the btn:[Manual Upgrade] button.
- An input file dialog will appear. Select the downloaded tools package from your local machine.

3. **Upload and Install:**
- The system will upload the package and start the upgrade process.
- Follow the on-screen instructions to complete the installation.

== Online Upgrade

The online check for upgrade option allows you to automatically check if there is a newer TigerGraph Suite version available and upgrade to it.

[NOTE]
====
Active internet connection is required for online upgrade.
====

=== Steps for Online Upgrade:

1. **Initiate Online Check:**
- In the AdminPortal, navigate to the upgrade page.
- Click the btn:[Online Check for Upgrade] button.

2. **Automatic Check and Upgrade:**
- The system will automatically check for the latest TigerGraph Suite version.
- If a newer version is available, the system will download and install the upgrade.
- Follow the on-screen instructions to complete the upgrade process.
3 changes: 0 additions & 3 deletions modules/graphstudio/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@
*** xref:explore-graph/find-paths-between-vertices.adoc[]
*** xref:explore-graph/run-gsql-queries.adoc[]
*** xref:explore-graph/augment-visualization-result.adoc[]
** Build Graph Patterns (Deprecated)
*** xref:build-graph-patterns/visual-query-builder-overview.adoc[]
*** xref:build-graph-patterns/visual-pattern-examples.adoc[]
** xref:write-queries.adoc[]
** xref:write-open-cypher-queries-in-tigergraph.adoc[]
** xref:actions.adoc[]
Expand Down
1 change: 0 additions & 1 deletion modules/graphstudio/pages/build-graph-patterns/README.adoc

This file was deleted.

Loading