Skip to content

Commit dcb71e4

Browse files
chadlwilsonchadlwilson
committed
Clarify wording for private docker registry settings
1 parent f036d03 commit dcb71e4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

‎INSTALL.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ The cluster profile settings are used to provide cluster level configurations fo
3737
![Cluster Profile basic settings][2]
3838
![Cluster Profile docker client settings][8]
3939

40-
| Field Name | Mandatory | Description |
40+
| Field Name | Mandatory | Description |
4141
|---------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
42-
| **Go server url** | Yes | GoCD server url(`http://YOUR_HOST_OR_IP_ADDRESS:8153/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` |
43-
| **Environment variables** | No | The environment variable for docker container |
44-
| **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 |
45-
| **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 |
46-
| **Docker URI** | Yes | Docker daemon uri. <br/>If your Go Server is running on local machine then use(for mac and linux) — `unix:///var/run/docker.sock`. Otherwise, refer to [Connecting to a remote docker daemon secured with TLS](#connecting-to-a-remote-docker-daemon-secured-with-tls) |
47-
| **Docker CA Certificate** | No | Docker CA certificate, refer to [Connecting to a remote docker daemon secured with TLS](#connecting-to-a-remote-docker-daemon-secured-with-tls)|
48-
| **Docker Client Key** | No | Docker client key, to refer to [Connecting to a remote docker daemon secured with TLS](#connecting-to-a-remote-docker-daemon-secured-with-tls) |
49-
| **Docker Client Certificate** | No | Docker client certificate, refer to [Connecting to a remote docker daemon secured with TLS](#connecting-to-a-remote-docker-daemon-secured-with-tls) |
50-
| **Private Docker Registry** | Yes | Optionally specify the private docker registry settings, either by inputting custom credentials on the GoCD admin UI, or by creating a docker configuration file in `$HOME/.docker/config.json` that is accessible by GoCD server. Please note that if you choose to use custom credentials and initially set the `private_registry_username` and `private_registry_password` fields, then switch to using a docker configuration file later, they will still show up, but masked, in the cluster configuration UI. If you don't want those values to show up, please explicitly clear them out in the configuration form before switching to use a docker configuration file|
42+
| **Go server url** | Yes | GoCD server url (`http://YOUR_HOST_OR_IP_ADDRESS:8153/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` |
43+
| **Environment variables** | No | The environment variable for docker container |
44+
| **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 |
45+
| **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 |
46+
| **Docker URI** | Yes | Docker daemon uri. <br/>If your Go Server is running on local machine then use(for mac and linux) — `unix:///var/run/docker.sock`. Otherwise, refer to [Connecting to a remote docker daemon secured with TLS](#connecting-to-a-remote-docker-daemon-secured-with-tls) |
47+
| **Docker CA Certificate** | No | Docker CA certificate, refer to [Connecting to a remote docker daemon secured with TLS](#connecting-to-a-remote-docker-daemon-secured-with-tls) |
48+
| **Docker Client Key** | No | Docker client key, to refer to [Connecting to a remote docker daemon secured with TLS](#connecting-to-a-remote-docker-daemon-secured-with-tls) |
49+
| **Docker Client Certificate** | No | Docker client certificate, refer to [Connecting to a remote docker daemon secured with TLS](#connecting-to-a-remote-docker-daemon-secured-with-tls) |
50+
| **Private Docker Registry** | Yes | Optionally specify the private docker registry settings, either by inputting custom credentials on the GoCD admin UI, or by creating a docker configuration file in `$HOME/.docker/config.json` that is accessible by GoCD server. Please note that if you choose to use custom credentials and initially set the `private_registry_username` and `private_registry_password` fields, then switch to using a docker configuration file later, they will still appear in the cluster configuration UI. If you don't want those values to show up, please explicitly clear them out in the configuration form before switching to use a docker configuration file |
5151

5252
### Create an elastic profile
5353

0 commit comments

Comments
 (0)