Tools & Templates

• 1: Tool Management
• 2: App Template
• 3: Register user-installed Jenkins tool

1 - Tool Management

A tool refers to an application that interacts with the DevOps Console to support CI/CD functionality.

For a list of tools currently supported by the DevOps Console, refer to Tool Classification.

Getting Started with Tool Management

To start managing tools, follow these steps:

1. Main page, click the Manage icon in the top right corner. You will be taken to the Tenant Dashboard page.
2. In the left menu, click Tools & Templates > Tools. You will be taken to the Tools page.

Tool Types

Each tool has a different usage area depending on the tool type.

Tool Classification

The following is a list of tools currently supported by the DevOps Console:

Management Affiliation

The tenant or project group type selected when adding a tool indicates the management affiliation. The following icons distinguish the type of management affiliation:

• Management affiliation is a tenant.
• Management affiliation is a project group.

Adding a Tool

To add a tool, follow these steps:

1. On the Tools page, click the Add button. The Add Tool popup window will open.

Selecting Tool Support Type

1. In the Add Tool popup window, select the tool’s support type.
2. Complete the selection and click the Next button. The Basic Information input screen will appear.

Entering Basic Information

1. In the Add Tool popup window, on the Basic Information input screen, select the tool classification and tool. The input screen will vary depending on the selected tool.
   • See Tool Classification for classification descriptions.
2. Enter the necessary information and click the Connection Test button.
3. Click the Next button.

SCM Repository

CICD Pipeline

Image Registry

Code Quality

Artifact Repository

Helm Chart Repository

Project Management Software

Entering Additional Information

1. On the Add Tool popup window, on the Basic Information input screen, click the Next button. The Additional Information input screen will appear.
2. Select each item and click the Complete button.
3. In the confirmation popup window, click the Confirm button to complete the tool addition.

Tool Details

To manage tool details, follow these steps:

1. On the Tools page, click the tool for which you want to manage details. You will be taken to the Tool Details page.

Managing Tool Basic Information

To view the tool’s basic information, follow these steps:

1. On the Tool Details page, click the Basic Information tab.

To modify the tool’s basic information, follow these steps:

1. On the Tool Details page, click the Basic Information tab.
2. Click the Modify button.
3. Modify the necessary information and click the Save button.

Managing Global Tools

This feature allows you to manipulate the Global Tool Configuration menu in the Jenkins web screen from the DevOps Console. The DevOps Console only supports one-way registration to Jenkins. (In other words, changes made by the user in the DevOps Console will overwrite the information in Jenkins.) Users can manage the list of tools available in Jenkins, and tools registered in Global Tool can be used in the Tools section when configuring a stage.

To manage global tools, follow these steps:

1. Click the Global Tool tab on the Tool Details page.

Adding Global Tools

To add a global tool, follow these steps:

1. Click the Edit icon for the item you want to add in the Global Tool tab. The Global Tool Management popup window will open.
   • Required Tools are automatically set by the DevOps Console.
   • Required Tools cannot be deleted, and only the home path can be modified.
2. Click the Add button. A new row will be added to the bottom of the list.
3. Enter the information in the new row and click the Save button.
4. Click the Confirm button in the confirmation popup window to complete the process.

Modifying Global Tools

To modify a global tool, follow these steps:

1. Click the Edit icon for the item you want to modify. The Global Tool Management popup window will open.
2. Modify the content and click the Save button.
3. Click the Confirm button in the confirmation popup window to complete the modification.

Deleting Global Tools

To delete a global tool, follow these steps:

1. Click the Global Tool tab on the Tool Details page. Click the Edit icon for the item you want to delete. The Global Tool Management popup window will open.
2. Delete the content and click the Save button.
3. Click the Confirm button in the confirmation popup window to complete the deletion.

Managing Agent (Kubernetes)

This feature allows you to manage the agents (slaves) used in Jenkins builds.

The Jenkins web screen’s 1) Jenkins Management > System Settings > Cloud > Pod Templates or 2) Jenkins Management > Node Management > Configure Clouds > Pod Templates menu can be manipulated from the DevOps Console.

The DevOps Console only supports one-way registration to Jenkins. (In other words, changes made by the user in the DevOps Console will overwrite the information in Jenkins.)

