gitlab #27

Supports: bionic xenial
Add to new model

Description

GitLab is a single application for the entire DevOps lifecycle. This makes GitLab unique and makes Concurrent DevOps possible, unlocking your organization from the constraints of a pieced together toolchain. Join us for a live Q&A to learn how GitLab can give you unmatched visibility and higher levels of efficiency in a single application across the DevOps lifecycle.


pipeline status
coverage report

GitLab

This charm provides the GitLab code hosting and CI/CD platform, for use with MySQL as a backend database.

Optionally, a reverse proxy can be placed in front of GitLab by relating this charm to a charm implementing the reverseproxy interface.

Usage

Running the following step will install the GitLab Omnibus package,
with default configuration.
juju deploy gitlab

Before GitLab can be used, you will need to relate it to a
PostgreSQL cluster via the db-admin relation:
juju add-relation gitlab:pgsql postgresql:db-admin

Usage via HTTPS can be achieved by running GitLab behind a reverse
proxy that has been properly configured for the desired external
domain name. A good default reverse proxy is provided by the
haproxy charm.
juju add-relation gitlab:reverseproxy haproxy

Upgrades

GitLab has a fairly strict upgrade policy due to the required
DB migrations which are run on package upgrade. Due to this,
this package will upgrade the package periodically to make sure
that no upgrade steps are missed. If you would like to control
this process manually, you can set a specific package version
you would like to stay on using the version configuration
item. The upgrade action can then be run when you do want to
upgrade. Unset the version option and then run the upgrade
action to upgrade to the latest version, or set a new desired
version in the version option and then run the upgrade
action to upgrade to a new specified version.

Migration

This charm (and GitLab) previously supported installation to
a MySQL database. If you had deployed this charm against MySQL,
you must migrate to PostgreSQL to keep using it, as GitLab
has deprecated support for MySQL as of the 12.1 release. Deploying
with MySQL is unsupported, as GitLab no longer actually
works with MySQL as a backend DB.

NOTE: There is a chance the following process could nuke your
database contents. Or mess up your schema. Always back up your
MySQL database prior to running the migratedb action.
If you have data in your PostgreSQL database, you should back
that up too, as the migration will very likely remove it if
there is already a gitlab database there.

ALSO NOTE: The migration and schema manipulation in upstream
GitLab is fragile. Given the official guidance is to upgrade
before upgrading to 12.1, if you have already upgraded or have
not upgraded in a while prior to attempting the migration, you
will need to carefully control the upgrade process (per the
above process) until you reach version 12.0.9, perform the
migration, and then continue any other upgrades. Failure to do
so will get your MySQL database schema and upgrade out of date.
The charm has some safety in place, as if you are on the latest
charm, and have MySQL related, it will cease upgrades and
reconfigurations. You can run both manually as you upgrade using
the upgrade and reconfigure actions which relate directly to
the apt package upgrades and gitlab-ctl reconfigure calls in
the upstream migration
documentation
.

In order to migrate, deploy a new cs:postgresql unit or cluster, and
relate the db-admin relation from the PostgreSQL charm to this
charm's pgsql relation. Do not remove the MySQL relation yet, as
the MySQL credentials will be stored in the charm's key/value
store and used to migrate data from the old database. Once the
relation to PostgreSQL is healthy, you can use the migratedb
action to migrate your data using pgloader. Once this is complete,
remove the MySQL relation, and GitLab will be reconfigured to use
the new PostgreSQL database. Migrations will run automatically.
If there is any issue with the migration process, the charm will
enter error state - the charm debug-log will be helpful in
determining the problem, and manual intervention will likely be
required. If all goes well, no further action will be required
to continue using PostgreSQL.

Contact Information

This charm is written by James Hebden of the Pirate Charmers group.

Planned features

  • configuration of SMTP settings
  • administrative password management via juju config
  • specify option to pass hostname over reverseproxy relation
  • specify option to override address used for reverseproxy
  • interface for relating GitLab CI runners (WIP)

Configuration

apt_key
(string) The APT signing key used for the repository specified by apt_repo
3F01618A51312F3F
apt_repo
(string) The APT source repository to configure before installing GitLab. The Ubuntu distribution, component, /ubuntu suffix, as well as package type (gitlab-ce/gitlab-ee) will be appended. e.g. gitlab-ce/ubuntu bionic main
https://packages.gitlab.com/gitlab
backup-count
(int) Number of backups to keep
backup-cron
(string) Interval to create backup, takes a cron compatible string
@daily
backup-location
(string) Location to store backups
email_display_name
(string) Display name for emails from gitlab. Defaults to GitLab
email_from
(string) Email address from which gitlab will send email. Defaults to gitlab@external_url.
email_reply_to
(string) Email address to be used as reply-to for emails from gitlab. Defaults to noreply@external_url.
external_url
(string) The external URI of this GitLab install. This will be used to configure GitLab, and any reverse proxy configured via the reverseproxy relation. Defaults to the fqdn of the unit.
http_port
(int) The HTTP port the GitLab backend will listen for connections on. It is recommended to relate this charm to a reverse proxy, rather than customising this value
80
package_name
(string) The package to use. Options are gitlab-ce for the FOSS version of gitlab-ee for the Enterprise Edition.
gitlab-ce
proxy_ssh_port
(int) The external TCP port over which SSH-based git clone operations will be available, when GitLab is related to an external load balancer via the reverseproxy relation. Without a reverseproxy relation, ssh_port is used.
222
proxy_via_ip
(boolean) Register IP rather than FQDN with the reverseproxy to support environments without DNS resolution of the host.
runners_bypass_proxy
(boolean) Register runners with fqdn even if a proxy is in use. The default value of False will register runners through the reverseproxy if present.
smtp_authentication
(string) Used to override the authentication method to use when external SMTP is in use.
login
smtp_domain
(string) HELO domain. Will default to the server name, influenced by the external URL configured.
smtp_password
(string) If both smtp_user and smtp_password are set, authentication will be used with the provided credentials when connecting to the configured external SMTP server.
smtp_port
(int) When using external SMTP, this setting allows you to customise the TCP port used to connect to the SMTP server.
25
smtp_server
(string) Set the external SMTP host to use when sending emails from GitLab. If unset, will default to local MTA.
smtp_tls
(boolean) Set this to true to enable TLS when connecting to the configured external SMTP server.
smtp_user
(string) If both smtp_user and smtp_password are set, authentication will be used with the provided credentials when connecting to the configured external SMTP server.
ssh_port
(int) The internal TCP port on which SSH-based git clone operations will be available. Port 22 by default.
22
version
(string) The version of GitLab to install. Defaults (when this setting is empty) to latest.