We’d love your help!
This project is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.
We gratefully welcome improvements to documentation as well as to code.
By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the [DCO](DCO) file for details.
This project is a regular Kubernetes Operator built using the Operator SDK. Refer to the Operator SDK documentation to understand the basic architecture of this operator.
At the time of this writing, the Operator SDK GitHub page listed the following commands as required to install the command line tool:
mkdir -p $GOPATH/src/github.com/operator-framework
cd $GOPATH/src/github.com/operator-framework
git clone https://github.com/operator-framework/operator-sdk
cd operator-sdk
git checkout v0.1.1
make dep
make installAlternatively, a released binary can be used instead:
curl https://github.com/operator-framework/operator-sdk/releases/download/v0.1.1/operator-sdk-v0.1.1-x86_64-linux-gnu -sLo $GOPATH/bin/operator-sdk
chmod +x $GOPATH/bin/operator-sdk|
Note
|
Make sure your $GOPATH/bin is part of your regular $PATH.
|
As usual for operators following the Operator SDK, the dependencies are checked into the source repository under the vendor directory. The dependencies are managed using go dep. Refer to that project’s documentation for instructions on how to add or update dependencies.
The first step is to get a local Kubernetes instance up and running. The recommended approach is using minikube. Refer to the Kubernetes' documentation for instructions on how to install it.
Once minikube is installed, it can be started with:
minikube start|
Note
|
Make sure to read the documentation to learn the performance switches that can be applied to your platform. |
Once minikube has finished starting, get the Operator running:
make runAt this point, a Scribble instance can be installed:
kubectl apply -f deploy/examples/simplest.yaml
kubectl get jaegers
kubectl get podsTo remove the instance:
kubectl delete -f deploy/examples/simplest.yamlTests should be simple unit tests and/or end-to-end tests. For small changes, unit tests should be sufficient, but every new feature should be accompanied with end-to-end tests as well. Tests can be executed with:
make test|
Note
|
you can adjust the Docker image namespace by overriding the variable NAMESPACE, like: make test NAMESPACE=quay.io/my-username. The full Docker image name can be customized by overriding BUILD_IMAGE instead, like: make test BUILD_IMAGE=quay.io/my-username/scribble-operator:0.0.1
|
Similar instructions also work for OpenShift, but the target run-openshift can be used instead of run.
The Operator SDK generates the pkg/apis/io/v1alpha1/zz_generated.deepcopy.go file via the command make generate. This should be executed whenever there’s a model change (pkg/apis/io/v1alpha1/types.go)
Kubernetes comes with no ingress provider by default. For development purposes, when running minikube, the following command can be executed to install an ingress provider:
make ingressThis will install the NGINX ingress provider. It’s recommended to wait for the ingress pods to be in the READY and RUNNING state before starting the operator. You can check it by running:
kubectl get pods -n ingress-nginxTo verify that it’s working, deploy the simplest.yaml and check the ingress routes:
$ kubectl apply -f deploy/examples/simplest.yaml
jaeger.io.objectiser/simplest created
$ kubectl get ingress
NAME HOSTS ADDRESS PORTS AGE
simplest-query * 192.168.122.69 80 12sAccessing the provided "address" in your web browser should display the Scribble UI.