The page has been translated by Gen AI.

App Template

App Template is a feature provided for quick development environment setup.

App Template consists of sample source code, Dockerfile, Helm Chart, and more. Users can quickly set up their development environment using App Template when creating a project.

We provide App Templates for various frameworks such as Node.js, Python, Spring Boot, and more. Users can also create and register their own App Templates.

App Template TypeDescription
System Template
  • A tool that can be used across the DevOps Console.
  • Only system administrators can manage it.
  • Tenant administrators can only release it when it is available in their tenant.
Tenant Template
  • A template that can be used in a specific tenant.
  • It can be mapped to multiple tenants and used.
  • The administrator of the corresponding tenant can manage it.
ProjectGroup Template
  • A template that can only be used in a specific project group.
  • It can be mapped to only one project group and used.
  • The owner of the corresponding project group can manage it.
Table. App Template Type

Getting Started with App Template

To start managing App Templates, follow these steps:

  1. Main page, click the Manage icon at the top right. Move to the Tenant Dashboard page.
  2. In the left menu, click Tools & Templates > App Template. Move to the App Template page.

Adding App Template

Users can add their own App Templates.

Source Code

Source code used to configure a sample project in the App Template.

The SCM Repository tool must be available in the tenant or project group where the App Template will be registered. Refer to Adding Tools for how to register the SCM Repository tool.

Register the source code in the SCM Repository in advance. When registering the App Template, the registered SCM Repository will appear, and you can enter the path to the source code.

Dockerfile

Note
You can manage the Dockerfile without registering it inside the source code. Refer to Managing Dockerfile Templates for more information.
For explanations and writing methods of Dockerfile, refer to the official website.

To register an App Template that supports Kubernetes or VM (Docker) deployment targets, you must add a Dockerfile to the source code or register a Dockerfile through Managing Dockerfile Templates.

When writing a Dockerfile, the FROM clause must be fixed as FROM ${BASE_IMAGE}.

The registered ${BASE_IMAGE} value is replaced with the image.repository value of the Helm chart for Kubernetes deployment targets or the image path registered in Managing Supported Images for VM (Docker) deployment targets.

Dockerfile sample

Color mode
FROM ${BASE_IMAGE}

COPY *.jar app.jar
ENTRYPOINT ["java","-jar","/app.jar"]
FROM ${BASE_IMAGE}

COPY *.jar app.jar
ENTRYPOINT ["java","-jar","/app.jar"]
Dockerfile Sample

Registering App Template

To register an App Template, follow these steps:

  1. App Template page, click the Add button. Move to the Add App Template page.
  2. Add App Template page, select the template support type and click the Start button.
  3. Enter the necessary information and click the Complete button.
ItemDescription
TypeSelect the type of template.
Tenant/Project GroupSelect the tenant or project group to map.
Table. Add App Template - Template Support Type Selection Items
ItemDescription
Deployment TargetSelect the deployment target supported by the template.
  • Kubernetes: When the deployment target is a cluster using Helm charts.
  • VM (Artifact): When the deployment target is a VM server using artifact files.
  • VM (Docker): When the deployment target is a VM server using Docker images.
  • N/A: When there is no deployment target (e.g., Android).
Template NameEnter the name of the App Template.
Application ClassificationSelect the classification of the application included in the template.
  • Used to classify templates.
LanguageSelect the development language of the source code included in the template.
Source CodeSelect whether the template includes source code.
Source Code Repository TypeSelect the location where the source code is stored. SCM or ZIP file selection is possible.
Repository URLEnter the URL of the repository where the template source code is located.
  • A list of SCM Repository tools available in the corresponding tenant or project group will appear.
Repository BranchEnter the branch of the repository where the template source code is located.
Individual AuthenticationEnter authentication information to access the repository.
  • If not used, the authentication information used when registering the tool will be used.
Dockerfile PathEnter the path to the Dockerfile in the repository.
  • Used for Docker image build.
Code QualitySelect whether to use code quality.
DescriptionWrite a description of the App Template.
Document URLEnter the URL of the document that explains the template.
  • It will appear as a link on the template selection page when creating a project.
Template IconSelect an icon to use for the template.
Build Result PathSpecify the build result path and file name.
Dockerfile TypeSelect the Dockerfile type.
  • You can choose to use the Dockerfile file in the source code or use the information registered in Managing Dockerfile Templates.
  • If you select the GUI template, the Dockerfile Template tab will be activated.
Table. Add App Template - Basic Information Input Items
Note