To manage agents (Kubernetes), follow these steps:

1. Click the Agent (Kubernetes) tab on the Tool Details page.
2. Click the Information icon in the Pod Template Management list. The Pod Template Usage Guide popup window will open.

Adding Container Resource Types

To add a container resource type, follow these steps:

1. Click the Agent (Kubernetes) tab on the Tool Details page.
2. Click the Edit icon in the Container Resource Type Management section. The Container Resource Type Management popup window will open.
3. Click the Add button and enter the content. Click the Save button.
4. Click the Confirm button in the confirmation popup window to complete the process.

Modifying Container Resource Types

To modify a container resource type, follow these steps:

1. Click the Agent (Kubernetes) tab on the Tool Details page.
2. Click the Edit icon in the Container Resource Type Management section. The Container Resource Type Management popup window will open.
3. Modify the content and click the Save button.
4. Click the Confirm button in the confirmation popup window to complete the modification.

Deleting Container Resource Types

To delete a container resource type, follow these steps:

1. Click the Agent (Kubernetes) tab on the Tool Details page.
2. Click the Edit icon in the Container Resource Type Management section. The Container Resource Type Management popup window will open.
3. Delete the content and click the Save button.
4. Click the Confirm button in the confirmation popup window to complete the deletion.

Adding Pod Templates

To add a Pod Template, follow these steps:

1. Click the Agent (Kubernetes) tab on the Tool Details page.
2. Click the Add button in the Pod Template Management list. The Add Agent (Kubernetes) screen will appear.
3. Enter the content and click the Save button.
4. Click the Confirm button in the confirmation popup window to complete the process.

Viewing Pod Template Details

To view the details of a Pod Template, follow these steps:

1. Click the Agent (Kubernetes) tab on the Tool Details page.
2. Click the View Details button for the agent you want to view in the Pod Template Management list. The Agent (Kubernetes) Details screen will appear.

Modifying Pod Templates

To modify a Pod Template, follow these steps:

1. Click the Agent (Kubernetes) tab on the Tool Details page.
2. Click the View Details button for the agent you want to modify in the Pod Template Management list. The Agent (Kubernetes) Details screen will appear.
3. Click the Modify button.
4. Modify the content and click the Save button.
5. Click the Confirm button in the confirmation popup window to complete the modification.

Deleting Pod Templates

To delete a Pod Template, follow these steps:

1. Click the Agent (Kubernetes) tab on the Tool Details page.
2. Click the View Details button for the agent you want to delete in the Pod Template Management list. The Agent (Kubernetes) Details screen will appear.
3. Click the Delete button.
4. Click the Confirm button in the confirmation popup window to complete the deletion.

Managing Agent (VM)

This feature allows you to manage the list of nodes available in Jenkins. The Jenkins web screen’s Jenkins Management > Node Management menu can be manipulated from the DevOps Console. The DevOps Console only supports one-way registration to Jenkins. (In other words, changes made by the user in the DevOps Console will overwrite the information in Jenkins.)

To manage agents (VM), follow these steps:

1. Click the Agent (VM) tab on the Tool Details page.
2. Click the Information icon in the Node Management list. The Node Usage Guide popup window will open.

Managing Agent Connections

This feature registers the tunneling port to connect the actual Jenkins and agent (VM). The tunneling port may vary depending on Jenkins.

To manage agent connections, follow these steps:

1. Click the Agent (VM) tab on the Tool Details page.
2. Click the Edit icon in the Agent Connection Management section. The Agent Connection Management popup window will open.
3. Enter the content and click the Save button.

Adding Agent (VM)

To add an agent (VM), follow these steps:

1. Click the Agent (VM) tab on the Tool Details page.
2. Click the Add button in the Agent Connection Management section. The Add Agent (VM) screen will appear.
3. Enter the content and click the Save button.
4. Click the Confirm button in the confirmation popup window to complete the process.

Viewing Agent (VM) Details

To view the details of an agent (VM), follow these steps:

1. Click the Agent (VM) tab on the Tool Details page.
2. Click the agent you want to view in the Node Management list. The Agent (VM) Details screen will appear.
3. Click the Information icon in the Jenkins - Agent Connection Information section.
4. The Agent Connection Guide popup window will open.

Connecting Agent (VM)

