Maven Virtual Registry: Documentation

🔭 Issues plan

1. Maven Virtual Registry: Database models (#467972 - closed).
2. Maven Virtual Registry: Permissions policy (#467977 - closed).
3. Maven Virtual Registry: Registry models API (#467979 - closed).
4. Maven Virtual Registry: Maven API endpoint (#467982 - closed).
5. Maven Virtual Registry: Cache logic (#467983 - closed).
6. Maven Registry: Cached responses destruction (#468113 - closed).
7. Improve workhorse dependencyproxy logic (#461561 - closed).
8. Maven Virtual Registry: Documentation (#468115 - closed). 👈 You're here.
9. Maven Virtual Registry: Performance review (#468116 - closed).
10. Maven Virtual Registry: feature flag cleanup (#468117).

🗒️ Description

Document the Maven virtual registry. The suggested approach here is:

• New section Virtual Registry under https://docs.gitlab.com/ee/user/packages/ (new menu entry on the left sidebar).

  • This page would present the overall concepts and ideas behind virtual registries and its restrictions: root Group only, registries and upstreams.
  • We could also have a word on caching and its settings.

• Under that new section, create another one (including a new menu entry on the left sidebar): Maven

  • This page would present all the specificities for the Maven format.
  • This page should present:
    • How to create a Maven virtual registry.
    • How to configure the clients with the different credentials type. (3 clients to present: $ mvn, $ gradle, $ sbt)

• Document all API endpoints. Make sure that they are flagged in Beta.

• Document that the feature is in Beta and behind a feature flag.

• Make sure to document that the proxy_download: false of the dependency proxy object storage settings will not work. For technical reasons, all downloads through the maven virtual registry uses proxy_download: true.