상태 페이지

Tier: Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

GitLab 상태 페이지를 사용하면 사고 발생 시 사용자에게 효율적으로 소통할 수 있는 정적 웹사이트를 생성하고 배포할 수 있습니다. 상태 페이지 랜딩 페이지에서는 최근 사고에 대한 개요가 표시됩니다:

상태 페이지 랜딩 페이지

사고를 선택하면 해당 사고에 대한 자세한 정보가 포함된 상세 페이지가 표시됩니다:

상태 페이지 상세

  • 사고에 대한 상태 및 최종 업데이트된 시간.
  • 사고 제목(이모지 포함).
  • 사고 설명(이모지 포함).
  • 사고 설명에 제공된 파일 첨부 또는 유효한 이미지 확장자를 가진 댓글. GitLab 13.1에 도입되었습니다.
  • 사고에 대한 시간순으로 정렬된 업데이트 디렉터리.

상태 페이지 설정

GitLab 상태 페이지를 구성하려면 다음을 수행해야 합니다:

  1. 클라우드 공급업체 정보로 GitLab 구성
  2. AWS 계정 구성.
  3. GitLab에서 상태 페이지 프로젝트 생성.
  4. 사고를 상태 페이지에 동기화.

클라우드 공급업체 정보로 GitLab 구성

AWS S3만 배포 대상으로 지원됩니다.

전제 조건:

  • 적어도 Maintainer 역할이 있어야 합니다.

GitLab에 외부 상태 페이지로 콘텐츠를 푸시하는 데 필요한 AWS 계정 정보를 제공하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 모니터링을 선택합니다.
  3. 상태 페이지를 확장합니다.
  4. 활성 확인란을 선택합니다.
  5. 상태 페이지 URL 상자에 외부 상태 페이지의 URL을 제공합니다.
  6. S3 버킷 이름 상자에 S3 버킷의 이름을 입력합니다. 자세한 내용은 버킷 구성 설명서를 참조하십시오.
  7. AWS 지역 상자에 버킷의 지역을 입력합니다. 자세한 내용은 AWS 문서를 참조하십시오.
  8. AWS 액세스 키 ID 및 AWS 비밀 액세스 키를 입력합니다.
  9. 변경 사항 저장을 선택합니다.

AWS 계정 구성

  1. AWS 계정 내에서 다음 파일을 사용하여 두 개의 새 IAM 정책을 생성합니다.
  2. 첫 번째 단계에서 생성된 권한 정책을 사용하여 새 AWS 액세스 키를 생성합니다.

상태 페이지 프로젝트 생성

AWS 계정을 구성한 후, 상태 페이지 프로젝트를 추가하고 상태 페이지를 AWS S3에 배포하기 위해 필요한 CI/CD 변수를 구성해야 합니다:

  1. 상태 페이지 프로젝트를 포크합니다. 최신 상태 페이지 기능을 얻을 수 있도록 리포지터리 미러링을 사용해야 합니다.
  2. 왼쪽 사이드바에서 설정 > CI/CD를 선택합니다.
  3. 변수를 확장합니다.
  4. 아래 Amazon Console에서 다음 변수를 추가합니다:

    • S3_BUCKET_NAME - Amazon S3 버킷 이름. 제공한 이름으로 버킷이 존재하지 않으면 첫 번째 파이프라인 실행에서 버킷을 생성하고 정적 웹사이트 호스팅을 구성합니다.

    • AWS_DEFAULT_REGION - AWS 지역.
    • AWS_ACCESS_KEY_ID - AWS 액세스 키 ID.
    • AWS_SECRET_ACCESS_KEY - AWS 비밀 키.
  5. 왼쪽 사이드바에서 빌드 > 파이프라인을 선택합니다.
  6. S3에 상태 페이지를 배포하려면 파이프라인 실행을 선택합니다.
