1 - Creating a Project (Helm Chart Deployment)

Note

The user must be enrolled in 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.

Users can create a project to deploy 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.

  1. Main page, click the Create Project button. 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 basic information, follow these steps:

  1. Project Creation page, select Project Configuration Method item’s App. Template Utilization.
  2. Select Kubernetes for the Deployment Target item.
  3. Enter additional content and click the Start button.
    ItemDescription
    Project NameEnter the project name.
    Project IDEnter the project ID.
    Project Configuration MethodSelect the project configuration method
    • App. Template Utilization: Select a pre-provided App. template.
    • Direct Configuration: Configure directly without an App. template.
    Deployment TargetSelect the deployment target
    • Kubernetes: Deploy the application to a Kubernetes cluster.
    • Kubernetes(ArgoCD): Deploy the application to a Kubernetes cluster using ArgoCD.
    • VM(Artifact): Deploy the application to a VM server.
    • VM(Docker): Deploy the application to a VM server as a Docker image.
    • N/A: Select if the build result is not deployed.
    K8S ClusterSelect the target cluster to deploy
    • DevOps Console K8S cluster’s cluster, only clusters with user access rights can be selected.
    NamespaceSelect the target namespace to deploy
    • K8S cluster’s retrieved cluster, only namespaces with user access rights can be selected.
    Table. Project Creation Basic Information Input Items

Selecting App Template

Note
For more information on application templates, see 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:

  1. Application Template screen, enter the template name to select the desired application template card and click it.
  2. When the Next button is activated, click the Next button.
ItemDescription
FilterYou can easily find application templates through predefined filters.
SearchYou can easily find application templates through search.
Table. Project Creation Application Template Items

Setting 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 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

Note
Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up a code repository, follow these steps:

  1. In the Code Repository section, select the Code Repository type.
  2. Select Create a New Repository or Use an Existing Repository and enter the information.
  3. Enter the Authentication Information and click the Connection Test button.
  4. If the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the code repository to use
  • Registered Tool: You can select and use the types of SCM Repository tools available to the user (Github, Gitlab, etc.).
  • DevOps Code: Available if you have applied for DevOps Code in the Samsung Cloud Platform Console.
  • Unregistered Tool: You can use it by entering the domain of an unregistered tool. The unregistered tool item only appears when the App. template is Environment Only (without source code).
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
  • If you don’t have an account, you can create one by clicking the Don’t have an account? link and opening the Account Creation Information popup window.
  • After creating a new account, please change your password through the Initial Password Setting link.
(Unregistered Tool)
Repository Information
Enter repository information
  • You can use a code repository that is not registered as a tool in DevOps Console.
  • You must go through an additional verification process by clicking the URL Check button.
Table. Project Creation Code Repository Setting Items

Setting Code Quality

The user can configure a repository for quality management.

To set up code quality, follow the procedure below.

  1. Code Quality item, select the Repository Type.
  2. Enter Basic Information and Authentication Information, then click the Connection Test button.
  3. When the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the repository to use
  • The types of Code Quality tools available to the user are displayed.
New/Existing/Not UsedSelect the repository creation method
  • If you select Create New Repository, you must enter the quality project name/quality project key.
  • If you select Not Created, you can proceed to the next step immediately.
Base URLSelect the SonarQube URL.
Quality Project NameEnter the name of the SonarQube project.
Quality Project KeyEnter the key of the SonarQube project.
Authentication InformationEnter authentication information
  • You can create a new user or use existing authentication information.
Table. Project Creation Code Quality Setting Items

Setting Image Repository

The user can set up the repository to store the built container image through the image repository setting step.

Note
Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up an image repository, follow these steps:

  1. Image Repository section, select the Repository Type.
  2. Select Create New Repository/Use Existing Repository and enter the information.
  3. Enter the Authentication Information and click the Connection Test button.
  4. When the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the type of repository to use
  • The types of Image Registry tools available to the user are displayed.