To register and use an agent (VM), you must connect it to the actual VM server.

To connect an agent (VM), follow these steps:

1. Click the Agent (VM) tab on the Tool Details page.
2. Click the agent you want to connect in the Node Management list. The Agent (VM) Details screen will appear.
3. Refer to jnlpUrl and secret.
4. Click the Information icon in the Jenkins - Agent Connection Information section. The Agent Connection Guide popup window will open.
5. Click the Download Agent File button to download the agent.jar file.
   • The agent.jar version may cause issues with execution.
   • You can also download it directly from your Jenkins ({JENKINS_URL}/jnlpJars/agent.jar).
6. Connect to the VM server where you want to deploy and create a directory.
7. Copy the downloaded agent.jar file to the created directory.
8. Run the following command in the created directory path:

java -jar agent.jar -jnlpUrl {jnlpUrl} -secret {secret}

java -jar agent.jar -jnlpUrl {jnlpUrl} -secret {secret}

Modifying Agent (VM)

To modify an agent (VM), follow these steps:

1. Click the Agent (VM) tab on the Tool Details page.
2. Click the agent you want to modify in the Node Management list. The Agent (VM) Details screen will appear.
3. Click the Modify button.
4. Modify the content and click the Save button.
5. Click the Confirm button in the confirmation popup window to complete the modification.

Deleting Agent (VM)

To delete an agent (VM), follow these steps:

1. Click the Agent (VM) tab on the Tool Details page.
2. Click the agent you want to delete in the Node Management list. The Agent (VM) Details screen will appear.
3. Click the Delete button.
4. Click the Confirm button in the confirmation popup window to complete the deletion.

Managing Global Libraries

You can manage the list of libraries available in the build pipeline. This is a feature that can be manipulated in the DevOps Console from the Jenkins Jenkins Management -> System Settings -> Global Pipeline Libraries menu. Library and connected Credential information can be found in the Jenkins Management > Manage Credentials menu. The DevOps Console only supports one-way registration to Jenkins. (In other words, the information modified by the user in the DevOps Console will overwrite the information in Jenkins.)

To manage agents (VMs), follow these steps:

1. Tool Details page, click the Global Library tab.

Adding Global Libraries

To add a global library, follow these steps:

1. Tool Details page, click the Global Library tab.
2. Click the Add button. The Add Global Library screen appears.
3. Enter the contents and click the Save button.
4. In the confirmation popup, click the Confirm button to complete.

Viewing Global Library Details

To view the details of a global library, follow these steps:

1. Tool Details page, click the Global Library tab.
2. In the Global Library list, click the item you want to view in detail. The Global Library Details screen appears.

Modifying Global Libraries

To modify a global library, follow these steps:

1. Tool Details page, click the Global Library tab.
2. In the Global Library list, click the item you want to view in detail. The Global Library Details screen appears.
3. Click the Modify button.
4. Modify the contents and click the Save button.
5. In the confirmation popup, click the Confirm button to complete.

Deleting Global Libraries

To delete a global library, follow these steps:

1. Tool Details page, click the Global Library tab.
2. In the Global Library list, click the item you want to delete. The Global Library Details screen appears.
3. Click the Delete button.
4. In the confirmation popup, click the Confirm button to complete.

Managing Supported Tenants/Project Groups

Users can manage the tenants or project groups that can use the tool.

To manage supported tenants or project groups, follow these steps:

1. Tool Details page, click the Supported Tenants or Supported Information tab.

Adding Supported Tenants/Project Groups

To add a supported tenant or project group, follow these steps:

1. Tool Details page, click the Supported Tenants or Supported Information tab.
2. Click the Add button. The Add Tenant/Project Group popup window opens.
3. Enter the contents and click the Save button.
4. In the confirmation popup, click the Confirm button to complete.

Modifying Supported Tenants/Project Groups

To modify a supported tenant/project group, follow these steps:

1. Tool Details page, click the Supported Tenants or Supported Information tab.
2. In the Supported Tenants or Supported Information list, select the usage and new creation possibility to modify.

Transferring Management Tenants/Project Groups

To transfer the management tenant/project group, follow these steps:

1. Tool Details page, click the Supported Tenants or Supported Information tab.
2. Click the Transfer Management Tenant or Transfer Management Project Group button. The Transfer Management Tenant or Transfer Management Project Group popup window opens.
3. Select the transfer target tenant or project group and click the Save button.

