Determine and document scope for GitLab Detective

In advanced of getting GitLab Detective in front of customers we should document the scope of what's covered by GitLab Detective. We should also document what things are out of scope. This helps us to shape check ideas and helps customers understand what to expect.

Scope

This list is not limited to deployment methods/types.

✅ In Scope

• GitLab hosts running the omnibus package
  • with logs in the default location

❎ Not Currently In Scope

• Helm-based deployments
  • For example, "grepping Rails exception logs for xyz" is simple at first glance, but where are the logs in a Helm based install?
  • Thus far: 2 customers have expressed interested in support for this tool with Helm-based deployments
    • Both of these saw demos -- see #96.
  • What will scope look like for Helm-based deployments?
    • split sidekiq configs -- from demo in #96
• Hosts running GitLab Runner -- #71
• source installs
• GitLab Dedicated
  • this is relevant more because of how GitLab Dedicated is deployed. GitLab Detective is for folks who operate GitLab instances.
• Checking GitLab configuration files other than /etc/gitlab/gitlab.rb (no included .rb files)
• How do we handle customized log paths? - !67 (merged)
• Checks where the results depend on the output from other checks -- #26
• External PostgreSQL - #77
• Looking through the content of .gitlab-ci.yml

Currently Unclear

It's OK if we have things in this category: let's sort through them.

• See these Qs from Anton.
  • 1. Should we check for disclosed security vulnerabilities in GitLab, or one of it's dependencies?
  • 2. Should we check external components for compatibility ie. Redis or PostgreSQL version is compatible with the current GitLab version etc?
    • @bcarranza I think we should if we can.
  • 3. Should we check issues with GitLab Runner?
    • YES if the check can occur on the coordinator side.
• How should we think about overlap with Rake tasks?
  • GitLab Detective is separate from Rake tasks and is not intended to replace any of the Rake tasks.
    • This has been codified. See !133 (merged)

---

🤝 Contributions welcome!

Feel free to edit in-line; leave a comment if you prefer.