The page has been translated by Gen AI.

(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.

  1. Click the Project card on the Main page. It will move to the Project Dashboard page.

Adding Code Repository (Option)

Note
Proceed only if a new code repository is required.

Repository TypeApp. 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 CreationXX
Existing Repository UseXX
Table. New Repository Creation and Existing Repository Activation Conditions

To add a code repository, follow the procedure below.

  1. Click the Project card on the Main page. It will move to the Project Dashboard page.
  2. Click Repository > Code Repository in the left menu.
  3. Click the Add Code Repository button at the top right. The Add Code Repository page will open.
  4. Enter/set each item and click the Connection Test button.
  5. Click the Save button to complete Add Code Repository.
ItemDescription
Repository TypeSelect the type of repository to use
  • Registered Tool: Select and use the type of SCM Repository tool available to the user (Github, Gitlab, etc.).
  • DevOps Code: Available when a DevOps Code application has been made in Samsung Cloud Platform Console.
  • Unregistered Tool: Enter the domain of an unregistered tool to use it. The unregistered tool item only appears when the App template is Environment Only.
New/Existing UsageSelect whether to Create a New Repository or Use an Existing Repository
Repository InformationEnter repository information
  • When creating a new repository, the URL is composed of the project group name/project name.
Authentication InformationEnter authentication information.
Repository InformationEnter repository information
  • Code repositories not registered as tools in DevOps Console can be used.
  • Click the URL Check button to proceed with the verification process.
Table. Code Repository Setting Items

Adding Image Repository (Option)

Note
Proceed only if a new image repository is required.

To add an image repository, follow the procedure below.

Adding App Image Repository

  1. Image Repository page, click the App Image Repository Addition button in the top right. Move to the App Image Repository Addition page.
  2. On the App Image Repository Addition page, enter/settings for each item.
  3. Click the Connection Test button.
  4. Click the Save button.
ItemDescription
Repository Type SelectionSelect the image repository type.
If you want to use an image repository not registered in Devops Console, select the Image Registry type.
Repository Creation SelectionChoose whether to create a new repository or use an existing one.
  • If you selected Docker hub or Image Registry type earlier, you can only select Use Existing Repository.
Registered ToolEnter repository information.
Unregistered ToolEnter repository information
  • You can register an image repository that has not been registered as a tool in DevOps Console.
  • Click the URL Check button to proceed with the verification process.
  • You can only select Use Existing Repository.
Table. App Image Repository Addition Input Items

Adding Pull-only Image Repository

  1. 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.
  2. On the Add Pull-only Image Repository page, enter/set each item.
  3. Click the Connection Test button.
  4. Click the Save button.

Helm Installation

To install Helm, follow the procedure below.

  1. Click the Project card on the Main page. It will move to the Project Dashboard page.
  2. Click Build/Deployment > Helm Installation in the left menu.
  3. Select the K8S cluster to install in the K8S cluster item.
  4. Click the desired Helm chart to move to the Helm Chart Details screen.
  5. Click the Helm Installation button. It will move to the Helm Chart Installation screen.
  6. Enter each item and click the Next button.
    ItemDescription
    Release NameEnter the name to use for the Helm chart release.
    It must be unique and not duplicated within the namespace.
    TypeDevelopment, operation
    VersionSelect the version of the chart to install Helm.
    K8S ClusterDisplays 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.
    NamespaceSelect the target namespace for Helm installation from the list.
    Reference InformationReference information provided by the selected K8S cluster.
    Click each tab to check detailed information.
    Chart Included Default Values.yamlThe values.yaml file can be modified to run Helm installation with the desired value.
    If necessary, check the reference information and modify the values.yaml file with the corresponding value.
    Input TypeThe 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/values.yaml input can be switched, but the previously entered content will be initialized.
    Form InputThe 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
  7. The Helm Chart Installation popup window will open. Click the Run button to complete Helm installation.
  8. Once the installation is complete, the Kubernetes deployment page will open.

Adding Build Pipeline

To add a build pipeline, follow the procedure below.

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
  3. On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
  4. Enter/set each item on the Add Pipeline page.
  5. Click the Next button.
ItemDescription
ClassificationSelect development or operation classification
Jenkins URLSelect Jenkins to add a build pipeline from the list.
Build AgentSelect 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 OSDisplays the OS information of the environment where the build agent runs.
Folder TypeSelect the folder type.
  • Existing folder: Add a pipeline under an existing folder in Jenkins.
  • New folder: Create a new folder in Jenkins and add a pipeline under it.
FolderSelect a folder from the list or enter the name of the new folder to be created.
Pipeline NameEnter the pipeline name.
Parameter SettingSet the parameters to be used in the pipeline.
Environment Variable SettingSet the environment variables to be used in the pipeline.
Stage SettingSet the stages to be used in the pipeline.
Build Result Email Recipient SettingSet the recipient to receive the result email after the pipeline is completed (success/failure).
Table. Build Pipeline Addition Setting Items

Setting Parameters

To set parameters to use when running the pipeline, follow the procedure below.

  1. Click the Parameters area. The Parameter Registration page will open on the right.
  2. Click the Add button to open the Add Parameter popup window.
  3. 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.

  1. Environment Variables section, click. The Environment Variable Registration page opens on the right.
  2. A list of pre-registered Environment Variables appears, and select the checkbox of the environment variable to be used.
  3. 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.

  1. Email Recipient area, click. The Add Email Recipient page opens on the right.
  2. In the Search area, search for and add the recipient.
  3. 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.

  1. Click the New Stage area. The stage setting page will open on the right.
  2. Select Checkout as the Stage Type.
  3. Enter information and click Apply. (The code repository added in Adding Code Repository (Option) can be selected from the URL.)
ItemDescription
URLSelect the code repository to perform checkout.
Branch NameEnter the branch name to checkout.
Table. Checkout Stage Setting Items

Setting Build Stage

To add a Build stage, follow these steps:

  1. Click the plus icon to add a new stage.
  2. Click the new stage area. The Stage Settings page opens on the right.
  3. On the Stage Settings page, select Build as the Stage Type.
  4. On the Stage Settings page, enter the information and click the Apply button.
ItemDescription
LanguageSelect the programming language used by the application.
Build ToolSelect the Build tool used for application building.
Provides default Shell commands based on the selected Build tool.
Shell CommandEnter the command to use for application building.
All commands available in the Shell can be used.
Table. Build Stage Input Items

Setting Docker Build Stage

To add a Docker Build stage, follow these steps:

  1. Plus icon을 클릭하여 새로운 스테이지를 추가하세요.
  2. New Stage 영역을 클릭하세요. Stage Settings 페이지가 오른쪽에 열립니다.
  3. Stage Type으로 Docker Build를 선택하세요.
  4. 정보 입력 후 Apply 버튼을 클릭하세요. (Registry URL에서 Adding Image Repository (Option)에서 추가한 이미지 저장소를 선택할 수 있습니다.)
Item
DescriptionExample
Registry URL (docker push)Select the image repository where the completed Docker build result image will be pushed.
IDID value of the account to be used in the image repository
Image Tag PatternThe Docker image tag will be automatically generated based on the selected pattern.
  • {YYYYMMDD}: year, month, day
  • {HHMMSS}: hour, minute, second
  • {BUILD_NUM}: current build pipeline execution number
  • {YYYYMMDD}.{HHMMSS}: 20200414.150938
  • {YYYYMMDD}.{BUILD_NUM}: 20220414.13
Add Base Image RepositoryThe 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 ToolDisplays the image build tool.
Pre-build CommandIf there are commands that must be executed before building the Docker image, write them in Shell command format.cp target/*.jar docker/
Image Build FolderIf the Docker image build needs to be executed in a specific folder, select the checkbox and enter the folder path.docker
DockerfileEnter the Dockerfile file name.Dockerfile
Image Build OptionsIf additional options are required for the image build tool, enter them.--no-cache
Build CommandDisplays the actual image build command to be executed.
Post-build CommandIf there are commands that must be executed after building the Docker image, write them in Shell command format.rm -rf docker/*.jar
Table. Docker Build Stage Input Items

Setting Deploy to K8S Stage

To add a Deploy to K8S stage, follow the procedure below.

  1. Click the Add icon to add a new stage.
  2. Click the New Stage area. The stage setting page will open on the right.
  3. Select Deploy to K8S as the Stage Type.
  4. 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
TypeSelect deployment type
  • Helm Release (Helm Chart Type)
  • Workload
  • ArgoCD
K8S ClusterSelect K8S cluster
  • Helm Release (Helm Chart Type) selection will display a list of Helm releases deployed through DevOps Console.
NamespaceSelect namespace.
Helm ReleaseSelect Helm release.
Deployment MethodSelect deployment method
  • Recreate
  • Rolling Update
Registry URLSelect the image repository where the image to be deployed to Kubernetes is docker pushed.
SecretSelect secret information input method
  • Auto Generation: Automatically generate and use the secret corresponding to the selected image repository in DevOps Console.
  • Use Existing Secret: Use a pre-created secret through K8S secret management.
Table. Deploy to K8S Stage Input Items

Checking Final Pipeline Script

  1. Check the actual build pipeline script to be created. Modify the script directly if necessary.
  2. Click the Complete button to complete adding the pipeline.

Result of Adding Pipeline

Note
The added pipeline will not be executed automatically. If execution is required, run the pipeline directly.
Tutorial (Project Creation to Build/Deployment)
(Workload Deployment) Adding Build/Deployment