Deleting Supported Tenants/Project Groups

To delete a supported tenant/project group, follow these steps:

1. Tool Details page, click the Supported Tenants or Supported Information tab.
2. Select the checkbox of the tenant/project group you want to delete.
3. Click the Delete button.
4. In the confirmation popup, click the Confirm button to complete.

Managing Supported K8S Clusters

Users can manage the K8S clusters that can use the tool.

To manage supported K8S clusters, follow these steps:

1. Tool Details page, click the Supported K8S Clusters tab.

Adding Supported K8S Clusters

To add a supported K8S cluster, follow these steps:

1. Tool Details page, click the Supported K8S Clusters tab.
2. Click the Add button. The Add K8S Cluster popup window opens.
3. Enter the contents and click the Save button.
4. In the confirmation popup, click the Confirm button to complete.

Modifying Supported K8S Clusters

To modify a supported K8S cluster, follow these steps:

1. Tool Details page, click the Supported K8S Clusters tab.
2. In the Supported K8S Clusters list, select the usage and new creation possibility to modify.

Deleting Supported K8S Clusters

To delete a supported K8S cluster, follow these steps:

1. Tool Details page, click the Supported K8S Clusters tab.
2. Select the checkbox of the K8S cluster you want to delete.
3. Click the Delete button.
4. In the confirmation popup, click the Confirm button to complete.

Managing Tool Operators

To manage tool operators, follow these steps:

1. Tool Details page, click the Tool Operator tab.

Adding Tool Operators

To add a tool operator, follow these steps:

1. Tool Details page, click the Tool Operator tab.
2. Click the Add button. The Add Tool Operator popup window opens.
3. Select the operator and click the Save button.
4. In the confirmation popup, click the Confirm button to complete.

Deleting Tool Operators

To delete a tool operator, follow these steps:

1. Tool Details page, click the Tool Operator tab.
2. Select the checkbox of the operator you want to delete.
3. Click the Delete button.
4. In the confirmation popup, click the Confirm button to complete.

Managing Jenkins Recommended Plugins

You can view the installed Jenkins version and plugin installation status and version information.

• Tool version: Jenkins version information
• Recommended plugins: Recommended plugin installation status and version information

Checking Tool Version and Recommended Plugins Information

To view the tool version and required plugin information, follow these steps:

1. Click Tool(CICD Pipeline) on the Tool Management page.
2. If tool has an information to update or install recommended plugins info, then popup is occurred and click confirm button then move to Plugins tab.
3. On the Tool Details page, click the Plugins tab.
4. View the Tool Version and Recommended Plugins items.

Installing Recommended Plugins

Follow this procedure to install recommended plugins.

1. On the Plugins page, Click Install button which you want to install plugin in Recommended Plugins area.
2. Install Recommended Plugin popup is occured, and click Confirm button.
3. Then popup appears message that installation request has been completed, and you can check the actual installation through the link in the popup.

Updating Recommended Plugins

Follow this procedure to update recommended plugins.

1. On the Plugins page, Click Update button which you want to install plugin in Recommended Plugins area.
2. Update Recommended Plugin popup is occured, and click Confirm button.
3. Then popup appears message that update request has been completed, and you can check the actual installation through the link in the popup.
4. You must restart your Jenkins to apply the update.

Deleting Tools

To delete a tool, follow these steps:

1. Tool page, click the tool you want to delete. The Tool Details page opens.
2. Click the Delete button.
3. In the confirmation popup, click the Confirm button to complete.

2 - App Template

App Template is a feature provided for quick development environment setup.

App Template consists of sample source code, Dockerfile, Helm Chart, and more. Users can quickly set up their development environment using App Template when creating a project.

We provide App Templates for various frameworks such as Node.js, Python, Spring Boot, and more. Users can also create and register their own App Templates.

Getting Started with App Template

To start managing App Templates, follow these steps:

1. Main page, click the Manage icon at the top right. Move to the Tenant Dashboard page.
2. In the left menu, click Tools & Templates > App Template. Move to the App Template page.

Adding App Template

Users can add their own App Templates.

Source Code

Source code used to configure a sample project in the App Template.

