Illumina Innovates with Rancher and Kubernetes
This section explains the respositories used for Rancher, how to build the repositories, and what information to include when you file an issue.
For more detailed information on how to contribute to the development of Rancher projects, refer to the Rancher Developer Wiki. The wiki has resources on many topics, including the following:
On the Rancher Users Slack, the channel for developers is #developer.
All of repositories are located within our main GitHub organization. There are many repositories used for Rancher, but we’ll provide descriptions of some of the main ones used in Rancher.
docker/machine
helm/helm
To see all libraries/projects used in Rancher, see the vendor.conf in the rancher/rancher repository.
vendor.conf
rancher/rancher
Rancher components used for provisioning/managing Kubernetes clusters.
Every repository should have a Makefile and can be built using the make command. The make targets are based on the scripts in the /scripts directory in the repository, and each target will use Dapper to run the target in an isolated environment. The Dockerfile.dapper will be used for this process, and includes all the necessary build tooling needed.
make
/scripts
Dockerfile.dapper
The default target is ci, and will run ./scripts/validate, ./scripts/build, ./scripts/test and ./scripts/package. The resulting binaries of the build will be in ./build/bin and are usually also packaged in a Docker image.
ci
./scripts/validate
./scripts/build
./scripts/test
./scripts/package
./build/bin
If you find any bugs or are having any trouble, please search the reported issue as someone may have experienced the same issue or we are actively working on a solution.
If you can’t find anything related to your issue, contact us by filing an issue. Though we have many repositories related to Rancher, we want the bugs filed in the Rancher repository so we won’t miss them! If you want to ask a question or ask fellow users about an use case, we suggest creating a post on the Rancher Forums.
Please follow this checklist when filing an issue which will helps us investigate and fix the issue. More info means more data we can use to determine what is causing the issue or what might be related to the issue.
Note: For large amounts of data, please use GitHub Gist or similar and link the created resource in the issue. Important: Please remove any sensitive data as it will be publicly viewable.
cat /etc/os-release
uname -r
docker version
docker info
Logs: Provide data/logs from the used resources.
Rancher
docker logs \ --timestamps \ $(docker ps | grep -E "rancher/rancher:|rancher/rancher " | awk '{ print $1 }')
kubectl
Note: Make sure you configured the correct kubeconfig (for example, export KUBECONFIG=$PWD/kube_config_rancher-cluster.yml for Rancher HA) or are using the embedded kubectl via the UI.
export KUBECONFIG=$PWD/kube_config_rancher-cluster.yml
kubectl -n cattle-system \ logs \ -l app=rancher \ --timestamps=true
docker
docker logs \ --timestamps \ $(docker ps | grep -E "rancher/rancher@|rancher_rancher" | awk '{ print $1 }')
kubectl -n cattle-system \ logs \ --timestamps=true \ -f $(kubectl --kubeconfig $KUBECONFIG get pods -n cattle-system -o json | jq -r '.items[] | select(.spec.containers[].name="cattle-server") | .metadata.name')
System logging (these might not all exist, depending on operating system)
/var/log/messages
/var/log/syslog
/var/log/kern.log
Docker daemon logging (these might not all exist, depending on operating system)
/var/log/docker.log
Metrics: If you are experiencing performance issues, please provide as much of data (files or screenshots) of metrics which can help determining what is going on. If you have an issue related to a machine, it helps to supply output of top, free -m, df which shows processes/memory/disk usage.
top
free -m
df
If you have any updates to our documentation, please make any pull request to our docs repo.
Rancher 2.x Docs repository: This repo is where all the docs for Rancher 2.x are located. They are located in the content folder in the repo.
content
Rancher 1.x Docs repository: This repo is where all the docs for Rancher 1.x are located. They are located in the rancher folder in the repo.
rancher