App Template

App. A template is a feature provided to enable users to quickly set up a development environment.

The App. template consists of sample source code, Dockerfile, Helm chart, etc., and users can quickly set up a development environment using the App. template when creating a project.

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

App. Getting Started with Template

App. To start template management, follow the steps below.

1. Click the Admin icon at the top right of the Main page. You will be taken to the Tenant Dashboard page.
2. From the left menu, click the Tools & Templates > App. Templates menu. You will be taken to the App. Templates page.

App. Add Template

Users can add their own App templates.

Source code

App. This is the source code that will be used in the template to build a sample project.

App. A usable SCM Repository must exist in the tenant or project group where the template will be registered. For instructions on registering an SCM Repository tool, see Add Tool.

Register the source code in the SCM Repository in advance. When registering an App template, the corresponding SCM Repository appears, and you should enter the path of the pre-registered source code.

Dockerfile

To register an App. Template that supports deployment target projects in the form of Kubernetes or VM (Docker), you must either add a Dockerfile to the source code when registering the source code or register a Dockerfile through 도커파일 템플릿 관리하기.

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

The registered ${BASE_IMAGE} value is substituted via the Velocity Template Engine as the image.repository value in the Helm chart when the deployment target is Kubernetes, and as the image path registered in Managing Supported Images when the deployment target is VM (Docker).

Dockerfile file 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 Template

App. To register a template, follow these steps.

1. Click the Add button on the App. Template page. You will be taken to the App. Template Add page.
2. App. Add Template On the page, select the template support type and click the Start button.
3. After entering the required information, click the Complete button.

   Item	Explanation
   type	Select the template type. Refer to App. Template Type for type-specific descriptions.
   Tenant/Project Group	Select the tenant/project group to map.

   Table. App. Add Template - Template Supported Type Selection Item

   Item	Explanation
   Deployment target	Select 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 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 (ex. Android)
   Template name	App. Enter the name of the template.
   Application classification	Select the category of the application included in the template Used to classify the template.
   language	Select the programming 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 to be included in the template is stored. You can choose SCM or a compressed file (ZIP).
   Repository URL	Enter the repository URL where the template source code is located The list of SCM Repository tool available in the tenant and project group will be displayed.
   Repository branch	Enter the branch of the repository where the template source code is located.
   Individual authentication information	Enter the credentials to access the repository If you select ‘Do not use’, the credentials used when registering the tool will be used.
   Dockerfile path	Enter the Dockerfile path within the repository Used when building the Docker image.
   code quality	Select whether to use code quality.
   Explanation	App. Write a description for the template.
   Document URL	Enter the URL of the document that describes the template It will appear as a link on the template selection page when creating a project.
   Template icon	Select the icon to use in the template.
   Build output path	Specify the build output path and filename.
   Dockerfile type	Select Dockerfile type You can choose whether to use the Dockerfile file within SosoCode, or to use the information registered in Manage Dockerfile Templates. When you select the GUI template, the Dockerfile Template tab becomes active.

   Table. App. Add Template - Basic Information Input Items

App. Edit template basic information

App. To modify the template’s basic information, follow these steps.

1. On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
2. Click the Basic Information tab on the App. Template Details page.
3. Click the Edit button in the Basic Information tab.
4. After editing the required information, click the Save button.

Manage pipeline templates

This is the build pipeline configuration that is automatically set up when a user creates a project using the App template.

Add pipeline template

To add a pipeline template, follow these steps.

1. On the App. Template page, click the item you want to add. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Pipeline Template tab.
3. Click the Add button on the Pipeline Template tab. You will be taken to the Add Pipeline Template page.
4. On the Add Pipeline Template page, enter the required information and click the Save button.

   Item	Explanation
   Template name	Enter the name of the pipeline template.
   Base Template (Base Template)	The default template is used for pipeline configuration when creating a project. If a default template is not registered, it is automatically set to ON, and this setting cannot be changed.
   Support Jenkins	Select the Jenkins that will support this pipeline template A list of CICD pipeline tools available in the tenant and project group is displayed. It is required to refer to the necessary information in the Tools area when configuring stages.
   environment variable	Enter environment variable information For detailed information about environment variables, refer to Configure environment variables.
   Stage	Enter information for each stage For detailed information about stages, refer to Setting up stages.

   Table. Pipeline Template Additional Input Items

Edit pipeline template

To modify the pipeline template, follow these steps.

1. On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Pipeline Template tab.
3. Click the item you want to edit in the Pipeline Template tab. You will be taken to the Pipeline Template Details page.
4. On the Pipeline Template Details page, click the Edit button. You will be taken to the Pipeline Template Edit page.
5. On the Pipeline Template Edit page, after modifying the information, click the Save button.

Delete pipeline template

To delete a pipeline template, follow these steps.

1. Click the item you want to delete on the App. Template page. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Pipeline Template tab.
3. Click the item you want to delete in the Pipeline Template tab. You will be taken to the Pipeline Template Details page.
4. On the Pipeline Template Details page, click the Delete button.
5. Click the Confirm button in the confirmation popup.

Managing Dockerfile Templates

App. In the Basic Information section of the template, the tab appears only when the Dockerfile Type item is GUI Template.

Modify Dockerfile template

Follow these steps to modify the Dockerfile template.

