App.템플릿

App. 템플릿이란 사용자의 빠른 개발환경 구성을 위해 제공되는 기능입니다.

App. 템플릿은 샘플 소스코드, Dockerfile, 헬름차트 등으로 구성되어 있으며 사용자는 프로젝트 생성 시에 App. 템플릿을 이용하여 개발환경을 빠르게 구성할 수 있습니다.

Node.js, Python, Spring Boot 등 다양한 프레임워크의 App. 템플릿을 제공하고 있고, 사용자가 직접 App. 템플릿을 만들어 등록할 수도 있습니다.

App. 템플릿 시작하기

App. 템플릿 관리를 시작하려면 다음 절차를 따르세요.

1. 메인 페이지 오른쪽 위의 관리 아이콘을 클릭하세요. 테넌트 대시보드 페이지로 이동합니다.
2. 왼쪽 메뉴에서 툴 & 템플릿 > App. 템플릿 메뉴를 클릭하세요. App. 템플릿 페이지로 이동합니다.

App. 템플릿 추가하기

사용자는 자신만의 App. 템플릿을 추가할 수 있습니다.

소스코드

App. 템플릿에서 사용되어 샘플 프로젝트를 구성하게 될 소스코드입니다.

App. 템플릿을 등록할 테넌트 또는 프로젝트그룹에 사용 가능한 SCM Repository 가 있어야 합니다. SCM Repository 툴 등록 방법은 툴 추가하기를 참고하세요.

SCM Repository 에 소스코드를 미리 등록하세요. App. 템플릿 등록 시, 해당 SCM Repository 가 나타나며 미리 등록한 소스코드 경로를 입력하세요.

Dockerfile

Kubernetes, VM(Docker) 형태의 배포 타겟 프로젝트를 지원하는 App. 템플릿을 등록하려면, 소스코드 등록 시 소스코드 내부에 Dockerfile 파일을 추가하거나 도커파일 템플릿 관리하기를 통해 Dockerfile 파일을 등록해야 합니다.

Dockerfile 작성 시, FROM 절은 FROM ${BASE_IMAGE} 로 고정해서 등록해야 합니다.

등록된 ${BASE_IMAGE} 값은 Velocity Template Engine을 통해 Kubernetes 배포 타겟인 경우 헬름차트의 image.repository 값으로 치환되고, VM(Docker) 배포 타겟인 경우 지원 이미지 관리하기에서 등록한 이미지 경로로 치환됩니다.

Dockerfile 파일 샘플

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. 템플릿 등록하기

App. 템플릿을 등록하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 추가 버튼을 클릭하세요. App. 템플릿 추가 페이지로 이동합니다.
2. App. 템플릿 추가 페이지에서 템플릿 지원 타입을 선택 후 시작 버튼을 클릭하세요.
3. 필요한 정보를 입력한 후 완료 버튼을 클릭하세요.

   항목	설명
   유형	템플릿의 유형을 선택하세요. 유형별 설명은 App. 템플릿 유형을 참고하세요.
   테넌트/프로젝트그룹	맵핑할 테넌트/프로젝트그룹을 선택하세요.

   표. App. 템플릿 추가 - 템플릿 지원 타입 선택 항목

   항목	설명
   배포 타겟	템플릿이 지원하는 배포 타겟을 선택 Kubernetes: 배포 타겟이 헬름차트를 이용한 클러스터인 경우 VM(Artifact): 배포 타겟이 Artifact 파일을 이용한 VM서버인 경우 VM(Docker): 배포 타겟이 도커 이미지를 이용한 VM서버인 경우 N/A: 배포 타겟이 없는 경우 (ex. Android)
   템플릿명	App. 템플릿의 이름을 입력하세요.
   애플리케이션 분류	템플릿에 포함된 애플리케이션의 분류를 선택 템플릿을 분류하는데 사용됩니다.
   언어	템플릿에 포함된 소스코드의 개발언어를 선택하세요.
   소스코드	템플릿에 소스코드가 포함되어있는지 여부를 선택하세요.
   소스코드 저장소 유형	템플릿에 포함할 소스코드가 저장된 위치를 선택하세요. SCM 또는 압축파일(ZIP) 선택이 가능합니다.
   리파지토리 URL	템플릿 소스코드가 위치한 리파지토리 URL을 입력 해당 테넌트, 프로젝트그룹에서 사용 가능한 SCM Repository 툴 목록이 나타납니다.
   리파지토리 브랜치	템플릿 소스코드가 위치한 리파지토리의 브랜치를 입력하세요.
   개별 인증정보	리파지토리에 접근하기위한 인증정보를 입력 미사용을 선택할 경우, 해당 툴 등록 시 사용된 인증정보를 사용합니다.
   도커파일 경로	리파지토리 내의 도커파일 파일 경로를 입력 도커 이미지 빌드 시 사용합니다.
   코드품질	코드품질 사용 여부를 선택하세요.
   설명	App. 템플릿에 대한 설명을 작성하세요.
   문서 URL	템플릿을 설명하는 문서의 URL을 입력 프로젝트 생성 시 템플릿 선택 페이지에서 링크로 나타나게 됩니다.
   템플릿 아이콘	템플릿에서 사용할 아이콘을 선택하세요.
   빌드 결과물 경로	빌드 결과물 경로 및 파일명을 지정하세요.
   도커파일 유형	Dockerfile 유형을 선택 소소코드 내 Dockerfile 파일을 사용할지, 도커파일 템플릿 관리하기에 등록한 정보를 사용할지 선택할 수 있습니다. GUI 템플릿을 선택할 경우, 도커파일 템플릿 탭이 활성화 됩니다.

   표. App. 템플릿 추가 - 기본정보 입력 항목

