Skip to content
This repository has been archived by the owner on Jan 21, 2024. It is now read-only.

Commit

Permalink
chore: replace master by controller (#456)
Browse files Browse the repository at this point in the history
  • Loading branch information
lemeurherve authored Nov 20, 2023
1 parent 71f6da7 commit c22d8dd
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,13 @@ Optional environment variables:
* `JENKINS_JAVA_BIN`: Path to Java executable to use instead of the default in PATH or obtained from JAVA_HOME
* `JENKINS_JAVA_OPTS` : Java Options to use for the remoting process, otherwise obtained from JAVA_OPTS, **Warning** :exclamation: For more information on Windows usage, please see the **Windows Jenkins Java Opts** [section below](#windows-jenkins-java-opts).
* `JENKINS_URL`: url for the Jenkins server, can be used as a replacement to `-url` option, or to set alternate jenkins URL
* `JENKINS_TUNNEL`: (`HOST:PORT`) connect to this agent host and port instead of Jenkins server, assuming this one do route TCP traffic to Jenkins master. Useful when when Jenkins runs behind a load balancer, reverse proxy, etc.
* `JENKINS_SECRET`: (use only if not set as an argument) the secret as shown on the master after creating the agent
* `JENKINS_AGENT_NAME`: (use only if not set as an argument) the name of the agent, it should match the name you specified when creating the agent on the master
* `JENKINS_TUNNEL`: (`HOST:PORT`) connect to this agent host and port instead of Jenkins server, assuming this one do route TCP traffic to Jenkins controller. Useful when when Jenkins runs behind a load balancer, reverse proxy, etc.
* `JENKINS_SECRET`: (use only if not set as an argument) the secret as shown on the controller after creating the agent
* `JENKINS_AGENT_NAME`: (use only if not set as an argument) the name of the agent, it should match the name you specified when creating the agent on the controller
* `JENKINS_AGENT_WORKDIR`: agent work directory, if not set by optional parameter `-workDir`
* `JENKINS_WEB_SOCKET`: `true` if the connection should be made via WebSocket rather than TCP
* `JENKINS_DIRECT_CONNECTION`: (`HOST:PORT`) Connect directly to this TCP agent port, skipping the HTTP(S) connection parameter download.
* `JENKINS_INSTANCE_IDENTITY`: The base64 encoded InstanceIdentity byte array of the Jenkins master. When this is set, the agent skips connecting to an HTTP(S) port for connection info.
* `JENKINS_INSTANCE_IDENTITY`: The base64 encoded InstanceIdentity byte array of the Jenkins controller. When this is set, the agent skips connecting to an HTTP(S) port for connection info.
* `JENKINS_PROTOCOLS`: Specify the remoting protocols to attempt when `JENKINS_INSTANCE_IDENTITY` is provided.

#### Example
Expand Down
12 changes: 6 additions & 6 deletions docs/windows-commandline.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

Options can be passed to the docker image via command line parameters after the image name or via link:https://docs.docker.com/engine/reference/run/#env-environment-variables[environment variables].

* `-Url <URL>` or `JENKINS_URL=<URL>` - the Jenkins master URL (this should NOT include the `computer/NAME/slave-agent.jnlp` part which appears in the Jenkins UI after creating a new agent)
* `-Secret <SECRET>` or `JENKINS_SECRET=<SECRET>` - the secret as shown on the master after creating the agent
* `-Name <NAME>` or `JENKINS_AGENT_NAME=<NAME>` - the name of the agent, it should match the name you specified when creating the agent on the master
* `-Tunnel <HOST:PORT>` or `JENKINS_TUNNEL=<HOST:PORT>` - A tunnel host to route the TCP traffic through when connecting to the master
* `-Url <URL>` or `JENKINS_URL=<URL>` - the Jenkins controller URL (this should NOT include the `computer/NAME/slave-agent.jnlp` part which appears in the Jenkins UI after creating a new agent)
* `-Secret <SECRET>` or `JENKINS_SECRET=<SECRET>` - the secret as shown on the controller after creating the agent
* `-Name <NAME>` or `JENKINS_AGENT_NAME=<NAME>` - the name of the agent, it should match the name you specified when creating the agent on the controller
* `-Tunnel <HOST:PORT>` or `JENKINS_TUNNEL=<HOST:PORT>` - A tunnel host to route the TCP traffic through when connecting to the controller
* `-WorkDir <WORKDIR>` or `JENKINS_AGENT_WORKDIR=<WORKDIR>` - same as the -workDir parameter mentioned above in the jenkins/agent image information.
* `-WebSocket` or `JENKINS_WEB_SOCKET=true` - when present the connection to the master will be done via WebSocket through the Jenkins URL rather than using a separate network port.
* `-WebSocket` or `JENKINS_WEB_SOCKET=true` - when present the connection to the controller will be done via WebSocket through the Jenkins URL rather than using a separate network port.
* `-DirectConnection <HOST:PORT>` or `JENKINS_DIRECT_CONNECTION=<HOST:PORT>` - Connect directly to this TCP agent port, skipping the HTTP(S) connection parameter download.
* `-InstanceIdentity <BASE64VALUE>` or `JENKINS_INSTANCE_IDENTITY=<BASE64VALUE>` - The base64 encoded InstanceIdentity byte array of the Jenkins master. When this is set, the agent skips connecting to an HTTP(S) port for connection info
* `-InstanceIdentity <BASE64VALUE>` or `JENKINS_INSTANCE_IDENTITY=<BASE64VALUE>` - The base64 encoded InstanceIdentity byte array of the Jenkins controller. When this is set, the agent skips connecting to an HTTP(S) port for connection info
* `-JavaHome <JAVA_HOME>` or `JAVA_HOME=<JAVA_HOME>` - An override for the default JAVA_HOME baked into the image (different for JDK8 vs. JDK11)
* `-Protocols <PROTOCOLS>` or `JENKINS_PROTOCOLS=<PROTOCOLS>` - Specify the link:https://github.com/jenkinsci/remoting/blob/de7818885a5bf478760ba29f5ee216291437cb16/docs/protocols.md#active-protocols[remoting protocols] to attempt when instanceIdentity is provided.
Expand Down
2 changes: 1 addition & 1 deletion jenkins-agent
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
# * JENKINS_WEB_SOCKET: true if the connection should be made via WebSocket rather than TCP
# * JENKINS_DIRECT_CONNECTION: Connect directly to this TCP agent port, skipping the HTTP(S) connection parameter download.
# Value: "<HOST>:<PORT>"
# * JENKINS_INSTANCE_IDENTITY: The base64 encoded InstanceIdentity byte array of the Jenkins master. When this is set,
# * JENKINS_INSTANCE_IDENTITY: The base64 encoded InstanceIdentity byte array of the Jenkins controller. When this is set,
# the agent skips connecting to an HTTP(S) port for connection info.
# * JENKINS_PROTOCOLS: Specify the remoting protocols to attempt when instanceIdentity is provided.

Expand Down
2 changes: 1 addition & 1 deletion jenkins-agent.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Param(
# * JENKINS_WEB_SOCKET : true if the connection should be made via WebSocket rather than TCP
# * JENKINS_DIRECT_CONNECTION: Connect directly to this TCP agent port, skipping the HTTP(S) connection parameter download.
# Value: "<HOST>:<PORT>"
# * JENKINS_INSTANCE_IDENTITY: The base64 encoded InstanceIdentity byte array of the Jenkins master. When this is set,
# * JENKINS_INSTANCE_IDENTITY: The base64 encoded InstanceIdentity byte array of the Jenkins controller. When this is set,
# the agent skips connecting to an HTTP(S) port for connection info.
# * JENKINS_PROTOCOLS: Specify the remoting protocols to attempt when instanceIdentity is provided.

Expand Down

0 comments on commit c22d8dd

Please sign in to comment.