Skip to content
Snippets Groups Projects

Add docs for runner fleet dashboard early adopters program

Merged Vladimir Shushlin requested to merge vshushlin/runner-dashboard-self-managed-docs into master
1 unresolved thread

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:

  1. Normal dashboard documentation which doesn't require Clickhouse
  2. Clickhouse setup docs
  3. 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.

Edited by Vladimir Shushlin

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Pedro Pombeiro approved this merge request

    approved this merge request

  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
    • Resolved by Fiona Neill

      Hey @vshushlin :wave: 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. :pray:

  • added 1 commit

    • 00a2ee02 - Add docs for runner fleet dashboard early adopters program

    Compare with previous version

  • added 1 commit

    • 6f21a9e2 - Add docs for runner fleet dashboard early adopters program

    Compare with previous version

  • Gina Doyle
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Fiona Neill
  • Pedro Pombeiro added 835 commits

    added 835 commits

    Compare with previous version

  • Pedro Pombeiro added 1 commit

    added 1 commit

    • 0969a940 - Address MR review suggestions

    Compare with previous version

  • Fiona Neill
  • Fiona Neill approved this merge request

    approved this merge request

  • Pedro Pombeiro added 99 commits

    added 99 commits

    Compare with previous version

  • Pedro Pombeiro added 1 commit

    added 1 commit

    • 235825ba - Add link to ClickHouse self-managed recommendations

    Compare with previous version

  • Fiona Neill added 1 commit

    added 1 commit

    • b1cfd6d1 - Apply 2 suggestion(s) to 1 file(s)

    Compare with previous version

  • Fiona Neill
  • Fiona Neill
  • Pedro Pombeiro added 418 commits

    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

    Compare with previous version

  • Gina Doyle approved this merge request

    approved this merge request

  • Pedro Pombeiro added 860 commits

    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

    Compare with previous version

  • A deleted user added clickhousereview pending label
  • Contributor
    1 Message
    :book: 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:

    The review does not need to block merging this merge request. See the:

    If needed, you can retry the :repeat: danger-review job that generated this comment.

    Generated by :no_entry_sign: Danger

  • Fiona Neill
  • Fiona Neill
  • Fiona Neill added 1 commit

    added 1 commit

    Compare with previous version

  • Fiona Neill resolved all threads

    resolved all threads

  • Fiona Neill enabled an automatic merge when the pipeline for 5cb1b94e succeeds

    enabled an automatic merge when the pipeline for 5cb1b94e succeeds

  • merged

  • Fiona Neill mentioned in commit 7b3f5efa

    mentioned in commit 7b3f5efa

  • 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
  • added workflowstaging label and removed workflowcanary label

  • Please register or sign in to reply
    Loading