Repository InformationSelect the repository creation method.
  • When creating a new repository, the URL is composed of the project group name/project name.
Authentication InformationEnter the authentication information.
Table. Project Creation Image Repository Setting Items

Setting Release Target Environment

The user can deploy through direct configuration using Helm charts.

When selecting Helm release name and Helm chart, the Helm chart installation items and the default Values.yaml items included in the chart are displayed.

Available Helm charts are linked to App templates. You can modify or delete them through Managing Supported Helm Charts.

To set up the deployment target environment, follow these steps:

  1. Select direct configuration using Helm charts in the deployment target section.
  2. Enter the Helm release name.
  3. Click the Search button to select the Helm chart to use.
  4. Modify the Values.yaml and click the Validation Check button.
  5. Click the Next button when it is activated.
ItemDescription
Deployment TargetSelect the deployment target.
Helm Release NameEnter the name of the Helm release to be created.
  • This name must be unique within the namespace of the cluster to be deployed.
Helm ChartSelect the Helm chart.
  • When a Helm chart is selected, detailed information about the selected chart is displayed below.
K8S InformationDisplays the information of the Kubernetes cluster required for the Value.yaml configuration.
Values.yamlModify the Values.yaml content.
  • This is the values.yaml file used when installing the Helm chart.
Table. Project Creation Deployment Target Environment Setting Items

Setting 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:

  1. 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.
  2. When the Next button is activated, click the Next button.
Item
Description
Build/Deploy PipelineDisplays build/deploy pipeline information.
  • Build/deploy pipeline is displayed based on the information registered in the pipeline template management of the App template.
ClassificationSelect development/operation classification.
  • Authority for the pipeline varies depending on the development/operation classification.
URLSelect Jenkins to configure the pipeline and enter the job name.
  • A list of Jenkins available to the user will be displayed.
Build AgentSelect the agent to be used for pipeline build.
Build Environment OSDisplays the OS information of the environment where the build agent runs.
User InformationIDP-connected Jenkins
  • Click the User Check button to verify user registration.
  • If not registered as a Jenkins user, a User Registration Guide popup window will open; click the Go to Jenkins link to proceed with User Registration or Initial Jenkins Login.
Non-IDP-connected Jenkins
  • Enter authentication information and click the Connection Test button.
Environment Variable SettingSet environment variables to be registered in the Jenkins pipeline.
Image Tag PatternSelect the method for assigning tags to container images.
Deploy StrategySelect the deployment method for container images.
Deployment Result RecipientSelect the user to receive the result after the build pipeline is completed.
Table. Build Pipeline Setting Items for Project Creation

Setting User Definition

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:

  1. Customize settings page, enter information, and click the Connection Test button.
  2. When the Next button is activated, click the Next button.
ItemDescription
Dockerfile SettingsChoose whether to Create a new Dockerfile or Use an existing Dockerfile.
  • Using an existing Dockerfile can only be selected if you choose the Environment Only App template and select Use an existing repository in Configuring the Code Repository.
Dockerfile PathSpecify the path of the Dockerfile file in the source code.
Branch NameThe branch name is automatically registered when setting up Configuring the Code Repository.
DockerfileCheck and modify the contents of the Dockerfile.
Pipeline ScriptCheck and modify the pipeline script.
Table. Project Creation Customization Settings
Note
For more information on Jenkins pipeline scripts, refer to the official website.

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.

  1. Summary Information screen, check the information and click the Complete button.
  2. The Project Creation popup window opens and the project creation proceeds.
  3. After the project creation is complete, click the Confirm button to move to the Project page.
Notice
It cannot be canceled during creation, and if the project is created normally, the Confirm button is activated.

2 - Creating a Project (Workload Deployment)

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

Users can create a project that deploys to a specific Kubernetes cluster using App Templates, Tool Management, and Workloads.

Starting Project Creation

