Skip to content

Commit a38bd73

Browse files
committed
Update installation documentation to include cluster profiles
1 parent 8cc30db commit a38bd73

File tree

7 files changed

+18
-16
lines changed

7 files changed

+18
-16
lines changed

INSTALL.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Table of Contents
66
* [Requirements](#requirements)
77
* [Installation](#installation)
88
* [Configuration](#configuration)
9-
- [Configure plugin settings](#configure-plugin-settings)
10-
- [Create an elastic profile](#create-an-elastic-profile)
11-
- [Configure job to use an elastic agent profile](#configure-job-to-use-an-elastic-agent-profile)
9+
- [Configure a Cluster Profile](#configure-a-cluster-profile)
10+
- [Create an Elastic Profile](#create-an-elastic-profile)
11+
- [Configure a Job to use an Elastic Agent Profile](#configure-a-job-to-use-an-elastic-agent-profile)
1212

1313
## Requirements
1414

15-
* GoCD server version `v17.9.0` or above
15+
* GoCD server version `v19.3.0` or above
1616
* Docker Server
1717

1818
## Installation
@@ -23,17 +23,18 @@ and restart the server.
2323

2424
## Configuration
2525

26-
### Configure plugin settings
26+
### Configure a Cluster Profile
2727

28-
The plugin settings are used to provide global level configurations for the plugin. Configurations such as docker server configuration and private registry settings are provided in plugin settings.
28+
The cluster profile settings are used to provide cluster level configurations for the plugin. Configurations such as docker server configuration and private registry settings are provided in cluster profile settings.
2929

30-
1. Login to `GoCD server` as admin and navigate to **_Admin_** _>_ **_Plugins_**
30+
1. Login to `GoCD server` as admin and navigate to **_Admin_** _>_ **_Elastic Profile_**
3131

32-
![Plugins][1]
32+
![Elastic Profiles][1]
3333

34-
2. Click on **_Settings icon_** of `Docker Elastic Agent Plugin` to update plugin settings configuration.
34+
2. Click on **_Add Cluster Profile_**. Select `Docker Elastic Agent Plugin` from the plugin ID dropdown.
3535

36-
![Configure plugin settings][2]
36+
![Cluster Profile basic settings][2]
37+
![Cluster Profile docker client settings][8]
3738

3839
| Field Name | Mandatory | Description |
3940
|---------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -51,11 +52,11 @@ The plugin settings are used to provide global level configurations for the plug
5152

5253
The Elastic Agent Profile is used to define the configuration of a docker container(GoCD docker agent). The profile is used to configure the docker image, set memory limits, provide docker command and environment variables etc...
5354

54-
1. Login to `GoCD server` as admin and navigate to **_Admin_** _>_ **_Elastic Agent Profiles_**
55+
1. Login to `GoCD server` as admin and navigate to **_Admin_** _>_ **_Elastic Profiles_**
5556

5657
![Elastic Profiles][3]
5758

58-
2. Click on **_Add_** to create new elastic agent profile
59+
2. Click on **_New Elastic Agent Profile_** to create new elastic agent profile for a cluster.
5960

6061
![Create elastic profile][4]
6162

@@ -65,11 +66,11 @@ The plugin settings are used to provide global level configurations for the plug
6566
| **Plugin id** | Yes | Select `Docker Elastic Agent Plugin` for **_Plugin id_** |
6667
| **Docker image** | Yes | GoCD elastic agent docker image name. Pre build GoCD agent docker images are available [here](https://www.gocd.org/download/#docker) |
6768
| **Docker Command** | No | Commands that you want to execute on container start. <br/>*_Note: This will override the existing docker entry-point defined in docker image._* |
68-
| **Environment Variables** | No | Environment variables for container. This will overrides the environment variables defined in plugin settings.(enter each per line) |
69+
| **Environment Variables** | No | Environment variables for container. This will overrides the environment variables defined in cluster profile.(enter each per line) |
6970
| **Host entries** | No | This allows users to add host entries in `/etc/hosts`(enter each per line) |
7071

7172

72-
### Configure job to use an elastic agent profile
73+
### Configure a job to use an elastic agent profile
7374

7475
1. Click the gear icon on **_Pipeline_**
7576

@@ -87,10 +88,11 @@ The plugin settings are used to provide global level configurations for the plug
8788

8889
6. Save your changes
8990

90-
[1]: images/plugins.png "Plugins"
91-
[2]: images/plugin-settings.png "Configure plugin settings"
91+
[1]: images/elastic_profiles_spa.png "Elastic Profiles"
92+
[2]: images/cluster-profiles/basic-settings.png "Cluster Profile basic settings"
9293
[3]: images/profiles_page.png "Elastic profiles"
9394
[4]: images/profile.png "Create elastic profile"
9495
[5]: images/pipeline.png "Pipeline"
9596
[6]: images/quick-edit.png "Quick edit"
9697
[7]: images/configure-job.png "Configure a job"
98+
[8]: images/cluster-profiles/docker-client-settings.png "Cluster Profile docker client settings"
67.2 KB
Loading
Loading

images/elastic_profiles_spa.png

60.1 KB
Loading

images/plugins.png

-184 KB
Binary file not shown.

images/profile.png

1.61 KB
Loading

images/profiles_page.png

22 KB
Loading

0 commit comments

Comments
 (0)