If the deployment target of the App Template is Kubernetes, the Supported Helm Chart step is added.

  • Select the Helm chart that can be used when deploying using this App Template.
  • You can select the Helm chart list by checking the checkbox and using the Add and Delete buttons in the middle.
Warning
App Templates cannot be used immediately after registration and require additional settings.
Refer to Adding Pipeline Templates and modify the usage to Yes by referring to Modifying Supported Tenant Information.

Modifying App Template Basic Information

To modify the basic information of an App Template, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Basic Information tab.
  3. Basic Information tab, click the Modify button.
  4. Modify the necessary information and click the Save button.
Note
If a pipeline template is not registered, a Notification popup will appear.

Managing Pipeline Templates

Pipeline templates are settings for building pipelines that are automatically configured when a user creates a project using an App Template.

Warning
If a pipeline template is not registered, the App Template cannot be used.

Adding Pipeline Templates

To add a pipeline template, follow these steps:

  1. App Template page, click the item you want to add. Move to the App Template Details page.
  2. App Template Details page, click the Pipeline Template tab.
  3. Pipeline Template tab, click the Add button. Move to the Add Pipeline Template page.
  4. Add Pipeline Template page, enter the necessary information and click the Save button.
ItemDescription
Template NameEnter the name of the pipeline template.
Default Template
  • The default template is used for pipeline configuration when creating a project.
  • If a default template is not registered, it will be automatically set to ON and cannot be changed.
Supported JenkinsSelect the Jenkins that supports this pipeline template.
  • A list of CICD pipeline tools available in the corresponding tenant or project group will appear.
  • Required to refer to the necessary information in the Tools area when configuring the stage.
Environment VariableEnter environment variable information.
StageEnter each stage information.
Table. Add Pipeline Template Input Items
Note
For explanations and writing methods of Jenkins environment variables, refer to the official website.

Modifying Pipeline Templates

To modify a pipeline template, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Pipeline Template tab.
  3. Pipeline Template tab, click the item you want to modify. Move to the Pipeline Template Details page.
  4. Pipeline Template Details page, click the Modify button. Move to the Modify Pipeline Template page.
  5. Modify Pipeline Template page, modify the information and click the Save button.

Deleting Pipeline Templates

Warning
Pipeline templates marked as Default cannot be deleted.

To delete a pipeline template, follow these steps:

  1. App Template page, click the item you want to delete. Move to the App Template Details page.
  2. App Template Details page, click the Pipeline Template tab.
  3. Pipeline Template tab, click the item you want to delete. Move to the Pipeline Template Details page.
  4. Pipeline Template Details page, click the Delete button.
  5. Click the Confirm button in the confirmation popup.

Managing Dockerfile Templates

This tab only appears when the Dockerfile Type item in the Basic Information content of the App Template is GUI Template.

Modifying Dockerfile Templates

To modify a Dockerfile template, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Dockerfile Template tab.
  3. Dockerfile Template tab, click the Modify or Create button.
  4. Dockerfile Template tab, enter the contents and click the Save button.
ItemDescription
Authentication Information SettingRegister authentication information for the image used in the FROM clause of the multi-stage build.
AddAdd an image used in the FROM clause of the multi-stage build.
Multi-stage DockerfileConfigure the multi-stage build based on the registered information.
DockerfileConfigure the basic Dockerfile.
Table. Modify Dockerfile Template Input Items
Guide

You can also manage the Dockerfile without registering it through Dockerfile in the source code.

  • If you use the Dockerfile file included in the source code, the Dockerfile Type item in the Basic Information content of the App Template must be set to Code Repository File.

The FROM clause is automatically set to the image path registered in Managing Supported Images.

Note
For explanations and writing methods of Dockerfile files, refer to the official website.

Managing Supported Tenants/Project Groups

Guide

The tab name is displayed differently depending on the template type.

  • System Template/Tenant Template: Supported Tenants
  • ProjectGroup Template: Supported Information

Users can manage the tenants or project groups where the App Template can be used.

To manage supported tenants or project groups, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Supported Tenants or Supported Information tab.
Note
The primary icon appears for the managed tenant.

Adding Supported Tenants

To add supported tenants, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Supported Tenants tab.
  3. Supported Tenants tab, click the Add button. The Add Tenant popup will appear.
  4. Add Tenant popup, select the tenant to support and click the Save button.

Modifying Supported Tenant Information

To modify the information of supported tenants, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Supported Tenants tab.
  3. Supported Tenants tab, select the tenant to modify and select the Verification and Usage items to modify.
ItemDescription
TenantInformation about the available tenant.
VerificationSelect the verification.
  • Verification in progress
  • Verification completed
UsageSelect the usage.
  • Verification must be Verification completed to change to Usage.
