Skip to content

Commit

Permalink
Add VTAdmin section under Concepts: Overview, features, and workflow. (
Browse files Browse the repository at this point in the history
…#1856)

* Add VTAdmin section under Concepts: Overview, features, and workflow diagram

Signed-off-by: Shail Pujan <[email protected]>

* Add VTAdmin section under Concepts: Overview, features, and workflow diagram

Signed-off-by: Shail Pujan <[email protected]>

* add details on VTAdmin integration with Vitess components and binary roles

Signed-off-by: Shail Pujan <[email protected]>

* Update VTAdmin docs with headings, links, and emphasis on functionality

Signed-off-by: Shail Pujan <[email protected]>

* Improved the flow of docs,improve hoe vtadmin works and remove the repeated content

Signed-off-by: Shail Pujan <[email protected]>

* Make changes as per suggestions and Add links for VTExplain, VTCtld, VReplication, and Move Tables in VTAdmin section.

Signed-off-by: Shail Pujan <[email protected]>

* 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 <[email protected]>

* Remove the concept link form the local install and mac install and remove whitespaces

Signed-off-by: Shail Pujan <[email protected]>

* Changes made in links and link the vtadmin concept page

Signed-off-by: Shail Pujan <[email protected]>

* Removed the repeated and incorrect lines and made changes in link

Signed-off-by: Shail Pujan <[email protected]>

---------

Signed-off-by: Shail Pujan <[email protected]>
  • Loading branch information
shailpujan88 authored Oct 16, 2024
1 parent b5d05de commit 95288d7
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 4 deletions.
24 changes: 24 additions & 0 deletions content/en/docs/21.0/concepts/vtadmin.md
Original file line number Diff line number Diff line change
@@ -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/)
2 changes: 1 addition & 1 deletion content/en/docs/21.0/get-started/local-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ $ mysql -P 15306 -u root --protocol tcp

</br>

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
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/21.0/get-started/local.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -289,7 +288,7 @@ mysql> show tables;

</br>

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
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/21.0/get-started/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 95288d7

Please sign in to comment.