diff --git a/content/en/docs/faq/_index.md b/content/en/docs/faq/_index.md index d185e3168..8b1f4976e 100644 --- a/content/en/docs/faq/_index.md +++ b/content/en/docs/faq/_index.md @@ -81,6 +81,16 @@ Enable the editing function of system resources on the console. Select a desire language of the console. +## Multi-cluster Management + +### [Restore the Host Cluster Access to A Member Cluster](../faq/multi-cluster-management/host-cluster-access-member-cluster/) + +Learn how to restore the Host Cluster access to a Member Cluster. + +## DevOps + +### [Install Plugins to Jenkins in KubeSphere](../faq/devops/install-jenkins-plugins/) + ## Applications ### [Remove Built-in Apps in KubeSphere](../faq/applications/remove-built-in-apps/) @@ -89,10 +99,4 @@ Learn how to remove built-in apps from the KubeSphere App Store. ### [Reuse the Same App Name after Its Deletion](../faq/applications/reuse-the-same-app-name-after-deletion/) -Learn how to reuse the same app name after its deletion. - -## Multi-cluster Management - -### [Restore the Host Cluster Access to A Member Cluster](../faq/multi-cluster-management/host-cluster-access-member-cluster/) - -Learn how to restore the Host Cluster access to a Member Cluster. \ No newline at end of file +Learn how to reuse the same app name after its deletion. \ No newline at end of file diff --git a/content/en/docs/faq/devops/_index.md b/content/en/docs/faq/devops/_index.md new file mode 100644 index 000000000..7d8b5899f --- /dev/null +++ b/content/en/docs/faq/devops/_index.md @@ -0,0 +1,6 @@ +--- +title: "DevOps" +keywords: 'Kubernetes, KubeSphere, DevOps, Jenkins' +description: 'FAQ about DevOps in KubeSphere' +weight: 16800 +--- diff --git a/content/en/docs/faq/devops/install-jenkins-plugins.md b/content/en/docs/faq/devops/install-jenkins-plugins.md new file mode 100644 index 000000000..258b7e836 --- /dev/null +++ b/content/en/docs/faq/devops/install-jenkins-plugins.md @@ -0,0 +1,79 @@ +--- +title: "Install Plugins to Jenkins in KubeSphere" +keywords: "KubeSphere, Kubernetes, DevOps, Jenkins, Plugin" +description: "How to install plugins to Jenkins in KubeSphere" +linkTitle: "Install Plugins to Jenkins in KubeSphere" +Weight: 16810 +--- + +The KubeSphere DevOps System offers containerized CI/CD functions based on Jenkins. The primary means of enhancing the functionality of Jenkins is to install plugins. This tutorial demonstrates how to install plugins on the Jenkins dashboard. + +{{< notice warning >}} + +Not all Jenkins plugins have good maintaining support. Some plugins may lead to issues in Jenkins or even cause serious problems in KubeSphere. It is highly recommended that you make a backup before installing any plugin and run testing in another environment if you can. + +{{}} + +## Prerequisites + +You need to enable [the KubeSphere DevOps system](../../../pluggable-components/devops/). + +## Install Plugins + +### Step 1: Get the address of Jenkins + +1. Run the following command to get the address of Jenkins. + + ```bash + export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services ks-jenkins) + export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT + ``` + +2. You can get the output similar to the following. You can access the Jenkins dashboard through the address with your own KubeSphere account and password (e.g. `admin/P@88w0rd`). + + ``` + http://192.168.0.4:30180 + ``` + + {{< notice note >}} + + Make sure you use your own address of Jenkins. You may also need to open the port in your security groups and configure related port forwarding rules depending on where your Kubernetes cluster is deployed. + + {{}} + +### Step 2: Install plugins on the Jenkins dashboard + +1. Log in to the Jenkins dashboard and click **Manage Jenkins**. + + ![click-manage-jenkins](/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-jenkins.png) + +2. On the **Manage Jenkins** page, scroll down to **Manage Plugins** and click it. + + ![click-manage-plugins](/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-plugins.png) + +3. Select the **Available** tab and you can see all the available plugins listed on the page. You can also use the **Filter** in the upper right corner to search for the plugins you need. Check the checkbox next to the plugin you need, and then click **Install without restart** or **Download now and install after restart** based on your needs. + + ![available-plugins](/images/docs/faq/devops/install-plugins-to-jenkins/available-plugins.png) + + {{< notice note >}} + + Jenkins plugins are inter-dependent. You may also need to install dependencies when you install a plugin. + + {{}} + +4. If you downloaded an HPI file in advance, you can also select the **Advanced** tab and upload the HPI file to install it as a plugin. + + ![click-advanced-tab](/images/docs/faq/devops/install-plugins-to-jenkins/click-advanced-tab.png) + +5. On the **Installed** tab, you can view all the plugins installed, and the plugins that are safe to uninstall will have the **Uninstall** button shown on the right. + + ![installed-plugins](/images/docs/faq/devops/install-plugins-to-jenkins/installed-plugins.png) + +6. On the **Updates** tab, you can install the updates for plugins by checking the checkbox of a plugin and then click the **Download now and install after restart** button. You can also click the **Check now** button to check for updates. + + ![update-plugins](/images/docs/faq/devops/install-plugins-to-jenkins/update-plugins.png) + +## See Also + +[Managing Plugins](https://www.jenkins.io/doc/book/managing/plugins/) \ No newline at end of file diff --git a/content/zh/docs/faq/_index.md b/content/zh/docs/faq/_index.md index 10fbb67a2..4f4834147 100644 --- a/content/zh/docs/faq/_index.md +++ b/content/zh/docs/faq/_index.md @@ -73,6 +73,18 @@ icon: "/images/docs/docs.svg" 选择控制台的显示语言。 +## 多集群管理 + +### [恢复 Host 集群对 Member 集群的访问](../faq/multi-cluster-management/host-cluster-access-member-cluster/) + +了解如何恢复 Host 集群对 Member 集群的访问。 + +## DevOps + +### [为 KubeSphere 中的 Jenkins 安装插件](../faq/devops/install-jenkins-plugins/) + +了解如何为 KubeSphere 中的 Jenkins 安装插件。 + ## 应用程序 ### [下架 KubeSphere 中的内置应用](../faq/applications/remove-built-in-apps/) @@ -81,10 +93,4 @@ icon: "/images/docs/docs.svg" ### [删除应用后复用相同应用名称](../faq/applications/reuse-the-same-app-name-after-deletion/) -了解如何在删除应用后复用相同应用名称。 - -## 多集群管理 - -### [恢复 Host 集群对 Member 集群的访问](../faq/multi-cluster-management/host-cluster-access-member-cluster/) - -了解如何恢复 Host 集群对 Member 集群的访问。 \ No newline at end of file +了解如何在删除应用后复用相同应用名称。 \ No newline at end of file diff --git a/content/zh/docs/faq/devops/_index.md b/content/zh/docs/faq/devops/_index.md new file mode 100644 index 000000000..7d8b5899f --- /dev/null +++ b/content/zh/docs/faq/devops/_index.md @@ -0,0 +1,6 @@ +--- +title: "DevOps" +keywords: 'Kubernetes, KubeSphere, DevOps, Jenkins' +description: 'FAQ about DevOps in KubeSphere' +weight: 16800 +--- diff --git a/content/zh/docs/faq/devops/install-jenkins-plugins.md b/content/zh/docs/faq/devops/install-jenkins-plugins.md new file mode 100644 index 000000000..258b7e836 --- /dev/null +++ b/content/zh/docs/faq/devops/install-jenkins-plugins.md @@ -0,0 +1,79 @@ +--- +title: "Install Plugins to Jenkins in KubeSphere" +keywords: "KubeSphere, Kubernetes, DevOps, Jenkins, Plugin" +description: "How to install plugins to Jenkins in KubeSphere" +linkTitle: "Install Plugins to Jenkins in KubeSphere" +Weight: 16810 +--- + +The KubeSphere DevOps System offers containerized CI/CD functions based on Jenkins. The primary means of enhancing the functionality of Jenkins is to install plugins. This tutorial demonstrates how to install plugins on the Jenkins dashboard. + +{{< notice warning >}} + +Not all Jenkins plugins have good maintaining support. Some plugins may lead to issues in Jenkins or even cause serious problems in KubeSphere. It is highly recommended that you make a backup before installing any plugin and run testing in another environment if you can. + +{{}} + +## Prerequisites + +You need to enable [the KubeSphere DevOps system](../../../pluggable-components/devops/). + +## Install Plugins + +### Step 1: Get the address of Jenkins + +1. Run the following command to get the address of Jenkins. + + ```bash + export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services ks-jenkins) + export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT + ``` + +2. You can get the output similar to the following. You can access the Jenkins dashboard through the address with your own KubeSphere account and password (e.g. `admin/P@88w0rd`). + + ``` + http://192.168.0.4:30180 + ``` + + {{< notice note >}} + + Make sure you use your own address of Jenkins. You may also need to open the port in your security groups and configure related port forwarding rules depending on where your Kubernetes cluster is deployed. + + {{}} + +### Step 2: Install plugins on the Jenkins dashboard + +1. Log in to the Jenkins dashboard and click **Manage Jenkins**. + + ![click-manage-jenkins](/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-jenkins.png) + +2. On the **Manage Jenkins** page, scroll down to **Manage Plugins** and click it. + + ![click-manage-plugins](/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-plugins.png) + +3. Select the **Available** tab and you can see all the available plugins listed on the page. You can also use the **Filter** in the upper right corner to search for the plugins you need. Check the checkbox next to the plugin you need, and then click **Install without restart** or **Download now and install after restart** based on your needs. + + ![available-plugins](/images/docs/faq/devops/install-plugins-to-jenkins/available-plugins.png) + + {{< notice note >}} + + Jenkins plugins are inter-dependent. You may also need to install dependencies when you install a plugin. + + {{}} + +4. If you downloaded an HPI file in advance, you can also select the **Advanced** tab and upload the HPI file to install it as a plugin. + + ![click-advanced-tab](/images/docs/faq/devops/install-plugins-to-jenkins/click-advanced-tab.png) + +5. On the **Installed** tab, you can view all the plugins installed, and the plugins that are safe to uninstall will have the **Uninstall** button shown on the right. + + ![installed-plugins](/images/docs/faq/devops/install-plugins-to-jenkins/installed-plugins.png) + +6. On the **Updates** tab, you can install the updates for plugins by checking the checkbox of a plugin and then click the **Download now and install after restart** button. You can also click the **Check now** button to check for updates. + + ![update-plugins](/images/docs/faq/devops/install-plugins-to-jenkins/update-plugins.png) + +## See Also + +[Managing Plugins](https://www.jenkins.io/doc/book/managing/plugins/) \ No newline at end of file diff --git a/static/images/docs/faq/devops/install-plugins-to-jenkins/available-plugins.png b/static/images/docs/faq/devops/install-plugins-to-jenkins/available-plugins.png new file mode 100644 index 000000000..4aedb3bcf Binary files /dev/null and b/static/images/docs/faq/devops/install-plugins-to-jenkins/available-plugins.png differ diff --git a/static/images/docs/faq/devops/install-plugins-to-jenkins/click-advanced-tab.png b/static/images/docs/faq/devops/install-plugins-to-jenkins/click-advanced-tab.png new file mode 100644 index 000000000..acffe94b0 Binary files /dev/null and b/static/images/docs/faq/devops/install-plugins-to-jenkins/click-advanced-tab.png differ diff --git a/static/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-jenkins.png b/static/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-jenkins.png new file mode 100644 index 000000000..b4de740ac Binary files /dev/null and b/static/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-jenkins.png differ diff --git a/static/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-plugins.png b/static/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-plugins.png new file mode 100644 index 000000000..23f45a9c0 Binary files /dev/null and b/static/images/docs/faq/devops/install-plugins-to-jenkins/click-manage-plugins.png differ diff --git a/static/images/docs/faq/devops/install-plugins-to-jenkins/installed-plugins.png b/static/images/docs/faq/devops/install-plugins-to-jenkins/installed-plugins.png new file mode 100644 index 000000000..3cab5b0fc Binary files /dev/null and b/static/images/docs/faq/devops/install-plugins-to-jenkins/installed-plugins.png differ diff --git a/static/images/docs/faq/devops/install-plugins-to-jenkins/update-plugins.png b/static/images/docs/faq/devops/install-plugins-to-jenkins/update-plugins.png new file mode 100644 index 000000000..3c5a84754 Binary files /dev/null and b/static/images/docs/faq/devops/install-plugins-to-jenkins/update-plugins.png differ