App. 템플릿 기본정보 수정하기

App. 템플릿 기본정보를 수정하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 기본정보 탭을 클릭하세요.
3. 기본정보 탭에서 수정 버튼을 클릭하세요.
4. 필요한 정보를 수정한 후 저장 버튼를 클릭하세요.

파이프라인 템플릿 관리하기

사용자가 App. 템플릿을 이용하여 프로젝트 생성 시, 자동 구성되는 빌드 파이프라인 설정입니다.

파이프라인 템플릿 추가하기

파이프라인 템플릿을 추가하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 추가하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 파이프라인 템플릿 탭을 클릭하세요.
3. 파이프라인 템플릿 탭에서 추가 버튼을 클릭하세요. 파이프라인 템플릿 추가 페이지로 이동합니다.
4. 파이프라인 템플릿 추가 페이지에서 필요한 정보를 입력한 후 저장 버튼을 클릭하세요.

   항목	설명
   템플릿 이름	파이프라인 템플릿의 이름을 입력하세요.
   기본 템플릿 (Base Template)	기본 템플릿은 프로젝트 생성시, 파이프라인 구성을 위해 사용되는 템플릿입니다. 기본 템플릿이 등록되어 있지 않다면 자동으로 ON 으로 설정되며, 해당 설정을 변경할 수는 없습니다.
   지원 Jenkins	해당 파이프라인 템플릿을 지원할 Jenkins를 선택 해당 테넌트, 프로젝트그룹에서 사용가능한 CICD pipeline 툴 목록이 나타납니다. 스테이지 구성시, Tools 영역에 필요한 정보를 참고하기위해 필요합니다.
   환경변수	환경변수 정보를 입력 환경변수에 대한 자세한 사항은 환경변수 설정하기를 참고하세요.
   스테이지	각 스테이지 정보를 입력 스테이지에 대한 자세한 사항은 스테이지 설정하기를 참고하세요.

   표. 파이프라인 템플릿 추가 입력 항목

파이프라인 템플릿 수정하기

파이프라인 템플릿을 수정하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 파이프라인 템플릿 탭을 클릭하세요.
3. 파이프라인 템플릿 탭에서 수정하려고 하는 항목을 클릭하세요. 파이프라인 템플릿 상세 페이지로 이동합니다.
4. 파이프라인 템플릿 상세 페이지에서 수정 버튼을 클릭하세요. 파이프라인 템플릿 수정 페이지로 이동합니다.
5. 파이프라인 템플릿 수정 페이지에서 정보 수정 후 저장 버튼을 클릭하세요.

파이프라인 템플릿 삭제하기

