CNG: Expand documentation on usage & development
Summary
Related to gitlab-org/omnibus-gitlab#5353 (comment 343449155)
@J0WI: I'm aware of that repo, but it lacks a lot of documentation compared to Omnibus. It's heavily focused on Helm Chart and I could probably raise the same question there. It just solves the "monolithic image" point for me, but it doesn't simplify usage on generic Docker platforms.
It's is clear by this statement that this user doesn't see the CNG containers as approachable, from several directions:
- While tailored for gitlab-org/charts/gitlab, they are usable individually outside of Kubernetes
- Docker Compose is used for development.
- Deployed into Kubernetes via Helm as a GitLab product.
- Can be consumed by any container runtime supporting the format.
- Clarity of how to consume these containers
- What environment needs to be present? (e.g.
GITLAB_WEBSERVER
) - What files need to be present in
/etc/gitlab
? (e.g..gitlab_shell_secret
) - What files can be present in
/var/opt/gitlab/templates
? (e.g.gitlab.yml.erb
)
- What environment needs to be present? (e.g.
- Origin, purpose, and dependencies of each container
- Build time
- Run time