The SCM Repository tool must be available in the tenant or project group where the App Template will be registered. Refer to Adding Tools for how to register the SCM Repository tool.

Register the source code in the SCM Repository in advance. When registering the App Template, the registered SCM Repository will appear, and you can enter the path to the source code.

Dockerfile

To register an App Template that supports Kubernetes or VM (Docker) deployment targets, you must add a Dockerfile to the source code or register a Dockerfile through Managing Dockerfile Templates.

When writing a Dockerfile, the FROM clause must be fixed as FROM ${BASE_IMAGE}.

The registered ${BASE_IMAGE} value is replaced with the image.repository value of the Helm chart for Kubernetes deployment targets or the image path registered in Managing Supported Images for VM (Docker) deployment targets.

Dockerfile sample

FROM ${BASE_IMAGE}

COPY *.jar app.jar
ENTRYPOINT ["java","-jar","/app.jar"]

FROM ${BASE_IMAGE}

COPY *.jar app.jar
ENTRYPOINT ["java","-jar","/app.jar"]

Registering App Template

To register an App Template, follow these steps:

1. App Template page, click the Add button. Move to the Add App Template page.
2. Add App Template page, select the template support type and click the Start button.
3. Enter the necessary information and click the Complete button.

Modifying App Template Basic Information

To modify the basic information of an App Template, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Basic Information tab.
3. Basic Information tab, click the Modify button.
4. Modify the necessary information and click the Save button.

Managing Pipeline Templates

Pipeline templates are settings for building pipelines that are automatically configured when a user creates a project using an App Template.

Adding Pipeline Templates

To add a pipeline template, follow these steps:

1. App Template page, click the item you want to add. Move to the App Template Details page.
2. App Template Details page, click the Pipeline Template tab.
3. Pipeline Template tab, click the Add button. Move to the Add Pipeline Template page.
4. Add Pipeline Template page, enter the necessary information and click the Save button.

Modifying Pipeline Templates

To modify a pipeline template, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Pipeline Template tab.
3. Pipeline Template tab, click the item you want to modify. Move to the Pipeline Template Details page.
4. Pipeline Template Details page, click the Modify button. Move to the Modify Pipeline Template page.
5. Modify Pipeline Template page, modify the information and click the Save button.

Deleting Pipeline Templates

To delete a pipeline template, follow these steps:

1. App Template page, click the item you want to delete. Move to the App Template Details page.
2. App Template Details page, click the Pipeline Template tab.
3. Pipeline Template tab, click the item you want to delete. Move to the Pipeline Template Details page.
4. Pipeline Template Details page, click the Delete button.
5. Click the Confirm button in the confirmation popup.

Managing Dockerfile Templates

This tab only appears when the Dockerfile Type item in the Basic Information content of the App Template is GUI Template.

Modifying Dockerfile Templates

To modify a Dockerfile template, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Dockerfile Template tab.
3. Dockerfile Template tab, click the Modify or Create button.
4. Dockerfile Template tab, enter the contents and click the Save button.

The FROM clause is automatically set to the image path registered in Managing Supported Images.

Managing Supported Tenants/Project Groups

Users can manage the tenants or project groups where the App Template can be used.

To manage supported tenants or project groups, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Supported Tenants or Supported Information tab.

Adding Supported Tenants

To add supported tenants, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Supported Tenants tab.
3. Supported Tenants tab, click the Add button. The Add Tenant popup will appear.
4. Add Tenant popup, select the tenant to support and click the Save button.

Modifying Supported Tenant Information

To modify the information of supported tenants, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Supported Tenants tab.
3. Supported Tenants tab, select the tenant to modify and select the Verification and Usage items to modify.

Modifying Supported Project Group Information

To modify the information of a supported project group, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page. App Template Details page, click the Support Information tab.
2. Support Information tab, click the Modify button. The App Template Modification screen appears.
3. App Template Modification screen, select and modify the Verification and Usage items.
4. Click the Save button.

Transferring Management Tenant

To transfer the management tenant, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Support Tenant tab.
3. Support Tenant tab, click the Transfer Management Tenant button. The Transfer Management Tenant popup window opens.
4. Transfer Management Tenant popup window, select the target tenant to transfer and click the Save button.

Deleting Support Tenant

