- How to set up
- Status Page UI
- Attachment storage
GitLab Status Page allows you to create and deploy a static website to communicate efficiently to users during an incident.
Setting up a Status Page is pretty painless but there are a few things you need to do.
To use GitLab Status Page you first need to set up your account details for your cloud provider in the operations settings page. Today, only AWS is supported.
- Within your AWS acccout, create two new IAM policies.
- Create a new AWS access key with the permissions policies created in the first step.
To deploy the Status Page to AWS S3 you need to add the Status Page project & configure the necessary CI variables.
- Fork the Status Page project. This can also be done via Repository Mirroring which will ensure you get the up-to-date Status Page features.
- Add the following variables in Settings > CI/CD > Variables. (To get these variables from Amazon, use your Amazon Console):
S3_BUCKET_NAME- name of the Amazon S3 bucket (If a bucket with the provided name doesn’t exist, the first pipeline run will create one and configure it for static website hosting)
AWS_DEFAULT_REGION- the AWS region
AWS_ACCESS_KEY_ID- the AWS access key ID
AWS_SECRET_ACCESS_KEY- the AWS secret
- Run the pipeline to deploy the Status Page to S3.
Once the CI/CD variables are set, you’ll need to set up the Project you want to use for Incident issues:
- To view the Operations Settings page, navigate to Settings > Operations > Status Page.
- Fill in your cloud provider’s credentials and make sure the Active checkbox is checked.
- Click Save changes.
The Status Page landing page shows you an overview of the recent incidents. Clicking on an incident will take you to the incident’s detail page.
The incident detail page shows detailed information about a particular incident. For example:
- Status on the incident, including when the incident was last updated.
- The incident title, including any emojis.
- The description of the incident, including emojis.
- Any file attachments provided in the incident description or comments with a valid image extension. Introduced in GitLab 13.1.
- A chronological ordered list of updates to the incident.
To publish an Incident, you first need to create an issue in the Project you enabled the Status Page settings in.
After the quick action is used, a background worker publishes the issue onto the Status Page using the credentials you provided during setup.
Since all incidents are published publicly, user and group mentions are anonymized with
and titles of non-public GitLab references are removed.
When an Incident is published in the GitLab project, you can access the details page of the Incident by clicking the Published on status page button displayed under the Incident’s title.
To publish an update to the Incident, update the incident issue’s description.
To add comments to the Status Page Incident, create a comment on the incident issue.
When you’re ready to publish the comment, add a microphone award emoji reaction (
:microphone 🎤) to the comment. This marks the comment as one which should be deployed to the Status Page.
To change the incident status from
closed, close the incident issue within GitLab. This will then be updated shortly on the Status Page website.
Beginning with GitLab 13.1, files attached to incident issue descriptions or comments are published and unpublished to the status page storage as part of the publication flow.
Only 5000 attachments per issue will be transferred to the status page.