Skip to content

G
gitlab-ce
Commit 60c8298d authored by Marcel Amirault's avatar Marcel Amirault
Browse files
Options

Merge branch 'selhorn-reflinks' into 'master' 

Replaced ref links with inline ones

See merge request gitlab-org/gitlab!28389
parents 4014a8cb c8ec702e
Show whitespace changes
Inline Side-by-side
Showing with 57 additions and 96 deletions
doc/administration/job_artifacts.md
View file @ 60c8298d
...@@ -21,7 +21,7 @@ To disable artifacts site-wide, follow the steps below. ...@@ -21,7 +21,7 @@ To disable artifacts site-wide, follow the steps below.
gitlab_rails['artifacts_enabled'] = false gitlab_rails['artifacts_enabled'] = false
``` ```
1. Save the file and [reconfigure GitLab][] for the changes to take effect. 1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
**In installations from source:** **In installations from source:**
...@@ -32,7 +32,7 @@ To disable artifacts site-wide, follow the steps below. ...@@ -32,7 +32,7 @@ To disable artifacts site-wide, follow the steps below.
enabled: false enabled: false
``` ```
1. Save the file and [restart GitLab][] for the changes to take effect. 1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect.
## Storing job artifacts ## Storing job artifacts
...@@ -57,7 +57,7 @@ _The artifacts are stored by default in ...@@ -57,7 +57,7 @@ _The artifacts are stored by default in
gitlab_rails['artifacts_path'] = "/mnt/storage/artifacts" gitlab_rails['artifacts_path'] = "/mnt/storage/artifacts"
``` ```
1. Save the file and [reconfigure GitLab][] for the changes to take effect. 1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
**In installations from source:** **In installations from source:**
...@@ -73,7 +73,7 @@ _The artifacts are stored by default in ...@@ -73,7 +73,7 @@ _The artifacts are stored by default in
path: /mnt/storage/artifacts path: /mnt/storage/artifacts
``` ```
1. Save the file and [restart GitLab][] for the changes to take effect. 1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect.
### Using object storage ### Using object storage
...@@ -153,7 +153,7 @@ _The artifacts are stored by default in ...@@ -153,7 +153,7 @@ _The artifacts are stored by default in
} }
``` ```
1. Save the file and [reconfigure GitLab][] for the changes to take effect. 1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
1. Migrate any existing local artifacts to the object storage: 1. Migrate any existing local artifacts to the object storage:
```shell ```shell
...@@ -186,7 +186,7 @@ _The artifacts are stored by default in ...@@ -186,7 +186,7 @@ _The artifacts are stored by default in
region: eu-central-1 region: eu-central-1
``` ```
1. Save the file and [restart GitLab][] for the changes to take effect. 1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect.
1. Migrate any existing local artifacts to the object storage: 1. Migrate any existing local artifacts to the object storage:
```shell ```shell
...@@ -205,13 +205,13 @@ by the `gitlab:artifacts:migrate` script. ...@@ -205,13 +205,13 @@ by the `gitlab:artifacts:migrate` script.
In order to migrate back to local storage: In order to migrate back to local storage:
1. Set both `direct_upload` and `background_upload` to false in `gitlab.rb`, under the artifacts object storage settings. 1. Set both `direct_upload` and `background_upload` to false in `gitlab.rb`, under the artifacts object storage settings.
1. [reconfigure GitLab][]. 1. [Reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure).
1. Run `gitlab-rake gitlab:artifacts:migrate_to_local`. 1. Run `gitlab-rake gitlab:artifacts:migrate_to_local`.
1. Disable object_storage for artifacts in `gitlab.rb`: 1. Disable object_storage for artifacts in `gitlab.rb`:
- Set `gitlab_rails['artifacts_object_store_enabled'] = false`. - Set `gitlab_rails['artifacts_object_store_enabled'] = false`.
- Comment out all other `artifacts_object_store` settings, including the entire - Comment out all other `artifacts_object_store` settings, including the entire
`artifacts_object_store_connection` section, including the closing `}`. `artifacts_object_store_connection` section, including the closing `}`.
1. [reconfigure GitLab][]. 1. [Reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure).
## Expiring artifacts ## Expiring artifacts
...@@ -231,7 +231,7 @@ steps below. ...@@ -231,7 +231,7 @@ steps below.
gitlab_rails['expire_build_artifacts_worker_cron'] = "50 * * * *" gitlab_rails['expire_build_artifacts_worker_cron'] = "50 * * * *"
``` ```
1. Save the file and [reconfigure GitLab][] for the changes to take effect. 1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
**In installations from source:** **In installations from source:**
...@@ -243,7 +243,7 @@ steps below. ...@@ -243,7 +243,7 @@ steps below.
cron: "50 * * * *" cron: "50 * * * *"
``` ```
1. Save the file and [restart GitLab][] for the changes to take effect. 1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect.
## Validation for dependencies ## Validation for dependencies
...@@ -295,7 +295,7 @@ and [projects APIs](../api/projects.md). ...@@ -295,7 +295,7 @@ and [projects APIs](../api/projects.md).
## Implementation details ## Implementation details
When GitLab receives an artifacts archive, an archive metadata file is also When GitLab receives an artifacts archive, an archive metadata file is also
generated by [GitLab Workhorse]. This metadata file describes all the entries generated by [GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse). This metadata file describes all the entries
that are located in the artifacts archive itself. that are located in the artifacts archive itself.
The metadata file is in a binary format, with additional GZIP compression. The metadata file is in a binary format, with additional GZIP compression.
...@@ -304,14 +304,10 @@ and disk I/O. It instead inspects the metadata file which contains all the ...@@ -304,14 +304,10 @@ and disk I/O. It instead inspects the metadata file which contains all the
relevant information. This is especially important when there is a lot of relevant information. This is especially important when there is a lot of
artifacts, or an archive is a very large file. artifacts, or an archive is a very large file.
When clicking on a specific file, [GitLab Workhorse] extracts it When clicking on a specific file, [GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse) extracts it
from the archive and the download begins. This implementation saves space, from the archive and the download begins. This implementation saves space,
memory and disk I/O. memory and disk I/O.
[reconfigure gitlab]: restart_gitlab.md#omnibus-gitlab-reconfigure "How to reconfigure Omnibus GitLab"
[restart gitlab]: restart_gitlab.md#installations-from-source "How to restart GitLab"
[gitlab workhorse]: https://gitlab.com/gitlab-org/gitlab-workhorse "GitLab Workhorse repository"
## Troubleshooting ## Troubleshooting
### Job artifacts using too much disk space ### Job artifacts using too much disk space
......
doc/administration/pages/index.md
View file @ 60c8298d
...@@ -4,14 +4,14 @@ description: 'Learn how to administer GitLab Pages.' ...@@ -4,14 +4,14 @@ description: 'Learn how to administer GitLab Pages.'
# GitLab Pages administration # GitLab Pages administration
> - [Introduced][ee-80] in GitLab EE 8.3. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80) in GitLab EE 8.3.
> - Custom CNAMEs with TLS support were [introduced][ee-173] in GitLab EE 8.5. > - Custom CNAMEs with TLS support were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173) in GitLab EE 8.5.
> - GitLab Pages [was ported][ce-14605] to Community Edition in GitLab 8.17. > - GitLab Pages [was ported](https://gitlab.com/gitlab-org/gitlab-foss/issues/14605) to Community Edition in GitLab 8.17.
> - Support for subgroup project's websites was > - Support for subgroup project's websites was
> [introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/30548) in GitLab 11.8. > [introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/30548) in GitLab 11.8.
GitLab Pages allows for hosting of static sites. It must be configured by an GitLab Pages allows for hosting of static sites. It must be configured by an
administrator. Separate [user documentation][pages-userguide] is available. administrator. Separate [user documentation](../../user/project/pages/index.md) is available.
NOTE: **Note:** NOTE: **Note:**
This guide is for Omnibus GitLab installations. If you have installed This guide is for Omnibus GitLab installations. If you have installed
...@@ -20,11 +20,11 @@ GitLab from source, see ...@@ -20,11 +20,11 @@ GitLab from source, see
## Overview ## Overview
GitLab Pages makes use of the [GitLab Pages daemon], a simple HTTP server GitLab Pages makes use of the [GitLab Pages daemon](https://gitlab.com/gitlab-org/gitlab-pages), a simple HTTP server
written in Go that can listen on an external IP address and provide support for written in Go that can listen on an external IP address and provide support for
custom domains and custom certificates. It supports dynamic certificates through custom domains and custom certificates. It supports dynamic certificates through
SNI and exposes pages using HTTP2 by default. SNI and exposes pages using HTTP2 by default.
You are encouraged to read its [README][pages-readme] to fully understand how You are encouraged to read its [README](https://gitlab.com/gitlab-org/gitlab-pages/blob/master/README.md) to fully understand how
it works. it works.
In the case of [custom domains](#custom-domains) (but not In the case of [custom domains](#custom-domains) (but not
...@@ -124,9 +124,9 @@ The Pages daemon doesn't listen to the outside world. ...@@ -124,9 +124,9 @@ The Pages daemon doesn't listen to the outside world.
pages_external_url 'http://example.io' pages_external_url 'http://example.io'
``` ```
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
Watch the [video tutorial][video-admin] for this configuration. Watch the [video tutorial](https://youtu.be/dD8c7WNcc6s) for this configuration.
### Wildcard domains with TLS support ### Wildcard domains with TLS support
...@@ -156,7 +156,7 @@ outside world. ...@@ -156,7 +156,7 @@ outside world.
where `pages-nginx.crt` and `pages-nginx.key` are the SSL cert and key, where `pages-nginx.crt` and `pages-nginx.key` are the SSL cert and key,
respectively. respectively.
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
### Additional configuration for Docker container ### Additional configuration for Docker container
...@@ -171,7 +171,7 @@ behavior: ...@@ -171,7 +171,7 @@ behavior:
gitlab_pages['inplace_chroot'] = true gitlab_pages['inplace_chroot'] = true
``` ```
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
NOTE: **Note:** NOTE: **Note:**
`inplace_chroot` option might not work with the other features, such as [Pages Access Control](#access-control). `inplace_chroot` option might not work with the other features, such as [Pages Access Control](#access-control).
...@@ -213,7 +213,7 @@ world. Custom domains are supported, but no TLS. ...@@ -213,7 +213,7 @@ world. Custom domains are supported, but no TLS.
`192.0.2.2` and `2001::2` are the secondary IPs the GitLab Pages daemon `192.0.2.2` and `2001::2` are the secondary IPs the GitLab Pages daemon
listens on. If you don't have IPv6, you can omit the IPv6 address. listens on. If you don't have IPv6, you can omit the IPv6 address.
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
### Custom domains with TLS support ### Custom domains with TLS support
...@@ -247,7 +247,7 @@ world. Custom domains and TLS are supported. ...@@ -247,7 +247,7 @@ world. Custom domains and TLS are supported.
`192.0.2.2` and `2001::2` are the secondary IPs where the GitLab Pages daemon `192.0.2.2` and `2001::2` are the secondary IPs where the GitLab Pages daemon
listens on. If you don't have IPv6, you can omit the IPv6 address. listens on. If you don't have IPv6, you can omit the IPv6 address.
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
### Custom domain verification ### Custom domain verification
...@@ -304,7 +304,7 @@ Pages access control is disabled by default. To enable it: ...@@ -304,7 +304,7 @@ Pages access control is disabled by default. To enable it:
gitlab_pages['access_control'] = true gitlab_pages['access_control'] = true
``` ```
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
1. Users can now configure it in their [projects' settings](../../user/project/pages/pages_access_control.md). 1. Users can now configure it in their [projects' settings](../../user/project/pages/pages_access_control.md).
#### Disabling public access to all Pages websites #### Disabling public access to all Pages websites
...@@ -340,7 +340,7 @@ pages: ...@@ -340,7 +340,7 @@ pages:
gitlab_pages['http_proxy'] = 'http://example:8080' gitlab_pages['http_proxy'] = 'http://example:8080'
``` ```
1. [Reconfigure GitLab][reconfigure] for the changes to take effect. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
### Using a custom Certificate Authority (CA) ### Using a custom Certificate Authority (CA)
...@@ -389,7 +389,7 @@ Follow the steps below to configure verbose logging of GitLab Pages daemon. ...@@ -389,7 +389,7 @@ Follow the steps below to configure verbose logging of GitLab Pages daemon.
gitlab_pages['log_verbose'] = true gitlab_pages['log_verbose'] = true
``` ```
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
## Change storage path ## Change storage path
...@@ -404,7 +404,7 @@ are stored. ...@@ -404,7 +404,7 @@ are stored.
gitlab_rails['pages_path'] = "/mnt/storage/pages" gitlab_rails['pages_path'] = "/mnt/storage/pages"
``` ```
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
## Configure listener for reverse proxy requests ## Configure listener for reverse proxy requests
...@@ -427,7 +427,7 @@ Omnibus GitLab 11.1. ...@@ -427,7 +427,7 @@ Omnibus GitLab 11.1.
gitlab_pages['listen_proxy'] = "localhost:10080" gitlab_pages['listen_proxy'] = "localhost:10080"
``` ```
1. [Reconfigure GitLab][reconfigure]. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
## Set maximum pages size ## Set maximum pages size
...@@ -559,7 +559,7 @@ then you must use the following procedure to configure [access control](#access- ...@@ -559,7 +559,7 @@ then you must use the following procedure to configure [access control](#access-
## Backup ## Backup
GitLab Pages are part of the [regular backup][backup], so there is no separate backup to configure. GitLab Pages are part of the [regular backup](../../raketasks/backup_restore.md), so there is no separate backup to configure.
## Security ## Security
...@@ -610,16 +610,3 @@ The fix is to correct the source file permissions and restart Pages: ...@@ -610,16 +610,3 @@ The fix is to correct the source file permissions and restart Pages:
sudo chmod 644 /opt/gitlab/embedded/ssl/certs/cacert.pem sudo chmod 644 /opt/gitlab/embedded/ssl/certs/cacert.pem
sudo gitlab-ctl restart gitlab-pages sudo gitlab-ctl restart gitlab-pages
``` ```
[backup]: ../../raketasks/backup_restore.md
[ce-14605]: https://gitlab.com/gitlab-org/gitlab-foss/issues/14605
[ee-80]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80
[ee-173]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173
[gitlab pages daemon]: https://gitlab.com/gitlab-org/gitlab-pages
[NGINX configs]: https://gitlab.com/gitlab-org/gitlab/tree/8-5-stable-ee/lib/support/nginx
[pages-readme]: https://gitlab.com/gitlab-org/gitlab-pages/blob/master/README.md
[pages-userguide]: ../../user/project/pages/index.md
[reconfigure]: ../restart_gitlab.md#omnibus-gitlab-reconfigure
[restart]: ../restart_gitlab.md#installations-from-source
[gitlab-pages]: https://gitlab.com/gitlab-org/gitlab-pages/tree/v0.2.4
[video-admin]: https://youtu.be/dD8c7WNcc6s
doc/administration/pages/source.md
View file @ 60c8298d
...@@ -17,12 +17,12 @@ Pages to the latest supported version. ...@@ -17,12 +17,12 @@ Pages to the latest supported version.
## Overview ## Overview
GitLab Pages makes use of the [GitLab Pages daemon], a simple HTTP server GitLab Pages makes use of the [GitLab Pages daemon](https://gitlab.com/gitlab-org/gitlab-pages), a simple HTTP server
written in Go that can listen on an external IP address and provide support for written in Go that can listen on an external IP address and provide support for
custom domains and custom certificates. It supports dynamic certificates through custom domains and custom certificates. It supports dynamic certificates through
SNI and exposes pages using HTTP2 by default. SNI and exposes pages using HTTP2 by default.
You are encouraged to read its [README][pages-readme] to fully understand how You are encouraged to read its [README](https://gitlab.com/gitlab-org/gitlab-pages/blob/master/README.md)
it works. to fully understand how it works.
In the case of [custom domains](#custom-domains) (but not In the case of [custom domains](#custom-domains) (but not
[wildcard domains](#wildcard-domains)), the Pages daemon needs to listen on [wildcard domains](#wildcard-domains)), the Pages daemon needs to listen on
...@@ -55,7 +55,7 @@ Before proceeding with the Pages configuration, make sure that: ...@@ -55,7 +55,7 @@ Before proceeding with the Pages configuration, make sure that:
Pages artifacts. Pages artifacts.
1. (Optional) You have a **wildcard certificate** for the Pages domain if you 1. (Optional) You have a **wildcard certificate** for the Pages domain if you
decide to serve Pages (`*.example.io`) under HTTPS. decide to serve Pages (`*.example.io`) under HTTPS.
1. (Optional but recommended) You have configured and enabled the [Shared Runners][] 1. (Optional but recommended) You have configured and enabled the [Shared Runners](../../ci/runners/README.md)
so that your users don't have to bring their own. so that your users don't have to bring their own.
### DNS configuration ### DNS configuration
...@@ -144,7 +144,7 @@ The Pages daemon doesn't listen to the outside world. ...@@ -144,7 +144,7 @@ The Pages daemon doesn't listen to the outside world.
``` ```
1. Restart NGINX 1. Restart NGINX
1. [Restart GitLab][restart] 1. [Restart GitLab](../restart_gitlab.md#installations-from-source)
### Wildcard domains with TLS support ### Wildcard domains with TLS support
...@@ -201,7 +201,7 @@ outside world. ...@@ -201,7 +201,7 @@ outside world.
``` ```
1. Restart NGINX 1. Restart NGINX
1. [Restart GitLab][restart] 1. [Restart GitLab](../restart_gitlab.md#installations-from-source)
## Advanced configuration ## Advanced configuration
...@@ -272,7 +272,7 @@ world. Custom domains are supported, but no TLS. ...@@ -272,7 +272,7 @@ world. Custom domains are supported, but no TLS.
`0.0.0.0` with `192.0.2.1`, where `192.0.2.1` the primary IP where GitLab `0.0.0.0` with `192.0.2.1`, where `192.0.2.1` the primary IP where GitLab
listens to. listens to.
1. Restart NGINX 1. Restart NGINX
1. [Restart GitLab][restart] 1. [Restart GitLab](../restart_gitlab.md#installations-from-source)
### Custom domains with TLS support ### Custom domains with TLS support
...@@ -341,7 +341,7 @@ world. Custom domains and TLS are supported. ...@@ -341,7 +341,7 @@ world. Custom domains and TLS are supported.
`0.0.0.0` with `192.0.2.1`, where `192.0.2.1` the primary IP where GitLab `0.0.0.0` with `192.0.2.1`, where `192.0.2.1` the primary IP where GitLab
listens to. listens to.
1. Restart NGINX 1. Restart NGINX
1. [Restart GitLab][restart] 1. [Restart GitLab](../restart_gitlab.md#installations-from-source)
## NGINX caveats ## NGINX caveats
...@@ -402,7 +402,7 @@ Pages access control is disabled by default. To enable it: ...@@ -402,7 +402,7 @@ Pages access control is disabled by default. To enable it:
access_control: true access_control: true
``` ```
1. [Restart GitLab][restart]. 1. [Restart GitLab](../restart_gitlab.md#installations-from-source).
1. Create a new [system OAuth application](../../integration/oauth_provider.md#adding-an-application-through-the-profile). 1. Create a new [system OAuth application](../../integration/oauth_provider.md#adding-an-application-through-the-profile).
This should be called `GitLab Pages` and have a `Redirect URL` of This should be called `GitLab Pages` and have a `Redirect URL` of
`https://projects.example.io/auth`. It does not need to be a "trusted" `https://projects.example.io/auth`. It does not need to be a "trusted"
...@@ -435,7 +435,7 @@ are stored. ...@@ -435,7 +435,7 @@ are stored.
path: /mnt/storage/pages path: /mnt/storage/pages
``` ```
1. [Restart GitLab][restart] 1. [Restart GitLab](../restart_gitlab.md#installations-from-source)
## Set maximum Pages size ## Set maximum Pages size
...@@ -445,21 +445,9 @@ The default is 100MB. ...@@ -445,21 +445,9 @@ The default is 100MB.
## Backup ## Backup
Pages are part of the [regular backup][backup] so there is nothing to configure. Pages are part of the [regular backup](../../raketasks/backup_restore.md) so there is nothing to configure.
## Security ## Security
You should strongly consider running GitLab Pages under a different hostname You should strongly consider running GitLab Pages under a different hostname
than GitLab to prevent XSS attacks. than GitLab to prevent XSS attacks.
[backup]: ../../raketasks/backup_restore.md
[ee-80]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80
[ee-173]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/173
[gitlab pages daemon]: https://gitlab.com/gitlab-org/gitlab-pages
[NGINX configs]: https://gitlab.com/gitlab-org/gitlab/tree/8-5-stable-ee/lib/support/nginx
[pages-readme]: https://gitlab.com/gitlab-org/gitlab-pages/blob/master/README.md
[pages-userguide]: ../../user/project/pages/index.md
[restart]: ../restart_gitlab.md#installations-from-source
[gitlab-pages]: https://gitlab.com/gitlab-org/gitlab-pages/tree/v0.4.0
[gl-example]: https://gitlab.com/gitlab-org/gitlab/blob/master/lib/support/init.d/gitlab.default.example
[shared runners]: ../../ci/runners/README.md
doc/topics/autodevops/index.md
View file @ 60c8298d
# Auto DevOps # Auto DevOps
> - [Introduced][ce-37115] in GitLab 10.0. > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/37115) in GitLab 10.0.
> - Generally available on GitLab 11.0. > - Generally available on GitLab 11.0.
Auto DevOps provides pre-defined CI/CD configuration which allows you to automatically detect, build, test, Auto DevOps provides pre-defined CI/CD configuration which allows you to automatically detect, build, test,
...@@ -317,7 +317,7 @@ When using Auto DevOps, you may want to deploy different environments to ...@@ -317,7 +317,7 @@ When using Auto DevOps, you may want to deploy different environments to
different Kubernetes clusters. This is possible due to the 1:1 connection that different Kubernetes clusters. This is possible due to the 1:1 connection that
[exists between them](../../user/project/clusters/index.md#multiple-kubernetes-clusters-premium). [exists between them](../../user/project/clusters/index.md#multiple-kubernetes-clusters-premium).
In the [Auto DevOps template] (used behind the scenes by Auto DevOps), there In the [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) (used behind the scenes by Auto DevOps), there
are currently 3 defined environment names that you need to know: are currently 3 defined environment names that you need to know:
- `review/` (every environment starting with `review/`) - `review/` (every environment starting with `review/`)
...@@ -369,7 +369,7 @@ Auto Build creates a build of the application using an existing `Dockerfile` or ...@@ -369,7 +369,7 @@ Auto Build creates a build of the application using an existing `Dockerfile` or
Heroku buildpacks. Heroku buildpacks.
Either way, the resulting Docker image is automatically pushed to the Either way, the resulting Docker image is automatically pushed to the
[Container Registry][container-registry] and tagged with the commit SHA or tag. [Container Registry](../../user/packages/container_registry/index.md) and tagged with the commit SHA or tag.
#### Auto Build using a Dockerfile #### Auto Build using a Dockerfile
...@@ -430,7 +430,7 @@ Any differences between the source and target branches are also ...@@ -430,7 +430,7 @@ Any differences between the source and target branches are also
### Auto SAST **(ULTIMATE)** ### Auto SAST **(ULTIMATE)**
> Introduced in [GitLab Ultimate][ee] 10.3. > Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.3.
Static Application Security Testing (SAST) uses the Static Application Security Testing (SAST) uses the
[SAST Docker image](https://gitlab.com/gitlab-org/security-products/sast) to run static [SAST Docker image](https://gitlab.com/gitlab-org/security-products/sast) to run static
...@@ -445,7 +445,7 @@ Any security warnings are also shown in the merge request widget. Read more how ...@@ -445,7 +445,7 @@ Any security warnings are also shown in the merge request widget. Read more how
### Auto Dependency Scanning **(ULTIMATE)** ### Auto Dependency Scanning **(ULTIMATE)**
> Introduced in [GitLab Ultimate][ee] 10.7. > Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.7.
Dependency Scanning uses the Dependency Scanning uses the
[Dependency Scanning Docker image](https://gitlab.com/gitlab-org/security-products/dependency-scanning) [Dependency Scanning Docker image](https://gitlab.com/gitlab-org/security-products/dependency-scanning)
...@@ -462,7 +462,7 @@ Any security warnings are also shown in the merge request widget. Read more abou ...@@ -462,7 +462,7 @@ Any security warnings are also shown in the merge request widget. Read more abou
### Auto License Compliance **(ULTIMATE)** ### Auto License Compliance **(ULTIMATE)**
> Introduced in [GitLab Ultimate][ee] 11.0. > Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.0.
License Compliance uses the License Compliance uses the
[License Compliance Docker image](https://gitlab.com/gitlab-org/security-products/license-management) [License Compliance Docker image](https://gitlab.com/gitlab-org/security-products/license-management)
...@@ -498,7 +498,7 @@ This is an optional step, since many projects do not have a Kubernetes cluster ...@@ -498,7 +498,7 @@ This is an optional step, since many projects do not have a Kubernetes cluster
available. If the [requirements](#requirements) are not met, the job will available. If the [requirements](#requirements) are not met, the job will
silently be skipped. silently be skipped.
[Review Apps][review-app] are temporary application environments based on the [Review Apps](../../ci/review_apps/index.md) are temporary application environments based on the
branch's code so developers, designers, QA, product managers, and other branch's code so developers, designers, QA, product managers, and other
reviewers can actually see and interact with code changes as part of the review reviewers can actually see and interact with code changes as part of the review
process. Auto Review Apps create a Review App for each branch. process. Auto Review Apps create a Review App for each branch.
...@@ -533,7 +533,7 @@ in the first place, and thus not realize that it needs to re-apply the old confi ...@@ -533,7 +533,7 @@ in the first place, and thus not realize that it needs to re-apply the old confi
### Auto DAST **(ULTIMATE)** ### Auto DAST **(ULTIMATE)**
> Introduced in [GitLab Ultimate][ee] 10.4. > Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.4.
Dynamic Application Security Testing (DAST) uses the Dynamic Application Security Testing (DAST) uses the
popular open source tool [OWASP ZAProxy](https://github.com/zaproxy/zaproxy) popular open source tool [OWASP ZAProxy](https://github.com/zaproxy/zaproxy)
...@@ -570,7 +570,7 @@ DAST can be disabled: ...@@ -570,7 +570,7 @@ DAST can be disabled:
### Auto Browser Performance Testing **(PREMIUM)** ### Auto Browser Performance Testing **(PREMIUM)**
> Introduced in [GitLab Premium][ee] 10.4. > Introduced in [GitLab Premium](https://about.gitlab.com/pricing/) 10.4.
Auto Browser Performance Testing utilizes the [Sitespeed.io container](https://hub.docker.com/r/sitespeedio/sitespeed.io/) to measure the performance of a web page. A JSON report is created and uploaded as an artifact, which includes the overall performance score for each page. By default, the root page of Review and Production environments will be tested. If you would like to add additional URL's to test, simply add the paths to a file named `.gitlab-urls.txt` in the root directory, one per line. For example: Auto Browser Performance Testing utilizes the [Sitespeed.io container](https://hub.docker.com/r/sitespeedio/sitespeed.io/) to measure the performance of a web page. A JSON report is created and uploaded as an artifact, which includes the overall performance score for each page. By default, the root page of Review and Production environments will be tested. If you would like to add additional URL's to test, simply add the paths to a file named `.gitlab-urls.txt` in the root directory, one per line. For example:
...@@ -595,7 +595,7 @@ the Kubernetes cluster, with a namespace based on the project name and unique ...@@ -595,7 +595,7 @@ the Kubernetes cluster, with a namespace based on the project name and unique
project ID, for example `project-4321`. project ID, for example `project-4321`.
Auto Deploy doesn't include deployments to staging or canary by default, but the Auto Deploy doesn't include deployments to staging or canary by default, but the
[Auto DevOps template] contains job definitions for these tasks if you want to [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) contains job definitions for these tasks if you want to
enable them. enable them.
You can make use of [environment variables](#environment-variables) to automatically You can make use of [environment variables](#environment-variables) to automatically
...@@ -619,7 +619,7 @@ deploys with Auto DevOps can undo your changes. Also, if you change something ...@@ -619,7 +619,7 @@ deploys with Auto DevOps can undo your changes. Also, if you change something
and want to undo it by deploying again, Helm may not detect that anything changed and want to undo it by deploying again, Helm may not detect that anything changed
in the first place, and thus not realize that it needs to re-apply the old config. in the first place, and thus not realize that it needs to re-apply the old config.
> [Introduced][ce-19507] in GitLab 11.0. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19507) in GitLab 11.0.
For internal and private projects a [GitLab Deploy Token](../../user/project/deploy_tokens/index.md#gitlab-deploy-token) For internal and private projects a [GitLab Deploy Token](../../user/project/deploy_tokens/index.md#gitlab-deploy-token)
will be automatically created, when Auto DevOps is enabled and the Auto DevOps settings are saved. This Deploy Token will be automatically created, when Auto DevOps is enabled and the Auto DevOps settings are saved. This Deploy Token
...@@ -669,7 +669,7 @@ restore your database before opting into version `2`. ...@@ -669,7 +669,7 @@ restore your database before opting into version `2`.
#### Migrations #### Migrations
> [Introduced][ce-21955] in GitLab 11.4 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/21955) in GitLab 11.4
Database initialization and migrations for PostgreSQL can be configured to run Database initialization and migrations for PostgreSQL can be configured to run
within the application pod by setting the project variables `DB_INITIALIZE` and within the application pod by setting the project variables `DB_INITIALIZE` and
...@@ -1017,7 +1017,7 @@ to the desired environment. See [Limiting environment scopes of variables](../.. ...@@ -1017,7 +1017,7 @@ to the desired environment. See [Limiting environment scopes of variables](../..
### Customizing `.gitlab-ci.yml` ### Customizing `.gitlab-ci.yml`
Auto DevOps is completely customizable because the [Auto DevOps template]: Auto DevOps is completely customizable because the [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml):
- Is just an implementation of a [`.gitlab-ci.yml`](../../ci/yaml/README.md) file. - Is just an implementation of a [`.gitlab-ci.yml`](../../ci/yaml/README.md) file.
- Uses only features available to any implementation of `.gitlab-ci.yml`. - Uses only features available to any implementation of `.gitlab-ci.yml`.
...@@ -1033,7 +1033,7 @@ include: ...@@ -1033,7 +1033,7 @@ include:
``` ```
Then add any extra changes you want. Your additions will be merged with the Then add any extra changes you want. Your additions will be merged with the
[Auto DevOps template] using the behaviour described for [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) using the behaviour described for
[`include`](../../ci/yaml/README.md#include). [`include`](../../ci/yaml/README.md#include).
It is also possible to copy and paste the contents of the [Auto DevOps It is also possible to copy and paste the contents of the [Auto DevOps
...@@ -1083,12 +1083,12 @@ include: ...@@ -1083,12 +1083,12 @@ include:
- template: Jobs/Build.gitlab-ci.yml - template: Jobs/Build.gitlab-ci.yml
``` ```
Consult the [Auto DevOps template] for information on available jobs. Consult the [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) for information on available jobs.
### PostgreSQL database support ### PostgreSQL database support
In order to support applications that require a database, In order to support applications that require a database,
[PostgreSQL][postgresql] is provisioned by default. The credentials to access [PostgreSQL](https://www.postgresql.org/) is provisioned by default. The credentials to access
the database are preconfigured, but can be customized by setting the associated the database are preconfigured, but can be customized by setting the associated
[variables](#environment-variables). These credentials can be used for defining a [variables](#environment-variables). These credentials can be used for defining a
`DATABASE_URL` of the format: `DATABASE_URL` of the format:
...@@ -1550,16 +1550,6 @@ spec: ...@@ -1550,16 +1550,6 @@ spec:
service account for your project. For help debugging this issue, see service account for your project. For help debugging this issue, see
[Troubleshooting failed deployment jobs](../../user/project/clusters/index.md#troubleshooting). [Troubleshooting failed deployment jobs](../../user/project/clusters/index.md#troubleshooting).
[ce-37115]: https://gitlab.com/gitlab-org/gitlab-foss/issues/37115
[docker-in-docker]: ../../docker/using_docker_build.md#use-docker-in-docker-executor
[review-app]: ../../ci/review_apps/index.md
[container-registry]: ../../user/packages/container_registry/index.md
[postgresql]: https://www.postgresql.org/
[Auto DevOps template]: https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml
[ee]: https://about.gitlab.com/pricing/
[ce-21955]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/21955
[ce-19507]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19507
## Development guides ## Development guides
[Development guide for Auto DevOps](../../development/auto_devops.md) [Development guide for Auto DevOps](../../development/auto_devops.md)
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7