You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+53-46Lines changed: 53 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,8 @@ Table of Contents
17
17
18
18
## Installation
19
19
20
-
* Copy the file `build/libs/docker-swarm-elastic-agents-VERSION.jar` to the GoCD server under `${GO_SERVER_DIR}/plugins/external`
21
-
and restart the server.
20
+
* Copy the file `build/libs/docker-swarm-elastic-agents-VERSION.jar` to the GoCD server under `${GO_SERVER_DIR}/plugins/external`
21
+
and restart the server.
22
22
* The `GO_SERVER_DIR` is usually `/var/lib/go-server` on **Linux** and `C:\Program Files\Go Server` on **Windows**.
23
23
24
24
## Configuration
@@ -27,62 +27,69 @@ and restart the server.
27
27
28
28
The plugin settings are used to provide global level configurations for the plugin. Configurations such as docker swarm cluster configuration and private registry settings are provided in plugin settings.
29
29
30
-
1. Login to `GoCD server` as admin and navigate to **_Admin_**_>_ **_Plugins_**<br/>
31
-
![Plugins][1]
32
-
33
-
2. Click on **_Settings icon_** of `GoCD Elastic agent plugin for Docker Swarm` to update plugin settings configuration.<br/>
|**Go server url**| Yes | GoCD server url(`https://YOUR_HOST_OR_IP_ADDRESS:8154/go`). The docker elastic agent will use this URL to register itself with GoCD. <br/>The GoCD hostname or ip must resolve in your container. Don't use `localhost` or `127.0.0.1`|
39
-
|**Environment variables**| No | The environment variable for docker container |
40
-
|**Agent auto-register timeout**| Yes | Agent auto-register timeout(in minutes). Plugin will kill the agent container if it fails to register within provided time limits |
41
-
|**Maximum docker containers**| Yes | Maximum docker containers to run at any given point in time. Plugin will not create more container when running container count reached to specified limits |
42
-
|**Docker URI**| Yes | Docker swarm cluster uri. <br/>If your Go Server is running on local machine then use(for mac and linux) — `unix:///var/run/docker.sock`|
43
-
|**Docker CA Certificate**| No | Docker swarm cluster CA certificate |
|**Go server url**| Yes | GoCD server url(`https://YOUR_HOST_OR_IP_ADDRESS:8154/go`). The docker elastic agent will use this URL to register itself with GoCD. <br/>The GoCD hostname or ip must resolve in your container. Don't use `localhost` or `127.0.0.1`|
41
+
|**Environment variables**| No | The environment variable for docker container |
42
+
|**Agent auto-register timeout**| Yes | Agent auto-register timeout(in minutes). Plugin will kill the agent container if it fails to register within provided time limits |
43
+
|**Maximum docker containers**| Yes | Maximum docker containers to run at any given point in time. Plugin will not create more container when running container count reached to specified limits |
44
+
|**Docker URI**| Yes | Docker swarm cluster uri. <br/>If your Go Server is running on local machine then use(for mac and linux) — `unix:///var/run/docker.sock`|
45
+
|**Docker CA Certificate**| No | Docker swarm cluster CA certificate |
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...
51
53
52
-
1. Login to `GoCD server` as admin and navigate to **_Admin_**_>_ **_Elastic Agent Profiles_**<br/>
53
-
![Elastic Profiles][3]
54
-
55
-
2. Click on **_Add_** to create new elastic agent profile<br/>
|**Docker image**| Yes | GoCD elastic agent docker image name. Pre build GoCD agent docker images are available [here](https://www.gocd.org/download/#docker)|
63
-
|**Memory soft limit**| Yes | Soft memory limit. Container will start with memory specified here |
64
-
|**Maximum hard limit**| Yes | Hard memory limit for container |
65
-
|**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._*|
66
-
|**Environment Variables**| No | Environment variables for container. This will overrides the environment variables defined in plugin settings.(enter each per line) |
67
-
|**Secrets**| No | Allows users bind a docker secret with container(enter each per line) |
68
-
|**Network attachments**| No | Allows user to attach docker networks to container(enter each per line) |
69
-
|**Volume Mounts**| No | Allows user to mount/bind volume to docker container(enter each per line) |
70
-
|**Host entries**| No | This allows users to add host entries in `/etc/hosts`(enter each per line) |
71
-
|**Constraints**| No | You can limit the set of nodes where a task can be scheduled by defining constraint expressions.<br/>Multiple constraints find nodes that satisfy every expression (AND match, enter each per line) |
54
+
1. Login to `GoCD server` as admin and navigate to **_Admin_**_>_ **_Elastic Agent Profiles_**
55
+
56
+
![Elastic Profiles][3]
57
+
58
+
2. Click on **_Add_** to create new elastic agent profile
|**Docker image**| Yes | GoCD elastic agent docker image name. Pre build GoCD agent docker images are available [here](https://www.gocd.org/download/#docker)|
67
+
|**Memory soft limit**| Yes | Soft memory limit. Container will start with memory specified here |
68
+
|**Maximum hard limit**| Yes | Hard memory limit for container |
69
+
|**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._*|
70
+
|**Environment Variables**| No | Environment variables for container. This will overrides the environment variables defined in plugin settings.(enter each per line) |
71
+
|**Secrets**| No | Allows users bind a docker secret with container(enter each per line) |
72
+
|**Network attachments**| No | Allows user to attach docker networks to container(enter each per line) |
73
+
|**Volume Mounts**| No | Allows user to mount/bind volume to docker container(enter each per line) |
74
+
|**Host entries**| No | This allows users to add host entries in `/etc/hosts`(enter each per line) |
75
+
|**Constraints**| No | You can limit the set of nodes where a task can be scheduled by defining constraint expressions.<br/>Multiple constraints find nodes that satisfy every expression (AND match, enter each per line) |
72
76
73
77
74
78
### Configure job to use an elastic agent profile
75
79
76
-
1. Click the gear icon on **_Pipeline_**<br/>
77
-
![Pipeline][5]
80
+
1. Click the gear icon on **_Pipeline_**
78
81
79
-
2. Click on **_Quick Edit_** button<br/>
80
-
![Quick edit][6]
82
+
![Pipeline][5]
83
+
84
+
2. Click on **_Quick Edit_** button
85
+
86
+
![Quick edit][6]
81
87
82
88
3. Click on **_Stages_**
83
89
4. Create/Edit a job
84
-
5. Enter the `unique id` of an elastic profile in Job Settings<br/>
85
-
![Configure a job][7]
90
+
5. Enter the `unique id` of an elastic profile in Job Settings
0 commit comments