Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
  • Loading branch information
AstroProfundis and yikeke authored May 23, 2019
1 parent d04d708 commit 32fa5e9
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions deploy/aws/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Deploy TiDB Operator and TiDB cluster on AWS EKS

## Requirements
This document describes how to deploy TiDB Operator and a TiDB cluster on AWS EKS with your laptop (Linux or macOS) for development or testing.

## Prerequisites

Before deploying a TiDB cluster on AWS EKS, make sure the following requirements are satisfied:
* [awscli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) >= 1.16.73, to control AWS resources

The `awscli` must be [configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) before it can interact with AWS. The fastest way is using the `aws configure` command:
Expand Down Expand Up @@ -98,15 +102,16 @@ kubectl get po -n tidb
helm ls
```

## Monitoring
## Monitor

You can access the `monitor_endpoint` address (printed in outputs) using your web browser to view monitoring metrics.

The initial Grafana login credentials are:
- User: admin
- Password: admin

# Destroy
- User: admin
- Password: admin

## Destroy

It may take some while to finish destroying the cluster.

Expand All @@ -116,13 +121,13 @@ $ terraform destroy

> **Note:** You have to manually delete the EBS volumes in AWS console after running `terraform destroy` if you do not need the data on the volumes anymore.

## Upgrade TiDB cluster
## Upgrade

To upgrade the TiDB cluster, modify the `tidb_version` variable to a higher version in the `variables.tf` file, and then run `terraform apply`.

> *Note*: The upgrading doesn't finish immediately. You can watch the upgrading process by `kubectl --kubeconfig credentials/kubeconfig_<cluster_name> get po -n tidb --watch`.
## Scale TiDB cluster
## Scale
To scale the TiDB cluster, modify the `tikv_count` or `tidb_count` variable to your desired count in the `variables.tf` file, and then run `terraform apply`.
Expand Down

0 comments on commit 32fa5e9

Please sign in to comment.