To start creating a project, follow these steps:

  1. Main page, click the Create Project button. 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 basic information, follow these steps:

  1. Project Creation page, select Project Configuration Method item’s App. Template Utilization.
  2. Select Kubernetes for the Deployment Target item.
  3. Enter additional content and click the Start button.
    ItemDescription
    Project NameEnter the project name.
    Project IDEnter the project ID.
    Project Configuration MethodSelect the project configuration method
    • App. Template Utilization: Select a pre-provided App. template.
    • Direct Configuration: Configure directly without an App. template.
    Deployment TargetSelect the deployment target
    • Kubernetes: Deploy the application to a Kubernetes cluster.
    • Kubernetes(ArgoCD): Deploy the application to a Kubernetes cluster using ArgoCD.
    • VM(Artifact): Deploy the application to a VM server.
    • VM(Docker): Deploy the application to a VM server as a Docker image.
    • N/A: Select if the build result is not deployed.
    K8S ClusterSelect the target cluster to deploy
    • DevOps Console K8S cluster’s cluster, only clusters with user access rights can be selected.
    NamespaceSelect the target namespace to deploy
    • K8S cluster’s retrieved cluster, only namespaces with user access rights can be selected.
    Table. Project Creation Basic Information Input Items

Selecting an Application Template

Note
For more information on application templates, see 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:

  1. Application Template screen, enter the template name to select the desired application template card and click it.
  2. When the Next button is activated, click the Next button.
ItemDescription
FilterYou can easily find application templates through predefined filters.
SearchYou can easily find application templates through search.
Table. Project Creation Application Template Items

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

Note
Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up a code repository, follow these steps:

  1. In the Code Repository section, select the Code Repository type.
  2. Select Create a New Repository or Use an Existing Repository and enter the information.
  3. Enter the Authentication Information and click the Connection Test button.
  4. If the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the code repository to use
  • Registered Tool: You can select and use the types of SCM Repository tools available to the user (Github, Gitlab, etc.).
  • DevOps Code: Available if you have applied for DevOps Code in the Samsung Cloud Platform Console.
  • Unregistered Tool: You can use it by entering the domain of an unregistered tool. The unregistered tool item only appears when the App. template is Environment Only (without source code).
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
  • If you don’t have an account, you can create one by clicking the Don’t have an account? link and opening the Account Creation Information popup window.
  • After creating a new account, please change your password through the Initial Password Setting link.
(Unregistered Tool)
Repository Information
Enter repository information
  • You can use a code repository that is not registered as a tool in DevOps Console.
  • You must go through an additional verification process by clicking the URL Check button.
Table. Project Creation Code Repository Setting Items

Setting Up Code Quality

The user can configure a repository for quality management.

To set up code quality, follow the procedure below.

  1. Code Quality item, select the Repository Type.
  2. Enter Basic Information and Authentication Information, then click the Connection Test button.
  3. When the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the repository to use
  • The types of Code Quality tools available to the user are displayed.
New/Existing/Not UsedSelect the repository creation method
  • If you select Create New Repository, you must enter the quality project name/quality project key.
  • If you select Not Created, you can proceed to the next step immediately.
Base URLSelect the SonarQube URL.
Quality Project NameEnter the name of the SonarQube project.
Quality Project KeyEnter the key of the SonarQube project.
Authentication InformationEnter authentication information
  • You can create a new user or use existing authentication information.
Table. Project Creation Code Quality Setting Items

Setting Up an Image Repository

The user can set up the repository to store the built container image through the image repository setting step.

Note
Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up an image repository, follow these steps:

  1. Image Repository section, select the Repository Type.
  2. Select Create New Repository/Use Existing Repository and enter the information.
  3. Enter the Authentication Information and click the Connection Test button.
  4. When the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the type of repository to use
  • The types of Image Registry tools available to the user are displayed.
