Tutorial (프로젝트생성부터 빌드/배포까지)

사용자는 다음 절차를 통해 DevOps Console 프로젝트를 생성하고 소스를 빌드하여 이미지를 만들고 Kubernetes 클러스터에 헬름차트를 배포 할 수 있습니다.

프로젝트그룹 생성하기

사용자는 프로젝트그룹을 생성할 수 있습니다. 사용자는 프로젝트그룹을 생성할 테넌트에 가입되어 있어야 합니다.

프로젝트그룹 생성하기

프로젝트그룹을 생성하려면 다음 절차를 따르세요.

1. 메인 페이지에서 프로젝트그룹 생성하며 시작하기 버튼 또는 프로젝트그룹 생성 버튼을 클릭하세요. 프로젝트그룹 생성 팝업창이 열립니다.
2. 항목을 입력 후 저장 버튼을 클릭하여 프로젝트그룹 생성을 완료하세요.

테넌트 가입하기

테넌트에 가입하려면 다음 절차를 따르세요.

1. 프로젝트그룹 생성 팝업창에서 테넌트 가입 바로가기 링크를 클릭하세요. 테넌트 가입 요청 팝업창이 열립니다.
2. 테넌트 검색 항목에 가입할 테넌트 코드를 정확하게 입력하고 검색 아이콘을 클릭하세요. 테넌트 정보가 조회됩니다.
3. 검색된 테넌트가 맞는지 확인하고 요청사유를 입력 후 추가 버튼을 클릭하세요. 하단 목록에 추가됩니다.
4. 하단 목록에 추가한 테넌트에 대한 권한을 선택한 후 저장 버튼을 클릭하세요.

(헬름차트 배포)프로젝트 생성하기

사용자는 App.템플릿, 헬름차트, 툴 관리을 이용하여, 특정 Kubernetes 클러스터에 애플리케이션을 배포하는 프로젝트를 만들 수 있습니다.

프로젝트 생성 시작하기

프로젝트 생성을 시작하려면 다음 절차를 따르세요.

1. 메인 페이지에서 프로젝트 생성 버튼을 클릭하세요. 프로젝트 생성 페이지가 열립니다.

기본 정보 입력하기

프로젝트의 기본 정보를 입력합니다. 프로젝트명, 프로젝트 ID는 중복될 수 없고 유일해야 합니다.

기본정보를 입력하려면 다음 절차를 따르세요.

1. 프로젝트 생성 페이지에서 프로젝트 구성 방법 항목의 App. 템플릿 활용을 선택하세요.
2. 배포 타겟 항목은 Kubernetes를 선택하세요.
3. 추가 내용 입력 후 시작 버튼을 클릭하세요.

   항목	설명
   프로젝트명	프로젝트명을 입력하세요.
   프로젝트 ID	프로젝트 ID를 입력하세요.
   프로젝트 구성 방법	프로젝트 구성 방법을 선택 App. 템플릿 활용: 미리 제공되는 App. 템플릿을 선택합니다. 직접 구성: App. 템플릿 없이 직접 구성합니다.
   배포 타겟	배포 타겟을 선택 Kubernetes: 애플리케이션을 Kubernetes 클러스터에 배포합니다. Kubernetes(ArgoCD): ArgoCD를 사용하여 애플리케이션을 Kubernetes 클러스터에 배포합니다. VM(Artifact): 애플리케이션을 VM서버에 배포합니다. VM(Docker): 애플리케이션을 Docker 이미지로 만들어 VM서버에 배포합니다. N/A: 빌드 결과를 배포하지 않는 경우 선택합니다.
   K8S 클러스터	배포할 대상 클러스터를 선택 DevOps Console K8S 클러스터의 클러스터 중 사용자가 접근권한을 가진 클러스터만 선택할 수 있습니다.
   네임스페이스	배포할 대상 네임스페이스를 선택 K8S 클러스터에서 조회된 클러스터 중 사용자가 접근 권한을 가진 네임스페이스만 선택할 수 있습니다.

   표. 프로젝트 생성 기본 정보 입력 항목

애플리케이션 템플릿 선택하기

사용자는 프로젝트를 구성할 애플리케이션 템플릿을 선택할 수 있습니다.

샘플 소스코드가 포함된 애플리케이션 템플릿을 기반으로 프로젝트를 생성하면, 배포될 애플리케이션을 확인할 수 있습니다.

반면 Environment Only로 표기된 템플릿을 이용하면 샘플 소스코드 없이 빌드/배포 환경만 구성합니다.

