Add docs for runner fleet dashboard early adopters program
What does this MR do and why?
Addresses Write documentation for using CI Analytics with... (#424500 - closed)
We want to test the new Runner Fleet dashboard with a few selected self-managed clients. This MR provides the documentation on how to setup Clickhouse database and enable necessary feature flags for such tests.
This page is intentionally placed in our development section of the documentation and not the user one. The idea is to emphasize that using Clickhouse is still experimental, and we don't yet fully support it.
I also plan to record a video walking through this.
Ideally in the future this documentation should be broken into 3 separate pages:
- Normal dashboard documentation which doesn't require Clickhouse
- Clickhouse setup docs
- Dashboard setup docs
But I on purpose budled it up toghether into a single page for now.
Review app: http://main-ee-135227.docs.gitlab-review.app/ee/development/runner_fleet_dashboard.html
Screenshots or screen recordings
I'm still working on this.
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Merge request reports
Activity
assigned to @vshushlin
- Resolved by 🤖 GitLab Bot 🤖
Proper labels assigned to this merge request. Please ignore me.
@vshushlin - please see the following guidance and update this merge request.1 Error Please add typebug typefeature, or typemaintenance label to this merge request. Edited by 🤖 GitLab Bot 🤖
added docs-only label
Setting label grouprunner based on
@vshushlin
's group.added grouprunner label
Setting label(s) devopsverify sectionci based on grouprunner.
added devopsverify sectionci labels
added 1 commit
- d3ea93f4 - Add docs for runner fleet dashboard early adopters program
marked the checklist item I have evaluated the MR acceptance checklist for this MR. as completed
changed milestone to %16.6
- Resolved by Pedro Pombeiro
@fneill @pedropombeiro can you do the first review pass on this?
I'm still working on it, but I consider it's ready for review.
requested review from @fneill
added Technical Writing label
- Resolved by Vladimir Shushlin
- Resolved by Vladimir Shushlin
- Resolved by Pedro Pombeiro
- Resolved by Vladimir Shushlin
- Resolved by Vladimir Shushlin
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Vladimir Shushlin
- Resolved by Vladimir Shushlin
- Resolved by Pedro Pombeiro
- Resolved by Vladimir Shushlin
- Resolved by Pedro Pombeiro
- Resolved by Fiona Neill
- Resolved by Vladimir Shushlin
- Resolved by Fiona Neill
- Resolved by Vladimir Shushlin
- Resolved by Vladimir Shushlin
- Resolved by Pedro Pombeiro
- Resolved by Vladimir Shushlin
- Resolved by Vladimir Shushlin
- Resolved by Vladimir Shushlin
- Resolved by Fiona Neill
- Resolved by Vladimir Shushlin
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Fiona Neill
Hey @vshushlin
thanks again for providing these docs! I've added a few suggestions. While it seems like there are a lot they're mainly for style. Usually docs in the/development
folder don't undergo such a heavy review, but since this is for a Beta feature, I wanted to make sure the page adheres to the style guidelines and structures in the user docs.
added 1 commit
- 00a2ee02 - Add docs for runner fleet dashboard early adopters program
assigned to @pedropombeiro
added 1 commit
- 6f21a9e2 - Add docs for runner fleet dashboard early adopters program
- Resolved by Fiona Neill
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
added 835 commits
-
6f21a9e2...bf567056 - 833 commits from branch
master
- 99b79e38 - Add docs for runner fleet dashboard early adopters program
- 5e42c614 - Address MR review suggestions
-
6f21a9e2...bf567056 - 833 commits from branch
- Resolved by Pedro Pombeiro
added 99 commits
-
0969a940...edc8f701 - 96 commits from branch
master
- d1fa4a4d - Add docs for runner fleet dashboard early adopters program
- c742bcd5 - Address MR review suggestions
- 8ecadd5b - Address MR review comment
Toggle commit list-
0969a940...edc8f701 - 96 commits from branch
added 1 commit
- 235825ba - Add link to ClickHouse self-managed recommendations
- Resolved by Fiona Neill
- Resolved by Fiona Neill
- Resolved by Darren Eastman
We should a note that the other metrics (except for wait time to pick up a job) will load without Clickhouse. Of course only if this assumption is correct.
- Resolved by Pedro Pombeiro
- Resolved by Pedro Pombeiro
added 418 commits
-
b1cfd6d1...a4fb2903 - 412 commits from branch
master
- 01e6abb4 - Add docs for runner fleet dashboard early adopters program
- 7f8f467c - Address MR review suggestions
- ef7c202d - Address MR review comment
- 30906059 - Add link to ClickHouse self-managed recommendations
- 9d3feddf - Apply 2 suggestion(s) to 1 file(s)
- f5b907ce - Add queue wait times to list of features
Toggle commit list-
b1cfd6d1...a4fb2903 - 412 commits from branch
mentioned in merge request gitlab-com/www-gitlab-com!130597 (merged)
added 860 commits
-
f5b907ce...63fbe576 - 853 commits from branch
master
- fc6ff154 - Add docs for runner fleet dashboard early adopters program
- 596d1842 - Address MR review suggestions
- 3f37a71a - Address MR review comment
- 66fa3c1c - Add link to ClickHouse self-managed recommendations
- 34ba83fe - Apply 2 suggestion(s) to 1 file(s)
- 37ebc788 - Add queue wait times to list of features
- 96a94425 - Apply Gina's suggestion
Toggle commit list-
f5b907ce...63fbe576 - 853 commits from branch
- A deleted user
added clickhousereview pending label
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/development/img/runner_fleet_dashboard.png
(Link to current live version) -
doc/development/runner_fleet_dashboard.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
- Resolved by Fiona Neill
- Resolved by Fiona Neill
enabled an automatic merge when the pipeline for 5cb1b94e succeeds
mentioned in commit 7b3f5efa
- doc/development/runner_fleet_dashboard.md 0 → 100644
81 1. Sign in to the ClickHouse SQL console. 82 1. Execute the following command. Replace `PASSWORD_HERE` with the generated password. 83 84 ```sql 85 CREATE DATABASE gitlab_clickhouse_main_production; 86 CREATE USER gitlab IDENTIFIED WITH sha256_password BY 'PASSWORD_HERE'; 87 CREATE ROLE gitlab_app; 88 GRANT SELECT, INSERT, ALTER, CREATE, UPDATE, DROP, TRUNCATE, OPTIMIZE ON gitlab_clickhouse_main_production.* TO gitlab_app; 89 GRANT gitlab_app TO gitlab; 90 ``` 91 92 1. Connect to the `gitlab_clickhouse_main_production` database (or just switch it in the ClickHouse Cloud UI). 93 94 1. To create the required database objects, execute: 95 96 ```sql @vshushlin now that !136103 (merged) is merged, should we update these instructions so that users rely on the migrations, instead of duplicating the schema here? This will also ensure they have the latest schema.
Edited by Pedro Pombeiro
added workflowstaging-canary label and removed workflowin review label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-production label and removed workflowproduction label
added releasedcandidate label