Update product analytics documentation to explain how to set up BYOC for instance and project levels

Problem to solve

The product analytics documentation makes a basic reference to the project-level settings, and onboarding a project. We also have our tutorial. The issue is that these are written with SaaS in mind, rather than how to self-serve as a self-managed or dedicated instance customer. It also doesn't take into account SaaS users looking to use their own product analytics providers.

Proposed solution

Note: We won't be able to reference the BYOC infrastructure repo until https://gitlab.com/gitlab-org/analytics-section/product-analytics/analytics-stack/-/issues/133+

Note update: We now have a (eventually) public repo URL of https://gitlab.com/gitlab-org/analytics-section/product-analytics/helm-charts. Therefore, we can begin to work on this with the knowledge that the URL will 404 until we release it publicly, hopefully within %16.11.

Update our documentation to describe how to set up your own cluster as a self-managed, dedicated, or SaaS instance customer. As well as how to use the managed product analytics provider as a SaaS instance customer. Correct instances where we say product analytics is only available on .com.

Ensure we explain:

  • The purchase flow and redirections.
    • Like when setting up a custom cluster on a project.
  • That self-managed with managed Product Analytics isn't supported yet.
  • Add blocked access errors from ( https://gitlab.com/gitlab-org/gitlab/-/issues/451250) to our trouble shooting guide.

note: For self-managed and dedicated instances, the instance-level settings require product analytics provider settings to have been filled in for product analytics to be enabled. Therefore, there is no way for them to only use project-level settings only without an instance-level fallback.

GitLab instance BYOC product analytics Managed product analytics Add instance-level settings Add project-level settings
Managed ✅ ✅ ❌ (controlled by us) ✅
Dedicated ✅ ❌ (customer has access to instance-level settings) ✅ ✅
Self-managed ✅ ❌ ✅ ✅

Implementation plan

  • Add or update the documentation to explain BYOC.
  • Link to this documentation from the product analytics settings pages in project-level and instance settings.
Edited by Elwyn Benson