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.