Repository InformationSelect the repository creation method.
  • When creating a new repository, the URL is composed of the project group name/project name.
Authentication InformationEnter the authentication information.
Table. Project Creation Image Repository Setting Items

Setting Up the Deployment Environment

Users can deploy by selecting the Deployment Target Workload.

To set up the deployment environment, follow these steps:

  1. In the Deployment Target section, select Select Deployment Target Workload. The Deployment Target Workload area will appear.
  2. In the Deployment Target Workload area, select the target workload and target container to deploy.
  3. When the Next button is activated, click the Next button.
ItemDescription
Deployment TargetSelect the deployment target
  • Configure directly through Helm Chart
  • Select Deployment Target Workload
Inquiry TargetSelect the inquiry target.
WorkloadSelect the workload
  • Displays workloads existing in the Kubernetes cluster selected when creating the project.
Target ContainerSelect the target container to use from the selected workload.
Table. Deployment Environment Setting Items

Setting Up the 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:

  1. 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.
  2. When the Next button is activated, click the Next button.
Item
Description
Build/Deploy PipelineDisplays build/deploy pipeline information.
  • Build/deploy pipeline is displayed based on the information registered in the pipeline template management of the App template.
ClassificationSelect development/operation classification.
  • Authority for the pipeline varies depending on the development/operation classification.
URLSelect Jenkins to configure the pipeline and enter the job name.
  • A list of Jenkins available to the user will be displayed.
Build AgentSelect the agent to be used for pipeline build.
Build Environment OSDisplays the OS information of the environment where the build agent runs.
User InformationIDP-connected Jenkins
  • Click the User Check button to verify user registration.
  • If not registered as a Jenkins user, a User Registration Guide popup window will open; click the Go to Jenkins link to proceed with User Registration or Initial Jenkins Login.
Non-IDP-connected Jenkins
  • Enter authentication information and click the Connection Test button.
Environment Variable SettingSet environment variables to be registered in the Jenkins pipeline.
Image Tag PatternSelect the method for assigning tags to container images.
Deploy StrategySelect the deployment method for container images.
Deployment Result RecipientSelect the user to receive the result after the build pipeline is completed.
Table. Build Pipeline Setting Items for Project Creation

Setting Up Custom Settings

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:

  1. Customize settings page, enter information, and click the Connection Test button.
  2. When the Next button is activated, click the Next button.
ItemDescription
Dockerfile SettingsChoose whether to Create a new Dockerfile or Use an existing Dockerfile.
  • Using an existing Dockerfile can only be selected if you choose the Environment Only App template and select Use an existing repository in Configuring the Code Repository.
Dockerfile PathSpecify the path of the Dockerfile file in the source code.
Branch NameThe branch name is automatically registered when setting up Configuring the Code Repository.
DockerfileCheck and modify the contents of the Dockerfile.
Pipeline ScriptCheck and modify the pipeline script.
Table. Project Creation Customization Settings
Note
For more information on Jenkins pipeline scripts, refer to the official website.

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.

  1. Summary Information screen, check the information and click the Complete button.
  2. The Project Creation popup window opens and the project creation proceeds.
  3. After the project creation is complete, click the Confirm button to move to the Project page.
Notice
It cannot be canceled during creation, and if the project is created normally, the Confirm button is activated.

3 - Creating an ArgoCD Deployment Project

Note
  • 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.

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

  1. Enter the project name and project ID.
  2. Select App Template as the Project Configuration Method.
  3. Select Kubernetes (ArgoCD) as the Deployment Target.
  4. 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.
  5. Click the Start button after completing each input.

Selecting an App Template

Note
For more information on application templates, see 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:

  1. Application Template screen, enter the template name to select the desired application template card and click it.
  2. When the Next button is activated, click the Next button.
ItemDescription
FilterYou can easily find application templates through predefined filters.
SearchYou can easily find application templates through search.
Table. Project Creation Application Template Items

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