1. On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Dockerfile Template tab.
3. Click the Edit or Create button in the Dockerfile Template tab.
4. After entering the content in the Dockerfile Template tab, click the Save button.

   Item	Explanation
   Authentication Settings	Register the authentication information for the image to be used in the FROM clause of a multi-stage build.
   Add	Add the image to be used in the FROM clause of the multi-stage build.
   Multi-stage Dockerfile	Configure the Multi-stage based on the credentials and additional items you registered.
   Dockerfile	Create a basic Dockerfile.

   Table. Dockerfile Template Modification Input Items

The FROM clause is automatically set to the image path registered in 지원 이미지 관리하기.

Manage supported tenants/project groups

The user can manage the tenant or project group where the App template will be used.

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

1. Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Supported Tenant or Supported Information tab.

Add supported tenant

To add a supported tenant, follow these steps.

1. Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Supported Tenants tab.
3. Click the Add button on the Supported Tenant tab. The Add Tenant popup window opens.
4. Add Tenant In the popup window, select the tenant you want to support, then click the Save button.

Edit supported tenant information

To modify the information of the supported tenant, follow these steps.

1. Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Supported Tenants tab.
3. In the Supported Tenant tab, select the verification status and usage status items for the tenant you want to change, and edit them.

   Item	Explanation
   Tenant	Available tenant information.
   Verification status	Select verification status Verifying Verification complete
   Whether to use	Select usage status It can be changed to Use only when Verification status is Verified.

   Table. Supported Tenant Screen Items

Edit supported project group information

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

1. Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Support Information tab.
3. Click the Edit button in the Support Information tab. The App. Template Edit screen appears.
4. On the App. Template Edit screen, select the verification status and usage status items to edit them.
5. Click the Save button.

   Item	Explanation
   Project Group	Available project group information.
   Verification status	Select verification status Verifying Verification complete
   Whether to use	Select usage Verification status can be changed to Use only when it is Verification completed.

   Table. Support Information Screen Items

Transfer Management Tenant

To transfer the management tenant, follow these steps.

1. Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Supported Tenants tab.
3. On the Support Tenant tab, click the Transfer Management Tenant button. The Transfer Management Tenant popup window opens.
4. Management Tenant Transfer In the popup window, after selecting the target tenant for transfer, click the Save button.

Delete supported tenant

To delete a supported tenant, follow these steps.

1. Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Supported Tenants tab.
3. In the Supported Tenant tab, select the tenant you want to delete and click the Delete button.
4. In the confirmation popup, click the Confirm button.

Manage supported images

The supported image registered by the user is used in the FROM clause registered in the source code’s Dockerfile or Dockerfile template.

Add supported image

To add a supported image, follow the steps below.

1. On the App. Template page, click the item you want to edit. You will be taken to the App. Template Detail page.
2. On the App. Template Details page, click the Supported Image tab.
3. In the Supported Image tab, click the Add button. The Add Supported Image popup window opens.
4. Add supported image After entering the information in the popup window, click the Connection Test button.
5. Save button is enabled, click the Save button.
6. In the confirmation popup, click the Confirm button.

   Item	Explanation
   Enter image information	Enter the supported image and authentication information.
   Use the registrant’s authentication information	This is an option that can be selected when the chosen image registry is a tool that cannot grant permissions (e.g., SCR). If not checked, when a supported image user creates a project, the Pull permission for the image entered by the supported image user is added. If the tool cannot grant permissions, no permission granting is performed. If not checked, when a supported image user creates a project, the authentication credentials of the supported image registrant are used instead of the supported image user’s permissions.

   Table. Additional Input Fields for Supported Image

Delete supported image

To delete the support image, follow these steps.

1. On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Supported Image tab.
3. In the Supported Images tab, select the checkbox of the item to delete and click the Delete button.
4. In the confirmation popup, click the Confirm button.

Manage supported Helm charts

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

Add support for Helm chart

To add a supported Helm chart, follow these steps.

1. Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
2. App. Template Details on the page, click the Supported Helm Chart tab.
3. In the Supported Helm Chart tab, click the Edit button. The App. Template Edit screen appears.
4. App. Template Modification On the screen’s Helm Chart List, select the checkbox of the Helm chart to be used, then add it to the Selected Helm Chart List using the Add button, and click the Save button.

Modify the supported Helm chart

To modify the supported Helm chart, follow these steps.

1. On the App. Template page, click the item you want to edit. You will be taken to the App. Template Details page.
2. Click the Supported Helm Chart tab on the App. Template Details page.
3. Click the Edit button in the Supported Helm Chart tab. The App. Template Edit screen appears.
4. On the App. Template Edit screen’s Helm Chart List, select the checkboxes of the Helm charts to use, then modify the Selected Helm Chart List using the Add and Delete buttons, and click the Save button.

Delete supported Helm chart

To delete the support Helm chart, follow these steps.

1. Click the item you want to edit on the App. Template page. You will be taken to the App. Template Details page.
2. On the App. Template Details page, click the Supported Helm Chart tab.
3. Click the Edit button in the Supported Helm Chart tab. The App. Template Edit screen appears.
4. App. Template Edit on the Selected Helm Chart List screen, select the checkbox of the Helm chart to delete, then delete it using the Delete button and click the Save button.

App. Delete Template

App. To delete the template, follow these steps.

1. Click the item you want to delete on the App. Template page. Navigate to the App. Template Details page.
2. On the App. Template Details page, click the Basic Information tab.
3. Click the Delete button on the Basic Information tab.
4. In the confirmation popup, click the Confirm button.