mirror of
https://github.com/kubesphere/website.git
synced 2025-12-26 00:12:48 +00:00
141 lines
5.9 KiB
Markdown
141 lines
5.9 KiB
Markdown
---
|
|
title: "Enable DevOps System"
|
|
keywords: "Kubernetes, Jenkins, KubeSphere, DevOps, cicd"
|
|
description: "How to Enable KubeSphere DevOps System"
|
|
|
|
linkTitle: "Enable DevOps System"
|
|
weight: 3520
|
|
---
|
|
|
|
## What is KubeSphere DevOps System
|
|
|
|
KubeSphere DevOps System is designed for CI/CD workflows in Kubernetes. Based on [Jenkins](https://jenkins.io/), it provides one-stop solutions to help both development and Ops teams build, test and publish apps to Kubernetes in a straight-forward way. It also features plugin management, Binary-to-Image (B2I), Source-to-Image (S2I), code dependency caching, code quality analysis, pipeline logging, etc.
|
|
|
|
The DevOps system offers an enabling environment for users as apps can be automatically released to the same platform. It is also compatible with third-party private image registries (e.g. Harbor) and code repositories (e.g. GitLab/GitHub/SVN/BitBucket). As such, it creates excellent user experiences by providing users with comprehensive, visualized CI/CD pipelines which are extremely useful in air-gapped environments.
|
|
|
|
For more information, see DevOps Administration.
|
|
|
|
## Enable DevOps before Installation
|
|
|
|
### Installing on Linux
|
|
|
|
When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components.
|
|
|
|
1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere-v3.netlify.app/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command:
|
|
|
|
```bash
|
|
vi config-sample.yaml
|
|
```
|
|
|
|
{{< notice note >}}
|
|
|
|
If you adopt [All-in-one Installation](https://kubesphere-v3.netlify.app/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable DevOps in this mode (e.g. for testing purpose), refer to the following section to see how DevOps can be installed after installation.
|
|
|
|
{{</ notice >}}
|
|
|
|
2. In this file, navigate to `devops` and change `false` to `true` for `enabled`. Save the file after you finish.
|
|
|
|
```bash
|
|
devops:
|
|
enabled: true # Change "false" to "true"
|
|
```
|
|
|
|
3. Create a cluster using the configuration file:
|
|
|
|
```bash
|
|
./kk create cluster -f config-sample.yaml
|
|
```
|
|
|
|
### **Installing on Kubernetes**
|
|
|
|
When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) for cluster setting. If you want to install DevOps, do not use `kubectl apply -f` directly for this file.
|
|
|
|
1. In the tutorial of [Installing KubeSphere on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml). After that, to enable DevOps, create a local file cluster-configuration.yaml.
|
|
|
|
```bash
|
|
vi cluster-configuration.yaml
|
|
```
|
|
|
|
2. Copy all the content in the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) and paste it to the local file just created.
|
|
3. In this local cluster-configuration.yaml file, navigate to `devops` and enable DevOps by changing `false` to `true` for `enabled`. Save the file after you finish.
|
|
|
|
```bash
|
|
devops:
|
|
enabled: true # Change "false" to "true"
|
|
```
|
|
|
|
4. Execute the following command to start installation:
|
|
|
|
```bash
|
|
kubectl apply -f cluster-configuration.yaml
|
|
```
|
|
|
|
## Enable DevOps after Installation
|
|
|
|
1. Log in the console as `admin`. Click **Platform** at the top left corner and select **Clusters Management**.
|
|
|
|
|
|
|
|
2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detailed page.
|
|
|
|
{{< notice info >}}
|
|
|
|
A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects.
|
|
|
|
{{</ notice >}}
|
|
|
|
3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**.
|
|
|
|
|
|
|
|
4. In this yaml file, navigate to `devops` and change `false` to `true` for `enabled`. After you finish, click **Update** at the bottom right corner to save the configuration.
|
|
|
|
```bash
|
|
devops:
|
|
enabled: true # Change "false" to "true"
|
|
```
|
|
|
|
5. You can use the web kubectl to check the installation process by executing the following command:
|
|
|
|
```bash
|
|
kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f
|
|
```
|
|
|
|
{{< notice tip >}}
|
|
|
|
You can find the web kubectl tool by clicking the hammer icon at the bottom right corner of the console.
|
|
|
|
{{</ notice >}}
|
|
|
|
## Verify the Installation of Component
|
|
|
|
{{< tabs >}}
|
|
|
|
{{< tab "Verify the Component in Dashboard" >}}
|
|
|
|
Go to **Components** and check the status of DevOps. You may see an image as follows:
|
|
|
|
|
|
|
|
{{</ tab >}}
|
|
|
|
{{< tab "Verify the Component through kubectl" >}}
|
|
|
|
Execute the following command to check the status of pods:
|
|
|
|
```bash
|
|
kubectl get pod -n kubesphere-devops-system
|
|
```
|
|
|
|
The output may look as follows if the component runs successfully:
|
|
|
|
```bash
|
|
NAME READY STATUS RESTARTS AGE
|
|
ks-jenkins-68b8949bb-jcvkt 1/1 Running 0 1h3m
|
|
s2ioperator-0 1/1 Running 1 1h3m
|
|
uc-jenkins-update-center-8c898f44f-hqv78 1/1 Running 0 1h14m
|
|
```
|
|
|
|
{{</ tab >}}
|
|
|
|
{{</ tabs >}} |