이미 구성된 소스코드 저장소를 사용하여 프로젝트를 구성할 경우 Environment Only로 표시된 템플릿을 선택하세요.

애플리케이션 템플릿 선택하기를 시작하려면 다음 절차를 따르세요.

1. 애플리케이션 템플릿 화면에서 템플릿 명을 입력하여 선택하려는 애플리케이션 템플릿 카드를 선택 후 클릭하세요.
2. 다음 버튼이 활성화되면 다음 버튼을 클릭하세요.

   항목	설명
   필터	미리 정의된 필터를 통해 애플리케이션 템플릿을 쉽게 찾을 수 있습니다.
   검색	검색을 통해 애플리케이션 템플릿을 쉽게 찾을 수 있습니다.

   표. 프로젝트 생성 애플리케이션 템플릿 항목

코드 저장소 설정하기

사용자는 코드저장소 설정 단계를 통해 소스코드를 관리할 저장소를 설정할 수 있습니다.

신규 저장소 생성과 기존 저장소 사용 활성화 조건은 애플리케이션 템플릿과 툴에 따라서 다르게 나타납니다.

저장된 인증정보를 수정/삭제하려면 인증정보 관리하기를 참고하세요.

코드 저장소를 설정하려면 다음 절차를 따르세요.

1. 코드 저장소 항목에서 코드 저장소 유형을 선택하세요.
2. 신규 저장소 생성 또는 기존 저장소 사용을 선택 후 정보를 입력하세요.
3. 인증정보를 입력 후 Connection Test 버튼을 클릭하세요.
4. 다음 버튼이 활성화되면 다음 버튼을 클릭하세요.

   항목	설명
   저장소 유형	사용할 코드 저장소를 선택 등록 툴: 사용자가 사용 가능한 SCM Repository 툴의 유형(Github, Gitlab 등)들을 선택하고 사용할 수 있습니다. 미등록 툴: 등록되지 않은 툴의 도메인을 입력하여 사용할 수 있습니다. 미등록 툴 항목은 소스코드가 미포함된(Environment Only) App. 템플릿일때만 나타납니다.
   신규/기존 사용 여부	신규 저장소 생성 또는 기존 저장소 사용 여부를 선택하세요. 특정 조건에 따라 활성화 여부가 달라집니다. 자세한 내용은 표. 신규 저장소 생성과 기존 저장소 사용 활성화 조건를 참고하세요.
   저장소 정보	저장소 정보를 입력 신규 저장소 생성 시 프로젝트그룹명/프로젝트명으로 URL이 구성됩니다.
   인증 정보	인증정보를 입력 만약 계정이 없다면, 계정이 없으신가요? 링크를 클릭하여 열리는 계정 생성 정보 팝업창에서 계정을 생성할 수 있습니다. 신규로 계정을 생성한 후에는 반드시 초기 비밀번호 설정 링크를 통해 비밀번호를 변경하세요.
   (미등록 툴) 저장소 정보	저장소 정보를 입력 DevOps Console의 툴로 등록되지 않은 코드 저장소를 사용할 수 있습니다. URL Check 버튼을 클릭하여 검증 과정을 추가로 거쳐야 합니다.

   표. 프로젝트 생성 코드 저장소 설정 항목

코드 품질 설정하기

사용자는 품질 관리를 위한 저장소를 구성할 수 있습니다.

코드 품질을 설정하려면 다음 절차를 따르세요.

1. 코드 품질 항목에서 저장소 유형을 선택하세요.
2. 기본정보와 인증정보를 입력 후 Connection Test 버튼을 클릭하세요.
3. 다음 버튼이 활성화되면 다음 버튼을 클릭하세요.

   항목	설명
   저장소 유형	사용할 저장소를 선택 사용자가 사용 가능한 Code Quality 툴의 유형들이 나타납니다.
   신규/기존/미사용 여부	저장소 생성 방식을 선택 신규 저장소 생성을 선택할 경우, 품질 프로젝트명/품질 프로젝트 Key를 입력해야 합니다. 미생성을 선택할 경우 바로 다음 단계로 진행할 수 있습니다.
   Base URL	SonarQube URL을 선택하세요.
   품질 프로젝트명	SonarQube의 프로젝트의 이름을 입력하세요.
   품질 프로젝트 Key	SonarQube의 프로젝트의 Key를 입력하세요.
   인증정보	인증정보를 입력 새로운 사용자 생성하거나 기존 인증정보를 사용할 수 있습니다.

   표. 프로젝트 생성 코드 품질 설정 항목

