@@ -21,7 +21,7 @@ First, you'll need an account on Azure. There are three ways to do this:
services, exploring Microsoft's cloud for free. Even after the first 30 days, you never have to pay
anything unless you decide to transition to paid services with a Pay-As-You-Go Azure subscription.
This is a great way to try out Azure and cloud computing, and you can
[read more in their comprehensive FAQ][Azure-Free-Account-FAQ].
[read more in their comprehensive FAQ](https://azure.microsoft.com/en-us/free/free-account-faq/).
- If you have an MSDN subscription, you can activate your Azure subscriber benefits. Your MSDN
subscription gives you recurring Azure credits every month, so why not put those credits to use and
try out GitLab right now?
...
...
@@ -73,7 +73,7 @@ The first items we need to configure are the basic settings of the underlying vi
_(read the [SSH documentation](../../ssh/README.md) to learn more about how to set up SSH
public keys)_
1. If you chose **Password** - enter the password you wish to use _(this is the password that you
will use later in this tutorial to [SSH] into the VM, so make sure it's a strong password/passphrase)_
will use later in this tutorial to [SSH](https://en.wikipedia.org/wiki/Secure_Shell) into the VM, so make sure it's a strong password/passphrase)_
1. Choose the appropriate `Subscription` tier for your Azure account
1. Choose an existing `Resource Group` or create a new one - e.g. **"GitLab-CE-Azure"**
...
...
@@ -177,7 +177,7 @@ Click **"Save"** for the changes to take effect.
domain registrar which points to the public IP address of your Azure VM. If you do this, you'll need
to make sure your VM is configured to use a _static_ public IP address (i.e. not a _dynamic_ one)
or you will have to reconfigure the DNS `A` record each time Azure reassigns your VM a new public IP
address. Read [IP address types and allocation methods in Azure][Azure-IP-Address-Types] to learn more.
address. Read [IP address types and allocation methods in Azure](https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-ip-addresses-overview-arm) to learn more.
## Let's open some ports
...
...
@@ -216,7 +216,7 @@ ports to enable public internet access to two services in particular:
public access to the instance of GitLab running on our VM.
1.**SSH** (port 22) - opening port 22 will enable our VM to respond to SSH connection requests,
allowing public access (with authentication) to remote terminal sessions
_(you'll see why we need [SSH] access to our VM [later on in this tutorial](#maintaining-your-gitlab-instance))_
_(you'll see why we need [SSH](https://en.wikipedia.org/wiki/Secure_Shell) access to our VM [later on in this tutorial](#maintaining-your-gitlab-instance))_
### Open HTTP on Port 80
...
...
@@ -233,7 +233,7 @@ connections:
### Open SSH on Port 22
Repeat the above process, adding a second Inbound security rule to open port 22, enabling our VM to
@@ -327,7 +327,7 @@ process will still be the same.
To perform an update, we need to connect directly to our Azure VM instance and run some commands
from the terminal. Our Azure VM is actually a server running Linux (Ubuntu), so we'll need to
connect to it using SSH ([Secure Shell][SSH]).
connect to it using SSH ([Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell)).
If you're running Windows, you'll need to connect using [PuTTY](https://www.putty.org) or an equivalent Windows SSH client.
If you're running Linux or macOS, then you already have an SSH client installed.
...
...
@@ -341,7 +341,7 @@ If you're running Linux or macOS, then you already have an SSH client installed.
#### SSH from the command-line
If you're running [SSH] from the command-line (terminal), then type in the following command to
If you're running [SSH](https://en.wikipedia.org/wiki/Secure_Shell) from the command-line (terminal), then type in the following command to
connect to your VM, substituting `username` and `your-azure-domain-name.com` for the correct values.
Again, remember that your Azure VM domain name will be the one you
...
...
@@ -356,8 +356,8 @@ Provide your password at the prompt to authenticate.
#### SSH from Windows (PuTTY)
If you're using [PuTTY](https://www.putty.org) in Windows as your [SSH] client, then you might want to take a quick
read on [using PuTTY in Windows][Using-SSH-In-Putty].
If you're using [PuTTY](https://www.putty.org) in Windows as your [SSH](https://en.wikipedia.org/wiki/Secure_Shell) client, then you might want to take a quick
read on [using PuTTY in Windows](https://mediatemple.net/community/products/dv/204404604/using-ssh-in-putty-).
### Updating GitLab
...
...
@@ -412,31 +412,16 @@ Check out our other [Technical Articles](../../articles/index.md) or browse the
-[Azure - Troubleshoot SSH Connections to an Azure Linux VM](https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshoot-ssh-connection)
-[Azure - Properly Shutdown an Azure VM](https://build5nines.com/properly-shutdown-azure-vm-to-save-money/)
-[SSH], [PuTTY](https://www.putty.org) and [Using SSH in PuTTY][Using-SSH-In-Putty]
[Original-Blog-Post]:https://about.gitlab.com/blog/2016/07/13/how-to-setup-a-gitlab-instance-on-microsoft-azure/"How to Set up a GitLab Instance on Microsoft Azure"
[Azure-Troubleshoot-Linux-VM]:https://docs.microsoft.com/en-us/azure/virtual-machines/linux/troubleshoot-app-connection"Troubleshoot application connectivity issues on a Linux virtual machine in Azure"
[Azure-IP-Address-Types]:https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-ip-addresses-overview-arm"IP address types and allocation methods in Azure"
[Azure-How-To-Open-Ports]:https://docs.microsoft.com/en-us/azure/virtual-machines/windows/nsg-quickstart-portal"How to open ports to a virtual machine with the Azure portal"
-[SSH](https://en.wikipedia.org/wiki/Secure_Shell), [PuTTY](https://www.putty.org) and [Using SSH in PuTTY](https://mediatemple.net/community/products/dv/204404604/using-ssh-in-putty-)
This guide will help you install GitLab on a [Google Cloud Platform (GCP)][gcp] instance.
This guide will help you install GitLab on a [Google Cloud Platform (GCP)](https://cloud.google.com/) instance.
NOTE: **Alternative installation method:**
Google provides a whitepaper for [deploying production-ready GitLab on
...
...
@@ -19,7 +19,7 @@ There are only two prerequisites in order to install GitLab on GCP:
1. You need to have a Google account.
1. You need to sign up for the GCP program. If this is your first time, Google
gives you [$300 credit for free][freetrial] to consume over a 60-day period.
gives you [$300 credit for free](https://console.cloud.google.com/freetrial) to consume over a 60-day period.
Once you have performed those two steps, you can [create a VM](#creating-the-vm).
...
...
@@ -37,7 +37,7 @@ To deploy GitLab on GCP you first need to create a virtual machine:
1. Click **Change** under Boot disk to select the size, type, and desired operating system. GitLab supports a [variety of linux operating systems][req], including Ubuntu and Debian. Click **Select** when finished.
1. Click **Change** under Boot disk to select the size, type, and desired operating system. GitLab supports a [variety of linux operating systems](../requirements.md), including Ubuntu and Debian. Click **Select** when finished.
...
...
@@ -85,7 +85,7 @@ here's how you configure GitLab to be aware of the change:
In the future you might want to set up [connecting with an SSH key][ssh]
In the future you might want to set up [connecting with an SSH key](https://cloud.google.com/compute/docs/instances/connecting-to-instance)
instead.
1. Edit the config file of Omnibus GitLab using your favorite text editor:
...
...
@@ -114,13 +114,13 @@ here's how you configure GitLab to be aware of the change:
### Configuring HTTPS with the domain name
Although not needed, it's strongly recommended to secure GitLab with a TLS
certificate. Follow the steps in the [Omnibus documentation][omni-ssl].
certificate. Follow the steps in the [Omnibus documentation](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https).
### Configuring the email SMTP settings
You need to configure the email SMTP settings correctly otherwise GitLab will
not be able to send notification emails, like comments, and password changes.
Check the [Omnibus documentation][omni-smtp] how to do so.
Check the [Omnibus documentation](https://docs.gitlab.com/omnibus/settings/smtp.html#smtp-settings) how to do so.
## Further reading
...
...
@@ -132,13 +132,6 @@ Kerberos, etc. Here are some documents you might be interested in reading:
@@ -205,7 +205,7 @@ The Ruby interpreter is required to run GitLab.
**Note:** The current supported Ruby (MRI) version is 2.6.x. GitLab 12.2
dropped support for Ruby 2.5.x.
The use of Ruby version managers such as [RVM], [rbenv](https://github.com/rbenv/rbenv) or [chruby] with GitLab
The use of Ruby version managers such as [RVM](https://rvm.io/), [rbenv](https://github.com/rbenv/rbenv) or [chruby](https://github.com/postmodern/chruby) with GitLab
in production, frequently leads to hard to diagnose problems. For example,
GitLab Shell is called from OpenSSH, and having a version manager can prevent
pushing and pulling over SSH. Version managers are not supported and we strongly
...
...
@@ -1035,6 +1035,3 @@ On RedHat/CentOS:
```shell
sudo yum groupinstall 'Development Tools'
```
[RVM]:https://rvm.io/"RVM Homepage"
[chruby]:https://github.com/postmodern/chruby"chruby on GitHub"
[OpenShift Origin](https://www.okd.io/)(**Note:** renamed to OKD in Aug 2018) is an open source container application
platform created by [RedHat], based on [Kubernetes](https://kubernetes.io/) and [Docker]. That means
platform created by [RedHat](https://www.redhat.com/en), based on [Kubernetes](https://kubernetes.io/) and [Docker](https://www.docker.com). That means
you can host your own PaaS for free and almost with no hassle.
In this tutorial, we will see how to deploy GitLab in OpenShift using GitLab's
...
...
@@ -34,16 +34,16 @@ offered by the OpenShift developers and managed by Vagrant. If you haven't done
already, go ahead and install the following components as they are essential to
-[OpenShift Client](https://docs.okd.io/3.11/cli_reference/get_started_cli.html)(`oc` for short)
It is also important to mention that for the purposes of this tutorial, the
latest Origin release is used:
-**oc**`v1.3.0` (must be [installed][oc-gh] locally on your computer)
-**OpenShift**`v1.3.0` (is pre-installed in the [VM image][vm-new])
-**Kubernetes**`v1.3.0` (is pre-installed in the [VM image][vm-new])
-**oc**`v1.3.0` (must be [installed](https://github.com/openshift/origin/releases/tag/v1.3.0) locally on your computer)
-**OpenShift**`v1.3.0` (is pre-installed in the [VM image](https://app.vagrantup.com/openshift/boxes/origin-all-in-one))
-**Kubernetes**`v1.3.0` (is pre-installed in the [VM image](https://app.vagrantup.com/openshift/boxes/origin-all-in-one))
>**Note:**
If you intend to deploy GitLab on a production OpenShift cluster, there are some
...
...
@@ -302,7 +302,7 @@ template:
-`gitlab-ce-postgresql`
While PostgreSQL and Redis are bundled in Omnibus GitLab, the template is using
separate images as you can see from [this line][line] in the template.
separate images as you can see from [this line](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/658c065c8d022ce858dd63eaeeadb0b2ddc8deea/docker/openshift-template.json#L239) in the template.
The predefined values have been calculated for the purposes of testing out
GitLab in the all-in-one VM. You don't need to change anything here, hit
...
...
@@ -371,7 +371,7 @@ running scaled to 2.
Upping the GitLab pods is actually like adding new application servers to your
cluster. You can see how that would work if you didn't use GitLab with
OpenShift by following the [HA documentation][ha] for the application servers.
OpenShift by following the [HA documentation](../../administration/high_availability/gitlab.md) for the application servers.
Bare in mind that you may need more resources (CPU, RAM, disk space) when you
scale up. If a pod is in pending state for too long, you can navigate to
...
...
@@ -505,14 +505,3 @@ And remember that in this tutorial we just scratched the surface of what Origin
is capable of. As always, you can refer to the detailed
[documentation](https://docs.okd.io) to learn more about deploying your own OpenShift
PaaS and managing your applications with the ease of containers.
@@ -10,7 +10,7 @@ be installed under a relative URL, for example `https://example.com/gitlab`.
This document describes how to run GitLab under a relative URL for installations
from source. If you are using an Omnibus package,
[the steps are different][omnibus-rel]. Use this guide along with the
[the steps are different](https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-a-relative-url-for-gitlab). Use this guide along with the
[installation guide](installation.md) if you are installing GitLab for the
first time.
...
...
@@ -30,7 +30,7 @@ serve GitLab under a relative URL is:
-`/home/git/gitlab-shell/config.yml`
-`/etc/default/gitlab`
After all the changes you need to recompile the assets and [restart GitLab].
After all the changes you need to recompile the assets and [restart GitLab](../administration/restart_gitlab.md#installations-from-source).
## Relative URL requirements
...
...
@@ -112,7 +112,7 @@ Make sure to follow all steps below:
If you are using a custom init script, make sure to edit the above
GitLab Workhorse setting as needed.
1.[Restart GitLab][] for the changes to take effect.
1.[Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect.
## Disable relative URL in GitLab
...
...
@@ -123,9 +123,6 @@ To disable the relative URL:
1. Follow the same as above starting from 2. and set up the
GitLab URL to one that doesn't contain a relative path.
[omnibus-rel]:https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-a-relative-url-for-gitlab"How to set up relative URL in Omnibus GitLab"
[restart gitlab]:../administration/restart_gitlab.md#installations-from-source"How to restart GitLab"
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
@@ -13,7 +13,7 @@ Based on your installation, choose a section below that fits your needs.
## Omnibus Packages
- The [Omnibus update guide][omni-update]
- The [Omnibus update guide](https://docs.gitlab.com/omnibus/update/README.html)
contains the steps needed to update an Omnibus GitLab package.
## Installation from source
...
...
@@ -29,14 +29,14 @@ 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]
-[Old upgrading guidelines for Community Edition](https://gitlab.com/gitlab-org/gitlab-foss/tree/11-8-stable/doc/update)
-[Old upgrading guidelines for Enterprise Edition](https://gitlab.com/gitlab-org/gitlab/tree/11-8-stable-ee/doc/update)
## 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][omni-docker].
update them are in [a separate document](https://docs.gitlab.com/omnibus/docker/README.html).
## Upgrading without downtime
...
...
@@ -106,7 +106,7 @@ meet the other online upgrade requirements mentioned above.
### Steps
Steps to [upgrade without downtime][omni-zero-downtime].
Steps to [upgrade without downtime](https://docs.gitlab.com/omnibus/update/README.html#zero-downtime-updates).
## Checking for background migrations before upgrading
...
...
@@ -163,8 +163,8 @@ of the `background_migration` queue, [check for background migrations before upg
## Upgrading between editions
GitLab comes in two flavors: [Community Edition][ce] which is MIT licensed,
and [Enterprise Edition][ee] which builds on top of the Community Edition and
GitLab comes in two flavors: [Community Edition](https://about.gitlab.com/features/#community) which is MIT licensed,
and [Enterprise Edition](https://about.gitlab.com/features/#enterprise) which builds on top of the Community Edition and
includes extra features mainly aimed at organizations with more than 100 users.
Below you can find some guides to help you change editions easily.
...
...
@@ -177,17 +177,17 @@ 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-ce-to-ee] - The steps are very similar
-[Source CE to EE update guides](upgrading_from_ce_to_ee.md) - 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
-[Omnibus CE to EE](https://docs.gitlab.com/omnibus/update/README.html#updating-community-edition-to-enterprise-edition) - Follow this guide to update your Omnibus
GitLab Community Edition to the Enterprise Edition.
### Enterprise to Community Edition
If you need to downgrade your Enterprise Edition installation back to Community
Edition, you can follow [this guide][ee-ce] to make the process as smooth as
Edition, you can follow [this guide](../downgrade_ee_to_ce/README.md) to make the process as smooth as
possible.
## Version specific upgrading instructions
...
...
@@ -227,15 +227,3 @@ for more information.
-[Restoring from backup after a failed upgrade](restore_after_failure.md)
-[Upgrading PostgreSQL Using Slony](upgrading_postgresql_using_slony.md), for
upgrading a PostgreSQL database with minimal downtime.
