Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
1cb266ed
Commit
1cb266ed
authored
Sep 01, 2020
by
Russell Dickenson
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch 'selhorn-runner-updates6' into 'master'
Updated case of runner See merge request gitlab-org/gitlab!40896
parents
38b18c11
b2edb333
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
30 additions
and
35 deletions
+30
-35
doc/ci/quick_start/README.md
doc/ci/quick_start/README.md
+30
-35
No files found.
doc/ci/quick_start/README.md
View file @
1cb266ed
...
@@ -11,9 +11,9 @@ GitLab offers a [continuous integration](https://about.gitlab.com/stages-devops-
...
@@ -11,9 +11,9 @@ GitLab offers a [continuous integration](https://about.gitlab.com/stages-devops-
[
pipeline
](
../pipelines/index.md
)
, you must:
[
pipeline
](
../pipelines/index.md
)
, you must:
-
Add a
[
`.gitlab-ci.yml` file
](
#creating-a-gitlab-ciyml-file
)
to your repository's root directory.
-
Add a
[
`.gitlab-ci.yml` file
](
#creating-a-gitlab-ciyml-file
)
to your repository's root directory.
-
Ensure your project is configured to use a
[
R
unner
](
#configuring-a-runner
)
.
-
Ensure your project is configured to use a
[
r
unner
](
#configuring-a-runner
)
.
The
`.gitlab-ci.yml`
file tells the
GitLab R
unner what to do. A simple pipeline commonly has
The
`.gitlab-ci.yml`
file tells the
r
unner what to do. A simple pipeline commonly has
three
[
stages
](
../yaml/README.md#stages
)
:
three
[
stages
](
../yaml/README.md#stages
)
:
-
`build`
-
`build`
...
@@ -57,7 +57,7 @@ The `.gitlab-ci.yml` file is where you configure what CI does with your project.
...
@@ -57,7 +57,7 @@ The `.gitlab-ci.yml` file is where you configure what CI does with your project.
It lives in the root of your repository.
It lives in the root of your repository.
On any push to your repository, GitLab will look for the
`.gitlab-ci.yml`
On any push to your repository, GitLab will look for the
`.gitlab-ci.yml`
file and start jobs on _
R
unners_ according to the contents of the file,
file and start jobs on _
r
unners_ according to the contents of the file,
for that commit.
for that commit.
Because
`.gitlab-ci.yml`
is in the repository and is version controlled, old
Because
`.gitlab-ci.yml`
is in the repository and is version controlled, old
...
@@ -109,7 +109,7 @@ The `.gitlab-ci.yml` file defines sets of jobs with constraints of how and when
...
@@ -109,7 +109,7 @@ The `.gitlab-ci.yml` file defines sets of jobs with constraints of how and when
they should be run. The jobs are defined as top-level elements with a name (in
they should be run. The jobs are defined as top-level elements with a name (in
our case
`rspec`
and
`rubocop`
) and always have to contain the
`script`
keyword.
our case
`rspec`
and
`rubocop`
) and always have to contain the
`script`
keyword.
Jobs are used to create jobs, which are then picked by
Jobs are used to create jobs, which are then picked by
[
Runners
](
../runners/README.md
)
and executed within the environment of the R
unner.
[
runners
](
../runners/README.md
)
and executed within the environment of the r
unner.
What is important is that each job is run independently from each other.
What is important is that each job is run independently from each other.
...
@@ -148,59 +148,54 @@ Clicking on it you will be directed to the jobs page for that specific commit.
...
@@ -148,59 +148,54 @@ Clicking on it you will be directed to the jobs page for that specific commit.
![
Single commit jobs page
](
img/single_commit_status_pending.png
)
![
Single commit jobs page
](
img/single_commit_status_pending.png
)
Notice that there is a pending job which is named after what we wrote in
Notice that there is a pending job which is named after what we wrote in
`.gitlab-ci.yml`
. "stuck" indicates that there is no
R
unner configured
`.gitlab-ci.yml`
. "stuck" indicates that there is no
r
unner configured
yet for this job.
yet for this job.
The next step is to configure a
R
unner so that it picks the pending jobs.
The next step is to configure a
r
unner so that it picks the pending jobs.
## Configuring a
R
unner
## Configuring a
r
unner
In GitLab,
Runners run the jobs that you define in
`.gitlab-ci.yml`
. A R
unner
In GitLab,
runners run the jobs that you define in
`.gitlab-ci.yml`
. A r
unner
can be a virtual machine, a VPS, a bare-metal machine, a Docker container or
can be a virtual machine, a VPS, a bare-metal machine, a Docker container
,
or
even a cluster of containers. GitLab and the
Runners
communicate through an API,
even a cluster of containers. GitLab and the
runner
communicate through an API,
so the only requirement is that the
R
unner's machine has network access to the
so the only requirement is that the
r
unner's machine has network access to the
GitLab server.
GitLab server.
A
R
unner can be specific to a certain project or serve multiple projects in
A
r
unner can be specific to a certain project or serve multiple projects in
GitLab. If it serves all projects
it's called a _Shared R
unner_.
GitLab. If it serves all projects
, it's called a _shared r
unner_.
Find more information about
different R
unners in the
Find more information about
r
unners in the
[
Runners
](
../runners/README.md
)
documentation.
[
runner
](
../runners/README.md
)
documentation.
You can find whether any Runners are assigned to your project by going to
The official runner supported by GitLab is written in Go.
**Settings ➔ CI/CD**
. Setting up a Runner is easy and straightforward. The
View
[
the documentation
](
https://docs.gitlab.com/runner/
)
.
official Runner supported by GitLab is written in Go and its documentation
can be found at
<https://docs.gitlab.com/runner/>
.
In order to have a functional Runner you need to follow two steps
:
For a runner to be available in GitLab, you must
:
1.
[
Install
it
](
https://docs.gitlab.com/runner/install/
)
1.
[
Install
GitLab Runner
](
https://docs.gitlab.com/runner/install/
)
.
1.
[
Configure it
](
https://docs.gitlab.com/runner/configuration/
)
1.
[
Register a runner for your group or project
](
https://docs.gitlab.com/runner/register/
)
.
Follow the links above to set up your own Runner or use a Shared Runner as
When a runner is available, you can view it by
described in the next section.
clicking
**Settings > CI/CD**
and expanding
**Runners**
.
Once the Runner has been set up, you should see it on the Runners page of your
project, following
**Settings ➔ CI/CD**
.
![
Activated runners
](
img/runners_activated.png
)
![
Activated runners
](
img/runners_activated.png
)
### Shared
R
unners
### Shared
r
unners
If you use
[
GitLab.com
](
https://gitlab.com/
)
you can use the
**Shared R
unners**
If you use
[
GitLab.com
](
https://gitlab.com/
)
, you can use the
**shared r
unners**
provided by GitLab
Inc
.
provided by GitLab.
These are special virtual machines that run on GitLab's infrastructure and can
These are special virtual machines that run on GitLab's infrastructure and can
build any project.
build any project.
To enable
the
**Shared Runners**
you have to go to your project
's
To enable
shared runners, go to your project's or group
's
**Settings
➔
CI/CD**
and click
**Enable shared runners**
.
**Settings
>
CI/CD**
and click
**Enable shared runners**
.
[
Read more
on Shared Runners
](
../runners/README.md
)
.
[
Read more
about shared runners
](
../runners/README.md#shared-runners
)
.
##
See
ing the status of your pipeline and jobs
##
View
ing the status of your pipeline and jobs
After configuring the
R
unner successfully, you should see the status of your
After configuring the
r
unner successfully, you should see the status of your
last commit change from _pending_ to either _running_, _success_ or _failed_.
last commit change from _pending_ to either _running_, _success_ or _failed_.
You can view all pipelines by going to the
**Pipelines**
page in your project.
You can view all pipelines by going to the
**Pipelines**
page in your project.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment