Creating a Project (VM Deployment)
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:
- Main page, click the Create Project button. This will take you to the Create Project page.
Entering Basic Information
- On the Create Project page, enter the project name and project ID.
- For the Project Configuration Method, select App Template.
- For the Deployment Target, select VM (Artifact) or VM (Docker).
- VM (Artifact) creates a
war/jarfile and deploys it to the target server. - VM (Docker) builds and deploys a Docker image using the
dockercommand.
- VM (Artifact) creates a
- Select the Deployment Method.
- For differences in deployment methods, see Table. SSH Method vs Agent Method
- After completing each input, click the Start button.
Selecting 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 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 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:
- On the Artifact Repository screen, select the repository type.
- Enter the basic information and authentication information, then click the Connection Test button.
- If the Next button is activated, click it.
| Item | Description |
|---|---|
| Repository Type | Select the type of repository to use
|
| New/Existing/Not Used | Select the method of creating a repository
|
| Base URL / Endpoint URL | Select the Nexus URL or Object Storage URL. |
| Repository Type / Bucket Name |
|
| Repository Name / Folder Name |
|
| Authentication Information | Enter the authentication information
|
Setting Up Deployment Target Environment
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:
- On the Deployment Target Environment screen, enter the required information and click the Next button.
| Item | Description |
|---|---|
| Deployment Configuration | Choose whether to write a deployment script directly
|
| Deployment Method | The selected deployment method is displayed.
|
| Artifact Repository | The address of the repository to use for the agent method is displayed.
|
| Manual Deployment | Select the default value for manual deployment
|
| Deployment Order | Choose whether to deploy to multiple target servers in parallel or sequentially. |
| Deployment Target Setting | Set up the deployment target server.
|
| Auto-Restore Setting | Choose whether to set up automatic restoration.
|
| Command Before File Deployment | Enter the command to be executed before file deployment. |
| Files to be Deployed |
|
| Command After File Deployment | Enter the command to be executed after file deployment. |
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:
- On the build pipeline setup stage, enter the Authentication Information and click the Connection Test button.
- If the Next button is activated, click it.
| Item | Description |
|---|---|
| Build/Deployment Pipeline | Displays build/deployment pipeline information.
|
| Classification | Select the development/operation classification.
|
| URL | Select the Jenkins to configure the pipeline and enter the job name.
|
| Build Agent | Select the agent to use for pipeline build.
|
| Build Environment OS | Displays the OS information of the environment where the build agent is executed. |
| Authentication Information | Enter the authentication information for Jenkins. |
| Environment Variable Setting | Set the environment variables to be registered in the Jenkins pipeline. |
| Deployment Result Recipient | Select the user to receive the result of the build pipeline completion. |
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:
- 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.
- 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.