상태 페이지

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

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

상태 페이지 랜딩 페이지

특정 장애에 대한 자세한 정보가 포함된 상세 페이지가 표시됩니다:

상태 페이지 상세 정보

  • 장애에 대한 상태 및 마지막 업데이트된 시간을 포함합니다.
  • 장애 제목 및 해당 이모지를 포함합니다.
  • 장애 설명 및 해당 이모지를 포함합니다.
  • 장애 설명 또는 유효한 이미지 확장자가 있는 댓글에서 제공된 파일 첨부.
  • 장애에 대한 시간순으로 정렬된 업데이트 목록입니다.

상태 페이지 설정하기

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 콘솔에서 변수를 추가합니다:

    • S3_BUCKET_NAME - Amazon S3 버킷의 이름입니다. 제공된 이름으로 된 버킷이 존재하지 않으면, 첫 번째 파이프라인 실행 시 정적 웹사이트 호스팅을 위해 하나를 생성하고 구성합니다.

    • AWS_DEFAULT_REGION - AWS 지역입니다.
    • AWS_ACCESS_KEY_ID - AWS 액세스 키 ID입니다.
    • AWS_SECRET_ACCESS_KEY - AWS 비밀 키입니다.
  5. 왼쪽 사이드바에서 Build > 파이프라인을 선택합니다.
  6. S3에 상태 페이지를 배포하려면, 새 파이프라인을 선택합니다.

경고: 이 프로젝트에서 이슈에 접근할 수 있는 사용자는 누구나 이슈를 볼 수 있기 때문에 GitLab 상태 페이지에 댓글을 게시할 수 있습니다로 축소하는 것을 고려하세요.

상태 페이지에 장애 동기화하기

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

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

GitLab 상태 페이지 사용 방법

GitLab 인스턴스를 구성한 후, 관련 업데이트가 외부 클라우드 제공업체로 장애에 관한 JSON 형식의 데이터를 푸시하는 백그라운드 작업이 트리거됩니다. 상태 페이지 웹사이트는 주기적으로 이 JSON 형식의 데이터를 가져와서 포맷팅하여 사용자에게 제공함으로써, 팀의 추가 노력 없이 현재의 장애에 관한 정보를 제공합니다:

%%{init: { "fontFamily": "GitLab Sans" }}%% graph TB accTitle: 상태 페이지의 이해 accDescr: GitLab이 장애 데이터를 가져오고 포맷하며 표시하는 방법 subgraph GitLab 인스턴스 이슈(이슈 업데이트) -- 트리거 --> 미들웨어(백그라운드 작업: JSON 생성) end subgraph 클라우드 제공업체 미들웨어 --데이터를 저장--> c1(클라우드 버킷에 JSON 파일 저장) end subgraph 상태 페이지 d(CDN의 정적 사이트) -- 데이터를 가져옴 --> c1 end

장애 게시하기

장애를 게시하려면:

  1. GitLab 상태 페이지 설정을 활성화한 프로젝트에 이슈를 생성합니다.
  2. 프로젝트 또는 그룹 소유자는 이슈를 빠른 작업인 /publish를 사용하여 GitLab 상태 페이지에 공개할 수 있습니다. 비공개 이슈는 공개할 수 없습니다.

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

  • 장애 응답자로 사용자 및 그룹 언급을 익명화합니다.
  • 비공개 GitLab 참조의 제목을 제거합니다.
  • 이슈 설명에 추가된 파일을 최대 5000개까지 게시합니다.

게시 후, 해당 이슈의 상세 페이지에는 장애 제목 아래에 표시된 상태 페이지에 게시됨 버튼을 통해 액세스할 수 있습니다.

상태 페이지 상세 정보 링크

인시던트 업데이트

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

경고: 참조된 이슈가 변경될 때(제목 또는 비밀 보호 등) 참조된 인시던트는 업데이트되지 않습니다.

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

상태 페이지 인시던트에 코멘트를 발행하려면 다음을 수행하세요:

  • 인시던트 이슈에 코멘트를 작성하세요.
  • 코멘트를 발행할 준비가 되면 코멘트에 마이크 이모지 반응 (:microphone: 🎤)를 추가하여 발행으로 표시하세요.
  • 해당 코멘트에 첨부된 파일(이슈 당 최대 5000개)도 발행됩니다.

경고: 이슈를 볼 수 있는 권한이 있는 모든 사람은 코멘트에 이모지 반응을 추가할 수 있으므로, 이슈에 대한 액세스 권한을 팀 멤버로만 제한하는 것을 고려해야 합니다.

인시던트 상태 업데이트

인시던트 상태를 열림(open)에서 닫힘(closed)으로 변경하려면 GitLab에서 인시던트 이슈를 닫으세요. 이슈를 닫으면 백그라운드 워커가 GitLab 상태 페이지 웹사이트를 업데이트합니다.

만약 게시된 이슈를 비밀로 지정하면, GitLab에서는 귀하의 GitLab 상태 페이지 웹사이트에서 해당 이슈를 비게시합니다.