파이프라인 템플릿을 삭제하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 삭제하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 파이프라인 템플릿 탭을 클릭하세요.
3. 파이프라인 템플릿 탭에서 삭제하려고 하는 항목을 클릭하세요. 파이프라인 템플릿 상세 페이지로 이동합니다.
4. 파이프라인 템플릿 상세 페이지에서 삭제 버튼을 클릭하세요.
5. 확인 팝업창에서 확인 버튼을 클릭하세요.

도커파일 템플릿 관리하기

App. 템플릿의 기본정보 내용 중 도커파일 유형 항목이 GUI 템플릿인 경우만 해당 탭이 나타납니다.

도커파일 템플릿 수정하기

도커파일 템플릿을 수정하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 도커파일 템플릿 탭을 클릭하세요.
3. 도커파일 템플릿 탭에서 수정 또는 생성 버튼을 클릭하세요.
4. 도커파일 템플릿 탭에서 내용 입력 후 저장 버튼을 클릭하세요.

   항목	설명
   인증정보 설정	Multi-stage 빌드의 FROM 절에 사용될 이미지의 인증정보를 등록하세요.
   추가	Multi-stage 빌드의 FROM 절에 사용될 이미지를 추가하세요.
   Multi-stage Dockerfile	인증정보 및 추가 항목에서 등록한 정보를 바탕으로 Multi-stage 를 구성하세요.
   Dockerfile	기본 Dockerfile 을 구성하세요.

   표. 도커파일 템플릿 수정 입력 항목

FROM 절은 지원 이미지 관리하기에서 등록한 이미지 경로로 자동 설정됩니다.

지원 테넌트/프로젝트그룹 관리하기

사용자는 해당 App. 템플릿이 사용될 테넌트 또는 프로젝트그룹을 관리할 수 있습니다.

지원 테넌트 또는 프로젝트그룹을 관리하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 테넌트 또는 지원 정보 탭을 클릭하세요.

지원 테넌트 추가하기

지원 테넌트를 추가하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 테넌트 탭을 클릭하세요.
3. 지원 테넌트 탭에서 추가 버튼을 클릭하세요. 테넌트 추가 팝업창이 열립니다.
4. 테넌트 추가 팝업창에서 지원할 테넌트를 선택한 후, 저장 버튼을 클릭하세요.

지원 테넌트 정보 수정하기

지원 테넌트의 정보를 수정하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 테넌트 탭을 클릭하세요.
3. 지원 테넌트 탭에서 변경할 테넌트의 검증 여부, 사용 여부 항목을 선택하여 수정하세요.

   항목	설명
   테넌트	사용가능한 테넌트 정보입니다.
   검증 여부	검증 여부를 선택 검증중 검증완료
   사용 여부	사용 여부를 선택 검증 여부가 검증완료인 경우만 사용으로 변경이 가능합니다.

   표. 지원 테넌트 화면 항목

지원 프로젝트그룹 정보 수정하기

지원 프로젝트그룹의 정보를 수정하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 정보 탭을 클릭하세요.
3. 지원 정보 탭에서 수정 버튼을 클릭하세요. App. 템플릿 수정 화면이 나타납니다.
4. App. 템플릿 수정 화면에서 검증 여부, 사용 여부 항목을 선택하여 수정하세요.
5. 저장 버튼을 클릭하세요.

   항목	설명
   프로젝트그룹	사용가능한 프로젝트그룹 정보입니다.
   검증 여부	검증 여부를 선택 검증중 검증완료
   사용 여부	사용 여부를 선택 검증 여부가 검증완료인 경우만 사용으로 변경이 가능합니다.

   표. 지원 정보 화면 항목

관리 테넌트 이관하기

관리 테넌트를 이관하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 테넌트 탭을 클릭하세요.
3. 지원 테넌트 탭에서 관리 테넌트 이관 버튼을 클릭하세요. 관리 테넌트 이관 팝업창이 열립니다.
4. 관리 테넌트 이관 팝업창에서 이관 대상 테넌트를 선택한 후, 저장 버튼을 클릭하세요.

지원 테넌트 삭제하기

