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: README.md
+38-20Lines changed: 38 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,6 @@ Table of Contents
5
5
6
6
*[Installation](#installation)
7
7
*[Building the code base](#building-the-code-base)
8
-
*[Is this production ready?](#is-this-production-ready)
9
8
*[Using your own docker image with elastic agents](#using-your-own-docker-image-with-elastic-agents)
10
9
*[Using the GoCD agent, installed via .deb/.rpm](#using-the-gocd-agent-installed-via-debrpm)
11
10
*[Use a custom bootstrapper](#use-a-custom-bootstrapper)
@@ -21,18 +20,6 @@ Documentation for installation is available [here](INSTALL.md).
21
20
22
21
To build the jar, run `./gradlew clean test assemble`
23
22
24
-
## Is this production ready?
25
-
26
-
It depends.
27
-
28
-
**tl;dr;**
29
-
30
-
If you need something simple to get started with, use this plugin. If you're looking to run a lot of builds, you probably want to look at the [docker swarm elastic agent plugin](https://github.com/gocd-contrib/docker-swarm-elastic-agents).
31
-
32
-
**The long answer:**
33
-
34
-
The plugin, as it is currently implemented is meant to be a very simple plugin to demonstrate how to get started with GoCD [elastic agent](https://plugin-api.go.cd/current/elastic-agents) feature. It does not support some of the other interesting things you can do with docker (resource limits, host file mapping etc.)
35
-
36
23
## Using your own docker image with elastic agents
37
24
38
25
The plugin executes the equivalent of the following docker command to start the agent —
@@ -75,26 +62,57 @@ See the bootstrap script and docker file here under [`contrib/scripts/bootstrap-
75
62
76
63
## Troubleshooting
77
64
78
-
Enabling debug level logging can help you troubleshoot an issue with the elastic agent plugin. To enable debug level logs, edit the `/etc/default/go-server` (for Linux) to add:
If you're running the server via `./server.sh` script —
69
+
Edit the file `wrapper-properties.conf` on your GoCD server and add the following options. The location of the `wrapper-properties.conf` can be found in the [installation documentation](https://docs.gocd.org/current/installation/installing_go_server.html) of the GoCD server.
85
70
71
+
```properties
72
+
# We recommend that you begin with the index `100` and increment the index for each system property
If you're running with GoCD server 19.6 and above on docker using one of the supported GoCD server images, set the environment variable `GOCD_SERVER_JVM_OPTIONS`:
77
+
78
+
```shell
79
+
docker run -e "GOCD_SERVER_JVM_OPTIONS=-Dplugin.cd.go.contrib.elastic-agent.docker.log.level=debug" ...
88
80
```
89
81
82
+
#### If you are on GoCD version 19.5 and lower:
83
+
84
+
* On Linux:
85
+
86
+
Enabling debug level logging can help you troubleshoot an issue with this plugin. To enable debug level logs, edit the file `/etc/default/go-server` (for Linux) to add:
Thanks to @konpa for the [docker icon](https://raw.githubusercontent.com/konpa/devicon/b80c6d9acb7b58b80904769015f9e0dd36fe46d2/icons/docker/docker-plain.svg) used by the plugin.
93
111
94
112
## License
95
113
96
114
```plain
97
-
Copyright 2018, ThoughtWorks, Inc.
115
+
Copyright 2019, ThoughtWorks, Inc.
98
116
99
117
Licensed under the Apache License, Version 2.0 (the "License");
100
118
you may not use this file except in compliance with the License.
0 commit comments