Skip to content
Snippets Groups Projects
Commit 741db1ed authored by Marin Jankovski's avatar Marin Jankovski
Browse files

Add maintenance docs and reorganize main readme.

parent 2ba876f0
No related branches found
No related tags found
1 merge request!410Major docs update
Hide whitespace changes
Inline Side-by-side
README.md
+ 12
− 95
View file @ 741db1ed
@@ -27,6 +27,17 @@ Omnibus GitLab is using a fork of [omnibus project](https://github.com/chef/omni
To setup GitLab CI please see the [separate GitLab CI
documentation](doc/gitlab-ci/README.md).
 
## Installation
Please follow the steps on the [downloads page][downloads].
### After installation
Your GitLab instance should reachable over HTTP at the IP or hostname of your server.
You can login as an admin user with username `root` and password `5iveL!fe`.
See [doc/maintenance/README.md](doc/maintenance/README.md) for useful commands to control/debug your GitLab instance.
### Configuration options
 
See [doc/settings/configuration.md](doc/settings/configuration.md).
@@ -113,72 +124,6 @@ See [doc/settings/nginx.md](doc/settings/nginx.md).
 
See [doc/settings/configuration.md](doc/settings/configuration.md#only-start-omnibus-gitlab-services-after-a-given-filesystem-is-mounted).
 
## Installation
Please follow the steps on the [downloads page][downloads].
### After installation
Run `sudo gitlab-ctl status`; the output should look like this:
```
run: nginx: (pid 972) 7s; run: log: (pid 971) 7s
run: postgresql: (pid 962) 7s; run: log: (pid 959) 7s
run: redis: (pid 964) 7s; run: log: (pid 963) 7s
run: sidekiq: (pid 967) 7s; run: log: (pid 966) 7s
run: unicorn: (pid 961) 7s; run: log: (pid 960) 7s
```
If any of the processes is not behaving like expected, try tailing their logs
to see what is wrong.
```
sudo gitlab-ctl tail postgresql
```
Your GitLab instance should reachable over HTTP at the IP or hostname of your server.
You can login as an admin user with username `root` and password `5iveL!fe`.
#### Starting and stopping
After omnibus-gitlab is installed and configured, your server will have a Runit
service directory (`runsvdir`) process running that gets started at boot via
`/etc/inittab` or the `/etc/init/gitlab-runsvdir.conf` Upstart resource. You
should not have to deal with the `runsvdir` process directly; you can use the
`gitlab-ctl` front-end instead.
You can start, stop or restart GitLab and all of its components with the
following commands.
```shell
# Start all GitLab components
sudo gitlab-ctl start
# Stop all GitLab components
sudo gitlab-ctl stop
# Restart all GitLab components
sudo gitlab-ctl restart
```
Note that on a single-core server it may take up to a minute to restart Unicorn
and Sidekiq. Your GitLab instance will give a 502 error until Unicorn is up
again.
It is also possible to start, stop or restart individual components.
```shell
sudo gitlab-ctl restart sidekiq
```
Unicorn supports zero-downtime reloads. These can be triggered as follows:
```shell
sudo gitlab-ctl hup unicorn
```
Note that you cannot use a Unicorn reload to update the Ruby runtime.
### Updating
 
Instructions for updating your Omnibus installation and upgrading from a manual installation are in the [update doc](doc/update/README.md).
@@ -292,19 +237,7 @@ For details check [backup restore document of GitLab CE](https://gitlab.com/gitl
 
## Invoking Rake tasks
 
To invoke a GitLab Rake task, use `gitlab-rake` (for GitLab) or
`gitlab-ci-rake` (for GitLab CI). For example:
```shell
sudo gitlab-rake gitlab:check
sudo gitlab-ci-rake -T
```
Leave out 'sudo' if you are the 'git' user or the 'gitlab-ci' user.
Contrary to with a traditional GitLab installation, there is no need to change
the user or the `RAILS_ENV` environment variable; this is taken care of by the
`gitlab-rake` and `gitlab-ci-rake` wrapper scripts.
See [doc/maintenance/README.md](doc/maintenance/README.md#invoking-rake-tasks).
 
## Directory structure
 
@@ -356,22 +289,6 @@ See [doc/settings/logs.md](doc/settings/logs.md#logrotate).
 
See [doc/settings/logs.md](doc/settings/logs.md#udp-log-shipping-gitlab-enterprise-edition-only)
 
## Starting a Rails console session
If you need access to a Rails production console for your GitLab installation
you can start one with the command below. Please be warned that it is very easy
to inadvertently modify, corrupt or destroy data from the console.
```shell
# start a Rails console for GitLab
sudo gitlab-rails console
# start a Rails console for GitLab CI
sudo gitlab-ci-rails console
```
This will only work after you have run `gitlab-ctl reconfigure` at least once.
## Using a MySQL database management server (Enterprise Edition only)
 
See [doc/settings/database.md](doc/settings/database.md).
doc/README.md
+ 36
− 25
View file @ 741db1ed
# Omnibus GitLab documentation
 
- [Getting started]()
## Installation
 
- [Package downloads page](https://about.gitlab.com/downloads/)
- [GitLab CI](gitlab-ci/README.md) Set up the GitLab CI coordinator that ships with Omnibus GitLab package.
 
## Updating
## Maintenance
 
- [Note about updating from GitLab 6.6 and higher to 7.10 or newer](doc/update/README.md#updating-from-gitlab-66-and-higher-to-710-or-newer)
- [Updating to the latest version](doc/update/README.md#updating-from-gitlab-66-and-higher-to-the-latest-version)
- [Updating from GitLab 6.6.0.pre1 to 6.6.4](doc/update/README.md#updating-from-gitlab-660pre1-to-664)
- [Downgrading to an earlier version](doc/update/README.md#reverting-to-gitlab-66x-or-later)
- [Upgrading from a non-Omnibus installation to an Omnibus installation using a backup](doc/update/README.md#upgrading-from-non-omnibus-postgresql-to-an-omnibus-installation-in-place)
- [Upgrading from non-Omnibus PostgreSQL to an Omnibus installation in-place](doc/update/README.md#upgrading-from-non-omnibus-postgresql-to-an-omnibus-installation-in-place)
- [Upgrading from non-Omnibus MySQL to an Omnibus installation (version 6.8+)](doc/update/README.md#upgrading-from-non-omnibus-mysql-to-an-omnibus-installation-version-68)
- [RPM error: 'package is already installed' ](doc/update/README.md#rpm-package-is-already-installed-error)
- [Updating from GitLab CI version prior to 5.4.0 to the latest version](doc/update/README.md#updating-from-gitlab-ci-version-prior-to-540-to-the-latest-version)
- [Get service status](doc/maintenance/README.md#get-service-status)
- [Starting and stopping](doc/maintenance/README.md#starting-and-stopping)
- [Invoking Rake tasks](doc/maintenance/README.md#invoking-rake-tasks)
- [Starting a Rails console session](doc/maintenance/README.md#starting-a-rails-console-session)
 
## Configuring
 
- [Configuration options](settings/configuration.md)
- [Configuring the external url](doc/settings/configuration.md#configuring-the-external-url-for-gitlab)
- [Storing git data in an alternative directory](doc/settings/configuration.md#storing-git-data-in-an-alternative-directory)
- [Changing the name of the git user group](doc/settings/configuration.md#changing-the-name-of-the-git-user-group)
- [Specify numeric user and group identifiers](doc/settings/configuration.md#specify-numeric-user-and-group-identifiers)
- [Only start omnibus-gitlab services after a given filesystem is mounted](doc/settings/configuration.md#only-start-omnibus-gitlab-services-after-a-given-filesystem-is-mounted)
- [SMTP](settings/smtp.md)
- [NGINX](settings/nginx.md)
- [LDAP](settings/ldap.md)
@@ -31,23 +28,37 @@
- [Redis](settings/redis.md)
- [Logs](settings/logs.md)
 
## Updating
- [Note about updating from GitLab 6.6 and higher to 7.10 or newer](doc/update/README.md#updating-from-gitlab-66-and-higher-to-710-or-newer)
- [Updating to the latest version](doc/update/README.md#updating-from-gitlab-66-and-higher-to-the-latest-version)
- [Updating from GitLab 6.6.0.pre1 to 6.6.4](doc/update/README.md#updating-from-gitlab-660pre1-to-664)
- [Downgrading to an earlier version](doc/update/README.md#reverting-to-gitlab-66x-or-later)
- [Upgrading from a non-Omnibus installation to an Omnibus installation using a backup](doc/update/README.md#upgrading-from-non-omnibus-postgresql-to-an-omnibus-installation-in-place)
- [Upgrading from non-Omnibus PostgreSQL to an Omnibus installation in-place](doc/update/README.md#upgrading-from-non-omnibus-postgresql-to-an-omnibus-installation-in-place)
- [Upgrading from non-Omnibus MySQL to an Omnibus installation (version 6.8+)](doc/update/README.md#upgrading-from-non-omnibus-mysql-to-an-omnibus-installation-version-68)
- [RPM error: 'package is already installed' ](doc/update/README.md#rpm-package-is-already-installed-error)
- [Updating from GitLab CI version prior to 5.4.0 to the latest version](doc/update/README.md#updating-from-gitlab-ci-version-prior-to-540-to-the-latest-version)
## Troubleshooting
 
- [Apt error: 'The requested URL returned error: 403'](doc/common_installation_problems/README.md#apt-error-the-requested-url-returned-error-403).
- [GitLab is unreachable in my browser](doc/common_installation_problems/README.md#gitlab-is-unreachable-in-my-browser).
- [GitLab CI shows GitLab login page](doc/common_installation_problems/README.md#gitlab-ci-shows-gitlab-login-page).
- [Emails are not being delivered](doc/common_installation_problems/README.md#emails-are-not-being-delivered).
- [Reconfigure freezes at ruby_block[supervise_redis_sleep] action run](doc/common_installation_problems/README.md#reconfigure-freezes-at-ruby_blocksupervise_redis_sleep-action-run).
- [TCP ports for GitLab services are already taken](doc/common_installation_problems/README.md#tcp-ports-for-gitlab-services-are-already-taken).
- [Git SSH access stops working on SELinux-enabled systems](doc/common_installation_problems/README.md#git-ssh-access-stops-working-on-selinux-enabled-systems).
- [Postgres error 'FATAL: could not create shared memory segment: Cannot allocate memory'](doc/common_installation_problems/README.md#postgres-error-fatal-could-not-create-shared-memory-segment-cannot-allocate-memory).
- [Reconfigure complains about the GLIBC version](doc/common_installation_problems/README.md#reconfigure-complains-about-the-glibc-version).
- [Reconfigure fails to create the git user](doc/common_installation_problems/README.md#reconfigure-fails-to-create-the-git-user).
- [Failed to modify kernel parameters with sysctl](doc/common_installation_problems/README.md#failed-to-modify-kernel-parameters-with-sysctl).
- [I am unable to install omnibus-gitlab without root access](doc/common_installation_problems/README.md#i-am-unable-to-install-omnibus-gitlab-without-root-access).
- [gitlab-rake assets:precompile fails with 'Permission denied'](doc/common_installation_problems/README.md#gitlab-rake-assetsprecompile-fails-with-permission-denied).
- ['Short read or OOM loading DB' error](doc/common_installation_problems/README.md#short-read-or-oom-loading-db-error).
 
## Omnibus GitLab developer documentation
 
- [Development Setup](doc/development/README.md)
- [Release process](doc/release/README.md)
- [Building your own package](doc/build/README.md)
### RPM 'package is already installed' error
See [doc/update/README.md.](doc/update/README.md#rpm-package-is-already-installed-error)
# Updating GitLab CI via omnibus-gitlab
## Updating from GitLab CI version prior to 5.4.0 to the latest version
See [doc/update/README.md.](doc/update/README.md#updating-from-gitlab-ci-version-prior-to-540-to-the-latest-version)
doc/maintenance/README.md 0 → 100644
+ 92
− 0
View file @ 741db1ed
# Maintenance commands
## After installation
### Get service status
Run `sudo gitlab-ctl status`; the output should look like this:
```
run: nginx: (pid 972) 7s; run: log: (pid 971) 7s
run: postgresql: (pid 962) 7s; run: log: (pid 959) 7s
run: redis: (pid 964) 7s; run: log: (pid 963) 7s
run: sidekiq: (pid 967) 7s; run: log: (pid 966) 7s
run: unicorn: (pid 961) 7s; run: log: (pid 960) 7s
```
### Tail process logs
See [doc/settings/logs.md.](doc/settings/logs.md)
### Starting and stopping
After omnibus-gitlab is installed and configured, your server will have a Runit
service directory (`runsvdir`) process running that gets started at boot via
`/etc/inittab` or the `/etc/init/gitlab-runsvdir.conf` Upstart resource. You
should not have to deal with the `runsvdir` process directly; you can use the
`gitlab-ctl` front-end instead.
You can start, stop or restart GitLab and all of its components with the
following commands.
```shell
# Start all GitLab components
sudo gitlab-ctl start
# Stop all GitLab components
sudo gitlab-ctl stop
# Restart all GitLab components
sudo gitlab-ctl restart
```
Note that on a single-core server it may take up to a minute to restart Unicorn
and Sidekiq. Your GitLab instance will give a 502 error until Unicorn is up
again.
It is also possible to start, stop or restart individual components.
```shell
sudo gitlab-ctl restart sidekiq
```
Unicorn supports zero-downtime reloads. These can be triggered as follows:
```shell
sudo gitlab-ctl hup unicorn
```
Note that you cannot use a Unicorn reload to update the Ruby runtime.
### Invoking Rake tasks
To invoke a GitLab Rake task, use `gitlab-rake` (for GitLab) or
`gitlab-ci-rake` (for GitLab CI). For example:
```shell
sudo gitlab-rake gitlab:check
sudo gitlab-ci-rake -T
```
Leave out 'sudo' if you are the 'git' user or the 'gitlab-ci' user.
Contrary to with a traditional GitLab installation, there is no need to change
the user or the `RAILS_ENV` environment variable; this is taken care of by the
`gitlab-rake` and `gitlab-ci-rake` wrapper scripts.
### Starting a Rails console session
If you need access to a Rails production console for your GitLab installation
you can start one with the command below. Please be warned that it is very easy
to inadvertently modify, corrupt or destroy data from the console.
```shell
# start a Rails console for GitLab
sudo gitlab-rails console
# start a Rails console for GitLab CI
sudo gitlab-ci-rails console
```
This will only work after you have run `gitlab-ctl reconfigure` at least once.
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