diff --git a/src/main/resources/io/jenkins/docker/connector/DockerComputerAttachConnector/config.jelly b/src/main/resources/io/jenkins/docker/connector/DockerComputerAttachConnector/config.jelly index f4fd5daa4..0209f437a 100644 --- a/src/main/resources/io/jenkins/docker/connector/DockerComputerAttachConnector/config.jelly +++ b/src/main/resources/io/jenkins/docker/connector/DockerComputerAttachConnector/config.jelly @@ -2,7 +2,18 @@ - Prerequisites: Docker image must have Java installed. Also entrypoint must be able to accept jenkins slave connection parameters. See jenkins/docker-jnlp-slave as an example + Prerequisites: + diff --git a/src/main/resources/io/jenkins/docker/connector/DockerComputerJNLPConnector/config.jelly b/src/main/resources/io/jenkins/docker/connector/DockerComputerJNLPConnector/config.jelly index ec77b30e7..12b57fb11 100644 --- a/src/main/resources/io/jenkins/docker/connector/DockerComputerJNLPConnector/config.jelly +++ b/src/main/resources/io/jenkins/docker/connector/DockerComputerJNLPConnector/config.jelly @@ -2,8 +2,18 @@ - Prerequisites: Docker image must have Java installed, - and Jenkins master has to be accessible over network from container. + Prerequisites: +
    +
  • + Jenkins master has to be accessible over network from the container. +
  • +
  • + Docker image must have Java installed. +
  • +
  • + Docker image must either have slave.jar pre-installed or have its entry point code download it. +
  • +
@@ -15,7 +25,7 @@ - + diff --git a/src/main/resources/io/jenkins/docker/connector/DockerComputerJNLPConnector/help-entryPointArgumentsString.jelly b/src/main/resources/io/jenkins/docker/connector/DockerComputerJNLPConnector/help-entryPointArgumentsString.jelly index 0355a65b9..f6a341f85 100644 --- a/src/main/resources/io/jenkins/docker/connector/DockerComputerJNLPConnector/help-entryPointArgumentsString.jelly +++ b/src/main/resources/io/jenkins/docker/connector/DockerComputerJNLPConnector/help-entryPointArgumentsString.jelly @@ -3,7 +3,15 @@

Arguments to be passed to the container's entry point. +

+

+ NOTE: + This field is a multi-line string. Each (non-empty) line defines a seperate argument. + If you require more than one argument + (e.g. copying one of the examples below) + then you will need to expand the field, + otherwise you'll end up with one long line instead of multiple lines.

Limited variable substitution (using $${VARIABLE_NAME} syntax) is carried out on the configured strings prior to starting the container. @@ -15,22 +23,31 @@

+

+ For example, if you are using a custom container that has + java + and + wget + installed but does not have + slave.jar + pre-installed then you could use the following instead: +

+ sh
+ -c
+ wget $${JENKINS_URL}jnlpJars/slave.jar && java -jar slave.jar -jnlpUrl $${JENKINS_URL}computer/$${NODE_NAME}/slave-agent.jnlp -secret $${JNLP_SECRET}
+
+

If this field is left blank then it defaults to arguments suitable for the standard Jenkins JNLP Agent Docker image, - jenkins/jnlp-slave, namely: + jenkins/jnlp-slave, + which are:

${entry}
- If you are using a custom container that does not use the same entry point then you could use the following arguments instead: -
- sh
- -c
- wget $${JENKINS_URL}jnlpJars/slave.jar && java -jar slave.jar -jnlpUrl $${JENKINS_URL}computer/$${NODE_NAME}/slave-agent.jnlp -secret $${JNLP_SECRET}
-

diff --git a/src/main/resources/io/jenkins/docker/connector/DockerComputerSSHConnector/config.jelly b/src/main/resources/io/jenkins/docker/connector/DockerComputerSSHConnector/config.jelly index a506d8489..dd5e4ea61 100644 --- a/src/main/resources/io/jenkins/docker/connector/DockerComputerSSHConnector/config.jelly +++ b/src/main/resources/io/jenkins/docker/connector/DockerComputerSSHConnector/config.jelly @@ -2,7 +2,30 @@ - Prerequisites: Docker image must have sshd and a JDK installed. + Prerequisites: +
    +
  • + The docker container's mapped SSH port, + typically a port on the docker host, + has to be accessible over network from the master. +
  • +
  • + Docker image must have + sshd + installed. +
  • +
  • + Docker image must have + Java + installed. +
  • +
  • + Log in details configured as per + ssh-slaves + plugin. +
  • +
+