The page has been translated by Gen AI.

Tutorial (Project Creation to Build/Deployment)

The user can create a DevOps Console project and build the source to create an image and deploy a Helm chart to a Kubernetes cluster through the following procedure.

Creating a Project Group

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

Creating a Project Group

To create a project group, follow these steps:

  1. Click the Create Project Group and Start button or Create Project Group button on the Main page. The Create Project Group popup window opens.
  2. Enter the items and click the Save button to complete the project group creation.
Note
  • Approval from the tenant administrator may be required.
  • If there are no available tenants to choose from, click the Join Tenant Quick Link to proceed with tenant registration.

Joining a Tenant

To join a tenant, follow the procedure below.

  1. Project Group Creation popup window, click the Join Tenant Shortcut link. The Tenant Join Request popup window will open.
  2. In the Tenant Search field, enter the tenant code you want to join exactly and click the Search icon. The tenant information will be retrieved.
  3. Verify that the searched tenant is correct, enter the Reason for Request, and click the Add button. It will be added to the list below.
  4. Select the authority for the tenant added to the list below and click the Save button.

Creating a Project (Helm Chart Deployment)

Note
  • The user must be a member of the project group and tenant to create a project.
  • For project group and tenant registration, refer to Creating a Project Group.

The user can create a project that deploys an application to a specific Kubernetes cluster using App Template, Helm Chart, and Tool Management.

Starting Project Creation

To start creating a project, follow these steps:

  1. Click the Create Project button on the Main page. The Create Project page opens.

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

Checking Build Pipeline Execution

On the Project page, you can check the pipeline execution status, and the build pipeline is automatically executed when the project is created for the first time.

If the build pipeline fails, modify and re-execute the pipeline through the Build Pipeline menu on the left.

To check the build pipeline execution, follow these steps:

  1. Click the Project card on the Main page. Move to the Project Dashboard page.
  2. Click the Build/Deployment > Build Pipeline menu on the left.

Checking Deployment Results

After the pipeline execution is complete, you can check the Helm chart deployment results.

For more information on Helm chart deployment results, refer to Helm Release.

To check the deployment results, follow these steps:

  1. Click the Project card on the Main page. Move to the Project Dashboard page.
  2. Click the Build/Deployment > Kubernetes Deployment menu on the left. Move to the Kubernetes Deployment page.
  3. Click the Helm Release list to check the detailed deployment results.
Membership Information
(Helm Chart Deployment) Adding Build/Deployment