diff options
Diffstat (limited to 'doc/ci/services')
| -rw-r--r-- | doc/ci/services/README.md | 9 | ||||
| -rw-r--r-- | doc/ci/services/gitlab.md | 6 | ||||
| -rw-r--r-- | doc/ci/services/index.md | 6 | ||||
| -rw-r--r-- | doc/ci/services/mysql.md | 6 | ||||
| -rw-r--r-- | doc/ci/services/postgres.md | 6 | ||||
| -rw-r--r-- | doc/ci/services/redis.md | 4 |
6 files changed, 14 insertions, 23 deletions
diff --git a/doc/ci/services/README.md b/doc/ci/services/README.md deleted file mode 100644 index 577a80407d7..00000000000 --- a/doc/ci/services/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -redirect_to: 'index.md' -remove_date: '2021-05-01' ---- - -This document was moved to [another location](index.md). - -<!-- This redirect file can be deleted after 2021-05-01. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/ci/services/gitlab.md b/doc/ci/services/gitlab.md index 8afe8c784f3..558f53a9535 100644 --- a/doc/ci/services/gitlab.md +++ b/doc/ci/services/gitlab.md @@ -11,7 +11,7 @@ Many applications need to access JSON APIs, so application tests might need acce to APIs too. The following example shows how to use GitLab as a microservice to give tests access to the GitLab API. -1. Configure a [runner](../runners/README.md) with the Docker or Kubernetes executor. +1. Configure a [runner](../runners/index.md) with the Docker or Kubernetes executor. 1. In your `.gitlab-ci.yml` add: ```yaml @@ -25,7 +25,7 @@ tests access to the GitLab API. ``` 1. To set values for the `GITLAB_HTTPS` and `GITLAB_ROOT_PASSWORD`, - [assign them to a variable in the user interface](../variables/README.md#add-a-cicd-variable-to-a-project). + [assign them to a variable in the user interface](../variables/index.md#add-a-cicd-variable-to-a-project). Then assign that variable to the corresponding variable in your `.gitlab-ci.yml` file. @@ -37,4 +37,4 @@ For more information about why `gitlab` is used for the `Host`, see You can also use any other Docker image available on [Docker Hub](https://hub.docker.com/u/gitlab). The `gitlab` image can accept environment variables. For more details, -see the [Omnibus documentation](../../install/README.md). +see the [Omnibus documentation](../../install/index.md). diff --git a/doc/ci/services/index.md b/doc/ci/services/index.md index 8d603b17e2e..c7891998a37 100644 --- a/doc/ci/services/index.md +++ b/doc/ci/services/index.md @@ -188,9 +188,9 @@ To override the default behavior, you can ## Passing CI/CD variables to services -You can also pass custom CI/CD [variables](../variables/README.md) +You can also pass custom CI/CD [variables](../variables/index.md) to fine tune your Docker `images` and `services` directly in the `.gitlab-ci.yml` file. -For more information, read about [`.gitlab-ci.yml` defined variables](../variables/README.md#create-a-custom-cicd-variable-in-the-gitlab-ciyml-file). +For more information, read about [`.gitlab-ci.yml` defined variables](../variables/index.md#create-a-custom-cicd-variable-in-the-gitlab-ciyml-file). ```yaml # The following variables are automatically passed down to the Postgres container @@ -228,7 +228,7 @@ test: | Setting | Required | GitLab version | Description | |------------|----------|----------------| ----------- | -| `name` | yes, when used with any other option | 9.4 | Full name of the image to use. It should contain the Registry part if needed. | +| `name` | yes, when used with any other option | 9.4 | Full name of the image to use. If the full image name includes a registry hostname, use the `alias` option to define a shorter service access name. For more information, see [Accessing the services](#accessing-the-services). | | `entrypoint` | no | 9.4 |Command or script to execute as the container's entrypoint. It's translated to Docker's `--entrypoint` option while creating the container. The syntax is similar to [`Dockerfile`'s `ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint) directive, where each shell token is a separate string in the array. | | `command` | no | 9.4 |Command or script that should be used as the container's command. It's translated to arguments passed to Docker after the image's name. The syntax is similar to [`Dockerfile`'s `CMD`](https://docs.docker.com/engine/reference/builder/#cmd) directive, where each shell token is a separate string in the array. | | `alias` (1) | no | 9.4 |Additional alias that can be used to access the service from the job's container. Read [Accessing the services](#accessing-the-services) for more information. | diff --git a/doc/ci/services/mysql.md b/doc/ci/services/mysql.md index 1e0762ca010..c691a6ef33d 100644 --- a/doc/ci/services/mysql.md +++ b/doc/ci/services/mysql.md @@ -12,11 +12,11 @@ need it for your tests to run. ## Use MySQL with the Docker executor -If you want to use a MySQL container, you can use [GitLab Runner](../runners/README.md) with the Docker executor. +If you want to use a MySQL container, you can use [GitLab Runner](../runners/index.md) with the Docker executor. This example shows you how to set a username and password that GitLab uses to access the MySQL container. If you do not set a username and password, you must use `root`. -1. [Create CI/CD variables](../variables/README.md#custom-cicd-variables) for your +1. [Create CI/CD variables](../variables/index.md#custom-cicd-variables) for your MySQL database and password by going to **Settings > CI/CD**, expanding **Variables**, and clicking **Add Variable**. @@ -130,5 +130,5 @@ GitLab Runner with the Shell executor. ## Example project To view a MySQL example, create a fork of this [sample project](https://gitlab.com/gitlab-examples/mysql). -This project uses publicly-available [shared runners](../runners/README.md) on [GitLab.com](https://gitlab.com). +This project uses publicly-available [shared runners](../runners/index.md) on [GitLab.com](https://gitlab.com). Update the README.md file, commit your changes, and view the CI/CD pipeline to see it in action. diff --git a/doc/ci/services/postgres.md b/doc/ci/services/postgres.md index 8451d56a71c..8d14e4795d2 100644 --- a/doc/ci/services/postgres.md +++ b/doc/ci/services/postgres.md @@ -13,7 +13,7 @@ do this with the Docker and Shell executors of GitLab Runner. ## Use PostgreSQL with the Docker executor -If you're using [GitLab Runner](../runners/README.md) with the Docker executor, +If you're using [GitLab Runner](../runners/index.md) with the Docker executor, you basically have everything set up already. First, in your `.gitlab-ci.yml` add: @@ -31,7 +31,7 @@ variables: To set values for the `POSTGRES_DB`, `POSTGRES_USER`, `POSTGRES_PASSWORD` and `POSTGRES_HOST_AUTH_METHOD`, -[assign them to a CI/CD variable in the user interface](../variables/README.md#custom-cicd-variables), +[assign them to a CI/CD variable in the user interface](../variables/index.md#custom-cicd-variables), then assign that variable to the corresponding variable in your `.gitlab-ci.yml` file. @@ -121,7 +121,7 @@ Database: nice_marmot We have set up an [Example PostgreSQL Project](https://gitlab.com/gitlab-examples/postgres) for your convenience that runs on [GitLab.com](https://gitlab.com) using our publicly -available [shared runners](../runners/README.md). +available [shared runners](../runners/index.md). Want to hack on it? Fork it, commit, and push your changes. Within a few moments the changes are picked by a public runner and the job begins. diff --git a/doc/ci/services/redis.md b/doc/ci/services/redis.md index 71d3ffb1c60..d8c7b805864 100644 --- a/doc/ci/services/redis.md +++ b/doc/ci/services/redis.md @@ -13,7 +13,7 @@ do this with the Docker and Shell executors of GitLab Runner. ## Use Redis with the Docker executor -If you are using [GitLab Runner](../runners/README.md) with the Docker executor +If you are using [GitLab Runner](../runners/index.md) with the Docker executor you basically have everything set up already. First, in your `.gitlab-ci.yml` add: @@ -67,7 +67,7 @@ Host: localhost We have set up an [Example Redis Project](https://gitlab.com/gitlab-examples/redis) for your convenience that runs on [GitLab.com](https://gitlab.com) using our publicly available -[shared runners](../runners/README.md). +[shared runners](../runners/index.md). Want to hack on it? Simply fork it, commit and push your changes. Within a few moments the changes are picked by a public runner and the job begins. |