This is the multi-page printable view of this section. Click here to print.
Tools & Templates
1 - Tool Management
Tools refer to applications that interact with the DevOps Console to support CI/CD functionality.
Please refer to Tool Classification for the list of tools supported by DevOps Console.
Getting Started with Tool Management
To begin tool management, follow the steps below.
- Click the Management icon at the top right of the Main page. You will be taken to the Tenant Dashboard page.
- From the left menu, click the Tools & Templates > Tools menu. You will be taken to the Tools page.
Tool type
Each tool’s applicable domain varies according to its type.
| Tool type | description |
|---|---|
| System Tool |
|
| Tenant Tool |
|
| ProjectGroup Tool |
|
Tool classification
The list of tools currently supported by the DevOps Console is as follows.
| Tool classification | tool |
|---|---|
| CICD Pipeline | Jenkins |
| SCM Repository | GitLab, GitHub, Git-based SCM |
| Image Registry | Harbor, Docker Hub, SCP Container Registry, Docker Image Registry |
| Code Quality | SonarQube |
| Artifact Repository | Nexus, Object Storage (S3 compatible) |
| Helm Chart Repository | Harbor |
| Project Management Software | JIRA |
- Supported tools may change (be added or removed) according to the release schedule.
- You can receive technical support for installing CI/CD tools through the Marketplace service of Samsung Cloud Platform. (Provided by eScore, and the supported tools can be checked in the Marketplace service)
Admin
Indicates the selected tenant or project group when adding a tool with the tenant/project group type.
Distinguish the types of management affiliation using the following icons.
- The management belongs to the tenant.
- The management affiliation is the project group.
Add tool
To add a tool, follow these steps.
- On the Tool page, click the Add button. The Add Tool popup appears.
Select tool support type
- Add Tool Select the tool’s supported type in the popup window.
- Complete the selection and click the Next button. The Basic Information input screen appears.
Item Explanation type Select the tool’s supported type - Refer to 툴 유형 for descriptions by type.
Tenant/Project Group Select which tenant/project group to map to. Table. Supported type selection items when adding a tool
Enter basic information
- Add Tool In the Basic Information input screen of the popup, select the tool category and the tool. The input screen changes based on the selected tool.
- Refer to Tool Classification for explanations by tool category.
- After entering the required information, click the Connection Test button.
- Click the Next button.
SCM Repository
| Item | description |
|---|---|
| Tool name | Enter the tool name for user identification. |
| Tool classification | Please select a tool category. |
| tool | Please select a tool. |
| URL | Enter the URL address to access the tool
|
| URL for API | Github.com Please enter the API path. |
| Whether Org creation is possible | Choose whether to enable the creation of a new Github Organization in this tenant/project group. |
| Whether new creation is possible | Select whether to allow creating new repositories in this tenant/project group. |
| IDP usage | Select whether to use IDP. |
| User account authentication type | Select the authentication type for the tool user. |
| Administrator account authentication type | Select the authentication type for the tool administrator. |
| Administrator ID | Please enter the tool administrator’s ID. |
| Administrator password / token | Enter the tool administrator’s password or token. |
CICD Pipeline
| Item | Explanation |
|---|---|
| Tool name | Enter the tool name for user identification. |
| Tool classification | Please select a tool category. |
| tool | Please select a tool. |
| URL | Enter the URL address to access the tool
|
| Mail Service | Choose whether to use the email sending feature. |
| Category | Select whether to use this tool for development or operation. |
| IP | Enter IP list
|
| IP range | Enter IP range
|
| IDP usage | Select whether to use IDP. |
| IDP type | When using IDP, select the IDP type (CMP IDP, other IDP). |
| User account authentication type | Select the authentication type for the tool user. |
| Administrator account authentication type | Select the authentication type for the tool administrator. |
| Admin ID | Please enter the tool administrator’s ID. |
| Administrator password / token | Enter the tool administrator’s password or token. |
If the Number of executors field of the Built-In Node in Jenkins system settings is set to 1 or higher, a security issue may arise, so the tool cannot be added.
- In the Jenkins management menu, the Number of executors field of the Built-In Node must be set to 0.
- Note Jenkins officially recommends avoiding running builds on the Controller Node.
Image Registry
| Item | description |
|---|---|
| Tool name | Enter the tool name for user identification. |
| Tool classification | Please select a tool category. |
| tool | Please select a tool. |
| Whether new creation is possible | Select whether to allow creating new repositories in this tenant/project group. |
| URL | Enter the URL address to access the tool
|
| URL for API | Enter the Docker Hub API path. |
| Image repository URL | Enter the URL for using Docker Registry. |
| Use private SSL certificate | Select whether to use a private SSL. |
| Include system common image | Select whether to include the system-wide image. |
| IDP usage | Select whether to use IDP. |
| User account authentication type | Select the authentication type for the tool user. |
| Administrator account authentication type | Select the authentication type for the tool administrator. |
| Administrator ID | Enter the tool administrator’s ID. |
| Administrator password / token | Enter the tool administrator’s password or token. |
Code Quality
| Item | Explanation |
|---|---|
| Tool name | Enter the tool name for user identification. |
| Tool classification | Please select a tool category. |
| tool | Please select a tool. |
| Whether new creation is possible | Select whether to enable creation of new SonarQube projects in this tenant/project group. |
| URL | Enter the URL address to access the tool
|
| Tool version | Enter the version of SonarQube. |
| IDP usage | Select whether to use IDP. |
| User account authentication type | Select the authentication type for the tool user. |
| Administrator account authentication type | Select the authentication type for the tool administrator. |
| Administrator ID | Enter the tool administrator’s ID. |
| Administrator password / token | Enter the tool administrator’s password or token. |
Artifact Repository
| Item | Explanation |
|---|---|
| Tool name | Enter the tool name for user identification. |
| Tool classification | Please select a tool category. |
| tool | Please select a tool. |
| Whether new creation is possible | Select whether to enable creation of a new Nexus repository in this tenant/project group. |
| URL | Enter the URL address to access the tool
|
| IDP usage | Select whether to use IDP. |
| User account authentication type | Select the authentication type for the tool user. |
| Administrator account authentication type | Select the authentication type for the tool administrator. |
| Administrator ID | Please enter the tool administrator’s ID. |
| Administrator password / token | Enter the tool administrator’s password or token. |
Helm Chart Repository
| Item | description |
|---|---|
| Tool name | Enter the tool name for user identification. |
| Tool classification | Please select a tool category. |
| tool | Please select a tool. |
| Whether new creation is possible | Select whether to allow creating new repositories in this tenant/project group. |
| URL | Enter the URL address to access the tool
|
| Use private SSL certificate | Select whether to use a private SSL. |
| Helm chart repository URL | Enter the repository URL for the tool
|
| IDP usage | Select whether to use IDP. |
| User account authentication type | Select the authentication type for the tool user. |
| Administrator account authentication type | Select the authentication type for the tool administrator. |
| Administrator ID | Please enter the tool administrator’s ID. |
| Administrator password / token | Enter the tool administrator’s password or token. |
Project Management Software
| Item | description |
|---|---|
| Tool name | Enter the tool name for user identification. |
| Tool classification | Please select a tool category. |
| tool | Please select a tool. |
| Whether new creation is possible | Choose whether to allow creation of new JIRA projects in this tenant/project group. |
| URL | Enter the URL address to access the tool
|
| IDP usage | Select whether to use IDP. |
| User account authentication type | Select the authentication type for the tool user. |
| Administrator account authentication type | Select the authentication type for the tool administrator. |
| Administrator ID | Please enter the tool administrator’s ID. |
| Administrator password / token | Enter the tool administrator’s password or token. |
Enter additional information
- Tool addition In the popup window’s Basic Information input screen, when you click the Next button, the Additional Information input screen appears.
- Select each item and click the Complete button.
- In the confirmation popup, click the Confirm button to complete adding the tool.
Item description Use status Select whether to use the tool in this tenant/project group. Whether new creation is possible Select whether to allow creating a new repository in the given tenant/project group. - It is displayed only when the tool category is SCM Repository.
Table. Additional Information Input Items
Tool Details
To begin managing the tool’s detailed information, follow these steps.
- On the Tool page, click the tool for which you want to manage detailed information. You will be taken to the Tool Details page.
Manage tool basic information
To check the tool’s basic information, follow these steps.
- On the Tool Details page, click the Basic Information tab.
To modify the tool’s basic information, follow these steps.
- On the Tool Details page, click the Basic Information tab.
- Click the Edit button.
- After editing the required information, click the Save button.
Managing Global Tools
Jenkins, the global tool tab is displayed.Jenkins web interface’s Jenkins Management > Global Tool Configuration menu can be operated from the DevOps Console.
Only one-way registration to Jenkins is supported from the DevOps Console. (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 Tools are used in Tools when configuring a stage.
To manage the global tool, follow the steps below.
- On the Tool Details page, click the Global Tool tab.
Add global tool
To add a global tool, follow these steps.
- In the Global Tool tab, click the Edit icon of the item you want to add. The Global Tool Management popup opens.
- Essential tool is automatically configured in the DevOps Console.
- essential tool cannot be deleted, and only the home path can be modified.
- Click the Add button. A new row will be added at the bottom of the list.
- Enter the information in the newly added row and click the Save button.
- Click the Confirm button in the confirmation popup to complete.
Item description Tool types The tool type is set automatically. Name Please enter the tool name. Home path Enter the path where the tool is installed. Table. Global Tool Additional Input Items
Modify Global Tool
To modify the global tool, follow these steps.
- Click the Edit icon of the item you want to add in the Global Tool tab. The Global Tool Management popup opens.
- After editing the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Delete Global Tool
To delete the global tool, follow these steps.
- Click the Edit icon of the item you want to add in the Global Tool tab. The Global Tool Management popup window opens.
- After deleting the list, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Managing agents (kubernetes)
Jenkins, the Agent (kubernetes) tab is displayed.Users can manage the agents (slave) used for builds in Jenkins.
Jenkins web screen’s 1) Jenkins Management > System Configuration > Cloud > Pod Templates or 2) Jenkins Management > Node Management > Configure Clouds > Pod Templates menu is a feature that can be operated from the DevOps Console.
DevOps Console only supports one-way registration to Jenkins. (In other words, changes made by the user in DevOps Console will overwrite the information in Jenkins.)
To manage the agent (Kubernetes), follow the steps below.
- On the Tool Details page, click the Agent (Kubernetes) tab.
- Click the information icon in the Pod Template Management list. The Pod Template Usage Guide popup opens.
Adding Container Resource Types
If the user modifies the container resource type, it affects the Pod Template.
- If you change the container resource type from unused → used, the number of Pod Templates will increase by (container resource type number X Pod Template number).
- If you change the container resource type from used → unused, the expanded Pod Template will shrink back to its original number.
- The agent names, labels, and other attributes of the expanding Pod Templates are automatically generated by combining the Resource Type entry entered by the user when registering the container resource type, to avoid duplication.
To add a container resource type, follow these steps.
- On the Tool Details page, click the Agent (Kubernetes) tab.
- Click the Edit icon of Container Resource Type Management. The Container Resource Type Management popup window opens.
- Click the Add button, enter the content, and then click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Item description Whether to use Set the usage. - To change the usage, there must be no build pipeline configured using the
Jenkinstool.
Resource Type Please enter the resource name. CPU/Memory (Request) When configuring the Kubernetes Pod Agent, enter the requested resource values to be used. CPU/Memory (Limit) Enter the limit values for the resources to be used when configuring the Kubernetes Pod Agent. Table. Container Resource Type Additional Input Items - To change the usage, there must be no build pipeline configured using the
Modify container resource type
To modify the container resource type, follow these steps.
- On the Tool Details page, click the Agent (Kubernetes) tab.
- Click the Edit icon of Container Resource Type Management. The Container Resource Type Management popup opens.
- After editing the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Delete Container Resource Type
To delete a container resource type, follow these steps.
- On the Tool Details page, click the Agent (Kubernetes) tab.
- Click the Edit icon of Container Resource Type Management. The Container Resource Type Management popup opens.
- After deleting the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Add Pod Template
To add a Pod Template, follow these steps.
- On the Tool Details page, click the Agent (Kubernetes) tab.
- Pod Template Management Click the Add button in the list. The Add Agent (Kubernetes) screen appears.
- After entering the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Item description Target Kubernetes Select the target Kubernetes to which the Pod Template will be added - Displays the list of Kubernetes clusters registered in Jenkins.
Agent name Enter the name of the Pod Template. Label Enter the Label value to invoke the agent in the Jenkins Pipeline Script. Inherited Pod Template Select the Pod Template that inherits configuration values (environment variables, Volume…) - Shows the list of Pod Templates registered in the actual Jenkins.
container Enter the name, Docker image, working directory, command, and argument values that map to the Container Template field in Jenkins. - Required container information cannot be deleted, and its name cannot be changed.
Tool path Information that maps to the Tool Locations field in Jenkins, enter the name/home path - Only tools that have been added to the global tool list can be selected.
Support stage Select the supported stage configuration - This information is used for configuring the build pipeline template in the DevOps Console.
- Required stage information cannot be deselected.
Table. Input items for adding a Pod Template
If the user does not check Docker Build in the Supported Stage item,
- When setting up a project using the App.Template of type Kubernetes or VM(Docker) that requires Docker Build, Jenkins cannot be used.
- When configuring the build pipeline via Add Build Pipeline, you cannot add a Docker Build stage.
Pod Template Details
To view the detailed information of a Pod Template, follow these steps.
- On the Tool Details page, click the Agent (Kubernetes) tab.
- Pod Template Management Click the Details button of the agent you want to view from the list. The Agent (Kubernetes) Details screen appears.
Modify Pod Template
To modify the Pod Template, follow these steps.
- On the Tool Details page, click the Agent (Kubernetes) tab.
- Pod Template Management Click the View Details button of the agent you want to view in the list. The Agent (Kubernetes) Details screen appears.
- Click the Edit button.
- After editing the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete the edit.
Delete Pod Template
To delete a Pod Template, follow these steps.
- On the Tool Details page, click the Agent (Kubernetes) tab.
- Pod Template Management In the list, click the Details button of the agent you want to view. Agent (Kubernetes) Details screen appears.
- Click the Delete button.
- In the confirmation popup, click the Confirm button to complete the deletion.
Managing Agents (VM)
Jenkins, the Agent (VM) tab is displayed.You can manage the list of Nodes available for use in Jenkins.
This feature allows you to operate the Jenkins Management > Node Management menu of Jenkins from the DevOps Console.
DevOps Console only supports one-way registration to Jenkins. (In other words, changes made by the user in DevOps Console will overwrite the information in Jenkins.)
To manage the agent (VM), follow the steps below.
- On the Tool Details page, click the Agent (VM) tab.
- Click the Info icon in the Node Management list. The Node Usage Guide popup opens.
Manage Agent Connections
Register the tunneling port that connects the actual Jenkins and the agent (VM). The tunneling port may vary for each Jenkins.
To manage agent connections, follow these steps.
- On the Tool Details page, click the Agent (VM) tab.
- Click the Edit icon of Agent Connection Management. The Agent Connection Management popup window opens.
- After entering the content, click the Save button.
Add Agent (VM)
To add an agent (VM), follow the steps below.
- On the Tool Details page, click the Agent (VM) tab.
- Click the Add button in Agent Connection Management. The Add Agent (VM) screen appears.
- After entering the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete the deletion.
Item description Target OS Enter the VM’s OS information. Agent name Enter the VM name. Remote root directory Enter the directory path. Label Enter the Label value to invoke the agent in the Jenkins Pipeline Script. Tool path Information that maps to the Jenkins Tool Locations field, enter the name/home path - Only tools added to the global tool list can be selected.
Support stage Select the supported stage configuration - This information is used for configuring the build pipeline template in the DevOps Console.
- Required stage information cannot be deselected.
Table. Agent (VM) Add Input Items
If the user does not check Docker Build in the Supported Stage item,
- When configuring a project through the App.Template of type Kubernetes or VM(Docker) that requires Docker Build, the
Jenkinscannot be used. - Through Add Build Pipeline, when configuring the build pipeline, you cannot add a Docker Build stage.
Agent (VM) Details
To view the detailed information of an agent (VM), follow the steps below.
- On the Tool Details page, click the Agent (VM) tab.
- In the Node Management list, click the agent. The Agent (VM) Details screen appears.
- Click the Information icon of Jenkins - Agent Connection Information.
- Agent Connection Guide The popup window opens.
Integrate Agent (VM)
Java be installed on the VM server.To register and use the agent (VM), you must connect to the actual VM server.
To integrate the agent (VM), follow these steps.
- On the Tool Details page, click the Agent (VM) tab.
- From the Node Management list, click the agent you want to integrate. The Agent (VM) Details screen appears.
- Refer to
jnlpUrlandsecret. - Click the Info icon of Jenkins - Agent Connection Information. The Agent Connection Guide popup opens.
- Agent File Download Click the button to download the
agent.jarfile.- There may be issues running depending on the version of
agent.jar. - You can also download it directly from your own
Jenkins. ({JENKINS_URL}/jnlpJars/agent.jar)
- There may be issues running depending on the version of
- Connect to the VM server to be deployed and create a directory.
- Copy the downloaded
agent.jarfile to the generated directory. - Run the following command in the generated directory path.
java -jar agent.jar -jnlpUrl {jnlpUrl} -secret {secret}java -jar agent.jar -jnlpUrl {jnlpUrl} -secret {secret}Modify Agent (VM)
To modify the agent (VM), follow the procedure below.
- On the Tool Details page, click the Agent (VM) tab.
- Click the agent you want to edit in the Node Management list. The Agent (VM) Details screen appears.
- Click the Edit button.
- After editing the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Delete Agent (VM)
To delete the agent (VM), follow these steps.
- On the Tool Details page, click the Agent (VM) tab.
- Click the agent you want to delete from the Node Management list. The Agent (VM) Details screen appears.
- Click the Delete button.
- Click the Confirm button in the confirmation popup to complete.
Managing Global Libraries
You can manage the list of libraries available in the build pipeline.
The Jenkins Management → System Settings → Global Pipeline Libraries menu of Jenkins can be managed through the DevOps Console.
The Credential information linked to the library can be viewed in the Jenkins Management > Manage Credentials menu.
DevOps Console only supports one-way registration to Jenkins. (In other words, changes made by the user in DevOps Console will overwrite the information in Jenkins.)
To manage the agent(VM), follow these steps.
- On the Tool Details page, click the Global Library tab.
Add Global Library
To add a global library, follow these steps.
- Tool Details on the page, click the Global Library tab.
- Click the Add button. The Add Global Library screen appears.
- After entering the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Item description Library name Enter the name of the library. type It is fixed to SCM and cannot be changed. Library URL Enter the Git repository URL where the library is located. Default version Enter the branch name or tag of the Git repository that contains the library. ID Enter the ID to pull the library. password Enter the password to pull the library. Table. Global Library Additional Input Items
Global Library Details
To view the detailed information of the global library, follow these steps.
- On the Tool Details page, click the Global Library tab.
- In the Global Library list, click the item you want to view in detail. The Global Library Details screen appears.
When type is SCM, SCM-related information is displayed.
- Required library status, library name, type, library URL, default version, ID
Modify Global Library
To modify the global library, follow these steps.
- On the Tool Details page, click the Global Library tab.
- From the Global Library list, click the item you want to view in detail. The Global Library Details screen appears.
- Click the Edit button.
- After editing the content, click the Save button.
- Click the Confirm button in the confirmation popup to complete.
Delete Global Library
To delete the global library, follow these steps.
- Tool Details on the page, click the Global Library tab.
- Global Library Click the item you want to delete from the list. Global Library Detail screen appears.
- Click the Delete button.
- In the confirmation popup, click the Confirm button to complete.
Manage supported tenants/project groups
The tab name is displayed differently depending on the tool type.
- System Tool/Tenant Tool: Supported Tenant
- ProjectGroup Tool: Support Information
The user can manage the tenant or project group that will use the tool.
To manage supported tenants or project groups, follow these steps.
- On the Tool Details page, click the Supported Tenant or Supported Information tab.
Add supported tenant/project group
To add a supported tenant or project group, follow these steps.
- On the Tool Details page, click the Supported Tenant or Supported Information tab.
- Click the Add button. The Add Tenant/Project Group popup window opens.
- After entering the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Item description Tenant/Project Group Select the tenant/project group that will use the tool. Use status Select whether to use the tool in this tenant/project group. Whether new creation is possible Select whether to allow creating new repositories in this tenant/project group.
This setting can only be configured for the tool categories listed below.- SCM Repository
- Image Registry
- Code Quality
- Artifact Repository
- Helm Chart Repository
- Test Management
- Project Management Software
Table. Additional Input Items for Supported Tenant/Project Group
Modify supported tenant/project group
To modify the supported tenant/project group, follow these steps.
- On the Tool Details page, click the Supported Tenant or Support Information tab.
- In the Supported Tenant or Supported Information list, select Usage status and New creation allowed to modify.
Transfer Management Tenant/Project Group
To transfer the management tenant/project group, follow the steps below.
- On the Tool Details page, click the Supported Tenant or Supported Information tab.
- Click the Transfer Management Tenant or Transfer Management Project Group button. The Transfer Management Tenant or Transfer Management Project Group popup window opens.
- Select the target tenant or project group for transfer, then click the Save button.
Delete supported tenant/project group
To delete a managed tenant/project group, follow these steps.
- On the Tool Details page, click the Supported Tenant or Supported Information tab.
- Select the checkbox of the tenant/project group you want to delete.
- Click the Delete button.
- Click the Confirm button in the confirmation popup to complete.
Support K8S cluster management
The user can manage the K8S cluster where the tool will be used.
To manage the supported K8S cluster, follow these steps.
- On the Tool Details page, click the Supported K8S Cluster tab.
Add supported K8S cluster
To add a supported K8S cluster, follow the steps below.
- On the Tool Details page, click the Supported K8S Cluster tab.
- On the Supported K8S Cluster page, click the Add button. The Add K8S Cluster popup window opens.
- After entering the content, click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Item description K8S cluster Select the K8S cluster to use with the tool. Use status Select whether to use the tool in this tenant/project group. Whether new creation is possible Select whether to allow creating new repositories in this tenant/project group.
This setting can only be configured for the tool categories below.- SCM Repository
- Image Registry
- Code Quality
- Artifact Repository
- Helm Chart Repository
- Test Management
- Project Management Software
Table. Additional input fields for supported K8S clusters
Modify supported K8S cluster
To modify the supported K8S cluster, follow the steps below.
- On the Tool Details page, click the Supported K8S Cluster tab.
- In the Supported K8S Clusters list, select Usage Status and New Creation Availability to edit.
Delete supported K8S cluster
To delete the supported K8S cluster, follow these steps.
- Click the Supported K8S Cluster tab on the Tool Details page.
- Supported K8S clusters list, select the checkbox of the K8S cluster you want to delete.
- Click the Delete button.
- In the confirmation popup, click the Confirm button to complete.
Manage tool operators
To manage tool operators, follow the steps below.
- On the Tool Details page, click the Tool Operator tab.
Add tool operator
To add a tool operator, follow these steps.
- Tool Details page, click the Tool Operator tab.
- Click the Add button. The Add Tool Operator popup opens.
- Select the operator and click the Save button.
- In the confirmation popup, click the Confirm button to complete.
Delete tool operator
To delete a tool operator, follow these steps.
- Tool Details page, click the Tool Operator tab.
- Select the checkbox for the item you want to delete from the tool administrator list.
- Click the Delete button.
- In the confirmation popup, click the Confirm button to complete.
Managing Jenkins Recommended Plugins
Jenkins, the plugin tab is displayed.You can check the installed Jenkins version and whether recommended plugins are installed and their version information, and you can update and install the recommended plugins.
- Tool version: Jenkins version information
- Recommended plugins: installation status and version information
Check tool version and recommended plugin information
To check the tool version and recommended plugin information, follow these steps.
- Tool Details page, click the Basic Information tab.
- If there is recommended plugin information that requires installation or update, an informational popup appears, and clicking OK moves you to the Plugins tab.
- On the Tool Details page, click the Plugin tab.
- Check the entries for Tool Version, Recommended Plugins.
Install recommended plugins
To install the recommended plugin, follow these steps.
- In the Recommended plugins area, select the Install button of the plugin you want to install.
- In the Recommended Plugin Installation popup, select the OK button.
- A popup appears indicating that the installation request has been completed, and the actual installation details can be viewed via the link in the popup.
Update recommended plugins
To update the recommended plugin, follow these steps.
- In the Recommended plugins area, select the Update button of the plugin you want to update.
- Select the Confirm button in the Recommended Plugin Update popup.
- A popup appears indicating that the installation request has been completed, and the actual installation details can be viewed via the link in the popup.
- You must restart Jenkins to apply the update you need to do so.
Delete tool
To uninstall the tool, follow these steps.
- On the Tool page, click the tool you want to delete. You will be taken to the Tool Details page.
- Click the Delete button.
- In the confirmation popup, click the Confirm button to complete.
2 - App Template
App. A template is a feature provided to enable users to quickly set up a development environment.
The App. template consists of sample source code, Dockerfile, Helm chart, etc., and users can quickly set up a development environment using the App. template when creating a project.
We provide App templates for various frameworks such as Node.js, Python, Spring Boot, and users can also create and register their own App templates.
| App. template type | Explanation |
|---|---|
| System Template |
|
| Tenant Template |
|
| ProjectGroup Template |
|
App. Getting Started with Template
App. To start template management, follow the steps below.
- Click the Admin icon at the top right of the Main page. You will be taken to the Tenant Dashboard page.
- From the left menu, click the Tools & Templates > App. Templates menu. You will be taken to the App. Templates page.
App. Add Template
Users can add their own App templates.
Source code
App. This is the source code that will be used in the template to build a sample project.
App. A usable SCM Repository must exist in the tenant or project group where the template will be registered. For instructions on registering an SCM Repository tool, see Add Tool.
Register the source code in the SCM Repository in advance. When registering an App template, the corresponding SCM Repository appears, and you should enter the path of the pre-registered source code.
Dockerfile
Dockerfile without registering it inside the source code. For related information, see Dockerfile Template Management.See the official site for documentation and instructions on writing a
Dockerfile.To register an App. Template that supports deployment target projects in the form of Kubernetes or VM (Docker), you must either add a Dockerfile to the source code when registering the source code or register a Dockerfile through 도커파일 템플릿 관리하기.
When writing a Dockerfile, the FROM clause must be fixed as FROM ${BASE_IMAGE}.
The registered ${BASE_IMAGE} value is substituted via the Velocity Template Engine as the image.repository value in the Helm chart when the deployment target is Kubernetes, and as the image path registered in Managing Supported Images when the deployment target is VM (Docker).
Dockerfile file 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"]App. Register Template
App. To register a template, follow these steps.
- Click the Add button on the App. Template page. You will be taken to the App. Template Add page.
- App. Add Template On the page, select the template support type and click the Start button.
- After entering the required information, click the Complete button.
Item Explanation type Select the template type. - Refer to App. Template Type for type-specific descriptions.
Tenant/Project Group Select the tenant/project group to map. Table. App. Add Template - Template Supported Type Selection ItemItem Explanation Deployment target Select the deployment target supported by the template - Kubernetes: when the deployment target is a cluster using Helm charts
- VM(Artifact): when the deployment target is a VM server using an Artifact file
- VM(Docker): when the deployment target is a VM server using a Docker image
- N/A: when there is no deployment target (ex. Android)
Template name App. Enter the name of the template. Application classification Select the category of the application included in the template - Used to classify the template.
language Select the programming language of the source code included in the template. source code Select whether the template includes source code. Source code repository type Select the location where the source code to be included in the template is stored. You can choose SCM or a compressed file (ZIP). Repository URL Enter the repository URL where the template source code is located - The list of SCM Repository tool available in the tenant and project group will be displayed.
Repository branch Enter the branch of the repository where the template source code is located. Individual authentication information Enter the credentials to access the repository - If you select ‘Do not use’, the credentials used when registering the tool will be used.
Dockerfile path Enter the Dockerfile path within the repository - Used when building the Docker image.
code quality Select whether to use code quality. Explanation App. Write a description for the template. Document URL Enter the URL of the document that describes the template - It will appear as a link on the template selection page when creating a project.
Template icon Select the icon to use in the template. Build output path Specify the build output path and filename. Dockerfile type Select Dockerfile type - You can choose whether to use the Dockerfile file within SosoCode, or to use the information registered in Manage Dockerfile Templates.
- When you select the GUI template, the Dockerfile Template tab becomes active.
Table. App. Add Template - Basic Information Input Items
App. Only when the template’s deployment target is Kubernetes, the supported Helm chart step is added.
- Select the Helm chart that can be used when deploying with this App template.
- After selecting the checkbox, you can select the Helm chart list using the Add, Delete buttons in the center.
After completing Add Pipeline Template, please refer to Modify Supported Tenant Information and modify the usage status.
App. Edit template basic information
App. To modify the template’s basic information, follow these steps.
- On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
- Click the Basic Information tab on the App. Template Details page.
- Click the Edit button in the Basic Information tab.
- After editing the required information, click the Save button.
Manage pipeline templates
This is the build pipeline configuration that is automatically set up when a user creates a project using the App template.
Add pipeline template
To add a pipeline template, follow these steps.
- On the App. Template page, click the item you want to add. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Pipeline Template tab.
- Click the Add button on the Pipeline Template tab. You will be taken to the Add Pipeline Template page.
- On the Add Pipeline Template page, enter the required information and click the Save button.
Item Explanation Template name Enter the name of the pipeline template. Base Template
(Base Template)- The default template is used for pipeline configuration when creating a project.
- If a default template is not registered, it is automatically set to ON, and this setting cannot be changed.
Support Jenkins Select the Jenkinsthat will support this pipeline template- A list of CICD pipeline tools available in the tenant and project group is displayed.
- It is required to refer to the necessary information in the Tools area when configuring stages.
environment variable Enter environment variable information - For detailed information about environment variables, refer to Configure environment variables.
Stage Enter information for each stage - For detailed information about stages, refer to Setting up stages.
Table. Pipeline Template Additional Input Items
Jenkins environment variables, refer to the official site official site.Edit pipeline template
To modify the pipeline template, follow these steps.
- On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Pipeline Template tab.
- Click the item you want to edit in the Pipeline Template tab. You will be taken to the Pipeline Template Details page.
- On the Pipeline Template Details page, click the Edit button. You will be taken to the Pipeline Template Edit page.
- On the Pipeline Template Edit page, after modifying the information, click the Save button.
Delete pipeline template
To delete a pipeline template, follow these steps.
- Click the item you want to delete on the App. Template page. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Pipeline Template tab.
- Click the item you want to delete in the Pipeline Template tab. You will be taken to the Pipeline Template Details page.
- On the Pipeline Template Details page, click the Delete button.
- Click the Confirm button in the confirmation popup.
Managing Dockerfile Templates
App. In the Basic Information section of the template, the tab appears only when the Dockerfile Type item is GUI Template.
Modify Dockerfile template
Follow these steps to modify the Dockerfile template.
- On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Dockerfile Template tab.
- Click the Edit or Create button in the Dockerfile Template tab.
- After entering the content in the Dockerfile Template tab, click the Save button.
Item Explanation Authentication Settings Register the authentication information for the image to be used in the FROM clause of a multi-stage build. Add Add the image to be used in the FROM clause of the multi-stage build. Multi-stage Dockerfile Configure the Multi-stage based on the credentials and additional items you registered. Dockerfile Create a basic Dockerfile. Table. Dockerfile Template Modification Input Items
You can manage it within the source code via Dockerfile without registering a Dockerfile template.
- When using a Dockerfile file included in the source code, the Basic Information section of the App template must have the Dockerfile Type field set to File in Code Repository.
The FROM clause is automatically set to the image path registered in 지원 이미지 관리하기.
Manage supported tenants/project groups
The tab name is displayed differently depending on the template type.
- System Template/Tenant Template: Supported Tenant
- ProjectGroup Template: Support Information
The user can manage the tenant or project group where the App template will be used.
To manage supported tenants or project groups, follow these steps.
- Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Supported Tenant or Supported Information tab.
Primary icon appears on the tenant you manage.Add supported tenant
To add a supported tenant, follow these steps.
- Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Supported Tenants tab.
- Click the Add button on the Supported Tenant tab. The Add Tenant popup window opens.
- Add Tenant In the popup window, select the tenant you want to support, then click the Save button.
Edit supported tenant information
To modify the information of the supported tenant, follow these steps.
- Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Supported Tenants tab.
- In the Supported Tenant tab, select the verification status and usage status items for the tenant you want to change, and edit them.
Item Explanation Tenant Available tenant information. Verification status Select verification status - Verifying
- Verification complete
Whether to use Select usage status - It can be changed to Use only when Verification status is Verified.
Table. Supported Tenant Screen Items
If the verification status is under verification, only users who have registered the App template can use it.
- Other users can use the App template after verification and approval are completed.
Edit supported project group information
To modify the information of the supported project group, follow these steps.
- Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Support Information tab.
- Click the Edit button in the Support Information tab. The App. Template Edit screen appears.
- On the App. Template Edit screen, select the verification status and usage status items to edit them.
- Click the Save button.
Item Explanation Project Group Available project group information. Verification status Select verification status - Verifying
- Verification complete
Whether to use Select usage - Verification status can be changed to Use only when it is Verification completed.
Table. Support Information Screen Items
If the verification status is “in verification,” only users who have registered the App template can use it.
- Other users can use the App template after verification and approval are completed.
Transfer Management Tenant
To transfer the management tenant, follow these steps.
- Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Supported Tenants tab.
- On the Support Tenant tab, click the Transfer Management Tenant button. The Transfer Management Tenant popup window opens.
- Management Tenant Transfer In the popup window, after selecting the target tenant for transfer, click the Save button.
Delete supported tenant
To delete a supported tenant, follow these steps.
- Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Supported Tenants tab.
- In the Supported Tenant tab, select the tenant you want to delete and click the Delete button.
- In the confirmation popup, click the Confirm button.
Manage supported images
The supported image registered by the user is used in the FROM clause registered in the source code’s Dockerfile or Dockerfile template.
Add supported image
To add a supported image, follow the steps below.
- On the App. Template page, click the item you want to edit. You will be taken to the App. Template Detail page.
- On the App. Template Details page, click the Supported Image tab.
- In the Supported Image tab, click the Add button. The Add Supported Image popup window opens.
- Add supported image After entering the information in the popup window, click the Connection Test button.
- Save button is enabled, click the Save button.
- In the confirmation popup, click the Confirm button.
Item Explanation Enter image information Enter the supported image and authentication information. Use the registrant’s authentication information This is an option that can be selected when the chosen image registry is a tool that cannot grant permissions (e.g., SCR). - If not checked, when a supported image user creates a project, the Pull permission for the image entered by the supported image user is added. If the tool cannot grant permissions, no permission granting is performed.
- If not checked, when a supported image user creates a project, the authentication credentials of the supported image registrant are used instead of the supported image user’s permissions.
Table. Additional Input Fields for Supported Image
Precautions when checking the use of the registrant’s authentication information
- Since the registrant’s authentication credentials may be exposed to users of the supported image, it should be used only when necessary.
- If the image repository only supports pulling images, you must select it to avoid problems during use. You must specify an image repository that will be used exclusively for pulling. (If selected, pulling and pushing cannot be performed simultaneously on the same image repository.)
- The registrant’s credentials are used in the project > image repository > pull-only image. These credentials cannot be changed by supported image users, and if the registrant’s credentials are re-registered in a supported image, they are updated uniformly.
Delete supported image
To delete the support image, follow these steps.
- On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Supported Image tab.
- In the Supported Images tab, select the checkbox of the item to delete and click the Delete button.
- In the confirmation popup, click the Confirm button.
Manage supported Helm charts
Refer to Add Helm Chart for registering supported Helm charts.
The supported Helm chart registered by the user is used when creating a project using the App. template.
Add support for Helm chart
To add a supported Helm chart, follow these steps.
- Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
- App. Template Details on the page, click the Supported Helm Chart tab.
- In the Supported Helm Chart tab, click the Edit button. The App. Template Edit screen appears.
- App. Template Modification On the screen’s Helm Chart List, select the checkbox of the Helm chart to be used, then add it to the Selected Helm Chart List using the Add button, and click the Save button.
Modify the supported Helm chart
To modify the supported Helm chart, follow these steps.
- On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
- Click the Supported Helm Chart tab on the App. Template Details page.
- Click the Edit button in the Supported Helm Chart tab. The App. Template Edit screen appears.
- On the App. Template Edit screen’s Helm Chart List, select the checkboxes of the Helm charts to use, then modify the Selected Helm Chart List using the Add and Delete buttons, and click the Save button.
Delete supported Helm chart
To delete the support Helm chart, follow these steps.
- Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
- On the App. Template Details page, click the Supported Helm Chart tab.
- Click the Edit button in the Supported Helm Chart tab. The App. Template Edit screen appears.
- App. Template Edit on the Selected Helm Chart List screen, select the checkbox of the Helm chart to delete, then delete it using the Delete button and click the Save button.
App. Delete Template
App. To delete the template, follow these steps.
- Click the item you want to delete on the App. Template page. Navigate to the App. Template Details page.
- On the App. Template Details page, click the Basic Information tab.
- Click the Delete button on the Basic Information tab.
- In the confirmation popup, click the Confirm button.
3 - Register User-installed Jenkins Tool
- It is recommended to use the Samsung Cloud Platform Marketplace for installing and operating Jenkins.
- If you cannot use the Marketplace or need to register a self‑installed Jenkins as a tool in the DevOps Console, refer to this document.
- This document guides the registration of the Jenkins tool in DevOps Console, so it provides only a brief overview of Jenkins installation and operation.
Getting started with registering a user-installed Jenkins tool
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 a domain for Jenkins access
- Jenkins domain is registered in DNS
- Use HTTPS (port 443) and a public certificate for Jenkins communication.
Installation
Install Jenkins on a VM or Kubernetes
Plugin Installation
Install the following plugins in Jenkins.
| Plugin ID | Name |
|---|---|
| apache-httpcomponents-client-4-api | Apache HttpComponents Client 4.x API |
| credentials | Credentials |
| credentials-binding | Credentials Binding |
| github | GitHub |
| jobConfigHistory | Job Configuration History |
| kubernetes | Kubernetes |
| mask-passwords | Mask Passwords |
| maven-plugin | Maven Integration |
| matrix-auth | Matrix Authorization Strategy |
| metrics | Metrics |
| pipeline-stage-view | Pipeline: Stage View |
| pipeline-utility-steps | Pipeline Utility Steps |
| script-security | Script Security |
| ssh-steps | SSH Pipeline Steps |
| workflow-aggregator | Pipeline |
| workflow-step-api | Pipeline: Step API |
Jenkins configuration
Common Settings
Jenkins Administration > System
| Item | value | Explanation |
|---|---|---|
| of executors | 0 | Set to 0 to restrict direct build execution on the Controller and allow builds only on the Agent. |
| Jenkins URL | (ex) https://{YOUR_DOMAIN}/jenkins/ | |
| System Admin e-mail address | (ex) admin@example.com |
Jenkins Administration > Security
| Item | value | Explanation |
|---|---|---|
| Authorization | Project-based Matrix Authorization Strategy | |
| Authenticated Users | Overall > Read | |
| <ADMIN_USER> | Overall > Administer | Add admin account using Add user |
Support email format for Jenkins Username
- By default, Jenkins does not allow the @ sign or dot (.) to be used in the login username. However, since DevOps Console uses an email address as the username, we configure Jenkins to allow email addresses as usernames as well.
- Create the file
/{JENKINS_HOME}/init.groovy.d/init.groovy, add the following content, and restart Jenkins.- (ex)
/var/jenkins_home/init.groovy.d/init.groovy
- (ex)
hudson.security.HudsonPrivateSecurityRealm.ID_REGEX=/^[\w-\.\@\_]+$/hudson.security.HudsonPrivateSecurityRealm.ID_REGEX=/^[\w-\.\@\_]+$/Additional Jenkins configuration installed on Kubernetes
RBAC
Configure 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: jenkinsJenkins Management > Clouds
kubernetes
- Add the kubernetes cloud.
- Set up the Kubernetes cloud as follows. Use the default values for the remaining items.
| Item | value | Explanation |
|---|---|---|
| Cloud name | kubernetes | |
| Type | Kubernetes selection | |
| Kubernetes URL | https://kubernetes.default | Create a Pod (Agent) in the cluster where Jenkins is running |
| Disable https certificate | check | |
| Kubernetes Namespace | (example) jenkins | Enter the Namespace where the Jenkins Controller is running, and a Pod (Agent) is created in that Namespace. |
| WebSocket | check | |
| Jenkins URL | (example) http://{JENKINS_SERVICE_NAME}:{PORT}/jenkins |
|
kubernetes > Pod Templates
- Add a Pod Template.
- BASE-TEMPLATE is a parent template used in the DevOps Console to define values that should be shared across all Pod Templates.
| Item | value | Explanation |
|---|---|---|
| Name | BASE-TEMPLATE | |
| Image Pull Secret | {IMAGE_PULL_SECRET} Enter name | Create a Secret in the Namespace so that the Pod(Agent) image can be pulled, and enter its name. |
Register Jenkins tool in DevOps Console
Register Firewall
Refer to the table below and register the firewall in Jenkins.
| Origin | Destination | Destination Port |
|---|---|---|
| User install Jenkins | DevOps Console web | 443 |
| DevOps Console source IP | User install Jenkins web | 443 |
DevOps Console Tasks
- For detailed information about registering the Jenkins tool, see Add Tool
- In the tool registration step, check the plugins installed on Jenkins, and if any plugins need to be installed, a plugin installation guide page will be displayed. Download and install the plugins as instructed.
Jenkins Verification
Jenkins Management > System
Global Trusted Pipeline Libraries
- Check that cicdpaas is configured in the Library.
- If it is not configured
- Verify the communication between DevOps Console and Jenkins.
- DevOps Console > Management > Jenkins detail screen > Check the settings in the Global Library tab.
DevOps Console Credentials
- Test Connection Click the button to confirm that Success appears.
Add an agent (VM) to Jenkins
DevOps Console Tasks
Jenkins Tasks
Jenkins Management > Nodes > Agent Detail View
Verify that the Agent added in the DevOps Console has been created. Run the Agent according to the guide on the Jenkins screen and connect it to Jenkins.
Add an agent (Kubernetes) to Jenkins
Before Adding a Kubernetes Agent
Create User‑Jenkins Agent Image
- For CI/CD in Jenkins, an agent image is required.
- Create a Jenkins agent image that matches the user’s needs by using the default images provided by Jenkins.
- After creating the image, push it to the user’s 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 jenkinsFROM 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 jenkinsDocker‑in‑Docker Image
- In the DevOps Console, Docker in Docker is used to create Docker images in a Kubernetes environment.
- Use Docker’s provided
dind(Docker‑in‑Docker) image and push it to your repository.
DevOps Console Tasks
- Add Pod Template
- By default, one (or multiple) agents are registered. Delete the default registered agent.
- If you need to build a Docker image, select Docker in Docker.
- Enter the JNLP image URL with the Jenkins agent address of the user you created above.
Jenkins Tasks
Jenkins Management > Clouds > Kubernetes > Pod Templates
- The agent (Kubernetes) added from the DevOps Console is registered as a Pod Template.
- If Docker‑in‑Docker is selected in DevOps Console, the default image address is pre‑filled in the dind container. Replace it with the image address you pushed to your repository.