Create Project (VM Deployment)

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.

1. On the Main page, click the Create Project button. It navigates to the Create Project page.

Enter basic information

1. On the Create Project page, enter the project name and project ID.
2. For the Project Configuration Method item, select App. Template Utilization.
3. Select VM(Artifact) or VM(Docker) for the Deployment Target field.
   • VM(Artifact) creates a war/jar file and transfers it to the deployment target server.
   • VM(Docker) runs the docker command after the build and image creation.
4. Please select the deployment method.
   • Differences by deployment method: Table. SSH method vs Agent method
5. 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.

1. On the Application Template screen, enter the template name, select the application template card you want, and then click.
2. 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.

To modify or delete stored credentials, refer to Manage Authentication Information.

To set up the code repository, follow these steps.

1. In the Code repository item, select the Code repository type.
2. Select Create new repository or Use existing repository, then enter the information.
3. Enter authentication information and click the Connection Test button.
4. 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 information	Enter 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

Configure Code Quality

Users can configure a repository for quality management.

To set code quality, follow these steps.

1. In the Code Quality item, select Repository Type.
2. Enter Basic Information and Authentication Information, then click the Connection Test button.
3. 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 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 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.

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. 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 Nexus URL or an Object Storage URL.
   Storage type / bucket name	In the case of Nexus, it is automatically registered as raw(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

To set the deployment target environment, follow these steps.

1. 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. Table. SSH method vs Agent method
   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.

1. In the build pipeline configuration step, enter the authentication information and click the Connection Test button.
2. 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 Jenkins to configure the pipeline, then enter the Job name Jenkins available 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	Jenkins Set 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.

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

1. Summary Information After checking the information on the screen, click the Complete button.
2. Project Creation popup window opens and the project creation proceeds.
3. After the project creation is complete, click the Confirm button to go to the Project page.