이미지 저장소 설정하기

사용자는 이미지 저장소 설정단계를 통해 빌드된 컨테이너 이미지를 저장할 저장소를 설정할 수 있습니다.

저장된 인증정보를 수정/삭제하려면 인증정보 관리하기를 참고하세요.

이미지 저장소를 설정하려면 다음 절차를 따르세요.

1. 이미지 저장소 항목에서 저장소 유형을 선택하세요.
2. 신규 저장소 생성/기존 저장소 사용 선택 후 정보를 입력하세요.
3. 인증정보를 입력 후 Connection Test 버튼을 클릭하세요.
4. 다음 버튼이 활성화되면 다음 버튼을 클릭하세요.

   항목	설명
   저장소 유형	사용할 저장소 유형을 선택 사용자가 사용가능한 Image Registry 툴의 유형들이 나타납니다.
   저장소 정보	저장소 생성 방식을 선택하세요. 신규 저장소 생성 시 프로젝트그룹명/프로젝트명으로 URL이 구성됩니다.
   인증 정보	인증정보를 입력하세요.

   표. 프로젝트 생성 이미지 저장소 설정 항목

배포대상 환경 설정하기

사용자는 헬름차트를 통해 직접 구성을 통해 배포를 할 수 있습니다.

헬름릴리스명과 헬름차트 선택 시 헬름차트 설치 항목과 차트에 포함된 기본 Values.yaml 항목이 나타납니다.

사용가능한 헬름차트는 App. 템플릿과 연계되어 있습니다. 지원 헬름차트 관리하기를 통해 수정/삭제 할 수 있습니다.

배포대상 환경을 설정하려면 다음 절차를 따르세요.

1. 배포 대상 항목에서 헬름차트를 통해 직접 구성을 선택하세요.
2. 헬름릴리스명을 입력하세요.
3. 검색 버튼을 클릭하여 사용할 헬름차트 를 선택하세요.
4. Values.yaml을 수정 후 Validation Check 버튼을 클릭하세요.
5. 다음 버튼이 활성화되면 다음 버튼을 클릭하세요.

   항목	설명
   배포 대상	배포 대상을 선택하세요.
   헬름릴리스명	생성할 헬름릴리스의 이름을 입력하세요. 해당 이름은 배포될 클러스터의 네임스페이스 내에서 유일해야 합니다.
   헬름차트	헬름차트를 선택하세요. 헬름차트 선택 시 하위에 선택한 차트에 대한 세부 내용이 표시
   K8S 정보	Value.yaml 구성에 필요한 Kubernetes 클러스터의 정보를 보여줍니다.
   Values. yaml	Values.yaml 내용을 수정하세요. 헬름차트 설치 시 사용할 values.yaml 파일 입니다.

   표. 프로젝트 생성 배포 대상 환경 설정 항목

빌드 파이프라인 설정하기

사용자는 애플리케이션을 빌드하고 배포하는 파이프라인을 구성할 수 있습니다.

구성할 파이프라인의 각 단계를 확인할 수 있으며 빌드 Job 이름을 변경할 수 있습니다.

빌드 파이프라인을 설정하려면 다음 절차를 따르세요.

1. 빌드 파이프라인 화면에서 IDP 연동 여부에 따라 분기됩니다.
   • IDP 연동 Jenkins의 경우 사용자 등록 확인을 위해 User Check 버튼을 클릭하세요.
   • IDP 미연동 Jenkins의 경우 인증정보 입력 후 Connection Test 버튼을 클릭하세요.
