- The user must be a member of a project group and tenant to create a project.
- For information on how to join a project group and tenant, see Creating a Project Group.
- ArgoCD deployment requires ArgoCD and a Git repository for GitOps deployment to be set up in advance.
- In the DevOps Console, the existing ArgoCD and its associated Git information are used for deployment.
Users can create a project using App Template, Tool Management, and ArgoCD.
Starting Project Creation
To start creating a project, follow these steps.
- Click the Create Project button on the Main page. This will take you to the Create Project page.
Entering 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 these steps.
- Enter the project name and project ID.
- Select App Template as the Project Configuration Method.
- Select Kubernetes (ArgoCD) as the Deployment Target.
- Choose the ArgoCD App Creation Method.
- Create a new App: Create a new ArgoCD application while creating the project.
- Use an existing App: Use an existing ArgoCD application to create the project.
- Click the Start button after completing each input.
Selecting an App 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 the Deployment Environment
To set up the deployment environment, you need to have ArgoCD and a Git repository for GitOps deployment ready.
The input values differ depending on the ArgoCD App Creation Method chosen.
- Create a new App
- Use an existing App
Creating a New App
To set up the deployment environment by creating a new ArgoCD application, follow these steps.
- On the Deployment Environment screen, enter the ArgoCD URL and click the Confirm button.
- The authentication information input screen appears.
- Enter the authentication information and click the Connection Test button.
- The input screen for the new ArgoCD application appears.
- Enter the ArgoCD application name and ArgoCD project name.
- Select the repository type.
- Select the Helm chart.
- The Helm chart and Helm chart Git repository information are displayed.
- Modify the Values.yaml and click the Validation Check button.
- Enter the Git repository information and authentication information, then click the Connection Test button.
- Click the Next button when it becomes active.
| Item | Description |
|---|---|
| URL input method | Select the URL input method.
|
| ArgoCD URL | Enter the ArgoCD URL and click the Confirm button. The authentication information section appears. |
| Authentication information | Enter the authentication information and click the Connection Test button. The application basic information section opens. |
| Application name | Enter the name of the ArgoCD application to be created. |
| Project name | Enter the name of the ArgoCD project. |
| Repository type | Select the repository type.
|
| Helm chart | Select the Helm chart. |
| Helm chart Git repository | Enter the information of the Git repository to be used for GitOps. |
Using an Existing App
To set up the deployment environment using an existing ArgoCD application, follow these steps.
- On the Deployment Environment screen, enter the ArgoCD URL and click the Confirm button.
- The input screen for the existing ArgoCD application name and authentication information appears.
- Enter the existing application name and authentication information, then click the Connection Test button.
- A pop-up window for URL Check opens to distinguish the Git repository linked to the ArgoCD application.
- Modify the Base URL in the URL Check pop-up window and click the Confirm button.
- The information of the Git repository linked to the ArgoCD application is displayed.
- Enter the authentication information of the Git repository and click the Connection Test button.
- In the Manifest Root path section, enter the yaml file name and key value to be modified.
- Click the Next button when it becomes active.
| Item | Description |
|---|---|
| URL input method | Select the URL input method
|
| ArgoCD URL | Enter the ArgoCD URL and click the Confirm button. The existing application name and authentication information section appears. |
| Application name / Authentication information | Enter the existing application name and authentication information, then click the Connection Test button. The Git repository and ArgoCD information section appears. |
| URL Check | Distinguish the Base URL and Path from the entire URL. |
| Git repository authentication information | Enter the authentication information of the Git repository used by the selected existing application. |
| Image Repo Key | Enter the path and key value of the yaml file where the image repository information is recorded. If the key values for the repository and tag are the same, enter the same value. |
| Image Tag Key | Enter the path and key value of the yaml file where the image tag information is recorded. If the key values for the repository and tag are the same, enter the same value. |
| Image Secret Key | Enter the path and key value of the yaml file where the image secret information is recorded. |
| Deploy Strategy Key | Enter the path and key value of the yaml file where the deployment strategy information is recorded (optional). |
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.