From 95288d79fb44c10a63e97919e9e562af417d9ed1 Mon Sep 17 00:00:00 2001 From: Shail Pujan <114280481+shailpujan88@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:23:22 +0530 Subject: [PATCH] Add VTAdmin section under Concepts: Overview, features, and workflow. (#1856) * Add VTAdmin section under Concepts: Overview, features, and workflow diagram Signed-off-by: Shail Pujan * Add VTAdmin section under Concepts: Overview, features, and workflow diagram Signed-off-by: Shail Pujan * add details on VTAdmin integration with Vitess components and binary roles Signed-off-by: Shail Pujan * Update VTAdmin docs with headings, links, and emphasis on functionality Signed-off-by: Shail Pujan * Improved the flow of docs,improve hoe vtadmin works and remove the repeated content Signed-off-by: Shail Pujan * Make changes as per suggestions and Add links for VTExplain, VTCtld, VReplication, and Move Tables in VTAdmin section. Signed-off-by: Shail Pujan * Update documentation links in VTAdmin section to use relative paths for VTExplain, VTCtld, VReplication, Move Tables and changes mage as suggested Signed-off-by: Shail Pujan * Remove the concept link form the local install and mac install and remove whitespaces Signed-off-by: Shail Pujan * Changes made in links and link the vtadmin concept page Signed-off-by: Shail Pujan * Removed the repeated and incorrect lines and made changes in link Signed-off-by: Shail Pujan --------- Signed-off-by: Shail Pujan --- content/en/docs/21.0/concepts/vtadmin.md | 24 +++++++++++++++++++ content/en/docs/21.0/get-started/local-mac.md | 2 +- content/en/docs/21.0/get-started/local.md | 3 +-- content/en/docs/21.0/get-started/operator.md | 2 +- 4 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 content/en/docs/21.0/concepts/vtadmin.md diff --git a/content/en/docs/21.0/concepts/vtadmin.md b/content/en/docs/21.0/concepts/vtadmin.md new file mode 100644 index 000000000..b2c2b8368 --- /dev/null +++ b/content/en/docs/21.0/concepts/vtadmin.md @@ -0,0 +1,24 @@ +--- +title: VTAdmin +--- + +## VTAdmin +VTAdmin is a component in Vitess that serves as a centralized management and administration tool for Vitess clusters. + +## Purpose +VTAdmin provides a unified interface for database administrators to monitor, manage, and maintain Vitess deployments. + +## Key Features + +* Cluster Visualization: Offers a visual representation of the Vitess cluster topology. +* Monitoring: Provides real-time insights into cluster performance and health. +* Schema Management: Allows viewing Schema and [VSchema](../../reference/features/vschema). + +## How VTAdmin Works +VTAdmin is a centralized, web-based interface that simplifies the management and monitoring of Vitess clusters by integrating closely with [VTCtld](../../reference/programs/vtctld) instances. It provides a unified view of keyspaces, shards, and tablets, enabling administrators to monitor tablet health, manage multiple clusters, and control [VReplication](../../reference/vreplication "VReplication Documentation") workflows such as [Reshard](../../reference/vreplication/reshard/) and [MoveTables](../../reference/vreplication/movetables/). The interface includes query execution tools for performance analysis and debugging, featuring the embedded [VTExplain](../../reference/programs/vtexplain) tool to help users optimize SQL queries and understand execution plans. VTAdmin helps users and operators by facilitating efficient operations and effective management of distributed Vitess environments. + +For more information about VTAdmin, please refer to the following links: + +* [VTAdmin Intro Blog Post](/blog/2022-12-05-vtadmin-intro/) + +* [VTAdmin Documentation](../../../21.0/reference/vtadmin/) diff --git a/content/en/docs/21.0/get-started/local-mac.md b/content/en/docs/21.0/get-started/local-mac.md index 38a300c83..a8fe70da5 100644 --- a/content/en/docs/21.0/get-started/local-mac.md +++ b/content/en/docs/21.0/get-started/local-mac.md @@ -247,7 +247,7 @@ $ mysql -P 15306 -u root --protocol tcp
-You can also now browse and administer your new Vitess cluster using the [VTAdmin](../../reference/vtadmin/) UI at the following URL: +You can also now browse and administer your new Vitess cluster using the [VTAdmin](../../concepts/vtadmin) UI at the following URL: ```text http://localhost:14201 diff --git a/content/en/docs/21.0/get-started/local.md b/content/en/docs/21.0/get-started/local.md index 5e1f247a1..bfa014987 100644 --- a/content/en/docs/21.0/get-started/local.md +++ b/content/en/docs/21.0/get-started/local.md @@ -59,7 +59,6 @@ nvm use 18 ``` See the [vtadmin README](https://github.com/vitessio/vitess/blob/main/web/vtadmin/README.md) for more details. - ## Disable AppArmor or SELinux AppArmor/SELinux will not allow Vitess to launch MySQL in any data directory by default. You will need to disable it: @@ -289,7 +288,7 @@ mysql> show tables;
-You can also now browse and administer your new Vitess cluster using the [VTAdmin](../../reference/vtadmin/) UI at the following URL: +You can also now browse and administer your new Vitess cluster using the [VTAdmin](../../concepts/vtadmin) UI at the following URL: ```text http://localhost:14201 diff --git a/content/en/docs/21.0/get-started/operator.md b/content/en/docs/21.0/get-started/operator.md index 63bc1d043..f3e5839b6 100644 --- a/content/en/docs/21.0/get-started/operator.md +++ b/content/en/docs/21.0/get-started/operator.md @@ -87,7 +87,7 @@ alias mysql="mysql -h 127.0.0.1 -P 15306 -u user" Setting up aliases changes `mysql` to always connect to Vitess for your current session. To revert this, type `unalias mysql && unalias vtctldclient` or close your session. -Once the port-forward starts running, the VTAdmin UI will be available at [http://localhost:14000/](http://localhost:14000/) +Once the port-forward starts running, the [VTAdmin](../../concepts/vtadmin) UI will be available at [http://localhost:14000/](http://localhost:14000/) ## Create Schema