2. 다음 버튼이 활성화되면 다음 버튼을 클릭하세요.

   항목	설명
   빌드/배포 파이프라인	빌드/배포 파이프라인 정보를 보여줍니다. 빌드/배포 파이프라인은 App. 템플릿의 파이프라인 템플릿 관리하기에 등록된 정보를 바탕으로 표시
   구분	개발/운영 구분을 선택하세요. 개발/운영 구분에 따라 해당 파이프라인의 권한이 달라집니다. 역할자별 권한은 표. 프로젝트 내 각 역할자별 권한(1)를 참고하세요.
   URL	파이프라인을 구성할 Jenkins 선택 후, Job 이름을 입력하세요. 사용자가 사용가능한 Jenkins 가 나타납니다.
   빌드 에이전트	파이프라인 빌드에 사용될 에이전트를 선택하세요. 에이전트에 대한 정보는 에이전트(kubernetes) 관리하기, 에이전트(VM) 관리하기를 참고하세요.
   빌드 환경 OS	빌드 에이전트가 실행되는 환경의 OS 정보를 표시 합니다.
   사용자 정보	IDP 연동 Jenkins 사용자 등록 확인을 위해 User Check 버튼을 클릭하세요. Jenkins 사용자로 등록되지 않은 경우, 사용자 등록 안내 팝업창이 열리면 Jenkins로 이동하기 링크를 클릭하여 사용자 가입 또는 Jenkins 최초 로그인을 진행하세요. IDP 미연동 Jenkins 인증정보를 입력하고 Connection Test 버튼을 클릭하세요.
   환경 변수 설정	Jenkins 파이프라인에 등록될 환경변수를 설정하세요.
   Image Tag Pattern	컨테이너 이미지의 tag 부여방식을 선택하세요.
   Deploy Strategy	컨테이너 이미지의 배포방식을 선택하세요.
   배포 결과 수신자	빌드 파이프라인 완료 후 결과를 수신할 사용자를 선택하세요.

   표. 프로젝트 생성 빌드 파이프라인 설정 항목

사용자 정의 설정하기

사용자는 빌드에 사용될 Dockerfile 파일의 경로를 지정하고 수정할 수 있습니다.

또한 빌드 파이프라인 설정하기에서 설정한 정보를 바탕으로 생성된 최종 스크립트를 확인할 수 있고 수정도 할 수 있습니다.

Dockerfile, 파이프라인 스크립트를 설정하려면 다음 절차를 따르세요.

1. 사용자 정의 설정 페이지에서 정보 입력 후 Connection Test 버튼을 클릭하세요.
2. 다음 버튼이 활성화 되면 다음 버튼을 클릭하세요.

   항목	설명
   Dockerfile 설정	신규 Dockerfile 생성 또는 기존 Dockerfile 사용 여부를 선택하세요. 기존 Dockerfile 사용은 Environment Only App. 템플릿을 선택 후 코드 저장소 설정하기에서 기존 저장소 사용으로 선택한 경우만 선택할 수 있습니다.
   Dockerfile 경로	소스코드 상의 Dockerfile 파일 경로를 지정하세요.
   Branch 명	Branch 명은 코드 저장소 설정하기에서 설정 시 등록한 Branch 명이 자동으로 등록됩니다.
   Dockerfile	Dockerfile의 파일 내용을 확인 및 수정하세요.
   파이프라인 스크립트	파이프라인 스크립트를 확인 및 수정하세요.

   표. 프로젝트 생성 사용자 정의 설정 항목

프로젝트 생성 완료하기

사용자는 최종적으로 생성할 프로젝트 및 툴 정보를 확인하고 프로젝트 생성을 시작할 수 있습니다.

프로젝트 생성을 완료하려면 다음 절차를 따르세요.

1. 요약정보 화면에서 정보 확인 후 완료 버튼을 클릭하세요.
2. 프로젝트 생성 팝업창이 열리며 프로젝트 생성이 진행됩니다.
3. 프로젝트 생성이 완료된 후 확인 버튼을 클릭하면 프로젝트 페이지로 이동합니다.

빌드 파이프라인 실행 확인하기

프로젝트 페이지에서 파이프라인 실행 상태를 확인할 수 있으며 최초 프로젝트 생성이 완료되면 빌드 파이프라인이 자동으로 실행됩니다.

빌드 파이프라인이 실패한 경우, 왼쪽 빌드 파이프라인 메뉴를 통해 파이프라인 수정 및 재실행을 진행하세요.

빌드 파이프라인 실행을 확인하려면 다음 절차를 따르세요.

1. 메인 페이지에서 프로젝트 카드를 클릭하세요. 프로젝트 대시보드 페이지로 이동합니다.
2. 왼쪽 메뉴에서 빌드/배포 > 빌드 파이프라인 메뉴를 클릭하세요.

배포 결과 확인하기

파이프라인 실행 완료 후 헬름차트 배포 결과를 확인할 수 있습니다.

헬름차트 배포 결과에 대한 자세한 내용은 헬름릴리스를 참고 하세요.

배포 결과를 확인하려면 다음 절차를 따르세요.

1. 메인 페이지에서 프로젝트 카드를 클릭하세요. 프로젝트 대시보드 페이지로 이동합니다.
2. 왼쪽 메뉴에서 빌드/배포 > Kubernetes 배포 메뉴를 클릭하세요. Kubernetes 배포 페이지로 이동합니다.
3. 헬름릴리스 목록을 클릭하여 상세 배포 결과를 확인하세요.