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 Type | Description |
|---|---|
| System Template |
|
| Tenant Template |
|
| ProjectGroup Template |
|
Getting Started with App Template
To start managing App Templates, follow these steps:
- Main page, click the Manage icon at the top right. Move to the Tenant Dashboard page.
- 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
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
FROM ${BASE_IMAGE}
COPY *.jar app.jar
ENTRYPOINT ["java","-jar","/app.jar"]FROM ${BASE_IMAGE}
COPY *.jar app.jar
ENTRYPOINT ["java","-jar","/app.jar"]Registering App Template
To register an App Template, follow these steps:
- App Template page, click the Add button. Move to the Add App Template page.
- Add App Template page, select the template support type and click the Start button.
- Enter the necessary information and click the Complete button.
| Item | Description |
|---|---|
| Type | Select the type of template.
|
| Tenant/Project Group | Select the tenant or project group to map. |
| Item | Description |
|---|---|
| Deployment Target | Select the deployment target supported by the template.
|
| Template Name | Enter the name of the App Template. |
| Application Classification | Select the classification of the application included in the template.
|
| Language | Select the development language of the source code included in the template. |
| Source Code | Select whether the template includes source code. |
| Source Code Repository Type | Select the location where the source code is stored. SCM or ZIP file selection is possible. |
| Repository URL | Enter the URL of the repository where the template source code is located.
|
| Repository Branch | Enter the branch of the repository where the template source code is located. |
| Individual Authentication | Enter authentication information to access the repository.
|
| Dockerfile Path | Enter the path to the Dockerfile in the repository.
|
| Code Quality | Select whether to use code quality. |
| Description | Write a description of the App Template. |
| Document URL | Enter the URL of the document that explains the template.
|
| Template Icon | Select an icon to use for the template. |
| Build Result Path | Specify the build result path and file name. |
| Dockerfile Type | Select the Dockerfile type.
|
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.
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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Basic Information tab.
- Basic Information tab, click the Modify button.
- Modify the necessary information and click the Save button.
Managing Pipeline Templates
Pipeline templates are settings for building pipelines that are automatically configured when a user creates a project using an App Template.
Adding Pipeline Templates
To add a pipeline template, follow these steps:
- App Template page, click the item you want to add. Move to the App Template Details page.
- App Template Details page, click the Pipeline Template tab.
- Pipeline Template tab, click the Add button. Move to the Add Pipeline Template page.
- Add Pipeline Template page, enter the necessary information and click the Save button.
| Item | Description |
|---|---|
| Template Name | Enter the name of the pipeline template. |
| Default Template |
|
| Supported Jenkins | Select the Jenkins that supports this pipeline template.
|
| Environment Variable | Enter environment variable information.
|
| Stage | Enter each stage information.
|
Jenkins environment variables, refer to the official website.Modifying Pipeline Templates
To modify a pipeline template, follow these steps:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Pipeline Template tab.
- Pipeline Template tab, click the item you want to modify. Move to the Pipeline Template Details page.
- Pipeline Template Details page, click the Modify button. Move to the Modify Pipeline Template page.
- Modify Pipeline Template page, modify the information and click the Save button.
Deleting Pipeline Templates
To delete a pipeline template, follow these steps:
- App Template page, click the item you want to delete. Move to the App Template Details page.
- App Template Details page, click the Pipeline Template tab.
- Pipeline Template tab, click the item you want to delete. Move to the Pipeline Template Details page.
- Pipeline Template Details page, click the Delete button.
- 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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Dockerfile Template tab.
- Dockerfile Template tab, click the Modify or Create button.
- Dockerfile Template tab, enter the contents and click the Save button.
| Item | Description |
|---|---|
| Authentication Information Setting | Register authentication information for the image used in the FROM clause of the multi-stage build. |
| Add | Add an image used in the FROM clause of the multi-stage build. |
| Multi-stage Dockerfile | Configure the multi-stage build based on the registered information. |
| Dockerfile | Configure the basic Dockerfile. |
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.
Managing Supported Tenants/Project Groups
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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Supported Tenants or Supported Information tab.
Adding Supported Tenants
To add supported tenants, follow these steps:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Supported Tenants tab.
- Supported Tenants tab, click the Add button. The Add Tenant popup will appear.
- 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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Supported Tenants tab.
- Supported Tenants tab, select the tenant to modify and select the Verification and Usage items to modify.
| Item | Description |
|---|---|
| Tenant | Information about the available tenant. |
| Verification | Select the verification.
|
| Usage | Select the usage.
|
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:
- 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.
- Support Information tab, click the Modify button. The App Template Modification screen appears.
- App Template Modification screen, select and modify the Verification and Usage items.
- Click the Save button.
| Item | Description |
|---|---|
| Project Group | Information about the available project group. |
| Verification | Select the verification.
|
| Usage | Select the usage.
|
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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Support Tenant tab.
- Support Tenant tab, click the Transfer Management Tenant button. The Transfer Management Tenant popup window opens.
- 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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Support Tenant tab.
- Support Tenant tab, select the tenant to delete and click the Delete button.
- Click the Confirm button in the confirmation popup window.
Managing Support Images
The Support Image registered by the user is used in the Dockerfile or Dockerfile template of the source code.
Adding Support Images
To add a support image, follow these steps:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Support Image tab.
- Support Image tab, click the Add button. The Add Support Image popup window opens.
- Add Support Image popup window, enter the information and click the Connection Test button.
- When the Save button is activated, click the Save button.
- Click the Confirm button in the confirmation popup window.
| Item | Description |
|---|---|
| Image Information Input | Enter the support image and authentication information. |
| Use Registrar’s Authentication Information | An option that can be selected when the selected image storage tool cannot grant permissions (e.g., SCR).
|
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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Support Image tab.
- Support Image tab, select the checkbox of the item to delete and click the Delete button.
- Click the Confirm button in the confirmation popup window.
Managing Support Helm Charts
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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Support Helm Chart tab.
- Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
- 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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Support Helm Chart tab.
- Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
- 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:
- App Template page, click the item you want to modify. Move to the App Template Details page.
- App Template Details page, click the Support Helm Chart tab.
- Support Helm Chart tab, click the Modify button. The App Template Modification screen appears.
- 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:
- App Template page, click the item you want to delete. Move to the App Template Details page.
- App Template Details page, click the Basic Information tab.
- Basic Information tab, click the Delete button.
- Click the Confirm button in the confirmation popup window.