상태 페이지

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

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

상태 페이지 랜딩 페이지

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

상태 페이지 상세

  • 사고의 상태, 최종 업데이트된 시간을 포함합니다.
  • 사고 제목과 이모지를 포함합니다.
  • 이모지를 포함한 사고 설명을 포함합니다.
  • 사건 설명에 제공된 파일 첨부 또는 유효한 이미지 확장자가 포함된 댓글을 포함합니다.
  • 사건에 대한 업데이트의 시간순으로 정렬된 디렉터리을 포함합니다.

상태 페이지 설정

GitLab 상태 페이지를 구성하려면 다음과 같이 해야 합니다:

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

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

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

전제 조건:

  • 적어도 관리자 역할이 있어야 합니다.

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

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

AWS 계정 구성

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

상태 페이지 프로젝트 생성

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

  1. 상태 페이지 프로젝트를 포크합니다. 최신 상태 페이지 기능을 얻을 수 있도록 Repository Mirroring을 사용하여 수행할 수 있습니다.
  2. 왼쪽 사이드바에서 Settings > CI/CD를 선택합니다.
  3. Variables를 확장합니다.
  4. Amazon Console에서 다음 변수를 추가합니다:
    • S3_BUCKET_NAME - Amazon S3 버킷의 이름입니다. 제공된 이름의 버킷이 없는 경우 첫 번째 파이프라인 실행에서 하나를 생성하고 정적 웹사이트 호스팅을 구성합니다.
    • AWS_DEFAULT_REGION - AWS 지역입니다.
    • AWS_ACCESS_KEY_ID - AWS 액세스 키 ID입니다.
    • AWS_SECRET_ACCESS_KEY - AWS 비밀 키입니다.
  5. 왼쪽 사이드바에서 Build > Pipelines를 선택합니다.
  6. 상태 페이지를 S3에 배포하려면 파이프라인 실행을 선택합니다.
caution
이 프로젝트에서 이슈에 액세스할 수 있는 모든 사용자가 잠재적으로 GitLab 상태 페이지에 댓글을 게시할 수 있으므로 문제에 누가 액세스할 수 있는지 고려해야 합니다.

상태 페이지로 사고 동기화

CI/CD 변수를 생성한 후 사용하려는 프로젝트를 사고 이슈에 대해 구성하도록 합니다:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. Settings > Monitor를 선택합니다.
  3. 상태 페이지를 확장합니다.
  4. 클라우드 제공자의 자격증명을 입력하고 Active 확인란을 선택합니다.
  5. 변경 사항 저장을 선택합니다.

GitLab 상태 페이지 사용 방법

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

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

사고 게시

사고를 게시하려면:

  1. 상태 페이지 설정을 활성화한 프로젝트에서 이슈를 생성합니다.
  2. 프로젝트 또는 그룹 소유자가 이 문제를 GitLab 상태 페이지에 게시하기 위한 /publish 퀵 액션을 사용해야 합니다. 기밀 이슈는 게시할 수 없습니다.

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

  • 임시 응답자로 사용자 및 그룹 멘션을 익명화합니다.
  • 비공개 GitLab 참조의 제목을 제거합니다.
  • 사건 이슈 설명에 첨부된 파일을 게시합니다. 이슈 당 최대 5000개까지 첨부 파일이 가능합니다.

게시한 후, 사건 제목 아래에 표시되는 상태 페이지에 발행됨 버튼을 선택하여 해당 사고에 대한 상세 페이지에 액세스할 수 있습니다.

상태 페이지 상세 링크

사고 업데이트

사고에 대한 업데이트를 게시하려면 사고 이슈 설명을 업데이트합니다.

caution
참조된 이슈가 변경되면(제목 또는 기밀 여부 등), 해당 이슈가 업데이트되지 않습니다.

사고에 대한 댓글 게시

상태 페이지 사건에 댓글을 게시하려면:

  • 사고 이슈에 댓글을 작성합니다.
  • 댓글을 게시하려면 댓글에 마이크 이모지 반응(:microphone: 🎤)을 추가하여 댓글을 게시합니다.
  • 댓글에 첨부된 파일(이슈당 최대 5000개)도 게시됩니다.
caution
이슈에 액세스할 수 있는 모든 사용자는 댓글에 이모지 반응을 추가할 수 있으므로 문제에 액세스하는 사용자를 팀 멤버로 제한하는 것을 고려하십시오.

사고 상태 업데이트

사고 상태를 open에서 closed로 변경하려면 GitLab 내에서 사고 이슈를 닫으십시오. 이슈를 닫으면 백그라운드 워커가 GitLab 상태 페이지 웹사이트를 업데이트합니다.

만약 게시된 문제를 기밀로 만들면, GitLab은 GitLab 상태 페이지 웹사이트에서 해당 문제를 게시 해제합니다.