Note
Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up a code repository, follow these steps:

  1. In the Code Repository section, select the Code Repository type.
  2. Select Create a New Repository or Use an Existing Repository and enter the information.
  3. Enter the Authentication Information and click the Connection Test button.
  4. If the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the code repository to use
  • Registered Tool: You can select and use the types of SCM Repository tools available to the user (Github, Gitlab, etc.).
  • DevOps Code: Available if you have applied for DevOps Code in the Samsung Cloud Platform Console.
  • Unregistered Tool: You can use it by entering the domain of an unregistered tool. The unregistered tool item only appears when the App. template is Environment Only (without source code).
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
  • If you don’t have an account, you can create one by clicking the Don’t have an account? link and opening the Account Creation Information popup window.
  • After creating a new account, please change your password through the Initial Password Setting link.
(Unregistered Tool)
Repository Information
Enter repository information
  • You can use a code repository that is not registered as a tool in DevOps Console.
  • You must go through an additional verification process by clicking the URL Check button.
Table. Project Creation Code Repository Setting Items

Setting up Code Quality

The user can configure a repository for quality management.

To set up code quality, follow the procedure below.

  1. Code Quality item, select the Repository Type.
  2. Enter Basic Information and Authentication Information, then click the Connection Test button.
  3. When the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the repository to use
  • The types of Code Quality tools available to the user are displayed.
New/Existing/Not UsedSelect the repository creation method
  • If you select Create New Repository, you must enter the quality project name/quality project key.
  • If you select Not Created, you can proceed to the next step immediately.
Base URLSelect the SonarQube URL.
Quality Project NameEnter the name of the SonarQube project.
Quality Project KeyEnter the key of the SonarQube project.
Authentication InformationEnter authentication information
  • You can create a new user or use existing authentication information.
Table. Project Creation Code Quality Setting Items

Setting up an Image Repository

The user can set up the repository to store the built container image through the image repository setting step.

Note
Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up an image repository, follow these steps:

  1. Image Repository section, select the Repository Type.
  2. Select Create New Repository/Use Existing Repository and enter the information.
  3. Enter the Authentication Information and click the Connection Test button.
  4. When the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the type of repository to use
  • The types of Image Registry tools available to the user are displayed.
Repository InformationSelect the repository creation method.
  • When creating a new repository, the URL is composed of the project group name/project name.
Authentication InformationEnter the authentication information.
Table. Project Creation Image Repository Setting Items

Setting up the Deployment Environment

Note

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.

  1. On the Deployment Environment screen, enter the ArgoCD URL and click the Confirm button.
  2. The authentication information input screen appears.
  3. Enter the authentication information and click the Connection Test button.
  4. The input screen for the new ArgoCD application appears.
  5. Enter the ArgoCD application name and ArgoCD project name.
  6. Select the repository type.
  7. Select the Helm chart.
  8. The Helm chart and Helm chart Git repository information are displayed.
  9. Modify the Values.yaml and click the Validation Check button.
  10. Enter the Git repository information and authentication information, then click the Connection Test button.
  11. Click the Next button when it becomes active.
ItemDescription
URL input methodSelect the URL input method.
  • Select from the list: Registered ArgoCD tools are displayed.
  • Enter directly
ArgoCD URLEnter the ArgoCD URL and click the Confirm button. The authentication information section appears.
Authentication informationEnter the authentication information and click the Connection Test button. The application basic information section opens.
Application nameEnter the name of the ArgoCD application to be created.
Project nameEnter the name of the ArgoCD project.
Repository typeSelect the repository type.
  • Create a new repository using Helm chart: Create a Git repository for GitOps using Helm chart. The Helm chart information section opens.
  • Use an existing Git repository
Helm chartSelect the Helm chart.
Helm chart Git repositoryEnter the information of the Git repository to be used for GitOps.
Table. New App creation settings

Using an Existing App

