Golang version: 1.17
First finish the prerequisites specified in the QuickStart section on the submarine website.
Next, install golang dependencies.
go mod vendor
If you follow the QuickStart section on the submarine website, you are running operator in-cluster.
Running operator out-of-cluster is very handy for development
# Step1: Install helm chart dependencies, --set dev=true option will not install the operator deployment to the cluster helm dependency update ./helm-charts/submarine helm install --set dev=true submarine ../helm-charts/submarine/ -n submarine # Step2: Build & Run "submarine-operator" make ./submarine-operator # Step3: Deploy a Submarine kubectl create ns submarine-user-test kubectl apply -n submarine-user-test -f artifacts/examples/example-submarine.yaml
If you follow the above steps, you can view the submarine workbench via the same approach specified in the QuickStart section on the submarine website.
Whenever you change the operator code, simply shutdown the operator and recompile the operator using make and re-run again.
For go files, please use gofmt to format the code.
For yaml files, please use prettier to format the code.
Important: You MUST put this repository in a folder named github.com/apache/, otherwise, the code will be generated into the wrong folder. Therefore, the full path of this developer-guide.md should be like SOMEWHERE_IN_FILESYSTEM/github.com/apache/submarine/submarine-cloud-v2/docs/developer-guide.md.
We use code-generator to generate a typed client, informers, listers and deep-copy functions.
Everytime when you change the codes in submarine-cloud-v2/pkg/apis, you must run make api to re-generate the API.
One can set up storage class fields in values.yaml or using helm with --set. We‘ve set up minikube’s provisioner for storage class as default.
For example, if you are using kind in local, please add --set storageClass.provisioner=rancher.io/local-path --set storageClass.volumeBindingMode=WaitForFirstConsumer to helm install command.
Documentation for storage class: https://kubernetes.io/docs/concepts/storage/storage-classes/
To modify the parameters of submarine resource, go to the location submarine/submarine-cloud-v2/artifacts to edit specific yaml files. In this case, you won't need to modify the code for operator.
However, if you intend to create a new custom resource, you should also add a corresponding operator code in submarine/submarine-cloud-v2/pkg/controller.
Important: Your yaml files should NOT include helm grammer.
# Step1: Add the dependency to go.mod go get ${new_dependency} # Example: go get k8s.io/code-generator # Step2: Download the dependency to vendor/ go mod vendor
Reference: spark-on-k8s-operator e2e test
# Step1: Build image "submarine-operator" to minikube's Docker eval $(minikube docker-env) make image # Step2: Install helm dependencies helm dependency update ./helm-charts/submarine helm install --wait --set dev=true submarine ../helm-charts/submarine # Step3: Run Tests ## one can add -v to see additional logs go test -timeout 30m ./test/e2e
Use the following helper script to run frontend E2E tests.
# Prerequisite: Make sure Workbench is running on $URL:$WORKBENCH_PORT. ./hack/run_frontend_e2e.sh [testcase]
[testcase]: Check the directory integration.Example:
./hack/run_frontend_e2e.sh loginIT
When running operator in-cluster by Helm, we need to rebuild the operator image for changes to take effect.
eval $(minikube docker-env) make image eval $(minikube docker-env -u) # Update the operator pod helm upgrade submarine ../helm-charts/submarine
Use the following helper script to build images and update the images used by running pods.
./hack/build_image.sh [all|server|database|jupyter|jupyter-gpu|mlflow]
Examples:
./hack/build_image.sh all # build all images ./hack/build_image.sh server # only build the server image