Note: I translated the title and description to English while keeping the rest of the Markdown grammar and document format intact.
This is the multi-page printable view of this section. Click here to print.
Getting Started
1 - Getting Started with DevOps Console
This guide explains how to log in to the DevOps Console, set the display language, and configure user information.
Signing Up
To use the DevOps Console, you need to create a separate DevOps Console account, which is distinct from the Samsung Cloud Platform account. You can create an account by signing up.
To create an account in the DevOps Console, follow these steps:
- Click the Sign Up link on the login page. You will be redirected to the sign-up page.
- Complete the Identity Verification process. After completing the verification, click the Next button.
Item RequiredDescription CAPTCHA Required Enter the characters displayed in the image into the input field Table. Identity Verification Information - Agree to the terms and conditions in the Sign-up Information section.
Item RequiredDescription Terms of Service Required Check to agree to the terms of service Privacy Policy Required Check to agree to the collection and use of personal information I am 14 years old or older. Required Check to confirm that you are 14 years old or older Table. Sign-up Information - Enter the required information in the User Information section.
Item RequiredDescription User ID (Email) Required Enter the email address to use as your user ID Mobile Phone Number Required Enter your mobile phone number - Enter your mobile phone number and click the Send OTP button to receive an OTP number
- Enter the OTP number received on your mobile phone and click the Verify button
- If the OTP number is valid, the mobile phone number verification is complete
Password Required Enter a password to use, which must be 8-20 characters long - Cannot use your user ID or name as your password
- Must include at least one uppercase letter (English), one lowercase letter (English), one number, and one special character (
!@#$%^&*) - Cannot use the same character three or more times in a row
- Cannot use four or more consecutive characters or numbers
- Password change cycle: 90 days
Confirm Password Required Confirm the password you want to use Name Required Enter your name - Can be entered using characters, numbers, and spaces, up to 100 characters
Language Required Set the language for notifications such as email and SMS Time Zone Required Set your time zone information Table. User Information - After entering all the information, click the Complete button. An Verification Email will be sent to the email address you entered.
- Click the Email Address Verification button in the received email to complete the sign-up process.
Logging in
To log in to the DevOps Console, enter your account information on the login page and click the Next button.
On the OTP authentication page, enter the OTP number issued by the selected OTP type and click the Login button.
If you don’t remember your ID or password, click the ID/Password Find link to find your account information before attempting to log in.
Once logged in, the DevOps Console Main page will open.
If you enter your password incorrectly more than 5 times, your account will be locked, so enter it accurately.
To unlock your account, click the ID/Password Find link and reset your password.
Modifying User Information
To modify user information, follow these steps:
- Click the Shortcut icon at the top right of the Main page.
- Click the DevOps IDP link. The DevOps IDP page will open in a new tab.
- On the user information page, you can change information such as your phone number, password, name, time zone, and language.
DevOps Console.To modify the information used in DevOps Console, follow these steps:
- Click the User icon at the top menu of the Main page.
- Click the Account Information menu. The Account Information popup window will open.
- Change the language and time zone information, and then click the Save button to complete the modification of your account information.
Changing Console Language
To change the language displayed in DevOps Console, click Language Settings at the bottom of the DevOps Console page after logging in, and change it to your desired language.
Managing Authentication Keys
DevOps Console.You can manage your individual authentication keys through the Authentication Key Management menu by clicking the User icon at the top menu of the Main page.
Adding Authentication Keys
To add an authentication key, follow these steps:
- Click the User icon at the top right of the Main page.
- Click the Authentication Key Management menu. The Authentication Key Management popup window will open.
- Click the Create Authentication Key button. The Create Authentication Key popup window will open.
- Set the expiration date and click the Save button to complete the creation of the authentication key.
Setting up Security
Through security settings, you can restrict the IP that can use the authentication key.
To add security settings, follow these steps:
- Click the User icon at the top right of the Main page.
- Click the API Key Management menu. The API Key Management popup window opens.
- Click the Security Settings tab and then click the Modify button. The Security Settings Change popup window opens.
- Set IP access control to Use.
- Enter the allowed IP access and click the Save button to complete the security settings.
Deleting an Authentication Key
To delete an authentication key, follow these steps:
- Click the User icon at the top right of the Main page.
- Click the API Key Management menu. The API Key Management popup window opens.
- Click the Status Change button.
- In the API Key Status Change popup, select Not in use and click the Save button.
- Click the Delete button to complete the deletion of the authentication key.
Checking My Activity History
By clicking the My Activity History menu in the top menu of the Main page, you can check your activity history in the DevOps Console.
Setting up Access Control IP
You can register an IP that can access the DevOps Console to control access.
To register an access control IP, follow these steps:
- Click the Shortcut icon at the top right of the Main page.
- Click the DevOps IDP link. The DevOps IDP page opens in a new tab.
- Click the Access Control menu on the left.
- Click the Modify button at the bottom of the Access Control page. The page changes to Access Control Modification.
- Set Access Control IP Settings to Use.
- Add the IP to be allowed access and click the Save button to complete the access control settings.
Withdrawing from Membership
DevOps Console membership, all collected member information and related resources and authorities are deleted.To withdraw from DevOps Console membership, follow these steps:
- Click the Shortcut icon at the top right of the Main page.
- Click the DevOps IDP link. The DevOps IDP page opens in a new tab.
- Click the Withdrawal from Membership button at the top right of the user information page. The Withdrawal from Membership popup window opens.
- Enter your current password in the input field and click the Withdrawal from Membership button to complete the withdrawal.
1.1 - Membership Information
Users can view and manage their basic information, authentication information, registered tenants, registered project groups, and registered projects.
Getting Started with Membership Information
To start managing membership information, follow these steps:
- Main page, click the Manage icon in the top right corner. Move to the Tenant Dashboard page.
- In the left menu, click the Membership Information menu. Move to the Membership Information page.
Managing Authentication Information
Authentication information is automatically stored when a user uses it for tool registration, usage, etc. If necessary, you can add new authentication information, modify or delete existing authentication information.
To manage authentication information, follow these steps:
- Main page, click the Manage icon in the top right corner. Move to the Tenant Dashboard page.
- In the left menu, click the Membership Information menu. Move to the Membership Information page.
- On the Membership Information page, click the Authentication Information tab.
Adding Authentication Information
To add authentication information, follow these steps:
- Authentication Information tab, click the Add button. The Add Authentication Information popup window will open.
- In the Add Authentication Information popup window, enter the information.
- All tools and URLs that the user can access will be displayed.
- After entering the information, click the Connection Test button.
- Click the Save button.
Modifying Authentication Information
To modify authentication information, follow these steps:
- In the Authentication Information tab, click on the authentication information you want to modify. The Modify Authentication Information popup window will open.
- In the Modify Authentication Information popup window, enter the information and click the Connection Test button.
- When the Save button is activated, click the Save button.
Deleting Authentication Information
To delete authentication information, follow these steps:
- In the Authentication Information tab, select the checkbox of the authentication information you want to delete.
- In the Authentication Information list, click the Delete button.
- In the confirmation popup window, click the Confirm button.
Managing Joined Tenants
Users can view the list of tenants they have joined. They can also request to join a new tenant and leave a tenant they have already joined.
To manage joined tenants, follow these steps:
- Click the Management icon at the top right of the Main page. You will be moved to the Tenant Dashboard page.
- In the left menu, click the Join Information menu. You will be moved to the Join Information page.
- In the Join Information page, click the Joined Tenants tab.
Requesting Tenant Membership
To request tenant membership, follow these steps:
- Registered Tenants tab, click the Join button. The Tenant Membership Request popup window will open.
- In the Tenant Membership Request popup window, enter the tenant code you want to join and click the Search icon.
- Enter the reason for the request and click the Add button.
- Select the authority of the added tenant and click the Save button.
- In the confirmation popup window, click the Confirm button.
Leaving a Tenant
To leave a tenant, follow these steps:
- In the Registered Tenants tab, select the checkbox of the tenant you want to leave.
- Click the Leave button.
- In the confirmation popup window, click the Confirm button.
Managing Joined Project Groups
Users can view the list of project groups they have joined.
To manage joined project groups, follow these steps:
- Click the Manage icon at the top right of the Main page. You will be moved to the Tenant Dashboard page.
- Click the Membership Information menu on the left. You will be moved to the Membership Information page.
- On the Membership Information page, click the Joined Project Groups tab.
When you click on a project group in the project group list, you will be moved to the Project Group Management page.
For more information on project group management, see Project Group Overview.
Managing Joined Projects
Users can view the list of projects they have joined.
To manage joined projects, follow these steps:
- Click the Manage icon at the top right of the Main page. You will be moved to the Tenant Dashboard page.
- Click the Membership Information menu on the left. You will be moved to the Membership Information page.
- On the Membership Information page, click the Joined Projects tab.
When you click on a project in the project list, you will be moved to the Project Management page.
For more information on projects, see Project.
2 - Tutorial (Project Creation to Build/Deployment)
The user can create a DevOps Console project and build the source to create an image and deploy a Helm chart to a Kubernetes cluster through the following procedure.
Creating a Project Group
The user can create a project group. The user must be a member of the tenant to create a project group.
Creating a Project Group
To create a project group, follow these steps:
- Click the Create Project Group and Start button or Create Project Group button on the Main page. The Create Project Group popup window opens.
- Enter the items and click the Save button to complete the project group creation.
- Approval from the tenant administrator may be required.
- If there are no available tenants to choose from, click the Join Tenant Quick Link to proceed with tenant registration.
Joining a Tenant
To join a tenant, follow the procedure below.
- Project Group Creation popup window, click the Join Tenant Shortcut link. The Tenant Join Request popup window will open.
- In the Tenant Search field, enter the tenant code you want to join exactly and click the Search icon. The tenant information will be retrieved.
- Verify that the searched tenant is correct, enter the Reason for Request, and click the Add button. It will be added to the list below.
- Select the authority for the tenant added to the list below and click the Save button.
Creating a Project (Helm Chart Deployment)
- The user must be a member of the project group and tenant to create a project.
- For project group and tenant registration, refer to Creating a Project Group.
The user can create a project that deploys an application to a specific Kubernetes cluster using App Template, Helm Chart, and Tool Management.
Starting Project Creation
To start creating a project, follow these steps:
- Click the Create Project button on the Main page. The Create Project page opens.
Entering Basic Information
Enter the project’s basic information. The project name and project ID must be unique and cannot be duplicated.
To enter basic information, follow these steps:
- Project Creation page, select Project Configuration Method item’s App. Template Utilization.
- Select Kubernetes for the Deployment Target item.
- Enter additional content and click the Start button.
Item Description Project Name Enter the project name. Project ID Enter the project ID. Project Configuration Method Select the project configuration method - App. Template Utilization: Select a pre-provided App. template.
- Direct Configuration: Configure directly without an App. template.
Deployment Target Select the deployment target - Kubernetes: Deploy the application to a Kubernetes cluster.
- Kubernetes(ArgoCD): Deploy the application to a Kubernetes cluster using ArgoCD.
- VM(Artifact): Deploy the application to a VM server.
- VM(Docker): Deploy the application to a VM server as a Docker image.
- N/A: Select if the build result is not deployed.
K8S Cluster Select the target cluster to deploy DevOps ConsoleK8S cluster’s cluster, only clusters with user access rights can be selected.
Namespace Select the target namespace to deploy - K8S cluster’s retrieved cluster, only namespaces with user access rights can be selected.
Table. Project Creation Basic Information Input Items
Selecting an Application Template
Users can select an application template to configure their project.
If you create a project based on an application template with sample source code, you can verify the application to be deployed.
On the other hand, using a template marked as Environment Only configures only the build/deployment environment without sample source code.
If you are using an already configured source code repository to configure your project, select a template marked as Environment Only.
To start choosing an application template, follow these steps:
- Application Template screen, enter the template name to select the desired application template card and click it.
- When the Next button is activated, click the Next button.
| Item | Description |
|---|---|
| Filter | You can easily find application templates through predefined filters. |
| Search | You can easily find application templates through search. |
Setting Up a Code Repository
The user can set up a repository to manage the source code through the code repository setting step.
Creating a New Repository and Using an Existing Repository activation conditions vary depending on the Application Template and Tool.
| Repository Type | App. template with source code + DevOps Console registered tool / DevOps Code | App. template with source code + DevOps Console unregistered tool | App. template without source code (Environment Only) + DevOps Console registered tool / DevOps Code | App. template without source code (Environment Only) + DevOps Console unregistered tool |
|---|---|---|---|---|
| New Repository Creation | ○ | X | ○ | X |
| Existing Repository Use | X | X | ○ | ○ |
To modify or delete saved authentication information, please refer to Managing Authentication Information.
To set up a code repository, follow these steps:
- In the Code Repository section, select the Code Repository type.
- Select Create a New Repository or Use an Existing Repository and enter the information.
- Enter the Authentication Information and click the Connection Test button.
- If the Next button is activated, click the Next button.
| Item | Description |
|---|---|
| Repository Type | Select the code repository to use
|
| New/Existing Usage | Select whether to Create a New Repository or Use an Existing Repository.
|
| Repository Information | Enter repository information
|
| Authentication Information | Enter authentication information
|
| (Unregistered Tool) Repository Information | Enter repository information
|
Setting Up Code Quality
The user can configure a repository for quality management.
To set up code quality, follow the procedure below.
- Code Quality item, select the Repository Type.
- Enter Basic Information and Authentication Information, then click the Connection Test button.
- When the Next button is activated, click the Next button.
| Item | Description |
|---|---|
| Repository Type | Select the repository to use
|
| New/Existing/Not Used | Select the repository creation method
|
| Base URL | Select the SonarQube URL. |
| Quality Project Name | Enter the name of the SonarQube project. |
| Quality Project Key | Enter the key of the SonarQube project. |
| Authentication Information | Enter authentication information
|
Setting Up an Image Repository
The user can set up the repository to store the built container image through the image repository setting step.
To modify or delete saved authentication information, please refer to Managing Authentication Information.
To set up an image repository, follow these steps:
- Image Repository section, select the Repository Type.
- Select Create New Repository/Use Existing Repository and enter the information.
- Enter the Authentication Information and click the Connection Test button.
- When the Next button is activated, click the Next button.
| Item | Description |
|---|---|
| Repository Type | Select the type of repository to use
|
| Repository Information | Select the repository creation method.
|
| Authentication Information | Enter the authentication information. |
Setting Up a Release Target Environment
The user can deploy through direct configuration using Helm charts.
When selecting Helm release name and Helm chart, the Helm chart installation items and the default Values.yaml items included in the chart are displayed.
Available Helm charts are linked to App templates. You can modify or delete them through Managing Supported Helm Charts.
To set up the deployment target environment, follow these steps:
- Select direct configuration using Helm charts in the deployment target section.
- Enter the Helm release name.
- Click the Search button to select the Helm chart to use.
- Modify the Values.yaml and click the Validation Check button.
- Click the Next button when it is activated.
| Item | Description |
|---|---|
| Deployment Target | Select the deployment target. |
| Helm Release Name | Enter the name of the Helm release to be created.
|
| Helm Chart | Select the Helm chart.
|
| K8S Information | Displays the information of the Kubernetes cluster required for the Value.yaml configuration. |
| Values.yaml | Modify the Values.yaml content.
|
Setting Up a Build Pipeline
Users can configure pipelines for building and deploying applications.
You can check each stage of the pipeline to be configured and change the build job name.
To set up a build pipeline, follow these steps:
- Build Pipeline screen branches according to IDP connection.
- For IDP-connected Jenkins, click the User Check button to verify user registration.
- For non-IDP-connected Jenkins, enter authentication information and click the Connection Test button.
- When the Next button is activated, click the Next button.
Item | Description |
|---|---|
| Build/Deploy Pipeline | Displays build/deploy pipeline information.
|
| Classification | Select development/operation classification.
|
| URL | Select Jenkins to configure the pipeline and enter the job name.
|
| Build Agent | Select the agent to be used for pipeline build.
|
| Build Environment OS | Displays the OS information of the environment where the build agent runs. |
| User Information | IDP-connected Jenkins
|
| Environment Variable Setting | Set environment variables to be registered in the Jenkins pipeline. |
| Image Tag Pattern | Select the method for assigning tags to container images. |
| Deploy Strategy | Select the deployment method for container images. |
| Deployment Result Recipient | Select the user to receive the result after the build pipeline is completed. |
Setting Up User Definitions
Users can specify and modify the path of the Dockerfile file to be used for building.
Additionally, you can check and modify the final script generated based on the information set up in Configuring the Build Pipeline.
To configure Dockerfile and pipeline scripts, follow these steps:
- Customize settings page, enter information, and click the Connection Test button.
- When the Next button is activated, click the Next button.
| Item | Description |
|---|---|
| Dockerfile Settings | Choose whether to Create a new Dockerfile or Use an existing Dockerfile.
|
| Dockerfile Path | Specify the path of the Dockerfile file in the source code. |
| Branch Name | The branch name is automatically registered when setting up Configuring the Code Repository. |
| Dockerfile | Check and modify the contents of the Dockerfile. |
| Pipeline Script | Check and modify the pipeline script. |
Completing Project Creation
The user can finally check the project and tool information to be created and start creating the project.
To complete the project creation, follow the procedure below.
- Summary Information screen, check the information and click the Complete button.
- The Project Creation popup window opens and the project creation proceeds.
- After the project creation is complete, click the Confirm button to move to the Project page.
Checking Build Pipeline Execution
On the Project page, you can check the pipeline execution status, and the build pipeline is automatically executed when the project is created for the first time.
If the build pipeline fails, modify and re-execute the pipeline through the Build Pipeline menu on the left.
To check the build pipeline execution, follow these steps:
- Click the Project card on the Main page. Move to the Project Dashboard page.
- Click the Build/Deployment > Build Pipeline menu on the left.
Checking Deployment Results
After the pipeline execution is complete, you can check the Helm chart deployment results.
For more information on Helm chart deployment results, refer to Helm Release.
To check the deployment results, follow these steps:
- Click the Project card on the Main page. Move to the Project Dashboard page.
- Click the Build/Deployment > Kubernetes Deployment menu on the left. Move to the Kubernetes Deployment page.
- Click the Helm Release list to check the detailed deployment results.
2.1 - (Helm Chart Deployment) Adding Build/Deployment
The user can create a new build pipeline in an already created DevOps Console project and build the source to create an image and deploy it to a Kubernetes cluster through the following procedure.
The Helm Release deployed through Helm Installation will be used in Deploy to K8S Stage Settings.
Start Adding Build/Deployment
To start adding build/deployment, follow the procedure below.
- Click the Project card on the Main page. It will move to the Project Dashboard page.
Adding Code Repository (Option)
| Repository Type | App. template with source code + DevOps Console registered tool / DevOps Code | App. template with source code + DevOps Console unregistered tool | App. template without source code (Environment Only) + DevOps Console registered tool / DevOps Code | App. template without source code (Environment Only) + DevOps Console unregistered tool |
|---|---|---|---|---|
| New Repository Creation | ○ | X | ○ | X |
| Existing Repository Use | X | X | ○ | ○ |
To add a code repository, follow the procedure below.
- Click the Project card on the Main page. It will move to the Project Dashboard page.
- Click Repository > Code Repository in the left menu.
- Click the Add Code Repository button at the top right. The Add Code Repository page will open.
- Enter/set each item and click the Connection Test button.
- Click the Save button to complete Add Code Repository.
| Item | Description |
|---|---|
| Repository Type | Select the type of repository to use
|
| New/Existing Usage | Select whether to Create a New Repository or Use an Existing Repository
|
| Repository Information | Enter repository information
|
| Authentication Information | Enter authentication information. |
| Repository Information | Enter repository information
|
Adding Image Repository (Option)
To add an image repository, follow the procedure below.
Adding App Image Repository
- Image Repository page, click the App Image Repository Addition button in the top right. Move to the App Image Repository Addition page.
- On the App Image Repository Addition page, enter/settings for each item.
- Click the Connection Test button.
- Click the Save button.
| Item | Description |
|---|---|
| Repository Type Selection | Select the image repository type. If you want to use an image repository not registered in Devops Console, select the Image Registry type. |
| Repository Creation Selection | Choose whether to create a new repository or use an existing one.
|
| Registered Tool | Enter repository information. |
| Unregistered Tool | Enter repository information
|
Adding Pull-only Image Repository
- Image Repository page, click the Add Pull-only Image Repository button at the top right. It moves to the Add Pull-only Image Repository page.
- On the Add Pull-only Image Repository page, enter/set each item.
- Click the Connection Test button.
- Click the Save button.
Helm Installation
To install Helm, follow the procedure below.
- Click the Project card on the Main page. It will move to the Project Dashboard page.
- Click Build/Deployment > Helm Installation in the left menu.
- Select the K8S cluster to install in the K8S cluster item.
- Click the desired Helm chart to move to the Helm Chart Details screen.
- Click the Helm Installation button. It will move to the Helm Chart Installation screen.
- Enter each item and click the Next button.
Item Description Release Name Enter the name to use for the Helm chart release.
It must be unique and not duplicated within the namespace.Type Development, operation Version Select the version of the chart to install Helm. K8S Cluster Displays the target K8S cluster for Helm installation.
It cannot be changed, and if a change is desired, select the K8S cluster in Helm Installation Start.Namespace Select the target namespace for Helm installation from the list. Reference Information Reference information provided by the selected K8S cluster.
Click each tab to check detailed information.Chart Included Default Values.yaml The values.yamlfile can be modified to run Helm installation with the desired value.
If necessary, check the reference information and modify thevalues.yamlfile with the corresponding value.Input Type The input type item is only displayed for Helm charts that support form input. - Form: Enter the items displayed on the screen. Refer to Form Input Support Helm Chart Creation for Helm chart creation that supports form input.
values.yaml: Modify the value in the general Helm chart yaml editor screen.
Form Input The screen displayed when Form is selected as the input type, check each item, and enter the value. After entering, click the Validation Check button to verify the input value. Table. Helm Installation Setting Items - The Helm Chart Installation popup window will open. Click the Run button to complete Helm installation.
- Once the installation is complete, the Kubernetes deployment page will open.
Adding Build Pipeline
To add a build pipeline, follow the procedure below.
- Main page, click the Project card. Move to the Project Dashboard page.
- Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
- On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
- Enter/set each item on the Add Pipeline page.
- Click the Next button.
| Item | Description |
|---|---|
| Classification | Select development or operation classification
|
| Jenkins URL | Select Jenkins to add a build pipeline from the list. |
| Build Agent | Select the agent (build environment) where the build pipeline will run. Click the Info icon to view the list of tools provided by the agent. |
| Build Environment OS | Displays the OS information of the environment where the build agent runs. |
| Folder Type | Select the folder type.
|
| Folder | Select a folder from the list or enter the name of the new folder to be created. |
| Pipeline Name | Enter the pipeline name. |
| Parameter Setting | Set the parameters to be used in the pipeline. |
| Environment Variable Setting | Set the environment variables to be used in the pipeline. |
| Stage Setting | Set the stages to be used in the pipeline. |
| Build Result Email Recipient Setting | Set the recipient to receive the result email after the pipeline is completed (success/failure). |
Setting Parameters
To set parameters to use when running the pipeline, follow the procedure below.
- Click the Parameters area. The Parameter Registration page will open on the right.
- Click the Add button to open the Add Parameter popup window.
- Add parameters and click the Apply button to complete parameter settings.
Setting Environment Variables
To set environment variables to be used in the pipeline, follow the procedure below.
- Environment Variables section, click. The Environment Variable Registration page opens on the right.
- A list of pre-registered Environment Variables appears, and select the checkbox of the environment variable to be used.
- Check the Selected Environment Variables and click the Apply button to complete the environment variable setting.
Setting Build Result Email Recipients
To set up the recipient to receive the build result by email, follow the procedure below.
- Email Recipient area, click. The Add Email Recipient page opens on the right.
- In the Search area, search for and add the recipient.
- Click the Apply button to complete the email recipient setting.
Setting Additional Stages
Setting Checkout Stage
To add a Checkout stage, follow the procedure below.
- Click the New Stage area. The stage setting page will open on the right.
- Select Checkout as the Stage Type.
- Enter information and click Apply. (The code repository added in Adding Code Repository (Option) can be selected from the URL.)
| Item | Description |
|---|---|
| URL | Select the code repository to perform checkout. |
| Branch Name | Enter the branch name to checkout. |
Setting Build Stage
To add a Build stage, follow these steps:
- Click the plus icon to add a new stage.
- Click the new stage area. The Stage Settings page opens on the right.
- On the Stage Settings page, select Build as the Stage Type.
- On the Stage Settings page, enter the information and click the Apply button.
| Item | Description |
|---|---|
| Language | Select the programming language used by the application. |
| Build Tool | Select the Build tool used for application building. Provides default Shell commands based on the selected Build tool. |
| Shell Command | Enter the command to use for application building. All commands available in the Shell can be used. |
Setting Docker Build Stage
To add a Docker Build stage, follow these steps:
- Plus icon을 클릭하여 새로운 스테이지를 추가하세요.
- New Stage 영역을 클릭하세요. Stage Settings 페이지가 오른쪽에 열립니다.
- Stage Type으로 Docker Build를 선택하세요.
- 정보 입력 후 Apply 버튼을 클릭하세요. (Registry URL에서 Adding Image Repository (Option)에서 추가한 이미지 저장소를 선택할 수 있습니다.)
Item | Description | Example |
|---|---|---|
Registry URL (docker push) | Select the image repository where the completed Docker build result image will be pushed. | |
| ID | ID value of the account to be used in the image repository | |
| Image Tag Pattern | The Docker image tag will be automatically generated based on the selected pattern.
|
|
| Add Base Image Repository | The Add Base Image Repository popup window will open.
| |
Registry URL (docker pull) | If the image repository providing the base image (Dockerfile’s FROM clause, docker pull) used in the Dockerfile and the image repository of the Registry URL (docker push) are different, select the image repository for docker pull. | |
| Image Build Tool | Displays the image build tool. | |
| Pre-build Command | If there are commands that must be executed before building the Docker image, write them in Shell command format. | cp target/*.jar docker/ |
| Image Build Folder | If the Docker image build needs to be executed in a specific folder, select the checkbox and enter the folder path. | docker |
| Dockerfile | Enter the Dockerfile file name. | Dockerfile |
| Image Build Options | If additional options are required for the image build tool, enter them. | --no-cache |
| Build Command | Displays the actual image build command to be executed. | |
| Post-build Command | If there are commands that must be executed after building the Docker image, write them in Shell command format. | rm -rf docker/*.jar |
Setting Deploy to K8S Stage
To add a Deploy to K8S stage, follow the procedure below.
- Click the Add icon to add a new stage.
- Click the New Stage area. The stage setting page will open on the right.
- Select Deploy to K8S as the Stage Type.
- Enter information and click the Apply button. (When selecting Helm Release (Helm Chart Type) in Type, the Helm release added in Helm Installation can be selected.)
Item | Description |
|---|---|
| Type | Select deployment type
|
| K8S Cluster | Select K8S cluster
|
| Namespace | Select namespace. |
| Helm Release | Select Helm release. |
| Deployment Method | Select deployment method
|
| Registry URL | Select the image repository where the image to be deployed to Kubernetes is docker pushed. |
| Secret | Select secret information input method
|
Checking Final Pipeline Script
- Check the actual build pipeline script to be created. Modify the script directly if necessary.
- Click the Complete button to complete adding the pipeline.
Result of Adding Pipeline
2.2 - (Workload Deployment) Adding Build/Deployment
The user can create a new build pipeline in an already created DevOps Console project, build the source to create an image, and proceed with workload deployment to a Kubernetes cluster through the following procedure.
The workload added through Adding Workload will be used in Setting up Deploy to K8S Stage.
Starting Build/Deployment Addition
To start adding build/deployment, follow the procedure below.
- Click the Project card on the Main page. It moves to the Project Dashboard page.
Adding Code Repository (Option)
To add a code repository, follow the procedure below.
- Code Repository page, click the Add Code Repository button in the top right corner. It will move to the Add Code Repository page.
- On the Add Code Repository page, enter/set each item.
- Click the Connection Test button.
- Click the Save button.
| Item | Description |
|---|---|
| Repository Type | Select the repository to use
|
| New/Existing Usage | Select Create New Repository or Use Existing Repository
|
| Repository Information | Enter repository information
|
| Authentication Information | Enter authentication information. |
| Repository Information | Enter repository information
|
Adding Image Repository (Option)
To add an image repository, follow the procedure below.
App. Adding Image Repository
- Image Repository page, click the App Image Repository Addition button in the top right. Move to the App Image Repository Addition page.
- On the App Image Repository Addition page, enter/settings for each item.
- Click the Connection Test button.
- Click the Save button.
| Item | Description |
|---|---|
| Repository Type Selection | Select the image repository type. If you want to use an image repository not registered in Devops Console, select the Image Registry type. |
| Repository Creation Selection | Choose whether to create a new repository or use an existing one.
|
| Registered Tool | Enter repository information. |
| Unregistered Tool | Enter repository information
|
Adding Pull-only Image Repository
- Image Repository page, click the Add Pull-only Image Repository button at the top right. It moves to the Add Pull-only Image Repository page.
- On the Add Pull-only Image Repository page, enter/set each item.
- Click the Connection Test button.
- Click the Save button.
Adding Workload
To add a workload, follow the procedure below.
- Main page, click the Project card. It moves to the Project Dashboard page.
- In the left menu, click the Build/Deploy > Kubernetes Deployment menu. It moves to the Kubernetes Deployment page.
- On the Kubernetes Deployment page, click the Add Workload menu. The Add Workload popup window opens.
- In the Add Workload popup window, enter the information and click the Save button.
- In the confirmation popup window, click the Confirm button to complete adding the workload.
Item | Description |
|---|---|
| Target to be retrieved | Only workloads deployed with the same image as the base image of the App template used when creating the project for the first time are displayed. |
| Workload already registered in the project | It shows the workload already registered in the project.
|
Modifying K8S Authentication Information
K8S authentication information refers to the authentication information used to verify the authority to use the K8S cluster/namespace when performing deployment in the build pipeline.
To modify the K8S authentication information, follow the procedure below.
- Deployment Details page, click the Edit Authentication Information icon to the right of K8S Cluster/Namespace. The Edit Authentication Information popup window will open.
- The authentication information is fixed to the account of the logged-in user. Click the Save button to modify it.
- In the confirmation popup window, click the Confirm button.
- The K8S authentication information will be changed to the logged-in user.
Adding Build Pipeline
To add a build pipeline, follow the procedure below.
- Main page, click the Project card. Move to the Project Dashboard page.
- Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
- On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
- Enter/set each item on the Add Pipeline page.
- Click the Next button.
| Item | Description |
|---|---|
| Classification | Select development or operation classification
|
| Jenkins URL | Select Jenkins to add a build pipeline from the list. |
| Build Agent | Select the agent (build environment) where the build pipeline will run. Click the Info icon to view the list of tools provided by the agent. |
| Build Environment OS | Displays the OS information of the environment where the build agent runs. |
| Folder Type | Select the folder type.
|
| Folder | Select a folder from the list or enter the name of the new folder to be created. |
| Pipeline Name | Enter the pipeline name. |
| Parameter Setting | Set the parameters to be used in the pipeline. |
| Environment Variable Setting | Set the environment variables to be used in the pipeline. |
| Stage Setting | Set the stages to be used in the pipeline. |
| Build Result Email Recipient Setting | Set the recipient to receive the result email after the pipeline is completed (success/failure). |
Setting up Parameters
To set parameters to use when running a pipeline, follow these steps:
- Parameters card should be clicked.
- Add button should be clicked to add parameters.
- Apply button should be clicked to complete parameter settings.
Setting up Environment Variables
To set environment variables to be used in the pipeline, follow the procedure below.
- Environment Variables section, click. The Environment Variable Registration page opens on the right.
- A list of pre-registered Environment Variables appears, and select the checkbox of the environment variable to be used.
- Check the Selected Environment Variables and click the Apply button to complete the environment variable setting.
Setting up Build Result Email Recipients
To set up the recipient to receive the build result by email, follow the procedure below.
- Email Recipient area, click. The Add Email Recipient page opens on the right.
- In the Search area, search for and add the recipient.
- Click the Apply button to complete the email recipient setting.
Setting up Additional Stages
Setting up Checkout Stage
To add a Checkout stage, follow these steps:
- Click the New Stage area. The Stage Settings page opens on the right.
- On the Stage Settings page, select Checkout as the Stage Type.
- Enter the information and click the Apply button. (You can select the code repository added in Adding a Code Repository (Option) from the URL.)
| Item | Description |
|---|---|
| URL | Select the code repository to perform checkout. |
| Branch Name | Enter the branch name to checkout. |
Setting up Build Stage
To add a Build stage, follow these steps:
- Click the plus icon to add a new stage.
- Click the new stage area. The Stage Settings page opens on the right.
- On the Stage Settings page, select Build as the Stage Type.
- On the Stage Settings page, enter the information and click the Apply button.
| Item | Description |
|---|---|
| Language | Select the programming language used by the application. |
| Build Tool | Select the Build tool used for application building. Provides default Shell commands based on the selected Build tool. |
| Shell Command | Enter the command to use for application building. All commands available in the Shell can be used. |
Setting up Docker Build Stage
To add a Docker Build stage, follow these steps:
- Plus icon을 클릭하여 새로운 스테이지를 추가하세요.
- New Stage 영역을 클릭하세요. Stage Settings 페이지가 오른쪽에 열립니다.
- Stage Type으로 Docker Build를 선택하세요.
- 정보 입력 후 Apply 버튼을 클릭하세요. (Registry URL에서 Adding Image Repository (Option)에서 추가한 이미지 저장소를 선택할 수 있습니다.)
Item | Description | Example |
|---|---|---|
Registry URL (docker push) | Select the image repository where the completed Docker build result image will be pushed. | |
| ID | ID value of the account to be used in the image repository | |
| Image Tag Pattern | The Docker image tag will be automatically generated based on the selected pattern.
|
|
| Add Base Image Repository | The Add Base Image Repository popup window will open.
| |
Registry URL (docker pull) | If the image repository providing the base image (Dockerfile’s FROM clause, docker pull) used in the Dockerfile and the image repository of the Registry URL (docker push) are different, select the image repository for docker pull. | |
| Image Build Tool | Displays the image build tool. | |
| Pre-build Command | If there are commands that must be executed before building the Docker image, write them in Shell command format. | cp target/*.jar docker/ |
| Image Build Folder | If the Docker image build needs to be executed in a specific folder, select the checkbox and enter the folder path. | docker |
| Dockerfile | Enter the Dockerfile file name. | Dockerfile |
| Image Build Options | If additional options are required for the image build tool, enter them. | --no-cache |
| Build Command | Displays the actual image build command to be executed. | |
| Post-build Command | If there are commands that must be executed after building the Docker image, write them in Shell command format. | rm -rf docker/*.jar |
Setting up Deploy to K8S Stage
To add the Deploy to K8S stage, follow the procedure below.
- Click the + icon to add a new stage.
- Click the New Stage area. The Stage Setting page opens on the right.
- On the Stage Setting page, select Deploy to K8S as the Stage Type.
- On the Stage Setting page, enter the information and click the Apply button. (If you select the type as workload, you can select the workload added in Adding Workload.)
Item | Description |
|---|---|
| Type | Select deployment type
|
| K8S Cluster | Select K8S cluster
|
| Namespace | Select namespace. |
| Helm Release | Select Helm release. |
| Deployment Method | Select deployment method
|
| Registry URL | Select the image repository where the image to be deployed to Kubernetes is docker pushed. |
| Secret | Select secret information input method
|
Checking the Final Pipeline Script
- Check the actual build pipeline script to be created. Modify the script directly if necessary.
- Click the Complete button to complete adding the pipeline.
Result of Adding Pipeline
2.3 - (VM Deployment) Adding Build/Deployment
The user can create a new build pipeline in an already created DevOps Console project, build the source, create an image, and deploy it to a VM server (VM Deployment) through the following procedure.
The VM server group/VM server added through Adding VM Server Group/VM Server (Option) will be used in Setting up Deploy to VM Stage.
Starting to Add Build/Deployment
To start adding build/deployment, follow the procedure below.
- Click the Project card on the Main page. It will move to the Project Dashboard page.
Adding Code Repository (Option)
To add a code repository, follow the procedure below.
- Code Repository page, click the Add Code Repository button in the top right corner. It will move to the Add Code Repository page.
- On the Add Code Repository page, enter/set each item.
- Click the Connection Test button.
- Click the Save button.
| Item | Description |
|---|---|
| Repository Type | Select the repository to use
|
| New/Existing Usage | Select Create New Repository or Use Existing Repository
|
| Repository Information | Enter repository information
|
| Authentication Information | Enter authentication information. |
| Repository Information | Enter repository information
|
Adding Image Repository (Option)
To add an image repository, follow the procedure below.
App. Adding Image Repository
- Image Repository page, click the App Image Repository Addition button in the top right. Move to the App Image Repository Addition page.
- On the App Image Repository Addition page, enter/settings for each item.
- Click the Connection Test button.
- Click the Save button.
| Item | Description |
|---|---|
| Repository Type Selection | Select the image repository type. If you want to use an image repository not registered in Devops Console, select the Image Registry type. |
| Repository Creation Selection | Choose whether to create a new repository or use an existing one.
|
| Registered Tool | Enter repository information. |
| Unregistered Tool | Enter repository information
|
Adding Pull-only Image Repository
- Image Repository page, click the Add Pull-only Image Repository button at the top right. It moves to the Add Pull-only Image Repository page.
- On the Add Pull-only Image Repository page, enter/set each item.
- Click the Connection Test button.
- Click the Save button.
Adding Artifact Repository (Option)
Proceed only if a new artifact repository is needed.
If used as a rollback artifact repository, only Nexus with raw(hosted) repository type is available.
To add an artifact repository, follow these steps:
- Artifact Repository page, click the Add Artifact Repository button in the top right corner. It will move to the Add Artifact Repository page.
- On the Add Artifact Repository page, enter/set each item.
- Click the Connection Test button.
- Click the Save button.
| Item | Description |
|---|---|
| Repository Creation Option | Select whether to create a new repository or use an existing one. |
| Basic Information Input | Enter Base URL, select repository type, and enter repository/authentication information. |
Adding VM Server Group/VM Server (Option)
To add a VM server group, follow these steps:
- Main page, click the Management icon at the top right. Move to the Tenant Dashboard page.
- Click the Deployment Target > VM Server Group menu from the left menu. Move to the VM Server Group page.
- On the VM Server Group page, click the Add button. Move to the Add VM Server Group page.
- Enter the basic information and click the Save button to complete the VM server group settings.
| Item | Description |
|---|---|
| Server Group Name | Enter the name of the VM server group. |
| Description | Enter a description. |
| Type | Select the type of VM server group
|
| VM Server |
|
Adding VM Server
To add a VM server, you need Manager permissions for the corresponding VM server group.
To add a VM server, follow these steps:
- Click the Manage icon in the top right corner of the Main page. You will be taken to the Tenant Dashboard page.
- Click the Deployment Target > VM Server Group menu from the left menu. You will be taken to the VM Server Group page.
- Click the VM server group where you want to add the VM server from the VM server group list on the VM Server Group page. You will be taken to the VM Server Group Details page.
- Click the Add button on the VM Server Group Details page. You will be taken to the Add VM Server page.
- Enter the basic information on the Add VM Server page and click the Add button to complete the VM server settings.
| Item | Description |
|---|---|
| Server Name | Enter the name of the VM server. |
| Description | Enter a description. |
| IP | Enter the IP address. |
| SSH Port | Enter the port of the VM server to use for SSH connection. |
| OS | Enter the operating system. |
| Location | Select a location. |
| Authentication Information | Enter the authentication information of the VM server to use for SSH connection. |
| Secret Key | This is a secret key to authenticate the VM server where the agent is installed. |
Adding Build Pipeline
To add a build pipeline, follow the procedure below.
- Main page, click the Project card. Move to the Project Dashboard page.
- Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
- On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
- Enter/set each item on the Add Pipeline page.
- Click the Next button.
| Item | Description |
|---|---|
| Classification | Select development or operation classification
|
| Jenkins URL | Select Jenkins to add a build pipeline from the list. |
| Build Agent | Select the agent (build environment) where the build pipeline will run. Click the Info icon to view the list of tools provided by the agent. |
| Build Environment OS | Displays the OS information of the environment where the build agent runs. |
| Folder Type | Select the folder type.
|
| Folder | Select a folder from the list or enter the name of the new folder to be created. |
| Pipeline Name | Enter the pipeline name. |
| Parameter Setting | Set the parameters to be used in the pipeline. |
| Environment Variable Setting | Set the environment variables to be used in the pipeline. |
| Stage Setting | Set the stages to be used in the pipeline. |
| Build Result Email Recipient Setting | Set the recipient to receive the result email after the pipeline is completed (success/failure). |
Setting up Parameters
To set parameters to use when running a pipeline, follow these steps:
- Parameters card should be clicked.
- Add button should be clicked to add parameters.
- Apply button should be clicked to complete parameter settings.
Setting up Environment Variables
To set environment variables to be used in the pipeline, follow the procedure below.
- Environment Variables section, click. The Environment Variable Registration page opens on the right.
- A list of pre-registered Environment Variables appears, and select the checkbox of the environment variable to be used.
- Check the Selected Environment Variables and click the Apply button to complete the environment variable setting.
Setting up Build Result Email Recipients
To set up the recipient to receive the build result by email, follow the procedure below.
- Email Recipient area, click. The Add Email Recipient page opens on the right.
- In the Search area, search for and add the recipient.
- Click the Apply button to complete the email recipient setting.
Setting up Additional Stages
Setting up Checkout Stage
To add a Checkout stage, follow these steps:
- Click the New Stage area. The Stage Settings page opens on the right.
- On the Stage Settings page, select Checkout as the Stage Type.
- Enter the information and click the Apply button. (You can select the code repository added in Adding a Code Repository (Option) from the URL.)
| Item | Description |
|---|---|
| URL | Select the code repository to perform checkout. |
| Branch Name | Enter the branch name to checkout. |
Setting up Build Stage
To add a Build stage, follow these steps:
- Click the plus icon to add a new stage.
- Click the new stage area. The Stage Settings page opens on the right.
- On the Stage Settings page, select Build as the Stage Type.
- On the Stage Settings page, enter the information and click the Apply button.
| Item | Description |
|---|---|
| Language | Select the programming language used by the application. |
| Build Tool | Select the Build tool used for application building. Provides default Shell commands based on the selected Build tool. |
| Shell Command | Enter the command to use for application building. All commands available in the Shell can be used. |
Setting up Docker Build Stage
To add a Docker Build stage, follow these steps:
- Plus icon을 클릭하여 새로운 스테이지를 추가하세요.
- New Stage 영역을 클릭하세요. Stage Settings 페이지가 오른쪽에 열립니다.
- Stage Type으로 Docker Build를 선택하세요.
- 정보 입력 후 Apply 버튼을 클릭하세요. (Registry URL에서 Adding Image Repository (Option)에서 추가한 이미지 저장소를 선택할 수 있습니다.)
Item | Description | Example |
|---|---|---|
Registry URL (docker push) | Select the image repository where the completed Docker build result image will be pushed. | |
| ID | ID value of the account to be used in the image repository | |
| Image Tag Pattern | The Docker image tag will be automatically generated based on the selected pattern.
|
|
| Add Base Image Repository | The Add Base Image Repository popup window will open.
| |
Registry URL (docker pull) | If the image repository providing the base image (Dockerfile’s FROM clause, docker pull) used in the Dockerfile and the image repository of the Registry URL (docker push) are different, select the image repository for docker pull. | |
| Image Build Tool | Displays the image build tool. | |
| Pre-build Command | If there are commands that must be executed before building the Docker image, write them in Shell command format. | cp target/*.jar docker/ |
| Image Build Folder | If the Docker image build needs to be executed in a specific folder, select the checkbox and enter the folder path. | docker |
| Dockerfile | Enter the Dockerfile file name. | Dockerfile |
| Image Build Options | If additional options are required for the image build tool, enter them. | --no-cache |
| Build Command | Displays the actual image build command to be executed. | |
| Post-build Command | If there are commands that must be executed after building the Docker image, write them in Shell command format. | rm -rf docker/*.jar |
Setting up Deploy to VM Stage
To add the Deploy to VM stage, follow the procedure below.
- Click the + icon to add a new stage.
- Click the New Stage area. The Stage Setting page will open on the right.
- On the Stage Setting page, select Deploy to VM as the Stage Type.
- Enter information on the Stage Setting page and click the Apply button.
| Item | Description |
|---|---|
| Deployment Configuration | Select the deployment configuration method
|
| Deployment Group | Select the deployment group
|
| Deployment Information | Contents saved in the deployment group are automatically set. |
| Manual Deployment | Select the default value for manual deployment
|
Checking the Final Pipeline Script
- Check the actual build pipeline script to be created. Modify the script directly if necessary.
- Click the Complete button to complete adding the pipeline.
Result of Adding Pipeline
2.4 - (Before Project Creation) Checking Deployment Target Namespace Permissions
Users should follow the procedure to create a DevOps Console project and check if they have usage permissions for the target cluster/namespace before building/deploying, and request the person in charge to add permissions to the cluster/namespace if necessary.
Checking Namespace Permissions for DevOps Console K8S Cluster
To check the permissions for the namespace of the K8S cluster in use in DevOps Console, follow the procedure below.
- Main page, click the Management icon at the top right. Move to the Tenant Dashboard page.
- Click the Deployment Target > K8S Cluster menu on the left menu. Move to the K8S Cluster list page.
- Click on a K8S cluster. Move to the Details page of the selected K8S cluster.
- Click the Namespace tab. The Namespace List screen appears.
- When you click on a namespace, you will be moved to the Namespace Details page.