To set up the deployment environment using an existing ArgoCD application, follow these steps.

  1. On the Deployment Environment screen, enter the ArgoCD URL and click the Confirm button.
  2. The input screen for the existing ArgoCD application name and authentication information appears.
  3. Enter the existing application name and authentication information, then click the Connection Test button.
  4. A pop-up window for URL Check opens to distinguish the Git repository linked to the ArgoCD application.
  5. Modify the Base URL in the URL Check pop-up window and click the Confirm button.
  6. The information of the Git repository linked to the ArgoCD application is displayed.
  7. Enter the authentication information of the Git repository and click the Connection Test button.
  8. In the Manifest Root path section, enter the yaml file name and key value to be modified.
  9. Click the Next button when it becomes active.
ItemDescription
URL input methodSelect the URL input method
  • Select from the list: Registered ArgoCD tools are displayed.
  • Enter directly
ArgoCD URLEnter the ArgoCD URL and click the Confirm button. The existing application name and authentication information section appears.
Application name / Authentication informationEnter the existing application name and authentication information, then click the Connection Test button. The Git repository and ArgoCD information section appears.
URL CheckDistinguish the Base URL and Path from the entire URL.
Git repository authentication informationEnter the authentication information of the Git repository used by the selected existing application.
Image Repo KeyEnter 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 KeyEnter 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 KeyEnter the path and key value of the yaml file where the image secret information is recorded.
Deploy Strategy KeyEnter the path and key value of the yaml file where the deployment strategy information is recorded (optional).
Table. Existing App usage settings
Note
The ArgoCD deployment project in the DevOps Console performs deployment by changing the information registered in Image Repo Key, Image Tag Key, Image Secret Key, and Deploy Strategy Key.

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:

  1. 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.
  2. When the Next button is activated, click the Next button.
Item
Description
Build/Deploy PipelineDisplays build/deploy pipeline information.
  • Build/deploy pipeline is displayed based on the information registered in the pipeline template management of the App template.
ClassificationSelect development/operation classification.
  • Authority for the pipeline varies depending on the development/operation classification.
URLSelect Jenkins to configure the pipeline and enter the job name.
  • A list of Jenkins available to the user will be displayed.
Build AgentSelect the agent to be used for pipeline build.
Build Environment OSDisplays the OS information of the environment where the build agent runs.
User InformationIDP-connected Jenkins
  • Click the User Check button to verify user registration.
  • If not registered as a Jenkins user, a User Registration Guide popup window will open; click the Go to Jenkins link to proceed with User Registration or Initial Jenkins Login.
Non-IDP-connected Jenkins
  • Enter authentication information and click the Connection Test button.
Environment Variable SettingSet environment variables to be registered in the Jenkins pipeline.
Image Tag PatternSelect the method for assigning tags to container images.
Deploy StrategySelect the deployment method for container images.
Deployment Result RecipientSelect the user to receive the result after the build pipeline is completed.
Table. Build Pipeline Setting Items for Project Creation

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:

  1. Customize settings page, enter information, and click the Connection Test button.
  2. When the Next button is activated, click the Next button.
ItemDescription
Dockerfile SettingsChoose whether to Create a new Dockerfile or Use an existing Dockerfile.
  • Using an existing Dockerfile can only be selected if you choose the Environment Only App template and select Use an existing repository in Configuring the Code Repository.
Dockerfile PathSpecify the path of the Dockerfile file in the source code.
Branch NameThe branch name is automatically registered when setting up Configuring the Code Repository.
DockerfileCheck and modify the contents of the Dockerfile.
Pipeline ScriptCheck and modify the pipeline script.
Table. Project Creation Customization Settings
Note
For more information on Jenkins pipeline scripts, refer to the official website.

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.

  1. Summary Information screen, check the information and click the Complete button.
  2. The Project Creation popup window opens and the project creation proceeds.
  3. After the project creation is complete, click the Confirm button to move to the Project page.