지원 테넌트를 삭제하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 테넌트 탭을 클릭하세요.
3. 지원 테넌트 탭에서 삭제하려는 테넌트를 선택 후 삭제 버튼을 클릭하세요.
4. 확인 팝업창에서 확인 버튼을 클릭하세요.

지원 이미지 관리하기

사용자가 등록한 지원 이미지는 소스코드의 Dockerfile 이나 도커파일 템플릿에서 등록한 FROM 절에 사용이 됩니다.

지원 이미지 추가하기

지원 이미지를 추가하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 이미지 탭을 클릭하세요.
3. 지원 이미지 탭에서 추가 버튼을 클릭하세요. 지원 이미지 추가 팝업창이 열립니다.
4. 지원 이미지 추가 팝업창에서 정보를 입력한 후 Connection Test 버튼을 클릭하세요.
5. 저장 버튼이 활성화되면 저장 버튼을 클릭하세요.
6. 확인 팝업창에서 확인 버튼을 클릭하세요.

   항목	설명
   이미지 정보 입력	지원 이미지와 인증정보를 입력하세요.
   등록자의 인증정보 사용	선택한 이미지 저장소가 권한을 부여할 수 없는 툴인 경우(ex. SCR) 선택할 수 있는 옵션입니다. 체크를 하지 않는 경우 지원이미지 사용자가 프로젝트를 생성할 때, 지원이미지 사용자에게 입력한 이미지의 Pull 권한을 추가합니다. 권한 부여를 할수 없는 툴인 경우 권한 부여를 수행하지 않습니다. 체크를 하지 않는 경우 지원이미지 사용자가 프로젝트를 생성할 때, 지원이미지 사용자의 권한 대신 지원이미지 등록자의 인증정보를 사용합니다.

   표. 지원 이미지 추가 입력 항목

지원 이미지 삭제하기

지원 이미지를 삭제하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 이미지 탭을 클릭하세요.
3. 지원 이미지 탭에서 삭제할 항목의 체크박스를 선택하고 삭제 버튼을 클릭합니다.
4. 확인 팝업창에서 확인 버튼을 클릭하세요.

지원 헬름차트 관리하기

사용자가 등록한 지원 헬름차트는 App. 템플릿을 이용하여 프로젝트 생성 시 사용됩니다.

지원 헬름차트 추가하기

지원 헬름차트를 추가하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 헬름차트 탭을 클릭하세요.
3. 지원 헬름차트 탭에서 수정 버튼을 클릭하세요. App. 템플릿 수정 화면이 나타납니다.
4. App. 템플릿 수정 화면의 헬름차트 목록에서 사용할 헬름차트의 체크박스를 선택한 후 추가 버튼을 통해 선택된 헬름차트 목록에 추가하고 저장 버튼을 클릭하세요.

지원 헬름차트 수정하기

지원 헬름차트를 수정하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 헬름차트 탭을 클릭하세요.
3. 지원 헬름차트 탭에서 수정 버튼을 클릭하세요. App. 템플릿 수정 화면이 나타납니다.
4. App. 템플릿 수정 화면의 헬름차트 목록에서 사용할 헬름차트의 체크박스를 선택한 후 추가, 삭제 버튼을 통해 선택된 헬름차트 목록을 수정하고 저장 버튼을 클릭하세요.

지원 헬름차트 삭제하기

지원 헬름차트를 삭제하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 수정하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 지원 헬름차트 탭을 클릭하세요.
3. 지원 헬름차트 탭에서 수정 버튼을 클릭하세요. App. 템플릿 수정 화면이 나타납니다.
4. App. 템플릿 수정 화면의 선택된 헬름차트 목록에서 삭제할 헬름차트의 체크박스를 선택한 후 삭제 버튼을 통해 삭제하고 저장 버튼을 클릭하세요.

App. 템플릿 삭제하기

App. 템플릿을 삭제하려면 다음 절차를 따르세요.

1. App. 템플릿 페이지에서 삭제하려고 하는 항목을 클릭하세요. App. 템플릿 상세 페이지로 이동합니다.
2. App. 템플릿 상세 페이지에서 기본정보 탭을 클릭하세요.
3. 기본정보 탭에서 삭제 버튼을 클릭하세요.
4. 확인 팝업창에서 확인 버튼을 클릭하세요.