To delete a support tenant, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Support Tenant tab.
3. Support Tenant tab, select the tenant to delete and click the Delete button.
4. Click the Confirm button in the confirmation popup window.

Managing Support Images

The Support Image registered by the user is used in the Dockerfile or Dockerfile template of the source code.

Adding Support Images

To add a support image, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Support Image tab.
3. Support Image tab, click the Add button. The Add Support Image popup window opens.
4. Add Support Image popup window, enter the information and click the Connection Test button.
5. When the Save button is activated, click the Save button.
6. Click the Confirm button in the confirmation popup window.

Deleting Support Images

To delete a support image, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Support Image tab.
3. Support Image tab, select the checkbox of the item to delete and click the Delete button.
4. Click the Confirm button in the confirmation popup window.

Managing Support Helm Charts

The Support Helm Chart registered by the user is used when creating a project using the App template.

Adding Support Helm Charts

To add a support helm chart, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Support Helm Chart tab.
3. Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
4. App Template Modification screen, select the checkbox of the helm chart to use in the Helm Chart List, and click the Add button to add it to the Selected Helm Chart List, then click the Save button.

Modifying Support Helm Charts

To modify a support helm chart, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Support Helm Chart tab.
3. Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
4. App Template Modification screen, select the checkbox of the helm chart to use in the Helm Chart List, and click the Add or Delete button to modify the Selected Helm Chart List, then click the Save button.

Deleting Support Helm Charts

To delete a support helm chart, follow these steps:

1. App Template page, click the item you want to modify. Move to the App Template Details page.
2. App Template Details page, click the Support Helm Chart tab.
3. Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
4. App Template Modification screen, select the checkbox of the helm chart to delete in the Selected Helm Chart List, and click the Delete button to delete it, then click the Save button.

Deleting App Templates

To delete an App template, follow these steps:

1. App Template page, click the item you want to delete. Move to the App Template Details page.
2. App Template Details page, click the Basic Information tab.
3. Basic Information tab, click the Delete button.
4. Click the Confirm button in the confirmation popup window.

3 - Register user-installed Jenkins tool

Start registering Jenkins tool for user installation

Install Jenkins and plugins.

Jenkins Installation

Before installing

To register Jenkins in the DevOps Console, Jenkins generally must meet the following conditions. If there are other conditions, register an SR before installation to verify.

• Use domain for Jenkins access
• Jenkins domain registered in DNS
• Jenkins communication with HTTPS (port 443), use public certificate

Installation

Install Jenkins on a VM or Kubernetes.

Plugin Installation

Install the following plugin in Jenkins.

Jenkins Settings

Common Settings

Jenkins Management > System

Jenkins Management > Security

Support email format for Jenkins Username

• By default, Jenkins does not allow the @ symbol (.) to be used in the login Username. However, since DevOps Console uses email as the Username, we configure Jenkins to allow using email as the Username as well.
• /{JENKINS_HOME}/init.groovy.d/init.groovy Create the file, enter the following contents, and restart Jenkins.
  • (ex) /var/jenkins_home/init.groovy.d/init.groovy

hudson.security.HudsonPrivateSecurityRealm.ID_REGEX=/^[\w-\.\@\_]+$/

hudson.security.HudsonPrivateSecurityRealm.ID_REGEX=/^[\w-\.\@\_]+$/

Additional Jenkins configuration installed on Kubernetes

RBAC

Set RBAC on Jenkins’s Service Account so that Jenkins can create Pods in Kubernetes.

# In GKE need to get RBAC permissions first with
# kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin [--user=<user-name>|--group=<group-name>]
  
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: jenkins
  
---
kind: Role
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: jenkins
rules:
- apiGroups: [""]
  resources: ["pods"]
  verbs: ["create","delete","get","list","patch","update","watch"]
- apiGroups: [""]
  resources: ["pods/exec"]
  verbs: ["create","delete","get","list","patch","update","watch"]
- apiGroups: [""]
  resources: ["pods/log"]
  verbs: ["get","list","watch"]
- apiGroups: [""]
  resources: ["events"]
  verbs: ["watch"]
- apiGroups: [""]
  resources: ["secrets"]
  verbs: ["get"]
  
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: jenkins
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: jenkins
subjects:
- kind: ServiceAccount
  name: jenkins

