Get started

Quick Start

• Install KubeSphere via kk (or other ways).

  kk create cluster --with-kubesphere nightly-$(date -d yesterday '+%Y%m%d')

• Enable DevOps application

  kubectl patch -nkubesphere-system cc ks-installer --type=json -p='[{"op": "replace", "path": "/spec/devops/enabled", "value": true}]'

Want to go into deep? Please checkout the documentation.

Install it as a Helm Chart

First, please clone this git repository. Then run command: make install-chart

• Because the default registry uses ghcr.io/kubesphere, if you want to use docker.io as the registry for image pull, you can exec helm install ks-devops chart/ks-devops --set image.registry=kubespheredev

Run it locally

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.

Development locally

• 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

Create Pipeline via CLI

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

APIs

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

Code contribution

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.

Lint your codes

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

TODO

• A separate front-end project of ks-devops
• Auth support
  • OIDC support as a default provider

Experimental support

octant-ks-devops is a plugin of octant. It provides a dashboard for Kubernetes and ks-devops.

Available communication channels:

• KubeSphere Devops google group
• DevOps Slack channel for English speakers
• DevOps Slack channel for Chinese speakers
• Forum for Chinese speakers
• KubeSphere DevOps Special Interest Group

Additional links

• Collection of KubeSphere Devops related projects