This is the multi-page printable view of this section. Click here to print.
Project
1 - Project Overview
Users can view not only the detailed information of the project but also related Helm release information, the tools they are using, and other relevant details.
Users with a project role of Master or higher can edit the project name through this menu, and the Owner can delete the project.
Project Overview Getting Started
To start using the project overview, follow these steps.
- On the Main page, click the Project card. You will be taken to the Project Dashboard page.
- From the left menu, click the Project Overview menu. The Project Overview screen appears.
Modify project name
To change the project name, follow these steps.
- Project Overview On the screen, click the Edit Project Name button at the top right. The Edit Project Name popup window will open.
- Edit Project Name In the popup window, edit the project name and click the Save button to complete the project name edit.
Delete Project
To delete a project, follow these steps.
- Project Overview On the screen, click the Delete Project button in the upper right. The Delete Project popup window opens.
- In the Project Deletion popup, click the Confirm button. You will be taken to the Project Deletion page.
- On the Project Deletion page, enter and select the required information, then click the Delete button. The Project Deletion popup window opens.
- Project Deletion Enter the project name in the popup window.
- Click the Confirm button to complete the project deletion.
Item Explanation Check project name Enter the name of the current project you want to delete. Delete Helm release
Delete build pipeline
Delete code repositoryIf you want to delete together with the project, select - Select: When the project is deleted, the actual physical deletion command is executed.
- Deselect: It is only logically deleted in
DevOps Console, and remains in each tool.
Table. Project Deletion Input Items
Manage all projects
Shows information for all projects that the user has permission for. Except for Project Name Change, Project Deletion, it provides the same functionality as Project Overview and Project Members.
For detailed information, refer to Project Overview and Project Members.
- Click the Admin icon at the top right of the Main page. Navigate to the Tenant Dashboard page.
- Click the Tenant > Project menu in the left menu. You will be taken to the Project page.
2 - Create Project
2.1 - Create Project (Helm Chart Deployment)
Users must be members of a project group and tenant to be able to create projects.
Refer to Create Project Group for how to join a project group and tenant.
Users can create a project that deploys an application to a specific Kubernetes cluster using App.Template, Helm Chart, and Tool Management.
Getting Started with Project Creation
To start creating a project, follow these steps.
- Click the Create Project button on the Main page. You will be taken to the Create Project page.
Enter basic information
Enter the basic information of the project. The project name and project ID must be unique and cannot be duplicated.
To enter the basic information, follow the steps below.
- On the Project Creation page, select the App. Template Utilization option of the Project Configuration Method item.
- For the deployment target field, select Kubernetes.
- After entering additional content, click the Start button.
Item Explanation Project name Please enter the project name. Project ID Please enter the project ID. Project configuration method Select a project configuration method - Use App template: select a pre‑provided App template.
- Manual configuration: configure without an App template.
deployment target Select 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): Package the application as a Docker image and deploy it to a VM server.
- N/A: Choose this when you do not deploy the build output.
K8S cluster Select the target cluster for deployment DevOps ConsoleOnly clusters that the user has access rights to can be selected among the K8S clusters.
namespace Select the target namespace for deployment - Only namespaces that the user has access rights to, among the clusters retrieved from the K8S cluster, can be selected.
Table. Project creation basic information entry items
App. Select Template
The user can select an application template to configure the project.
If you create a project based on an application template that includes sample source code, you can view the application that will be deployed.
In contrast, using a template labeled Environment Only configures only the build/deployment environment without sample source code.
If you configure a project using an already set up source code repository, select the template marked Environment Only.
To start selecting an application template, follow these steps.
- On the Application Template screen, enter the template name, select the application template card you want, and then click.
- When the Next button is enabled, click the Next button.
Item Explanation Filter You can easily find application templates using predefined filters. search You can easily find application templates through search. Table. Project Creation Application Template Items
Configure code repository
Users can configure a repository for managing source code through the code repository setup step.
Create new repository and use existing repository activation conditions differ depending on the application template and tool.
| Repository type | App with source code. Template + DevOps Console registration tool | App with source code included. Template + DevOps Console unregistered tool | Source code not included (EnvironmentOnly) App. Template + DevOps Console registration tool | Source code not included (Environment Only) App. Template + DevOps Console unregistered tool |
|---|---|---|---|---|
| Create new repository | ○ | X | ○ | X |
| Use existing repository | X | X | ○ | ○ |
To modify or delete stored credentials, refer to Manage Authentication Information.
To set up the code repository, follow these steps.
- In the Code repository item, select the Code repository type.
- Select Create new repository or Use existing repository, then enter the information.
- Enter authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation Repository type Select the code repository to use - Registered tool: The user can select and use the types of SCM Repository tools (
Github,Gitlab, etc.) that are available. - Unregistered tool: You can enter the domain of an unregistered tool to use it. The unregistered tool entry appears only when the source code is not included (Environment Only) App. Template.
New/Existing usage Please select New repository creation or whether to use an existing repository. - Activation status varies depending on specific conditions. For details, refer to Table. Activation conditions for creating a new repository and using an existing repository.
Repository information Enter repository information - When creating a new repository, the URL is formed from the project group name/project name.
Authentication information Enter authentication information - If you do not have an account, Don’t have an account? click the link to open the Account Creation Information popup where you can create an account.
- After creating a new account, be sure to change your password via the Set Initial Password link.
(Unregistered tool)
Repository informationEnter repository information - You can use a code repository that is not registered as a tool in
DevOps Console. - Click the URL Check button to undergo an additional verification process.
Table. Project Creation Code Repository Settings - Registered tool: The user can select and use the types of SCM Repository tools (
Configure Code Quality
Users can configure a repository for quality management.
To set code quality, follow these steps.
- In the Code Quality item, select Repository Type.
- Enter Basic Information and Authentication Information, then click the Connection Test button.
- Next button is enabled, click the Next button.
Item Explanation Repository type Select the repository to use - The types of Code Quality tools available to the user are displayed.
New / Existing / Unused status Select repository creation method - If you select Create new repository, you must enter the quality project name/quality project key.
- If you select Do not create, you can proceed directly to the next step.
Base URL Select the SonarQubeURL.Quality Project Name Enter the name of the SonarQubeproject.Quality Project Key Enter the Key of the SonarQubeproject.authentication information Enter authentication credentials - You can create a new user or use existing authentication credentials.
Table. Project Creation Code Quality Settings
Configure Image Repository
Users can configure a repository to store the built container images through the image repository configuration step.
To modify or delete stored credentials, refer to Manage Authentication Information.
To set up the image repository, follow these steps.
- In the Image Repository item, select the Repository Type.
- Create new repository / Use existing repository select, then enter the information.
- Enter authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation Repository type Select the repository type to use - The types of Image Registry tools available to the user are displayed.
Repository information Select the repository creation method. - When creating a new repository, the URL is formed with the project group name/project name.
Authentication information Enter your credentials. Table. Project Creation Image Repository Settings
Configure the deployment target environment
Users can deploy by directly configuring via Helm charts.
Helm release name and Helm chart when selected, the Helm chart installation options and the default Values.yaml entries included in the chart are displayed.
Available Helm charts are associated with the App template. You can edit or delete them through Manage supported Helm charts.
To set the deployment target environment, follow these steps.
- In the Deployment target field, select Configure directly via Helm chart.
- Please enter the Helm release name.
- Click the Search button to select the Helm chart to use.
- After editing Values.yaml, click the Validation Check button.
- When the Next button is enabled, click the Next button.
Item Explanation deployment target Please select the deployment target. Helm release name Enter the name of the Helm release to create. - The name must be unique within the namespace of the target cluster.
Helm chart Select a Helm chart. - When a Helm chart is selected, detailed information about the chosen chart is displayed below
K8S information Shows the information of the Kubernetes cluster required for configuring Value.yaml. Values. yaml Edit the contents of Values.yaml. values.yamlfile to be used when installing the Helm chart.
Table. Project creation deployment target environment configuration items
Setting up the build pipeline
Users can configure pipelines that build and deploy applications.
You can view each stage of the pipeline to be configured and rename the build job.
To set up the build pipeline, follow these steps.
- Build Pipeline screen branches based on IDP integration status.
- For IDP-integrated Jenkins, click the User Check button to perform User Registration Confirmation.
- For Jenkins not integrated with IDP, enter the authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.Item
Explanation Build/Deployment pipeline Displays build/deployment pipeline information. - The build/deployment pipeline is displayed based on the information registered in the App template’s Manage Pipeline Templates.
Category Select the development/operation distinction. - The permissions for the pipeline vary according to the development/operation distinction.
- Refer to Table. Role-based permissions within the project (1) for role-based permissions.
URL Select Jenkinsto configure the pipeline, then enter the job name.- The
Jenkinsinstances available to the user are displayed.
Build Agent Select the agent to be used for pipeline builds. - For information about the agent, please refer to Managing agents (kubernetes), Managing agents (VM).
Build environment OS Displays the OS information of the environment in which the build agent runs. User information IDP Integrated Jenkins - Click the User Check button to verify user registration.
- If you are not registered as a Jenkins user, when the User Registration Guide popup appears, click the Go to Jenkins link to proceed with User Sign‑Up or Initial Jenkins Login.
- Enter the authentication information and click the Connection Test button.
Set environment variables Set the environment variables to be registered in the Jenkins pipeline. Image Tag Pattern Select the tag assignment method for the container image. Deploy Strategy Select the deployment method for the container image. Recipient of deployment results Select the user who will receive the results after the build pipeline completes. Table. Project creation build pipeline configuration items
Configure Custom Settings
The user can specify and modify the path of the Dockerfile file used for the build.
Additionally, you can view the final script generated based on the information configured in 빌드 파이프라인 설정하기 and also edit it.
Dockerfile, follow these steps to configure the pipeline script.
- After entering information on the Custom settings page, click the Connection Test button.
- Click the Next button when the Next button is enabled.
Item Explanation Dockerfile configuration Create New Dockerfile or Use Existing Dockerfile. Please select. - «Use Existing Dockerfile is only selectable after choosing the
Environment OnlyApp template and, in 코드 저장소 설정하기, selecting Use Existing Repository.
Dockerfile path Specify the Dockerfilefile path in the source code.Branch name The branch name is automatically registered when you set it in Code Repository Configuration. Dockerfile Check and modify the contents of the Dockerfile.pipeline script Check and modify the pipeline script. Table. Project Creation Custom Settings Items - «Use Existing Dockerfile is only selectable after choosing the
Complete project creation
The user can review the project and tool information to be created and start project creation.
To complete project creation, follow the steps below.
- Summary Information After checking the information on the screen, click the Complete button.
- Project Creation popup window opens and the project creation proceeds.
- After the project creation is complete, click the Confirm button to go to the Project page.
2.2 - Create Project (Workload Deployment)
Refer to Create Project Group for how to join a project group and tenant.
Users can create a project that deploys to a specific Kubernetes cluster using App.Template, Tool Management and workloads.
Getting Started with Project Creation
To begin creating a project, follow the steps below.
- On the Main page, click the Create Project button. You will be taken to the Create Project page.
Enter basic information
Enter the basic information of the project. The project name and project ID must be unique and cannot be duplicated.
To enter the basic information, follow the steps below.
- On the Project Creation page, select the App. Template Utilization option of the Project Configuration Method item.
- For the deployment target field, select Kubernetes.
- After entering additional content, click the Start button.
Item Explanation Project name Please enter the project name. Project ID Please enter the project ID. Project configuration method Select a project configuration method - Use App template: select a pre‑provided App template.
- Manual configuration: configure without an App template.
deployment target Select 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): Package the application as a Docker image and deploy it to a VM server.
- N/A: Choose this when you do not deploy the build output.
K8S cluster Select the target cluster for deployment DevOps ConsoleOnly clusters that the user has access rights to can be selected among the K8S clusters.
namespace Select the target namespace for deployment - Only namespaces that the user has access rights to, among the clusters retrieved from the K8S cluster, can be selected.
Table. Project creation basic information entry items
Select Application Template
The user can select an application template to configure the project.
If you create a project based on an application template that includes sample source code, you can view the application that will be deployed.
In contrast, using a template labeled Environment Only configures only the build/deployment environment without sample source code.
If you configure a project using an already set up source code repository, select the template marked Environment Only.
To start selecting an application template, follow these steps.
- On the Application Template screen, enter the template name, select the application template card you want, and then click.
- When the Next button is enabled, click the Next button.
Item Explanation Filter You can easily find application templates using predefined filters. search You can easily find application templates through search. Table. Project Creation Application Template Items
Configure code repository
Users can configure a repository for managing source code through the code repository setup step.
Create new repository and use existing repository activation conditions differ depending on the application template and tool.
| Repository type | App with source code. Template + DevOps Console registration tool | App with source code included. Template + DevOps Console unregistered tool | Source code not included (EnvironmentOnly) App. Template + DevOps Console registration tool | Source code not included (Environment Only) App. Template + DevOps Console unregistered tool |
|---|---|---|---|---|
| Create new repository | ○ | X | ○ | X |
| Use existing repository | X | X | ○ | ○ |
To modify or delete stored credentials, refer to Manage Authentication Information.
To set up the code repository, follow these steps.
- In the Code repository item, select the Code repository type.
- Select Create new repository or Use existing repository, then enter the information.
- Enter authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation Repository type Select the code repository to use - Registered tool: The user can select and use the types of SCM Repository tools (
Github,Gitlab, etc.) that are available. - Unregistered tool: You can enter the domain of an unregistered tool to use it. The unregistered tool entry appears only when the source code is not included (Environment Only) App. Template.
New/Existing usage Please select New repository creation or whether to use an existing repository. - Activation status varies depending on specific conditions. For details, refer to Table. Activation conditions for creating a new repository and using an existing repository.
Repository information Enter repository information - When creating a new repository, the URL is formed from the project group name/project name.
Authentication information Enter authentication information - If you do not have an account, Don’t have an account? click the link to open the Account Creation Information popup where you can create an account.
- After creating a new account, be sure to change your password via the Set Initial Password link.
(Unregistered tool)
Repository informationEnter repository information - You can use a code repository that is not registered as a tool in
DevOps Console. - Click the URL Check button to undergo an additional verification process.
Table. Project Creation Code Repository Settings - Registered tool: The user can select and use the types of SCM Repository tools (
Configure Code Quality
Users can configure a repository for quality management.
To set code quality, follow these steps.
- In the Code Quality item, select Repository Type.
- Enter Basic Information and Authentication Information, then click the Connection Test button.
- Next button is enabled, click the Next button.
Item Explanation Repository type Select the repository to use - The types of Code Quality tools available to the user are displayed.
New / Existing / Unused status Select repository creation method - If you select Create new repository, you must enter the quality project name/quality project key.
- If you select Do not create, you can proceed directly to the next step.
Base URL Select the SonarQubeURL.Quality Project Name Enter the name of the SonarQubeproject.Quality Project Key Enter the Key of the SonarQubeproject.authentication information Enter authentication credentials - You can create a new user or use existing authentication credentials.
Table. Project Creation Code Quality Settings
Configure Image Repository
Users can configure a repository to store the built container images through the image repository configuration step.
To modify or delete stored credentials, refer to Manage Authentication Information.
To set up the image repository, follow these steps.
- In the Image Repository item, select the Repository Type.
- Create new repository / Use existing repository select, then enter the information.
- Enter authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation Repository type Select the repository type to use - The types of Image Registry tools available to the user are displayed.
Repository information Select the repository creation method. - When creating a new repository, the URL is formed with the project group name/project name.
Authentication information Enter your credentials. Table. Project Creation Image Repository Settings
Configure the deployment target environment
The user can deploy by selecting Select deployment target workload.
To configure the deployment target environment, follow the steps below.
- In the Deployment Target item, select Select Deployment Target Workload. The Deployment Target Workload area appears.
- In the Deployment Target Workload area, select the workload and container to be deployed.
- When the Next button is enabled, click the Next button.
Item Explanation deployment target Select deployment target - Configure directly via Helm chart
- Select workload for deployment target
Query target Select the item to view. Workload Select workload - Displays the workloads that exist in the selected Kubernetes cluster when starting project creation.
target container Select the target container to use for the selected workload. Table. Deployment Target Environment Configuration Items
Setting up the build pipeline
Users can configure pipelines that build and deploy applications.
You can view each stage of the pipeline to be configured and rename the build job.
To set up the build pipeline, follow these steps.
- Build Pipeline screen branches based on IDP integration status.
- For IDP-integrated Jenkins, click the User Check button to perform User Registration Confirmation.
- For Jenkins not integrated with IDP, enter the authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.Item
Explanation Build/Deployment pipeline Displays build/deployment pipeline information. - The build/deployment pipeline is displayed based on the information registered in the App template’s Manage Pipeline Templates.
Category Select the development/operation distinction. - The permissions for the pipeline vary according to the development/operation distinction.
- Refer to Table. Role-based permissions within the project (1) for role-based permissions.
URL Select Jenkinsto configure the pipeline, then enter the job name.- The
Jenkinsinstances available to the user are displayed.
Build Agent Select the agent to be used for pipeline builds. - For information about the agent, please refer to Managing agents (kubernetes), Managing agents (VM).
Build environment OS Displays the OS information of the environment in which the build agent runs. User information IDP Integrated Jenkins - Click the User Check button to verify user registration.
- If you are not registered as a Jenkins user, when the User Registration Guide popup appears, click the Go to Jenkins link to proceed with User Sign‑Up or Initial Jenkins Login.
- Enter the authentication information and click the Connection Test button.
Set environment variables Set the environment variables to be registered in the Jenkins pipeline. Image Tag Pattern Select the tag assignment method for the container image. Deploy Strategy Select the deployment method for the container image. Recipient of deployment results Select the user who will receive the results after the build pipeline completes. Table. Project creation build pipeline configuration items
Configure Custom Settings
The user can specify and modify the path of the Dockerfile file used for the build.
Additionally, you can view the final script generated based on the information configured in 빌드 파이프라인 설정하기 and also edit it.
Dockerfile, follow these steps to configure the pipeline script.
- After entering information on the Custom settings page, click the Connection Test button.
- Click the Next button when the Next button is enabled.
Item Explanation Dockerfile configuration Create New Dockerfile or Use Existing Dockerfile. Please select. - «Use Existing Dockerfile is only selectable after choosing the
Environment OnlyApp template and, in 코드 저장소 설정하기, selecting Use Existing Repository.
Dockerfile path Specify the Dockerfilefile path in the source code.Branch name The branch name is automatically registered when you set it in Code Repository Configuration. Dockerfile Check and modify the contents of the Dockerfile.pipeline script Check and modify the pipeline script. Table. Project Creation Custom Settings Items - «Use Existing Dockerfile is only selectable after choosing the
Complete project creation
The user can review the project and tool information to be created and start project creation.
To complete project creation, follow the steps below.
- Summary Information After checking the information on the screen, click the Complete button.
- Project Creation popup window opens and the project creation proceeds.
- After the project creation is complete, click the Confirm button to go to the Project page.
2.3 - Create Project (ArgoCD Deployment)
- Users must be members of a project group and tenant to be able to create projects.
- Refer to Create Project Group for how to join a project group and tenant.
- Deployment via ArgoCD requires that ArgoCD and the Git repository to be used for GitOps deployment be prepared in advance.
- In the Devops Console, deployment is performed using the pre‑configured ArgoCD and its associated Git information.
Users can create a project that deploys using App.Template, Tool Management, and ArgoCD.
Getting Started with Project Creation
To start creating a project, follow the steps below.
- On the Main page, click the Create Project button. You will be taken to the Create Project page.
Enter basic information
Enter the project’s basic information. The project name and project ID must be unique and cannot be duplicated.
To enter the basic information, follow the steps below.
- Enter the project name and project ID.
- For the Project Configuration Method item, select App. Template Utilization.
- Please select deployment target as Kubernetes(ArgoCD).
- Please select the ArgoCD App creation method.
- Create a new App: When creating a project, create a new ArgoCD application in ArgoCD.
- Use existing App: Create a project using the existing ArgoCD application.
- After completing each input, click the Start button.
App. Select Template
The user can select an application template to configure the project.
If you create a project based on an application template that includes sample source code, you can view the application that will be deployed.
In contrast, using a template labeled Environment Only configures only the build/deployment environment without sample source code.
If you configure a project using an already set up source code repository, select the template marked Environment Only.
To start selecting an application template, follow these steps.
- On the Application Template screen, enter the template name, select the application template card you want, and then click.
- When the Next button is enabled, click the Next button.
Item Explanation Filter You can easily find application templates using predefined filters. search You can easily find application templates through search. Table. Project Creation Application Template Items
Configure code repository
Users can configure a repository for managing source code through the code repository setup step.
Create new repository and use existing repository activation conditions differ depending on the application template and tool.
| Repository type | App with source code. Template + DevOps Console registration tool | App with source code included. Template + DevOps Console unregistered tool | Source code not included (EnvironmentOnly) App. Template + DevOps Console registration tool | Source code not included (Environment Only) App. Template + DevOps Console unregistered tool |
|---|---|---|---|---|
| Create new repository | ○ | X | ○ | X |
| Use existing repository | X | X | ○ | ○ |
To modify or delete stored credentials, refer to Manage Authentication Information.
To set up the code repository, follow these steps.
- In the Code repository item, select the Code repository type.
- Select Create new repository or Use existing repository, then enter the information.
- Enter authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation Repository type Select the code repository to use - Registered tool: The user can select and use the types of SCM Repository tools (
Github,Gitlab, etc.) that are available. - Unregistered tool: You can enter the domain of an unregistered tool to use it. The unregistered tool entry appears only when the source code is not included (Environment Only) App. Template.
New/Existing usage Please select New repository creation or whether to use an existing repository. - Activation status varies depending on specific conditions. For details, refer to Table. Activation conditions for creating a new repository and using an existing repository.
Repository information Enter repository information - When creating a new repository, the URL is formed from the project group name/project name.
Authentication information Enter authentication information - If you do not have an account, Don’t have an account? click the link to open the Account Creation Information popup where you can create an account.
- After creating a new account, be sure to change your password via the Set Initial Password link.
(Unregistered tool)
Repository informationEnter repository information - You can use a code repository that is not registered as a tool in
DevOps Console. - Click the URL Check button to undergo an additional verification process.
Table. Project Creation Code Repository Settings - Registered tool: The user can select and use the types of SCM Repository tools (
Configure Code Quality
Users can configure a repository for quality management.
To set code quality, follow these steps.
- In the Code Quality item, select Repository Type.
- Enter Basic Information and Authentication Information, then click the Connection Test button.
- Next button is enabled, click the Next button.
Item Explanation Repository type Select the repository to use - The types of Code Quality tools available to the user are displayed.
New / Existing / Unused status Select repository creation method - If you select Create new repository, you must enter the quality project name/quality project key.
- If you select Do not create, you can proceed directly to the next step.
Base URL Select the SonarQubeURL.Quality Project Name Enter the name of the SonarQubeproject.Quality Project Key Enter the Key of the SonarQubeproject.authentication information Enter authentication credentials - You can create a new user or use existing authentication credentials.
Table. Project Creation Code Quality Settings
Configure Image Repository
Users can configure a repository to store the built container images through the image repository configuration step.
To modify or delete stored credentials, refer to Manage Authentication Information.
To set up the image repository, follow these steps.
- In the Image Repository item, select the Repository Type.
- Create new repository / Use existing repository select, then enter the information.
- Enter authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation Repository type Select the repository type to use - The types of Image Registry tools available to the user are displayed.
Repository information Select the repository creation method. - When creating a new repository, the URL is formed with the project group name/project name.
Authentication information Enter your credentials. Table. Project Creation Image Repository Settings
Configure the deployment target environment
To set the deployment target environment, ArgoCD and the Git repository to be used for GitOps deployment must be prepared.
ArgoCD App creation method The input values vary depending on the selection.
- Create new App
- Use existing App
Create new App
To create a new ArgoCD application and set the target deployment environment, follow the steps below.
- On the Deployment target environment screen, enter the ArgoCD URL and click the Confirm button.
- The authentication information entry screen appears.
- Enter Authentication information and click the Connection Test button.
- The input screen for the new ArgoCD application appears.
- Enter ArgoCD application name and ArgoCD project name.
- Select the Repository type.
- Please select Helm chart.
- Information about Helm chart and Helm chart Git repository is displayed.
- After editing Values.yaml, click the Validation Check button.
- After entering the Git repository information and authentication details, click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation URL input method Select the URL input method. - Select from the list: the ArgoCD tools registered as tools will appear.
- Enter manually
ArgoCD URL After entering the ArgoCD URL, click the Confirm button. The Authentication Information area appears. Authentication information Enter Authentication Information and click the Connection Test button. The Application Basic Information area opens. Application name Enter the name of the ArgoCD application to create in ArgoCD. Project name Enter the project name of the ArgoCD application. Repository type Select the repository type. - Create a new repository with Helm chart: Use a Helm chart to create a Git repository for
GitOps. Helm chart information area opens. - Use existing Git repository
Helm chart Please select a Helm chart. Helm chart Git repository Enter the information for the Git repository to be used by GitOps.Table. New App Creation Settings
Use existing App
To configure the target deployment environment using an existing ArgoCD application, follow these steps.
- Target deployment environment screen, enter ArgoCD URL, then click the Confirm button.
- The screen for entering the existing ArgoCD application name and credentials appears.
- Enter the Existing Application Name and Authentication Information, then click the Connection Test button.
- A URL Check popup window opens to distinguish the Git repository linked to the ArgoCD application..
- URL Check After editing the Base URL in the popup window, click the Confirm button.
- The Git repository information associated with the ArgoCD application is displayed.
- Enter the authentication information for the Git repository, then click the Connection Test button.
- Enter the yaml file name and key value to change in the Manifest Root path area.
- When the Next button is enabled, click the Next button.
Item Explanation URL input method Select URL input method - Select from list: ArgoCD tools registered as tools appear.
- Enter manually
ArgoCD URL After entering the ArgoCD URL, click the Confirm button. The Existing application name and credentials section will appear. Application name / authentication information Enter the Existing application name and credentials, then click the Connection Test button. The Git repository and ArgoCD information area appears. URL Check Separate the Base URL and Path in the full URL. Git repository credentials Enter the credentials for the Git repository used by the selected existing application. Image Repo Key Enter the path to the Yaml file that records the image repository information and the Key value. If the key values for repository and tag are the same, enter the same value. Image Tag Key Enter the path to the Yaml file containing the image tag information and the Key value. If the repository and tag have the same key, enter the same value. Image Secret Key Enter the path to the Yaml file containing the image secret information and the Key value. Deploy Strategy Key Enter the path to the Yaml file containing deployment strategy information and the Key value (optional). Table. Existing App usage configuration items
Setting up the build pipeline
Users can configure pipelines that build and deploy applications.
You can view each stage of the pipeline to be configured and rename the build job.
To set up the build pipeline, follow these steps.
- Build Pipeline screen branches based on IDP integration status.
- For IDP-integrated Jenkins, click the User Check button to perform User Registration Confirmation.
- For Jenkins not integrated with IDP, enter the authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.Item
Explanation Build/Deployment pipeline Displays build/deployment pipeline information. - The build/deployment pipeline is displayed based on the information registered in the App template’s Manage Pipeline Templates.
Category Select the development/operation distinction. - The permissions for the pipeline vary according to the development/operation distinction.
- Refer to Table. Role-based permissions within the project (1) for role-based permissions.
URL Select Jenkinsto configure the pipeline, then enter the job name.- The
Jenkinsinstances available to the user are displayed.
Build Agent Select the agent to be used for pipeline builds. - For information about the agent, please refer to Managing agents (kubernetes), Managing agents (VM).
Build environment OS Displays the OS information of the environment in which the build agent runs. User information IDP Integrated Jenkins - Click the User Check button to verify user registration.
- If you are not registered as a Jenkins user, when the User Registration Guide popup appears, click the Go to Jenkins link to proceed with User Sign‑Up or Initial Jenkins Login.
- Enter the authentication information and click the Connection Test button.
Set environment variables Set the environment variables to be registered in the Jenkins pipeline. Image Tag Pattern Select the tag assignment method for the container image. Deploy Strategy Select the deployment method for the container image. Recipient of deployment results Select the user who will receive the results after the build pipeline completes. Table. Project creation build pipeline configuration items
Configure Custom Settings
The user can specify and modify the path of the Dockerfile file used for the build.
Additionally, you can view the final script generated based on the information configured in 빌드 파이프라인 설정하기 and also edit it.
Dockerfile, follow these steps to configure the pipeline script.
- After entering information on the Custom settings page, click the Connection Test button.
- Click the Next button when the Next button is enabled.
Item Explanation Dockerfile configuration Create New Dockerfile or Use Existing Dockerfile. Please select. - «Use Existing Dockerfile is only selectable after choosing the
Environment OnlyApp template and, in 코드 저장소 설정하기, selecting Use Existing Repository.
Dockerfile path Specify the Dockerfilefile path in the source code.Branch name The branch name is automatically registered when you set it in Code Repository Configuration. Dockerfile Check and modify the contents of the Dockerfile.pipeline script Check and modify the pipeline script. Table. Project Creation Custom Settings Items - «Use Existing Dockerfile is only selectable after choosing the
Complete project creation
The user can review the project and tool information to be created and start project creation.
To complete project creation, follow the steps below.
- Summary Information After checking the information on the screen, click the Complete button.
- Project Creation popup window opens and the project creation proceeds.
- After the project creation is complete, click the Confirm button to go to the Project page.
2.4 - Create Project (VM Deployment)
Users must be members of a project group and tenant to be able to create projects.
Refer to Create Project Group for how to join a project group and tenant.
Users can create a project that deploys to a specific VM server using App.Template and Tool Management.
Before creating a project for VM deployment, register information about the target VM server. For detailed information on VM server registration, refer to Getting Started with VM Server Group.
Getting Started with Project Creation
To start creating a project, follow these steps.
- On the Main page, click the Create Project button. It navigates to the Create Project page.
Enter basic information
- On the Create Project page, enter the project name and project ID.
- For the Project Configuration Method item, select App. Template Utilization.
- Select VM(Artifact) or VM(Docker) for the Deployment Target field.
- VM(Artifact) creates a
war/jarfile and transfers it to the deployment target server. - VM(Docker) runs the
dockercommand after the build and image creation.
- VM(Artifact) creates a
- Please select the deployment method.
- Differences by deployment method: Table. SSH method vs Agent method
- After each input is completed, click the Start button.
App. Select Template
The user can select an application template to configure the project.
If you create a project based on an application template that includes sample source code, you can view the application that will be deployed.
In contrast, using a template labeled Environment Only configures only the build/deployment environment without sample source code.
If you configure a project using an already set up source code repository, select the template marked Environment Only.
To start selecting an application template, follow these steps.
- On the Application Template screen, enter the template name, select the application template card you want, and then click.
- When the Next button is enabled, click the Next button.
Item Explanation Filter You can easily find application templates using predefined filters. search You can easily find application templates through search. Table. Project Creation Application Template Items
Configure code repository
Users can configure a repository for managing source code through the code repository setup step.
Create new repository and use existing repository activation conditions differ depending on the application template and tool.
| Repository type | App with source code. Template + DevOps Console registration tool | App with source code included. Template + DevOps Console unregistered tool | Source code not included (EnvironmentOnly) App. Template + DevOps Console registration tool | Source code not included (Environment Only) App. Template + DevOps Console unregistered tool |
|---|---|---|---|---|
| Create new repository | ○ | X | ○ | X |
| Use existing repository | X | X | ○ | ○ |
To modify or delete stored credentials, refer to Manage Authentication Information.
To set up the code repository, follow these steps.
- In the Code repository item, select the Code repository type.
- Select Create new repository or Use existing repository, then enter the information.
- Enter authentication information and click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation Repository type Select the code repository to use - Registered tool: The user can select and use the types of SCM Repository tools (
Github,Gitlab, etc.) that are available. - Unregistered tool: You can enter the domain of an unregistered tool to use it. The unregistered tool entry appears only when the source code is not included (Environment Only) App. Template.
New/Existing usage Please select New repository creation or whether to use an existing repository. - Activation status varies depending on specific conditions. For details, refer to Table. Activation conditions for creating a new repository and using an existing repository.
Repository information Enter repository information - When creating a new repository, the URL is formed from the project group name/project name.
Authentication information Enter authentication information - If you do not have an account, Don’t have an account? click the link to open the Account Creation Information popup where you can create an account.
- After creating a new account, be sure to change your password via the Set Initial Password link.
(Unregistered tool)
Repository informationEnter repository information - You can use a code repository that is not registered as a tool in
DevOps Console. - Click the URL Check button to undergo an additional verification process.
Table. Project Creation Code Repository Settings - Registered tool: The user can select and use the types of SCM Repository tools (
Configure Code Quality
Users can configure a repository for quality management.
To set code quality, follow these steps.
- In the Code Quality item, select Repository Type.
- Enter Basic Information and Authentication Information, then click the Connection Test button.
- Next button is enabled, click the Next button.
Item Explanation Repository type Select the repository to use - The types of Code Quality tools available to the user are displayed.
New / Existing / Unused status Select repository creation method - If you select Create new repository, you must enter the quality project name/quality project key.
- If you select Do not create, you can proceed directly to the next step.
Base URL Select the SonarQubeURL.Quality Project Name Enter the name of the SonarQubeproject.Quality Project Key Enter the Key of the SonarQubeproject.authentication information Enter authentication credentials - You can create a new user or use existing authentication credentials.
Table. Project Creation Code Quality Settings
Configure Artifact Repository
Users can configure a repository for artifacts.
If you select Uncreated, you can proceed directly to the next step.
To configure the artifact repository, follow these steps.
- On the Artifact Repository screen, select the repository type.
- Enter the basic information and authentication information, then click the Connection Test button.
- When the Next button is enabled, click the Next button.
Item Explanation Repository type Select the repository type to use - The types of Artifact Repository tools available to the user are displayed.
New / Existing / Unused status Select the repository creation method - If you select Uncreated, you can proceed directly to the next step.
Base URL / Endpoint URL Select a NexusURL or anObject StorageURL.Storage type / bucket name - In the case of
Nexus, it is automatically registered asraw(hosted). - In the case of
Object Storage, the bucket name entered during tool registration is automatically registered.
Repository name / Folder name - Enter the repository name to use in
Nexus. - Enter the folder name to use in
Object Storage.
Authentication information Enter authentication information - You can create a new user or use existing authentication information.
Table. Artifact Repository Configuration Input Items
Configure the deployment target environment
Deployment target configuration requires that VM server group/VM server be registered.
For registration methods and detailed information, refer to VM서버 그룹.
To set the deployment target environment, follow these steps.
- Deployment Target Environment on the screen, after entering the required information, click the Next button.
Item Explanation Deployment configuration Choose whether to write a deployment script manually - When selecting to write a deployment script manually, write the content in the custom step.
Deployment method The selected deployment method is displayed. Artifact repository The address of the repository to use when the agent mode is selected is displayed. - Deployment mode is enabled when it is Agent.
Manual deployment Select the default value for manual deployment - Select the default setting for parameters related to manual deployment when running the pipeline.
Deployment order If there are multiple target servers, choose whether to deploy in parallel or sequentially. Deployment target settings Set the deployment target server. - When you click Settings, the Deploy Target VM Settings popup opens.
Automatic recovery setting Select whether to enable automatic rollback - If the deployment fails, it will be rolled back to the most recent successful deployment.
- Deployment method is enabled when it is Agent.
Command before file deployment Write the commands that need to be executed before file deployment. File to send - Source: Enter the file path after the build pipeline execution path (Jenkins workspace).
- Target: Enter the path where the file will be deployed on the VM server.
- Add button can be used to add files.
Command after file distribution Write the commands that must be executed after file deployment. Table. Deployment Target Environment Configuration Items
Setting up the build pipeline
Users can configure pipelines that build and deploy applications.
You can review each stage of the pipeline to be configured and rename the build job.
To set up the build pipeline, follow these steps.
- In the build pipeline configuration step, enter the authentication information and click the Connection Test button.
- Next button is enabled, click the Next button.
Item Explanation Build/Deployment pipeline Displays build/deployment pipeline information. - The build/deployment pipeline is displayed based on the information registered in the App. template’s Manage Pipeline Templates
Category Select Development/Operation mode - The permissions for the pipeline vary depending on the Development/Operation distinction.
- Refer to Table. Permissions by role within the project (1) for role-specific permissions.
URL Select Jenkinsto configure the pipeline, then enter the Job nameJenkinsavailable to the user appears.
Build Agent Select the agent to be used for pipeline builds - For information about agents, refer to Managing agents (kubernetes), Managing agents (VM).
Build environment OS Displays the OS information of the environment in which the build agent runs. Authentication information Enter the credentials for Jenkins.Set environment variables JenkinsSet the environment variables to be registered in the pipeline.Deployment result recipient Select the user who will receive the results after the build pipeline completes. Table. Build pipeline configuration input items
Configure Custom Settings
In the deployment target server and deployment settings step, if you select the deployment configuration item write deployment script directly, complete the deployment configuration by modifying the pipeline contents at this stage.
To customize the settings, follow these steps.
- After reviewing and editing the content in the Custom step, click the Next button.
Complete project creation
The user can review the project and tool information to be created and start project creation.
To complete project creation, follow the steps below.
- Summary Information After checking the information on the screen, click the Complete button.
- Project Creation popup window opens and the project creation proceeds.
- After the project creation is complete, click the Confirm button to go to the Project page.
2.5 - Create Project (Empty)
- Users must be members of a project group and tenant to be able to create projects.
- For instructions on joining a project group and tenant, refer to Create Project Group.
The user can create an Empty (Empty) project without any configuration.
To create an empty project and configure build/deployment, the user must manually perform tasks such as Add code repository, Add image repository, Install Helm, Add build pipeline.
Getting Started with Project Creation
To start creating an empty project, follow these steps.
- On the Main page, click the Create Project button. You will be taken to the Create Project page.
Enter basic information
Enter the basic information for the project. The project name and project ID must be unique and cannot be duplicated.
To enter the basic information, follow these steps.
- On the Project Creation page, select Direct Configuration under the Project Configuration Method item.
- Enter Project Name and Project ID, then click the Start button. The Summary Information screen appears.
Complete project creation
The user can review the project and tool information to be created and start project creation.
To complete project creation, follow the steps below.
- Summary Information After checking the information on the screen, click the Complete button.
- Project Creation popup window opens and the project creation proceeds.
- After the project creation is complete, click the Confirm button to go to the Project page.
3 - Start Project
The user can create a project via Create a project.
On the project page, users can utilize various menus for project management.
Getting Started
To start the project, follow these steps.
- On the Main page, click the Project card. You will be taken to the Project Dashboard page.
Project menu
Dashboard
Dashboard (Project Dashboard)
This is a dashboard menu that lets you view information about the individual items that make up the project at a glance.
Build/Deployment
Build pipeline(Build/Deploy - Build Pipeline)
This menu allows you to view the Jenkins pipeline and perform and modify build/deployment tasks.
Kubernetes deployment (Build/Deploy - Kubernetes Deployment)
This menu lets you view the list of deployed Helm releases and their deployment status.
VM deployment (Build/Deploy - VM Deployment)
This menu allows you to view the list of deployed VMs and their deployment status.
Helm install (Helm install)
This is the menu where you can view Helm charts.
Ingress/Service management (Ingress/Service management)
A menu where you can view and add Ingress/Service.
Kubernetes Secret management (Kubernetes Secret management)
This menu allows you to view and add Kubernetes Secrets.
Environment Variable Management (환경변수 관리)
This is a menu that allows you to view and add environment variables.
storage
Code repository (repository)
This is a menu that allows you to view and add code repositories for a project.
Artifact Repository (Artifact Repository)
This menu lets you view and add the project’s image repository.
Image Repository (Image Repository)
This menu allows you to view and add the project’s image repository.
Chart repository (Chart repository)
This menu lets you view and add a project’s chart repositories.
Helm chart (헬름차트)
A menu for viewing and adding project Helm charts.
Quality
Code Quality (Code Quality)
Project code quality. This is a menu that allows you to view and add projects.
Project Overview
Project Overview (프로젝트 개요)
This menu allows you to view not only the project’s detailed information but also related Helm release information and details about the tools you are using.
member
Member (Project Member)
This is a menu for managing project users.
4 - Project Dashboard
You can view the information of individual items that make up the project at a glance on the dashboard.
Getting Started with Project Dashboard
To start using the dashboard, follow these steps.
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Dashboard menu in the left menu.
Item Explanation Project information Displays the basic project information. pipeline Displays the status of pipelines added to the build pipeline.
Click the numeric link to view the status of other pipelines.Helm release status You can check the status of the Helm release added to the Kubernetes deployment. Blue/Green deployment status You can check the status of blue/green deployments. Canary status You can check the canary status. ArgoCD application status You can check the status of the ArgoCD application added to the Kubernetes deployment. Kubernetes deployment history Displays the Kubernetes deployment history in reverse chronological order. VM deployment history Displays the VM deployment history in reverse chronological order. code quality Displays code quality tool analysis information by integrating with the code quality tool. Code history Displays the history of the added code repository.
For the following items, you can select from the list to display in the code history.- Git configuration
- Git Branch
Scale and Usage Status Displays the project’s users, tools, and build/deployment status. Monthly pipeline execution trend Shows the monthly pipeline execution count, average execution interval, and execution time for the project. Inactive pipeline Shows a list of pipelines that have not been run and have no successful history, according to the reference date. Required stage Shows which stage tasks were performed in the pipeline, based on the code repository. Recent event history You can view the recent event history that occurred in the project. Table. Project Dashboard Display Items
5 - Project Members
It includes features to grant other users access to the project, modify the permissions of users who already have access, or delete permissions so they can no longer access the project.
Getting Started with Project Members
To start using project members, follow these steps.
- On the Main page, click the Project card. You will be taken to the Project Dashboard page.
- Click the Member menu in the left menu. The Member screen appears.
Add Project Member
To add members to a project, follow these steps.
- Click the Add button in the Member list. Member Add popup opens.
- After completing the settings in the Add Member popup, click the Confirm button to finish adding a project member.
Item Explanation User tab After searching for the email, click the Add button to add as a member. Project tab Select to add all members from another project to the current project’s members. Add member Click the user you want to add as a project member to add them. Permission Settings Set the role to assign to members. - Owner
- Master
- Developer
- Viewer
Delete member Click the X icon to delete from the project members. Table. Project Member Add Screen Items
Change Project Member Role
To change a project member’s role, follow these steps.
- Identify the user whose role you want to change in the Member list.
- Select the user’s project role from the list. It is saved immediately upon selection, and the user’s project role will be updated.
Delete project member
To remove a member from a project, follow these steps.
- In the Member list, select the checkbox of the user you wish to delete.
- Click the Delete button above the Member list to remove the selected user from the project members.