# In GKE need to get RBAC permissions first with
# kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin [--user=<user-name>|--group=<group-name>]
  
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: jenkins
  
---
kind: Role
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: jenkins
rules:
- apiGroups: [""]
  resources: ["pods"]
  verbs: ["create","delete","get","list","patch","update","watch"]
- apiGroups: [""]
  resources: ["pods/exec"]
  verbs: ["create","delete","get","list","patch","update","watch"]
- apiGroups: [""]
  resources: ["pods/log"]
  verbs: ["get","list","watch"]
- apiGroups: [""]
  resources: ["events"]
  verbs: ["watch"]
- apiGroups: [""]
  resources: ["secrets"]
  verbs: ["get"]
  
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: jenkins
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: jenkins
subjects:
- kind: ServiceAccount
  name: jenkins

Jenkins Management > Clouds

kubernetes

• kubernetes add the cloud.
• kubernetes set the cloud as follows. Use the default values for the remaining items.

kubernetes > Pod Templates

• Add a Pod Template.
• BASE-TEMPLATE is a higher-level template used in the DevOps Console that sets values that must be commonly used in each Pod Template.

Register Jenkins tool in DevOps Console

Register firewall

Refer to the table below and register the firewall in Jenkins.

DevOps Console Task

• For detailed information related to Jenkins tool registration, please refer to Add Tool.
• In the tool registration step, check the plugins installed in Jenkins, and if there are plugins that need to be installed, a plugin installation guide page will be displayed. Download and install the plugins as instructed.

Jenkins Check

Jenkins Management > System

Global Trusted Pipeline Libraries

• Check if cicdpaas is set in the Library.
• If it is not set
  • DevOps Console ↔ Jenkins Check the communication status.
  • DevOps Console > Management > Jenkins detail screen > Check the settings in the Global Library tab.

DevOps Console Credentials

• Test Connection Click the button to verify that Success is displayed.

Add agent (VM) to Jenkins

DevOps Console Task

Check Add Agent (VM) and add the agent (VM).

Jenkins job

Jenkins Management > Nodes > Agent Detail Screen

Check that the Agent added from the DevOps Console has been created. Run the Agent according to the guide on the Jenkins screen and connect it to Jenkins.

Add agent (Kubernetes) to Jenkins

Before adding the agent (Kubernetes)

User Jenkins agent image creation

• An agent image is required for CI/CD in Jenkins.
• Use the default images provided by Jenkins to create a Jenkins agent image that fits the user.
• After generating the image, push it to the user image repository.

FROM jenkins/inbound-agent:latest-jdk17

USER root

# Docker CLI
RUN curl -L0 "https://download.docker.com/linux/static/stable/x86_64/docker-29.1.3.tgz" -o /tmp/docker.tgz && \
    tar --extract \
      --file /tmp/docker.tgz \
      --strip-components 1 \
      --directory /usr/local/bin/ && \
    rm /tmp/docker.tgz
  
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx

# Install your build tools...
# xxx

USER jenkins

FROM jenkins/inbound-agent:latest-jdk17

USER root

# Docker CLI
RUN curl -L0 "https://download.docker.com/linux/static/stable/x86_64/docker-29.1.3.tgz" -o /tmp/docker.tgz && \
    tar --extract \
      --file /tmp/docker.tgz \
      --strip-components 1 \
      --directory /usr/local/bin/ && \
    rm /tmp/docker.tgz
  
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx

# Install your build tools...
# xxx

USER jenkins

Docker in Docker image

• DevOps Console uses Docker in Docker to generate Docker images in a Kubernetes environment.
• Push the docker:dind (Docker in Docker) image provided by Docker to your repository.

DevOps Console Task

• Pod Template Add check and add the agent (kubernetes).
  • By default, one (or multiple) agents are registered. Delete the default registered agent.
• If you need to build a Docker image, select to use Docker in Docker.
• Enter the Jenkins agent address of the user created above into the jnlp image URL.

Jenkins job

Jenkins Management > Clouds > kubernetes > Pod Templates

• The agent (Kubernetes) added from DevOps Console is registered as a Pod Template.
• If you selected Docker in Docker in the DevOps Console, the dind container has the default image address entered. Change to the docker:dind image address you pushed to your user repository.