TiDB Operator is written in Go. If you don't have a Go development environment, set one up.
The version of Go should be 1.13 or later.
After Go is installed, you need to define GOPATH
and modify PATH
modified to access your Go binaries.
You can configure them as follows, or you can Google a setup as you like.
$ export GOPATH=$HOME/go
$ export PATH=$PATH:$GOPATH/bin
- visit https://github.com/pingcap/tidb-operator
- Click
Fork
button (top right) to establish a cloud-based fork.
Per Go's workspace instructions, place TiDB Operator code on your
GOPATH
using the following cloning procedure.
Define a local working directory:
$ working_dir=$GOPATH/src/github.com/pingcap
Set user
to match your github profile name:
$ user={your github profile name}
Create your clone:
$ mkdir -p $working_dir
$ cd $working_dir
$ git clone [email protected]:$user/tidb-operator.git
Set your clone to track upstream repository.
$ cd $working_dir/tidb-operator
$ git remote add upstream https://github.com/pingcap/tidb-operator
Since you don't have write access to the upstream repository, you need to disable pushing to upstream master:
$ git remote set-url --push upstream no_push
$ git remote -v
The output should look like:
origin [email protected]:$(user)/tidb-operator.git (fetch)
origin [email protected]:$(user)/tidb-operator.git (push)
upstream https://github.com/pingcap/tidb-operator (fetch)
upstream no_push (push)
Get your local master up to date:
$ cd $working_dir/tidb-operator
$ git fetch upstream
$ git checkout master
$ git rebase upstream/master
Branch from master:
$ git checkout -b myfeature
You can now edit the code on the myfeature
branch.
Run following commands to check your code change.
$ make check
This will show errors if your code change does not pass checks (e.g. fmt, lint). Please fix them before submitting the PR.
If you change code related to CRD, such as type definitions in pkg/apis/pingcap/v1alpha1/types.go
,
please also run following commands to generate necessary code and artifacts.
$ hack/update-all.sh
We uses kind to start a Kubernetes cluster locally and kubectl must be installed to access Kubernetes cluster.
You can refer to their official references to install them on your machine, or
run the following command to install them into our local binary directory:
output/bin
.
$ hack/local-up-operator.sh -i
$ export PATH=$(pwd)/output/bin:$PATH
Make sure they are installed correctly:
$ kind --version
...
$ kubectl version --client
...
Create a Kubernetes cluster with kind
:
$ kind create cluster
Build and run tidb-operator:
$ ./hack/local-up-operator.sh
Start a basic TiDB cluster:
$ kubectl apply -f examples/basic/tidb-cluster.yaml
Before running your code in a real Kubernetes cluster, make sure it passes all unit tests.
$ make test
At first, you must have Docker installed and running.
Now you can run the following command to run all e2e test.
$ ./hack/e2e.sh
NOTE: We don't support bash version < 4 for now. For those who are using a not supported version of bash, especially macOS (which default bash version is 3.2)
users, please run hack/run-in-container.sh
to start a containerized environment or install bash 4+ manually.
It's possible to limit specs to run, for example:
$ ./hack/e2e.sh -- --ginkgo.focus='Basic'
Run the following command to see help:
$ ./hack/e2e.sh -h
NOTE: hack/run-in-container.sh
can start a dev container the same as our CI
environment. This is recommended way to run e2e tests, e.g.
$ ./hack/run-in-container.sh # starts an interactive shell
(tidb-operator-dev) $ <run your commands>
You can start more than one terminals and run ./hack/run-in-container.sh
to
enter into the same container for debugging. Run ./hack/run-in-container.sh -h
to see help.
While on your myfeature
branch, run the following commands:
$ git fetch upstream
$ git rebase upstream/master
Before you commit, make sure that all the checks and unit tests are passed:
$ make check
$ make test
Then commit your changes.
$ git commit
Likely you'll go back and edit/build/test some more than commit --amend
in a few cycles.
When your commit is ready for review (or just to establish an offsite backup of your work),
push your branch to your fork on github.com
:
$ git push -f origin myfeature
- Visit your fork at https://github.com/$user/tidb-operator (replace
$user
obviously). - Click the
Compare & pull request
button next to yourmyfeature
branch. - Edit the description of the pull request to match your change, and if your pull request introduce a user-facing change, a release note is required.
You can refer to Release Notes Language Style Guide for how to write proper release notes.
Once your pull request has been opened, it will be assigned to at least two reviewers. Those reviewers will do a thorough code review, looking for correctness, bugs, opportunities for improvement, documentation and comments, and style.
Commit changes made in response to review comments to the same branch on your fork.
Very small PRs are easy to review. Very large PRs are very difficult to review.
There are api reference docs, design proposals, and other developer related docs in docs
directory. Feel free to check things there. Happy Hacking!