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.

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

en: Update info on EKS and dashboard access (#1212) #1225

Merged
merged 6 commits into from
May 28, 2021
Merged

en: Update info on EKS and dashboard access (#1212) #1225

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
cdbb33b
Update info on EKS and dashboard access
dveeden May 17, 2021
8ec4972
Update en/access-dashboard.md
dveeden May 20, 2021
af837ec
Update en/access-dashboard.md
dveeden May 20, 2021
649b302
Update en/deploy-on-aws-eks.md
dveeden May 20, 2021
aa92a79
Move note about loadbalancer scheme
dveeden May 20, 2021
ffa4962
Update en/deploy-on-aws-eks.md
dveeden May 24, 2021
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: 6 additions & 2 deletions en/access-dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ aliases: ['/docs/tidb-in-kubernetes/stable/access-dashboard/','/docs/tidb-in-kub

# Access TiDB Dashboard

TiDB Dashboard is a visualized tool in TiDB 4.0 used to monitor and diagnose the TiDB cluster. For details, see [TiDB Dashboard](https://docs.pingcap.com/tidb/stable/dashboard-intro).
> **Warning:**
>
> The TiDB Dashboard is available in the `/dashboard` path of the PD. Other paths outside of this may not have access control.

TiDB Dashboard is a visualized tool introduced starting from TiDB 4.0 and is used to monitor and diagnose TiDB clusters. For details, see [TiDB Dashboard](https://docs.pingcap.com/tidb/stable/dashboard-intro).

This document describes how to access TiDB Dashboard in Kubernetes.

Expand All @@ -30,7 +34,7 @@ spec:
enableDashboardInternalProxy: true
```

## Quick start
## Access TiDB Dashboard by port forward

> **Warning:**
>
Expand Down
10 changes: 9 additions & 1 deletion en/deploy-on-aws-eks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,10 @@ curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/

Refer to [configure the TiDB cluster](configure-a-tidb-cluster.md) to further customize and configure the CR before applying.

> **Note:**
>
> By default, the configuration in `tidb-cluster.yaml` sets up the LoadBalancer for TiDB with the "internal" scheme. This means that the LoadBalancer is only accessible within the VPC, not externally. To access TiDB over the MySQL protocol, you need to use a bastion host or use `kubectl port-forward`. If you want to expose TiDB over the internet and if you are aware of the risks of doing this, you can change the scheme for the LoadBalancer from "internal" to "internet-facing" in the `tidb-cluster.yaml` file.

To deploy the `TidbCluster` and `TidbMonitor` CR in the EKS cluster, run the following command:

{{< copyable "shell-regular" >}}
Expand Down Expand Up @@ -301,7 +305,7 @@ After the bastion host is created, you can connect to the bastion host via SSH a
> * [The default authentication plugin of MySQL 8.0](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_default_authentication_plugin) is updated from `mysql_native_password` to `caching_sha2_password`. Therefore, if you use MySQL client from MySQL 8.0 to access the TiDB service (cluster version < v4.0.7), and if the user account has a password, you need to explicitly specify the `--default-auth=mysql_native_password` parameter.
> * By default, TiDB (starting from v4.0.2) periodically shares usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](https://docs.pingcap.com/tidb/stable/telemetry).

### Access the Grafana monitoring dashboard
## Access the Grafana monitoring dashboard

Obtain the LoadBalancer domain name of Grafana:

Expand All @@ -327,6 +331,10 @@ You can access the `${grafana-lb}:3000` address using your web browser to view m
>
> The default Grafana username and password are both `admin`.

## Access the TiDB Dashboard

See [Access TiDB Dashboard](access-dashboard.md) for instructions about how to securely allow access to the TiDB Dashboard.

## Upgrade

To upgrade the TiDB cluster, edit the `spec.version` by executing `kubectl edit tc basic -n tidb-cluster`.
Expand Down