Move most of README information inside docs

parent 21262fd3
Pipeline #47175297 passed with stages
in 28 minutes and 31 seconds
# Cloud Native GitLab Helm Chart
[![pipeline status](https://gitlab.com/charts/gitlab/badges/master/pipeline.svg)](https://gitlab.com/charts/gitlab/pipelines)
The `gitlab` chart is the best way to operate GitLab on Kubernetes. This chart contains all the required components to get started, and can scale to large deployments.
# Cloud Native GitLab Helm Chart
Do note that it is not necessary to have GitLab installed on Kubernetes in order to use [GitLab Kubernetes integration](https://docs.gitlab.com/ee/user/project/clusters/index.html).
The `gitlab` chart is the best way to operate GitLab on Kubernetes. It contains
all the required components to get started, and can scale to large deployments.
Some of the key benefits of this chart and [corresponding containers](https://gitlab.com/gitlab-org/build/CNG) are:
* Improved scalability and reliability
* No requirement for root privileges
* Utilization of object storage instead of NFS for storage
The default deployment includes:
- Improved scalability and reliability.
- No requirement for root privileges.
- Utilization of object storage instead of NFS for storage.
## Detailed documentation
- Core GitLab components: Unicorn, Shell, Workhorse, Registry, Sidekiq, and Gitaly
- Optional dependencies: Postgres, Redis, Minio
- An auto-scaling, unprivileged [GitLab Runner](https://docs.gitlab.com/runner/) using the Kubernetes executor
- Automatically provisioned SSL via [Let's Encrypt](https://letsencrypt.org/).
See the [repository documentation](doc/index.md) for how to install GitLab and
other information on charts, tools, and advanced configuration.
## Architecture and goals
......@@ -23,32 +23,14 @@ of this project goals and architecture.
## Known issues and limitations
Some features of GitLab are not currently available:
* [GitLab Pages](https://gitlab.com/charts/gitlab/issues/37)
* [GitLab Geo](https://gitlab.com/charts/gitlab/issues/8)
* [GitLab Elastic Search support](https://gitlab.com/charts/gitlab/issues/976)
* [No in-cluster HA database](https://gitlab.com/charts/gitlab/issues/48)
* MySQL will not be supported, as support is [deprecated within GitLab](https://docs.gitlab.com/omnibus/settings/database.html#using-a-mysql-database-management-server-enterprise-edition-only)
Limitations:
* Support is only available for Postgres 9.6. Backup and restore [will not work with other versions](https://gitlab.com/charts/gitlab/issues/852).
See [limitations](doc/index.md#limitations).
## Release Notes
Check the [releases documentation](doc/releases/index.md) for information on important releases,
and see the [changelog](CHANGELOG.md) for the full details on any release.
## Quick-start installation
See the [installation documentation](doc/installation/index.md) for a quick-start to using this chart.
## Detailed documentation
See the [repository documentation](doc/index.md) for detailed documentation on charts, tools, and advanced configuration.
and see the [changelog](CHANGELOG.md) for the full details on any release.
## Contributing
Please see the [contribution guidelines](CONTRIBUTING.md)
And then check out the [development styleguide](doc/development/index.md).
See the [contribution guidelines](CONTRIBUTING.md) and then check out the
[development styleguide](doc/development/index.md).
......@@ -2,6 +2,9 @@
This is the official and recommended way to install GitLab on a cloud native environment.
Do note that it is not necessary to have GitLab installed on Kubernetes in order to use
the [GitLab Kubernetes integration](https://docs.gitlab.com/ee/user/project/clusters/).
## Introduction
The `gitlab` chart is the best way to operate GitLab on Kubernetes. This chart
......@@ -23,7 +26,12 @@ Some features of GitLab are not currently available using the Helm chart:
- [GitLab Pages](https://gitlab.com/charts/gitlab/issues/37)
- [GitLab Geo](https://gitlab.com/charts/gitlab/issues/8)
- [No in-cluster HA database](https://gitlab.com/charts/gitlab/issues/48)
- [Elasticsearch support](https://gitlab.com/charts/gitlab/issues/976)
Database limitations:
- MySQL will not be supported, as support is [deprecated within GitLab](https://docs.gitlab.com/omnibus/settings/database.html#using-a-mysql-database-management-server-enterprise-edition-only)
- Support is only available for Postgres 9.6. Backup and restore [will not work with other versions](https://gitlab.com/charts/gitlab/issues/852).
## GitLab version mappings
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment