summaryrefslogtreecommitdiff
path: root/doc/update/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/update/README.md')
-rw-r--r--doc/update/README.md45
1 files changed, 29 insertions, 16 deletions
diff --git a/doc/update/README.md b/doc/update/README.md
index d4fc0cc91bf..e2fffadb1ea 100644
--- a/doc/update/README.md
+++ b/doc/update/README.md
@@ -5,32 +5,38 @@ update guides.
There are currently 3 official ways to install GitLab:
-- Omnibus packages
-- Source installation
-- Docker installation
+- [Omnibus packages](#omnibus-packages)
+- [Source installation](#installation-from-source)
+- [Docker installation](#installation-using-docker)
Based on your installation, choose a section below that fits your needs.
## Omnibus Packages
-- The [Omnibus update guide](http://docs.gitlab.com/omnibus/update/README.html)
+- The [Omnibus update guide][omni-update]
contains the steps needed to update an Omnibus GitLab package.
## Installation from source
-- [Upgrading Community Edition from source][source-ce] - The individual
- upgrade guides are for those who have installed GitLab CE from source.
-- [Upgrading Enterprise Edition from source][source-ee] - The individual
- upgrade guides are for those who have installed GitLab EE from source.
+- [Upgrading Community Edition and Enterprise Edition from
+ source](upgrading_from_source.md) - The guidelines for upgrading Community
+ Edition and Enterprise Edition from source.
- [Patch versions](patch_versions.md) guide includes the steps needed for a
patch version, eg. 6.2.0 to 6.2.1, and apply to both Community and Enterprise
Editions.
+In the past we used separate documents for the upgrading instructions, but we
+have since switched to using a single document. The old upgrading guidelines
+can still be found in the Git repository:
+
+- [Old upgrading guidelines for Community Edition][old-ce-upgrade-docs]
+- [Old upgrading guidelines for Enterprise Edition][old-ee-upgrade-docs]
+
## Installation using Docker
GitLab provides official Docker images for both Community and Enterprise
editions. They are based on the Omnibus package and instructions on how to
-update them are in [a separate document][omnidocker].
+update them are in [a separate document][omni-docker].
## Upgrading without downtime
@@ -97,6 +103,10 @@ migrations this could potentially lead to hours of downtime, depending on the
size of your database. To work around this you will have to use PostgreSQL and
meet the other online upgrade requirements mentioned above.
+### Steps
+
+Steps to [upgrade without downtime][omni-zero-downtime].
+
## Upgrading between editions
GitLab comes in two flavors: [Community Edition][ce] which is MIT licensed,
@@ -113,11 +123,10 @@ The following guides are for subscribers of the Enterprise Edition only.
If you wish to upgrade your GitLab installation from Community to Enterprise
Edition, follow the guides below based on the installation method:
-- [Source CE to EE update guides][source-ee] - Find your version, and follow the
- `-ce-to-ee.md` guide. The steps are very similar to a version upgrade: stop
- the server, get the code, update config files for the new functionality,
- install libraries and do migrations, update the init script, start the
- application and check its status.
+- [Source CE to EE update guides][source-ce-to-ee] - The steps are very similar
+ to a version upgrade: stop the server, get the code, update config files for
+ the new functionality, install libraries and do migrations, update the init
+ script, start the application and check its status.
- [Omnibus CE to EE][omni-ce-ee] - Follow this guide to update your Omnibus
GitLab Community Edition to the Enterprise Edition.
@@ -138,9 +147,13 @@ possible.
upgrading a PostgreSQL database with minimal downtime.
[omnidocker]: http://docs.gitlab.com/omnibus/docker/README.html
-[source-ee]: https://gitlab.com/gitlab-org/gitlab-ee/tree/master/doc/update
-[source-ce]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/update
+[old-ee-upgrade-docs]: https://gitlab.com/gitlab-org/gitlab-ee/tree/11-8-stable-ee/doc/update
+[old-ce-upgrade-docs]: https://gitlab.com/gitlab-org/gitlab-ce/tree/11-8-stable/doc/update
+[source-ce-to-ee]: upgrading_from_ce_to_ee.md
[ee-ce]: ../downgrade_ee_to_ce/README.md
[ce]: https://about.gitlab.com/features/#community
[ee]: https://about.gitlab.com/features/#enterprise
[omni-ce-ee]: https://docs.gitlab.com/omnibus/update/README.html#updating-community-edition-to-enterprise-edition
+[omni-docker]: https://docs.gitlab.com/omnibus/docker/README.html
+[omni-update]: https://docs.gitlab.com/omnibus/update/README.html
+[omni-zero-downtime]: https://docs.gitlab.com/omnibus/update/README.html#zero-downtime-updates