Notice
It cannot be canceled during creation, and if the project is created normally, the Confirm button is activated.

4 - Creating a Project (VM Deployment)

Note

The user must be a member of a project group and tenant to create a project.

For more information on joining a project group and tenant, see Creating a Project Group.

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 the VM server information. For more information on registering a VM server, see Getting Started with VM Server Group.

Starting Project Creation

To start creating a project, follow these steps:

  1. Main page, click the Create Project button. This will take you to the Create Project page.

Entering Basic Information

  1. On the Create Project page, enter the project name and project ID.
  2. For the Project Configuration Method, select App Template.
  3. For the Deployment Target, select VM (Artifact) or VM (Docker).
    • VM (Artifact) creates a war/jar file and deploys it to the target server.
    • VM (Docker) builds and deploys a Docker image using the docker command.
  4. Select the Deployment Method.
  5. After completing each input, click the Start button.

Selecting App Template

Note
For more information on application templates, see 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:

  1. Application Template screen, enter the template name to select the desired application template card and click it.
  2. When the Next button is activated, click the Next button.
ItemDescription
FilterYou can easily find application templates through predefined filters.
SearchYou can easily find application templates through search.
Table. Project Creation Application Template Items

Setting Up 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 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

Note
Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up a code repository, follow these steps:

  1. In the Code Repository section, select the Code Repository type.
  2. Select Create a New Repository or Use an Existing Repository and enter the information.
  3. Enter the Authentication Information and click the Connection Test button.
  4. If the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the code repository to use
  • Registered Tool: You can select and use the types of SCM Repository tools available to the user (Github, Gitlab, etc.).
  • DevOps Code: Available if you have applied for DevOps Code in the Samsung Cloud Platform Console.
  • Unregistered Tool: You can use it by entering the domain of an unregistered tool. The unregistered tool item only appears when the App. template is Environment Only (without source code).
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
  • If you don’t have an account, you can create one by clicking the Don’t have an account? link and opening the Account Creation Information popup window.
  • After creating a new account, please change your password through the Initial Password Setting link.
(Unregistered Tool)
Repository Information
Enter repository information
  • You can use a code repository that is not registered as a tool in DevOps Console.
  • You must go through an additional verification process by clicking the URL Check button.
Table. Project Creation Code Repository Setting Items

Setting Up Code Quality

The user can configure a repository for quality management.

To set up code quality, follow the procedure below.

  1. Code Quality item, select the Repository Type.
  2. Enter Basic Information and Authentication Information, then click the Connection Test button.
  3. When the Next button is activated, click the Next button.
ItemDescription
Repository TypeSelect the repository to use
  • The types of Code Quality tools available to the user are displayed.
New/Existing/Not UsedSelect the repository creation method
  • If you select Create New Repository, you must enter the quality project name/quality project key.
  • If you select Not Created, you can proceed to the next step immediately.
Base URLSelect the SonarQube URL.
Quality Project NameEnter the name of the SonarQube project.
Quality Project KeyEnter the key of the SonarQube project.
Authentication InformationEnter authentication information
  • You can create a new user or use existing authentication information.
Table. Project Creation Code Quality Setting Items

Setting Up Artifact Repository

Users can configure a repository for artifacts.

If you select Not Created, you can proceed to the next step.

To set up an artifact repository, follow these steps:

  1. On the Artifact Repository screen, select the repository type.
  2. Enter the basic information and authentication information, then click the Connection Test button.
  3. If the Next button is activated, click it.
ItemDescription
Repository TypeSelect the type of repository to use
  • The available types of Artifact Repository tools are displayed.
New/Existing/Not UsedSelect the method of creating a repository
  • If you select Not Created, you can proceed to the next step.
Base URL / Endpoint URLSelect the Nexus URL or Object Storage URL.
Repository Type / Bucket Name
  • If Nexus, it is automatically registered as raw (hosted).
  • If 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 InformationEnter the authentication information
  • You can create a new user or use existing authentication information.
Table. Artifact Repository Setup Input Items

Setting Up Deployment Target Environment

Note

Deployment Target Setting requires a registered VM Server Group/VM Server.

For registration methods and more information, see VM Server Group.

To set up the deployment target environment, follow these steps:

  1. On the Deployment Target Environment screen, enter the required information and click the Next button.
ItemDescription
Deployment ConfigurationChoose whether to write a deployment script directly
  • If you select to write a deployment script directly, you will write the content in the user-defined stage.
Deployment MethodThe selected deployment method is displayed.
Artifact RepositoryThe address of the repository to use for the agent method is displayed.
  • Activated when the Deployment Method is Agent.
Manual DeploymentSelect the default value for manual deployment
  • Select the default setting value for manual deployment-related parameters when running the pipeline.
Deployment OrderChoose whether to deploy to multiple target servers in parallel or sequentially.
Deployment Target SettingSet up the deployment target server.
  • When you click Setting, the Deployment Target VM Setting popup window opens.
Auto-Restore SettingChoose whether to set up automatic restoration.
  • If deployment fails, it will be restored to the previous successful deployment.
  • Activated when the Deployment Method is Agent.
Command Before File DeploymentEnter the command to be executed before file deployment.
Files to be Deployed
  • Source: Enter the file path after the Jenkins workspace where the build pipeline is executed.
  • Target: Enter the path where the file will be deployed on the VM server.
  • You can add files using the Add button.
Command After File DeploymentEnter the command to be executed after file deployment.
Table. Deployment Target Environment Setup Items

Setting Up Build Pipeline

Users can configure a pipeline to build and deploy an application.

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:

  1. On the build pipeline setup stage, enter the Authentication Information and click the Connection Test button.
  2. If the Next button is activated, click it.
ItemDescription
Build/Deployment PipelineDisplays build/deployment pipeline information.
ClassificationSelect the development/operation classification.
URLSelect the Jenkins to configure the pipeline and enter the job name.
  • The available Jenkins are displayed.
Build AgentSelect the agent to use for pipeline build.
Build Environment OSDisplays the OS information of the environment where the build agent is executed.
Authentication InformationEnter the authentication information for Jenkins.
Environment Variable SettingSet the environment variables to be registered in the Jenkins pipeline.
Deployment Result RecipientSelect the user to receive the result of the build pipeline completion.
Table. Build Pipeline Setup Input Items

Setting Up User-Defined Configuration

If you selected Direct Deployment Script Writing in the deployment target and deployment setting stage, modify the pipeline content in this stage to complete the deployment setting.

To set up a user-defined configuration, follow these steps:

  1. On the User-Defined stage, review and modify the content, then click the Next button.

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.

  1. Summary Information screen, check the information and click the Complete button.
  2. The Project Creation popup window opens and the project creation proceeds.
  3. After the project creation is complete, click the Confirm button to move to the Project page.
Notice
It cannot be canceled during creation, and if the project is created normally, the Confirm button is activated.

5 - Creating an Empty Project

Note
  • 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.

Users can create an empty (empty) project with no settings.

After creating an empty project, to configure the build/deployment, users must manually perform tasks such as Adding a Code Repository, Adding an Image Repository, Installing Helm, Adding a Build Pipeline.

Starting Project Creation

To start creating an empty project, follow these steps.

  1. 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 basic information, follow these steps.

  1. On the Create Project page, select Direct Configuration from the Project Configuration Method.
  2. Enter the Project Name and Project ID, then click the Start button. The Summary Information screen will appear.

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.

  1. Summary Information screen, check the information and click the Complete button.
  2. The Project Creation popup window opens and the project creation proceeds.
  3. After the project creation is complete, click the Confirm button to move to the Project page.
Notice
It cannot be canceled during creation, and if the project is created normally, the Confirm button is activated.