Table. Supported Tenants Screen Items
Note

If the Verification is Verification in progress, only the user who registered the App Template can use it.

  • Other users can use the App template after verification and usage processing.

Modifying Supported Project Group Information

To modify the information of a supported project group, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page. App Template Details page, click the Support Information tab.
  2. Support Information tab, click the Modify button. The App Template Modification screen appears.
  3. App Template Modification screen, select and modify the Verification and Usage items.
  4. Click the Save button.
ItemDescription
Project GroupInformation about the available project group.
VerificationSelect the verification.
  • Verifying
  • Verification Complete
UsageSelect the usage.
  • Verification must be Verification Complete to change to Use.
Table. Support Information Screen Items
Note

If the verification is in progress, only the user who registered the App template can use it.

  • Other users can use the App template after verification and usage processing.

Transferring Management Tenant

To transfer the management tenant, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Support Tenant tab.
  3. Support Tenant tab, click the Transfer Management Tenant button. The Transfer Management Tenant popup window opens.
  4. Transfer Management Tenant popup window, select the target tenant to transfer and click the Save button.

Deleting Support Tenant

To delete a support tenant, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Support Tenant tab.
  3. Support Tenant tab, select the tenant to delete and click the Delete button.
  4. Click the Confirm button in the confirmation popup window.
Caution
Primary designated tenants cannot be deleted.

Managing Support Images

Guide
The Support Image tab only appears when the deployment target of the App template is Kubernetes or VM(Docker).

The Support Image registered by the user is used in the Dockerfile or Dockerfile template of the source code.

Adding Support Images

Guide
When adding support images, only Image Registry Tools available in the tenant and project group are listed.

To add a support image, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Support Image tab.
  3. Support Image tab, click the Add button. The Add Support Image popup window opens.
  4. Add Support Image popup window, enter the information and click the Connection Test button.
  5. When the Save button is activated, click the Save button.
  6. Click the Confirm button in the confirmation popup window.
ItemDescription
Image Information InputEnter the support image and authentication information.
Use Registrar’s Authentication InformationAn option that can be selected when the selected image storage tool cannot grant permissions (e.g., SCR).
  • If not checked, the support image user will be added to the pull permission of the entered image when creating a project. If the tool cannot grant permissions, the permissions will not be granted.
  • If checked, the support image user’s authority is used instead of the support image registrar’s authentication information when creating a project.
Table. Support Image Addition Input Items
Caution

Precautions for using the registrar’s authentication information

  • Be careful when using this option, as the registrar’s authentication information may be exposed to the support image user.
  • This option should only be used when necessary, and only for image storage that provides pull-only functionality. (If checked, one image storage cannot be used for both pull and push at the same time.)
  • The registrar’s authentication information is used in the project > image storage > pull-only image. This information cannot be changed by the support image user, and if the registrar’s authentication information is re-registered in the support image, it will be changed collectively.

Deleting Support Images

To delete a support image, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Support Image tab.
  3. Support Image tab, select the checkbox of the item to delete and click the Delete button.
  4. Click the Confirm button in the confirmation popup window.

Managing Support Helm Charts

Guide
The Support Helm Chart tab is only exposed when the deployment target of the App template is Kubernetes.
Refer to Adding Helm Charts for support helm chart registration.

The Support Helm Chart registered by the user is used when creating a project using the App template.

Adding Support Helm Charts

To add a support helm chart, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Support Helm Chart tab.
  3. Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
  4. App Template Modification screen, select the checkbox of the helm chart to use in the Helm Chart List, and click the Add button to add it to the Selected Helm Chart List, then click the Save button.

Modifying Support Helm Charts

To modify a support helm chart, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Support Helm Chart tab.
  3. Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
  4. App Template Modification screen, select the checkbox of the helm chart to use in the Helm Chart List, and click the Add or Delete button to modify the Selected Helm Chart List, then click the Save button.

Deleting Support Helm Charts

To delete a support helm chart, follow these steps:

  1. App Template page, click the item you want to modify. Move to the App Template Details page.
  2. App Template Details page, click the Support Helm Chart tab.
  3. Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
  4. App Template Modification screen, select the checkbox of the helm chart to delete in the Selected Helm Chart List, and click the Delete button to delete it, then click the Save button.

Deleting App Templates

To delete an App template, follow these steps:

  1. App Template page, click the item you want to delete. Move to the App Template Details page.
  2. App Template Details page, click the Basic Information tab.
  3. Basic Information tab, click the Delete button.
  4. Click the Confirm button in the confirmation popup window.
Tool Management
Register user-installed Jenkins tool