Merge branch 'master' into remove-pushgateway

Makefile

@@ -124,7 +124,7 @@ check-gosec:
 	CGO_ENABLED=0 retool do gosec $$($(PACKAGE_DIRECTORIES))
 
 cli:
-	$(GO) -ldflags '$(LDFLAGS)' -o tkc cmd/tkctl/main.go
+	$(GO) -ldflags '$(LDFLAGS)' -o tkctl cmd/tkctl/main.go
 
 debug-docker-push: debug-build-docker
 	docker push "${DOCKER_REGISTRY}/pingcap/debug-launcher:latest"

README.md

@@ -1,7 +1,7 @@
 # TiDB Operator
 
 - [**Stack Overflow**](https://stackoverflow.com/questions/tagged/tidb)
-- [**Community Slack Channel**](http://bit.ly/tidbslack)
+- [**Community Slack Channel**](https://join.slack.com/t/tidbcommunity/shared_invite/enQtNjIyNjA5Njk0NTAxLTVmZDkxOWY1ZGZhMDg3YzcwNGU0YmM4ZjIyODRhOTg4MWEwZjJmMGQzZTJlNjllMGY1YzdlNzIxZGE2NzRlMGY)
 - [**Reddit**](https://www.reddit.com/r/TiDB/)
 - **Mailing list**: [Google Group](https://groups.google.com/forum/#!forum/tidb-user)
 - [**Blog**](https://www.pingcap.com/blog/)

ci/release_cli_binary_and_debug_image.groovy

@@ -5,7 +5,7 @@ def call(BUILD_BRANCH, RELEASE_TAG) {
     env.PATH = "${env.GOROOT}/bin:${env.GOPATH}/bin:/bin:${env.PATH}:/home/jenkins/bin"
 
     def GITHASH
-    def TKC_CLI_PACKAGE = "tkc-${GOOS}-${GOARCH}-${RELEASE_TAG}"
+    def TKCTL_CLI_PACKAGE = "tkctl-${GOOS}-${GOARCH}-${RELEASE_TAG}"
 
     catchError {
         node('k8s_centos7_build') {
@@ -19,11 +19,11 @@ def call(BUILD_BRANCH, RELEASE_TAG) {
                     ["linux", "darwin", "windows"].each {
                         sh """
                         GOOS=${it} GOARCH=${GOARCH} make cli
-                        tar -zcf ${TKC_CLI_PACKAGE}.tgz tkc
-                        sha256sum ${TKC_CLI_PACKAGE}.tgz > ${TKC_CLI_PACKAGE}.sha256
-                        
-                        upload.py ${TKC_CLI_PACKAGE}.tgz ${TKC_CLI_PACKAGE}.tgz
-                        upload.py ${TKC_CLI_PACKAGE}.sha256 ${TKC_CLI_PACKAGE}.sha256
+                        tar -zcf ${TKCTL_CLI_PACKAGE}.tgz tkctl
+                        sha256sum ${TKCTL_CLI_PACKAGE}.tgz > ${TKCTL_CLI_PACKAGE}.sha256
+
+                        upload.py ${TKCTL_CLI_PACKAGE}.tgz ${TKCTL_CLI_PACKAGE}.tgz
+                        upload.py ${TKCTL_CLI_PACKAGE}.sha256 ${TKCTL_CLI_PACKAGE}.sha256
                         """
                     }
                 }
@@ -51,7 +51,7 @@ def call(BUILD_BRANCH, RELEASE_TAG) {
             slackSend channel: '#cloud_jenkins', color: 'danger', teamDomain: 'pingcap', tokenCredentialId: 'slack-pingcap-token', message: "${slackmsg}"
         } else {
             slackmsg = "${slackmsg}" + "\n" +
-                    "tkc cli tool build and debug image build failed for BRANCH:${BUILD_BRANCH} and TAG:${RELEASE_TAG}`"
+                    "tkctl cli tool build and debug image build failed for BRANCH:${BUILD_BRANCH} and TAG:${RELEASE_TAG}`"
             slackSend channel: '#cloud_jenkins', color: 'good', teamDomain: 'pingcap', tokenCredentialId: 'slack-pingcap-token', message: "${slackmsg}"
         }
     }

deploy/aws/.gitignore

@@ -0,0 +1,5 @@
+.terraform/
+credentials/
+terraform.tfstate
+terraform.tfstate.backup
+.terraform.tfstate.lock.info

deploy/aws/README.md

@@ -0,0 +1,90 @@
+# Deploy TiDB Operator and TiDB cluster on AWS EKS
+
+## Requirements:
+* [awscli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) >= 1.16.73
+* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) >= 1.11
+* [helm](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client) >= 2.9.0
+* [jq](https://stedolan.github.io/jq/download/)
+* [aws-iam-authenticator](https://github.com/kubernetes-sigs/aws-iam-authenticator#4-set-up-kubectl-to-use-authentication-tokens-provided-by-aws-iam-authenticator-for-kubernetes)
+
+## Configure awscli
+
+https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html
+
+## Setup
+
+The default setup will create a new VPC and a t2.micro instance as bastion machine. And EKS cluster with the following ec2 instance worker nodes:
+
+* 3 m5d.xlarge instances for PD
+* 3 i3.2xlarge instances for TiKV
+* 2 c4.4xlarge instances for TiDB
+* 1 c5.xlarge instance for monitor
+
+
+``` shell
+$ git clone https://github.com/pingcap/tidb-operator
+$ cd tidb-operator/cloud/aws
+$ terraform init
+$ terraform apply
+```
+
+After `terraform apply` is executed successfully, you can access the `monitor_endpoint` using your web browser.
+
+To access TiDB cluster, use the following command to first ssh into the bastion machine, and then connect it via MySQL client:
+
+``` shell
+ssh -i credentials/k8s-prod-my-cluster.pem ec2-user@<bastion_ip>
+mysql -h <tidb_dns> -P <tidb_port> -u root
+```
+
+If the DNS name is not resolvable, be patient and wait a few minutes.
+
+You can interact with the EKS cluster using `kubectl` and `helm` with the kubeconfig file `credentials/kubeconfig_<cluster_name>`. The default `cluster_name` is `my-cluster`, you can change it in the variables.tf.
+
+``` shell
+# By specifying --kubeconfig argument
+kubectl --kubeconfig credentials/kubeconfig_<cluster_name> get po -n tidb
+helm --kubeconfig credentials/kubeconfig_<cluster_name> ls
+
+# Or setting KUBECONFIG environment variable
+export KUBECONFIG=$PWD/credentials/kubeconfig_<cluster_name>
+kubectl get po -n tidb
+helm ls
+```
+
+> **NOTE:** You have to manually delete the EBS volumes after running `terraform destroy` if you don't need the data on the volumes any more.
+
+## Upgrade TiDB cluster
+
+To upgrade TiDB cluster, modify `tidb_version` variable to a higher version in variables.tf and run `terraform apply`.
+
+> *Note*: The upgrading doesn't finish immediately. You can watch the upgrading process by `watch kubectl --kubeconfig credentials/kubeconfig_<cluster_name> get po -n tidb`
+
+## Scale TiDB cluster
+
+To scale TiDB cluster, modify `tikv_count` or `tidb_count` to your desired count, and then run `terraform apply`.
+
+> *Note*: Currently, scaling in is not supported since we cannot determine which node to scale. Scaling out needs a few minutes to complete, you can watch the scaling out by `watch kubectl --kubeconfig credentials/kubeconfig_<cluster_name> get po -n tidb`
+
+## Customize
+
+### Customize AWS related resources
+
+By default, the terraform script will create a new VPC. You can use an existing VPC by setting `create_vpc` to `false` and specify your existing VPC id and subnet ids to `vpc_id` and `subnets` variables.
+
+An ec2 instance is also created by default as bastion machine to connect to the created TiDB cluster, because the TiDB service is exposed as an [Internal Elastic Load Balancer](https://aws.amazon.com/blogs/aws/internal-elastic-load-balancers/). The ec2 instance has MySQL and Sysbench pre-installed, so you can SSH into the ec2 instance and connect to TiDB using the ELB endpoint. You can disable the bastion instance creation by setting `create_bastion` to `false` if you already have an ec2 instance in the VPC.
+
+The TiDB version and component count are also configurable in variables.tf, you can customize these variables to suit your need.
+
+Currently, the instance type of TiDB cluster component is not configurable because PD and TiKV relies on [NVMe SSD instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html), different instance types have different disks.
+
+### Customize TiDB parameters
+
+Currently, there are not much parameters exposed to be customizable. If you need to customize these, you should modify the `templates/tidb-cluster-values.yaml.tpl` files before deploying. Or if you modify it and run `terraform apply` again after the cluster is running, it will not take effect unless you manually delete the pod via `kubectl delete po -n tidb --all`. This will be resolved when issue [#255](https://github.com/pingcap/tidb-operator/issues/225) is fixed.
+
+## TODO
+
+- [ ] Use [cluster autoscaler](https://github.com/kubernetes/autoscaler)
+- [ ] Allow create a minimal TiDB cluster for testing
+- [ ] Make the resource creation synchronously to follow Terraform convention
+- [ ] Make more parameters customizable

deploy/aws/bastion-userdata

@@ -0,0 +1,6 @@
+#cloud-config
+packages:
+- mysql
+runcmd:
+- curl -s https://packagecloud.io/install/repositories/akopytov/sysbench/script.rpm.sh | bash
+- yum -y install sysbench

deploy/aws/charts/tidb-cluster

@@ -0,0 +1 @@
+../../../charts/tidb-cluster

deploy/aws/charts/tidb-operator

@@ -0,0 +1 @@
+../../../charts/tidb-operator

deploy/aws/data.tf

@@ -0,0 +1,52 @@
+data "aws_availability_zones" "available" {}
+
+data "aws_ami" "amazon-linux-2" {
+ most_recent = true
+
+ owners = ["amazon"]
+
+ filter {
+   name   = "name"
+   values = ["amzn2-ami-hvm-*-x86_64-gp2"]
+ }
+}
+
+data "template_file" "tidb_cluster_values" {
+  template = "${file("${path.module}/templates/tidb-cluster-values.yaml.tpl")}"
+  vars  {
+    cluster_version = "${var.tidb_version}"
+    pd_replicas = "${var.pd_count}"
+    tikv_replicas = "${var.tikv_count}"
+    tidb_replicas = "${var.tidb_count}"
+  }
+}
+
+# kubernetes provider can't use computed config_path right now, see issue:
+# https://github.com/terraform-providers/terraform-provider-kubernetes/issues/142
+# so we don't use kubernetes provider to retrieve tidb and monitor connection info,
+# instead we use external data source.
+# data "kubernetes_service" "tidb" {
+#   depends_on = ["helm_release.tidb-cluster"]
+#   metadata {
+#     name = "tidb-cluster-tidb"
+#     namespace = "tidb"
+#   }
+# }
+
+# data "kubernetes_service" "monitor" {
+#   depends_on = ["helm_release.tidb-cluster"]
+#   metadata {
+#     name = "tidb-cluster-grafana"
+#     namespace = "tidb"
+#   }
+# }
+
+data "external" "tidb_service" {
+  depends_on = ["null_resource.wait-tidb-ready"]
+  program = ["bash", "-c", "kubectl --kubeconfig credentials/kubeconfig_${var.cluster_name} get svc -n tidb tidb-cluster-tidb -ojson | jq '.status.loadBalancer.ingress[0]'"]
+}
+
+data "external" "monitor_service" {
+  depends_on = ["null_resource.wait-tidb-ready"]
+  program = ["bash", "-c", "kubectl --kubeconfig credentials/kubeconfig_${var.cluster_name} get svc -n tidb tidb-cluster-grafana -ojson | jq '.status.loadBalancer.ingress[0]'"]
+}