caution
이 프로젝트의 이슈에 액세스할 수 있는 사용자는 GitLab Status Page에 댓글을 게시할 수 있으므로 이슈에 액세스할 수 있는 사용자를 제한하는 것이 좋습니다.

사고를 상태 페이지에 동기화

CI/CD 변수를 생성한 후, 사고 이슈에 사용할 프로젝트를 구성해야 합니다:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 모니터링을 선택합니다.
  3. 상태 페이지를 확장합니다.
  4. 클라우드 공급업체 자격 증명을 작성하고 활성 확인란을 선택합니다.
  5. 변경 사항 저장을 선택합니다.

GitLab 상태 페이지 사용 방법

GitLab 인스턴스를 구성한 후 관련 업데이트는 사건에 대한 배경 작업을 트리거하여 JSON 형식의 데이터를 외부 클라우드 공급업체로 푸시합니다. 상태 페이지 웹사이트는 주기적으로 이 JSON 형식의 데이터를 가져와 사용자에게 제공하여 팀의 추가 노력 없이 진행 중인 사건에 대한 정보를 제공합니다:

graph TB subgraph GitLab 인스턴스 issues(이슈 업데이트) -- 트리거 --> middleware(백그라운드 작업: JSON 생성) end subgraph 클라우드 공급업체 middleware --데이터를 저장 --> c1(클라우드 버킷에 JSON 파일 저장) end subgraph 상태 페이지 d(CDN의 정적 사이트) -- 데이터를 가져옴 --> c1 end

사고 게시

사고를 게시하려면:

  1. GitLab 상태 페이지 설정을 사용한 프로젝트에서 이슈를 생성합니다.
  2. 프로젝트 또는 그룹 소유자는 /publish 빠른 조치를 사용하여 이슈를 GitLab 상태 페이지에 게시해야 합니다. 비공개 이슈는 게시할 수 없습니다.

백그라운드 워커가 설정 중에 제공한 자격 증명을 사용하여 이슈를 상태 페이지에 게시합니다. 게시 과정에서 GitLab은 다음을 수행합니다:

  • 사용자 및 그룹 언급을 사건 응답자로 익명화합니다.
  • GitLab 참조의 비공개 제목을 제거합니다.
  • 사고 이슈 설명에 첨부된 파일을 게시합니다. 이 때 이슈 당 최대 5000개의 파일이 가능합니다. (GitLab 13.1에 도입되었습니다.)

게시한 후에는 상태 페이지에 게시됨 버튼을 선택하여 사건의 세부 정보 페이지에 액세스할 수 있습니다.

상태 페이지 상세 링크

인시던트 업데이트

인시던트를 업데이트하려면 인시던트 이슈의 설명을 업데이트하세요.

caution
참조된 이슈가 변경되면(제목 또는 기밀 여부와 같이) 해당 이슈에 대한 인시던트는 업데이트되지 않습니다.

인시던트에 대한 코멘트 발행

상태 페이지 인시던트에 코멘트를 발행하려면:

  • 인시던트 이슈에 코멘트를 작성합니다.
  • 코멘트를 발행하려면, 코멘트에 마이크 이모지 리액션 (:microphone: 🎤)을 추가하여 발행으로 표시합니다.
  • 이슈 당 첨부된 파일(이슈 당 최대 5000개까지) 역시 발행됩니다. (GitLab 13.1에서 도입됨.)
caution
이슈를 볼 수 있는 권한이 있는 모든 사람이 코멘트에 이모지 리액션을 추가할 수 있으므로, 이슈에 대한 액세스를 팀 멤버로 제한하는 것을 고려해야 합니다.

인시던트 상태 업데이트

인시던트 상태를 open에서 closed로 변경하려면 GitLab에서 인시던트 이슈를 닫으세요. 이슈를 닫으면 배경 작업자가 GitLab 상태 페이지 웹사이트를 업데이트합니다.

만약 발행된 이슈를 기밀 처리한다면, GitLab에서는 해당 이슈를 상태 페이지 웹사이트에서 발행 취소합니다.