Feature Flag: FF_CONFIGURABLE_ROOT_DIR
Summary
This issue is to rollout pages configurable root dir feature on production,
that is currently behind the FF_CONFIGURABLE_ROOT_DIR
feature flag.
This replaces the hard-coded root directory public
by a configurable value as provided by the GitLab API. There it can be configured by in their .gitlab-ci.yml
file.
Expectations
What are we expecting to happen?
For existing pages deployments, nothing.
New pages deployments will be able to configure the artifact directory exposed by Pages by adding a publish
property to the pages
job in their project's .gitlab-ci.yml
.
What might happen if this goes wrong?
If this causes unexpected issues, the most likely result would be an increased amount of 404
or 500
Errors returned by the GitLab Pages daemon.
To recover, turn the Feature Flag off by reverting the following MRs:
- Staging: gitlab-com/gl-infra/k8s-workloads/gitlab-com!2780 (merged)
- Pre: gitlab-com/gl-infra/k8s-workloads/gitlab-com!2792 (merged)
- Prod: gitlab-com/gl-infra/k8s-workloads/gitlab-com!2781 (merged)
If reverting the FF does not solve the issue, roll back the deployed Pages version to the latest stable release. To do so, revert this MR: gitlab!123039 (merged)
Dashboard links to monitor performance
Staging
- Grafana: https://dashboards.gitlab.net/d/web-pages-main/web-pages-overview?orgId=1&var-PROMETHEUS_DS=Global&var-environment=gstg&var-stage=main
- Kibana: https://nonprod-log.gitlab.net/app/discover#/view/ec67bc30-0691-11ee-9aee-27a0c7499f28?_g=(filters%3A!()%2CrefreshInterval%3A(pause%3A!t%2Cvalue%3A60000)%2Ctime%3A(from%3Anow-24h%2Fh%2Cto%3Anow))
Prod
- Grafana: https://dashboards.gitlab.net/d/web-pages-main/web-pages-overview?orgId=1&var-PROMETHEUS_DS=Global&var-environment=gprd&var-stage=main
- Kibana: https://log.gprd.gitlab.net/app/discover#/view/15b6a0f0-0698-11ee-a017-0d32180b1390?_g=(filters%3A!()%2CrefreshInterval%3A(pause%3A!t%2Cvalue%3A0)%2Ctime%3A(from%3Anow-24h%2Cto%3Anow))
Rollout Steps
-
Enable FF in Staging: gitlab-com/gl-infra/k8s-workloads/gitlab-com!2780 (merged) -
Enable FF in Pre:gitlab-com/gl-infra/k8s-workloads/gitlab-com!2792 (merged) -
Temporarily enable with environment variable: gitlab-com/gl-infra/k8s-workloads/gitlab-com!2781 (merged) -
Enable by default (optional): !890 (merged) -
Remove the feature flag: !917 (merged)