App. Template
App. A template is a feature provided to help users quickly set up their development environment.
App. Templates consist of sample source code, a Dockerfile, a Helm chart, and so on. When creating a project, users You can quickly set up a development environment using templates.
Apps built with various frameworks such as Node.js, Python, and Spring Boot. It provides a template, and the user directly App. You can also create and register a template.
| App. Template Type | Description |
|---|---|
| System Template |
|
| Tenant Template |
|
| ProjectGroup Template |
|
App. # Getting Started with Templates
App. To begin template management, follow these steps.
- Click the Manage icon in the upper-right corner of the Main page. 1. Navigate to the Tenant Dashboard page.
- In the left menu, select **Tools & Templates > App. 2. Click the Templates menu. 2. **App. 2. Navigate to the Template page.
App. # Add a template
Users can have their own App. You can add a template.
Source Code
App. Source code used in the template to configure the sample project.
App. The tenant or project group where you register the template must have an available SCM repository. For instructions on registering an SCM Repository tool, refer to Add a tool.
Register the source code in the SCM repository in advance. App. When registering a template, the corresponding SCM Repository is displayed. Enter the pre-registered source code path.
Dockerfile
Dockerfile without registering it within the source code. For related information, see Manage Dockerfile Templates.For an explanation of and how to write a
Dockerfile, refer to the official site.App that supports deployment target projects in the form of Kubernetes and VM (Docker). To register a template**, you must either add a Dockerfile to the source code when registering the source code, or register a Dockerfile by using Manage Dockerfile Templates.
When writing a Dockerfile, the FROM instruction must be fixed as FROM ${BASE_IMAGE} when registering it.
When the registered ${BASE_IMAGE} value is used for a Kubernetes deployment target, it is substituted with the image.repository value in the Helm chart through the Velocity Template Engine. For a VM (Docker) deployment target, it is substituted with the image path registered in Manage Supported Images.
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"]App. ## Register a Template
App. To register a template, follow these steps.
- **App. 1. On the Templates page, click the Add button. 1. **App. 1. Navigate to the Add Template page.
- **App. 2. On the Add Template page, select the template support type and then click the Start button.
- Enter the required information and then click the Complete button.
Item Description Type Select a template type. - For descriptions by type, see App. Template Types.
Tenant/Project Group Select the tenant/project group to map. Table. App. Add Template - Select Template Support TypeItem Description Deployment target Select the deployment target supported by the template - Kubernetes: When the deployment target is a cluster using a Helm chart
- VM(Artifact): When the deployment target is a VM server using an Artifact file
- VM(Docker): When the deployment target is a VM server using a Docker image
- N/A: When there is no deployment target (e.g., Android)
Template Name Enter the name of the App. template. Application Classification Select the classification of the application included in the template - Used to classify the template.
Language Select the development language for the source code included in the template. Source code Select whether the template contains source code. Source Code Repository Type Select the location where the source code to be included in the template is stored. You can choose either SCM or a compressed file (ZIP). Repository URL Enter the repository URL where the template source code is located. - A list of SCM Repository tools available for the specified tenant and project group is displayed.
Repository Branch Enter the branch of the repository where the template source code is located. Individual authentication information Enter the authentication information for accessing the repository. - If you select Unused, the authentication information used when registering the tool is used.
Dockerfile path Enter the path to the Dockerfile in the repository. - Used when building the Docker image.
Code Quality Select whether to use code quality. Description Write a description for the App. template. Document URL Enter the URL of the document that describes the template. - This link will appear on the template selection page when creating a project.
Template icon Select the icon to use in the template. Build artifact path Specify the path and file name of the build output. Dockerfile Types Select a Dockerfile type - You can choose whether to use a Dockerfile file within the source code or the information registered in Manage Dockerfile Templates.
- If you select a GUI template, the Dockerfile Template tab is enabled.
Table. App. Add Template - Basic Information Input Items
App. The Supported Helm Chart step is added only when the template’s deployment target is Kubernetes.
- The corresponding app. - Select the Helm chart to use when deploying with a template.
- Select the checkboxes, then use the Add and Remove buttons in the center to select Helm charts from the list.
After completing Add a Pipeline Template, refer to Update Supported Tenant Information to modify the usage status.
App. # Edit Template Basic Information
App. To modify the basic information of a template, follow these steps.
- **App. 1. On the Template page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Basic Information tab.
- Click the Modify button on the Basic Information tab.
- After making the necessary changes, click the Save button.
Manage Pipeline Templates
The user uses App. This is the build pipeline configuration that is automatically set up when creating a project using a template.
Add a pipeline template
To add a pipeline template, follow these steps.
- **App. 1. On the Templates page, click the item you want to add. 1. App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Pipeline Templates tab.
- Click the Add button in the Pipeline Templates tab. 3. Navigate to the Add Pipeline Template page.
- On the Add Pipeline Template page, enter the required information and then click the Save button.
Item Description Template name Enter the name of the pipeline template. Base Template
(Base Template)- The default template is a template used to configure pipelines when creating a project.
- If no default template is registered, it is automatically set to ON, and this setting cannot be changed.
Supported Jenkins Select the Jenkinsthat supports the pipeline template.- The list of available CICD pipeline tools for the tenant and project group is displayed.
- Required to reference the necessary information in the Tools area when configuring stages.
Environment Variables Enter environment variable information - For details on environment variables, see Configure Environment Variables.
Stage Enter the information for each stage. - For details about stages, see Configure Stages.
Table. Additional input items for pipeline templates
Jenkins environment variable settings, refer to the official site.Modifying a Pipeline Template
To modify a pipeline template, follow these steps.
- **App. 1. On the Templates page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Pipeline Template tab.
- Click the item you want to modify in the Pipeline Template tab. 3. Navigates to the Pipeline Template Details page.
- On the Pipeline Template Details page, click the Edit button. 4. Navigate to the Edit Pipeline Template page.
- On the Edit Pipeline Template page, update the information and click the Save button.
Deleting a Pipeline Template
To delete a pipeline template, follow these steps.
- **App. 1. On the Templates page, click the item you want to delete. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Pipeline Templates tab.
- Click the item you want to delete in the Pipeline Template tab. 3. Navigates to the Pipeline Template Details page.
- On the Pipeline Template Details page, click the Delete button.
- Click the Confirm button in the confirmation popup.
Manage Dockerfile Templates
App. This tab is displayed only when the Dockerfile Type field in the Basic Information section of the template is set to GUI Template.
Modifying the Dockerfile template
To modify the Dockerfile template, follow these steps.
- **App. 1. On the Templates page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Dockerfile Template tab.
- Click the Modify or Create button in the Dockerfile Template tab.
- In the Dockerfile Template tab, enter the content and then click the Save button.
Item Description Configure Authentication Information Register the credentials for the image used in the FROM instruction of a multi-stage build. Add Add the image to be used in the FROM instruction of a multi-stage build. Multi-stage Dockerfile Configure the multi-stage setup based on the information registered in the authentication information and additional items. Dockerfile Set up the basic Dockerfile. Table. Input fields for modifying the Dockerfile template
You can also manage the Dockerfile within the source code without registering a Dockerfile template.
- When using a Dockerfile included in the source code, you must use App. - The Dockerfile Type field in the Basic Information section of the template must be set to File in Code Repository.
The FROM clause is automatically set to the image path registered in Manage Supported Images.
Manage Supported Tenants/Project Groups
The tab name varies depending on the template type.
- System Template/Tenant Template: Supported Tenants
- ProjectGroup Template: Support Information
The user is the corresponding App. You can manage the tenants or project groups where the template will be used.
To manage a supported tenant or project group, follow these steps.
- **App. 1. On the Template page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Tenants or Support Information tab.
Primary icon.Add a supported tenant
To add a supported tenant, follow these steps.
- **App. 1. On the Templates page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Tenants tab.
- Click the Add button on the Supported Tenants tab. 3. The Add Tenant popup window opens.
- In the Add Tenant popup, select the tenant to support and then click the Save button.
Edit Supported Tenant Information
To modify the information for a supported tenant, follow these steps.
- **App. 1. On the Template page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Tenants tab.
- In the Supported Tenants tab, select the Verified and Enabled fields for the tenant you want to modify, and then make the changes.
Item Description Tenant This is the available tenant information. Verification status Select verification status - Verifying
- Verification complete
Usage Select the usage status. - You can change the status to Enabled only if Validation Status is Validated.
Table. Supported tenant screen items
If Verification Status is Verifying, App. Only users who have registered a template can use it.
- Other users can use the app after verification and approval. - You can use templates.
Edit Supported Project Group Information
To modify the information for a supported project group, follow these steps.
- **App. 1. On the Template page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Support Information tab.
- Click the Edit button on the Support Information tab. 3. **App. 3. The Edit Template screen appears.
- **App. 4. On the Edit Template screen, select the Validation and Usage fields to make changes.
- Click the Save button.
Item Description Project Group This is the available project group information. Verification status Select verification status - Verifying
- Verification complete
Usage Select the usage status. - You can change the status to Enabled only if Validation Status is Validated.
Table. Support information screen items
If the verification status is in progress, App. Only users who have registered a template can use it.
- Other users can use the app after verification and approval. - You can use templates.
Migrate the management tenant
To transfer the management tenant, follow these steps.
- **App. 1. On the Template page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Tenants tab.
- Click the Transfer Managed Tenant button on the Supported Tenants tab. 3. The Manage Tenant Transfer popup window opens.
- In the Transfer Management Tenant dialog box, select the target tenant to transfer to, and then click Save.
Delete a supported tenant
To delete a supported tenant, follow these steps.
- **App. 1. On the Templates page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Tenants tab.
- Select the tenant you want to delete in the Supported Tenants tab, and then click the Delete button.
- Click the Confirm button in the confirmation popup.
Manage supported images
The supported images registered by the user are used in the FROM directive of the Dockerfile or Dockerfile template in the source code.
Add a supported image
To add a support image, follow these steps.
- **App. 1. On the Template page, click the item you want to modify. 1. App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Images tab.
- Click the Add button on the Supported Images tab. 3. The Add Supported Image popup window opens.
- In the Add Support Image popup, enter the information and then click the Connection Test button.
- When the Save button is enabled, click the Save button.
- Click the Confirm button in the confirmation popup.
Item Description Enter image information Enter the support image and authentication information. Use the registrant’s authentication information An option available when the selected image repository is a tool that cannot grant permissions (e.g., SCR). - If unchecked, when a supported image user creates a project, pull permissions for the image entered by the supported image user are added. If the tool cannot grant permissions, no permission granting is performed.
- If unchecked, when a supported image user creates a project, the credentials of the supported image registrant are used instead of the permissions of the supported image user.
Table. Additional input items for supported images
Considerations When Checking the Use of Registrant Authentication Information
- Because the registrant’s authentication information may be exposed to the user of the support image, use it only when necessary.
- Select this option only if the image repository provides image pull access only, to prevent issues during use. - You must enter an image repository dedicated exclusively to pulling. - (If checked, Pull and Push operations cannot be performed simultaneously on a single image repository.)
- The registrant’s authentication information is used in Project > Image Repository > Pull-only images. - The authentication information for the support image cannot be modified by support image users. If the registrant re-registers the authentication information in the support image, it is updated in bulk.
Delete a supported image
To delete a support image, follow these steps.
- **App. 1. On the Template page, click the item you want to modify. 1. App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Images tab.
- Select the checkbox for the item you want to delete on the Supported Images tab, and then click the Delete button.
- Click the Confirm button in the confirmation popup.
Manage supported Helm charts
For registering a supported Helm chart, see Add a Helm chart.
The supported Helm charts registered by the user are App. Used when creating a project using a template.
Add a Support Helm Chart
To add a support Helm chart, follow these steps.
- **App. 1. On the Template page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Helm Charts tab.
- Click the Edit button on the Supported Helm Charts tab. 3. **App. 3. The Edit Template screen appears.
- **App. 4. On the Edit Template screen, select the checkbox for the Helm chart you want to use in the Helm Chart List, add it to the Selected Helm Chart List by clicking the Add button, and then click the Save button.
Modifying the Support Helm Chart
To modify a supported Helm chart, follow these steps.
- **App. 1. On the Templates page, click the item you want to modify. 1. **App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Helm Charts tab.
- Click the Edit button on the Supported Helm Charts tab. 3. **App. 3. The Edit Template screen appears.
- **App. 4. On the Edit Template screen, select the checkbox for the Helm chart to use in the Helm Chart List, then modify the Selected Helm Chart List using the Add and Delete buttons, and click Save.
Delete a supported Helm chart
To delete a support Helm chart, follow these steps.
- **App. 1. On the Templates page, click the item you want to modify. 1. App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Supported Helm Charts tab.
- Click the Edit button on the Supported Helm Charts tab. 3. **App. 3. The Edit Template screen appears.
- **App. 4. On the Edit Template screen, select the checkbox for the Helm chart to delete from the Selected Helm Charts list, click the Delete button, and then click the Save button.
App. # Delete a template
App. To delete a template, follow these steps.
- **App. 1. On the Templates page, click the item you want to delete. 1. App. 1. Navigates to the Template Details page.
- **App. 2. On the Template Details page, click the Basic Information tab.
- Click the Delete button on the Basic Information tab.
- Click the Confirm button in the confirmation popup.