- Install KubeSphere via kk (or other ways). This is an optional step, basically we need a Kubernetes Cluster and the front-end of DevOps.
- Install
ks-devops
via chart - Replace the images of
ks-apiserver
andks-controller-manager
. In current phase, we need to use a temporary images of KubeSphere which comes from the branch remove-devops-ctrl:
kubespheredev/ks-apiserver:remove-devops-ctrl
kubespheredev/ks-controller-manager:remove-devops-ctrl
Want to go into deep? Please checkout the documentation.
First, please clone this git repository. Then run command: make install-chart
- Because the default registry uses
ghcr.io/kubesphere
, if you want to usedocker.io
as the registry for image pull, you can exechelm install ks-devops chart/ks-devops --set image.registry=kubespheredev
Technically, apiserver and controller are all binary files. So, it's possible to run them in your local environment. You just need to make sure that the connection between your environment and a Kubernetes cluster works well. This is a default config file of these components, please see also the sample file.
-
Run kind in local or remote machine
-
Make sure that you can access cluster via kubectl command in local machine
-
Execute the following command to install our CRDs:
make install
-
Debug code...
-
Execute the following command to uninstall our CRDs:
make uninstall
ks is an official client of KubeSphere. You can create a Pipeline by it.
ks pip create --ws simple --template java --project default --skip-check -b good
For example, you can access an API like:
curl -H "X-Authorization: Bearer xxxx" \
http://localhost:9090/kapis/devops.kubesphere.io/v1alpha3/devops/testblpsz/pipelines
Please get a token from Kubernetes cluster, and replace
xxxx
with it.
If you want to see ks-devops postman API collection , please visit ks-devops postman
If you're going to update or add CRD go struct, please run the following command once done with that:
make manifests generate generate-listers
then, it can generate CRDs and DeepCopy methods.
We are using golangci-lint as our code linter. Before you make some code changes, please execute following command to check code style:
golangci-lint run
# Or with specified folder, e.g.
golangci-lint run controllers/jenkinsconfig
- A separate front-end project of ks-devops
- Auth support
- OIDC support as a default provider
octant-ks-devops is a plugin of octant. It provides a dashboard for Kubernetes and ks-devops.