Skip to content

Commit

Permalink
[JENKINS-65398] renaming master to controller in texts/strings/md (#485)
Browse files Browse the repository at this point in the history
  • Loading branch information
aHenryJard authored Oct 19, 2021
1 parent 994ff27 commit 67aac9d
Show file tree
Hide file tree
Showing 11 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Jenkins Remoting layer

Jenkins remoting is an executable JAR,
which implements communication layer in [Jenkins](https://jenkins.io) automation server.
It's being used for master <=> agent and master <=> CLI communications.
It's being used for controller <=> agent and controller <=> CLI communications.

In general, this library contains the bootstrap code to bridge separate JVMs into a single semi-shared space.
It includes: TCP-based communication protocols, data serialization, Java classloading.
Expand Down
8 changes: 4 additions & 4 deletions docs/inbound-agent.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Launching inbound agents
Jenkins provides a number of ways of connecting remote agents.
Two of the most popular are outbound SSH agents and inbound agents.
SSH agents, most commonly used on Unix platforms, are master initiated.
The master creates the connection when it needs.
SSH agents, most commonly used on Unix platforms, are controller initiated.
The controller creates the connection when it needs.
Inbound agents, most commonly used on Windows platforms, are agent initiated.
The agent must first connect to the master and then the master sends commands as needed.
The agent must first connect to the controller and then the controller sends commands as needed.
These were formerly known as JNLP agents, but that name was erroneous and confusing.
This document describes some of the primary mechanisms for launching inbound agents.

Expand Down Expand Up @@ -115,7 +115,7 @@ You can obtain usage information by executing `java -cp agent.jar hudson.remotin
Not all parameters work together and some parameters require the use of others.

There are also system or environment variables that control some advanced behaviors documented at [Remoting Configuration](https://github.com/jenkinsci/remoting/blob/master/docs/configuration.md).
Many of these need to be set at both master and agent.
Many of these need to be set at both controller and agent.
Changing some of these may result in unreliable behavior.
One of these parameters that is supported with defined behavior is [`NO_PROXY`](https://github.com/jenkinsci/remoting/blob/master/docs/no_proxy.md).
Similar to the usage in a number of other applications, this controls which hosts should be excluded from proxy configurations.
Expand Down
4 changes: 2 additions & 2 deletions docs/protocols.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ Uses WebSocket over an HTTP(S) port to handle handshakes, encryption, framing, e

### Remoting Kafka Plugin

* [Remoting Kafka Plugin](https://github.com/jenkinsci/remoting-kafka-plugin) uses Kafka as fault-tolerant communication layer to support command invocation between Jenkins master and agent.
* The plugin gets rid of current direct TCP connection between master and agent.
* [Remoting Kafka Plugin](https://github.com/jenkinsci/remoting-kafka-plugin) uses Kafka as fault-tolerant communication layer to support command invocation between Jenkins controller and agent.
* The plugin gets rid of current direct TCP connection between controller and agent.
* More info can be found in the technical [documentation](https://github.com/jenkinsci/remoting-kafka-plugin/blob/master/docs/DOCUMENTATION.md) of the plugin.
2 changes: 1 addition & 1 deletion src/assembly/agent-load-test/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Jenkins Remoting Agent Load Tester
==================================

This is a test utility to determine the capacity limits of your Jenkins master.
This is a test utility to determine the capacity limits of your Jenkins controller.
Using this utility, you can fire up a remoting server that accepts a number of
loopback connections in order to see what load the JNLP remoting protocols
produce on your server.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/hudson/remoting/Callable.java
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ default Channel getChannelOrFail() throws ChannelStateException {
/**
* Gets an open channel, which is ready to accept commands.
*
* It is a convenience method for cases, when a callable needs to invoke call backs on the master.
* It is a convenience method for cases, when a callable needs to invoke call backs on the controller.
* In such case the requests will be likely failed by {@linkplain UserRequest} logic anyway, but it is better to fail fast.
*
* @return Channel instance
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/hudson/remoting/Engine.java
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
import org.jenkinsci.remoting.util.VersionNumber;

/**
* Agent engine that proactively connects to Jenkins master.
* Agent engine that proactively connects to Jenkins controller.
*
* @author Kohsuke Kawaguchi
*/
Expand Down Expand Up @@ -451,18 +451,18 @@ public void setInternalDir(@NonNull String internalDir) {
public void setFailIfWorkDirIsMissing(boolean failIfWorkDirIsMissing) { this.failIfWorkDirIsMissing = failIfWorkDirIsMissing; }

/**
* Returns {@code true} if and only if the socket to the master will have {@link Socket#setKeepAlive(boolean)} set.
* Returns {@code true} if and only if the socket to the controller will have {@link Socket#setKeepAlive(boolean)} set.
*
* @return {@code true} if and only if the socket to the master will have {@link Socket#setKeepAlive(boolean)} set.
* @return {@code true} if and only if the socket to the controller will have {@link Socket#setKeepAlive(boolean)} set.
*/
public boolean isKeepAlive() {
return keepAlive;
}

/**
* Sets the {@link Socket#setKeepAlive(boolean)} to use for the connection to the master.
* Sets the {@link Socket#setKeepAlive(boolean)} to use for the connection to the controller.
*
* @param keepAlive the {@link Socket#setKeepAlive(boolean)} to use for the connection to the master.
* @param keepAlive the {@link Socket#setKeepAlive(boolean)} to use for the connection to the controller.
*/
public void setKeepAlive(boolean keepAlive) {
this.keepAlive = keepAlive;
Expand Down Expand Up @@ -693,7 +693,7 @@ public void closeRead() throws IOException {

@SuppressWarnings({"ThrowableInstanceNeverThrown"})
private void innerRun(IOHub hub, SSLContext context, ExecutorService service) {
// Create the protocols that will be attempted to connect to the master.
// Create the protocols that will be attempted to connect to the controller.
List<JnlpProtocolHandler<? extends JnlpConnectionState>> protocols = new JnlpProtocolHandlerFactory(service)
.withIOHub(hub)
.withSSLContext(context)
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/hudson/remoting/Launcher.java
Original file line number Diff line number Diff line change
Expand Up @@ -122,15 +122,15 @@ public class Launcher {
@CheckForNull
public File agentLog = null;

@Option(name="-text",usage="encode communication with the master with base64. " +
@Option(name="-text",usage="encode communication with the controller with base64. " +
"Useful for running agent over 8-bit unsafe protocol like telnet")
public void setTextMode(boolean b) {
mode = b?Mode.TEXT:Mode.BINARY;
System.out.println("Running in "+mode.name().toLowerCase(Locale.ENGLISH)+" mode");
}

@Option(name="-jnlpUrl",usage="instead of talking to the master via stdin/stdout, " +
"emulate a JNLP client by making a TCP connection to the master. " +
@Option(name="-jnlpUrl",usage="instead of talking to the controller via stdin/stdout, " +
"emulate a JNLP client by making a TCP connection to the controller. " +
"Connection parameters are obtained by parsing the JNLP file.")
public URL agentJnlpURL = null;

Expand Down Expand Up @@ -160,9 +160,9 @@ public void addClasspath(String pathList) throws Exception {
System.setProperty("java.class.path",System.getProperty("java.class.path")+File.pathSeparatorChar+pathList);
}

@Option(name="-tcp",usage="instead of talking to the master via stdin/stdout, " +
@Option(name="-tcp",usage="instead of talking to the controller via stdin/stdout, " +
"listens to a random local port, write that port number to the given file, " +
"then wait for the master to connect to that port.")
"then wait for the controller to connect to that port.")
public File tcpPortFile=null;


Expand All @@ -173,7 +173,7 @@ public void addClasspath(String pathList) throws Exception {
* @since 2.24
*/
@CheckForNull
@Option(name="-jar-cache",metaVar="DIR",usage="Cache directory that stores jar files sent from the master")
@Option(name="-jar-cache",metaVar="DIR",usage="Cache directory that stores jar files sent from the controller")
public File jarCache = null;

/**
Expand Down Expand Up @@ -230,7 +230,7 @@ public void setNoCertificateCheck(boolean ignored) throws NoSuchAlgorithmExcepti
public boolean noReconnect = false;

@Option(name = "-noKeepAlive",
usage = "Disable TCP socket keep alive on connection to the master.")
usage = "Disable TCP socket keep alive on connection to the controller.")
public boolean noKeepAlive = false;

/**
Expand Down Expand Up @@ -387,7 +387,7 @@ public void run() throws Exception {
hudson.remoting.jnlp.Main._main(jnlpArgs.toArray(new String[0]));
} catch (CmdLineException e) {
System.err.println("JNLP file "+ agentJnlpURL +" has invalid arguments: "+jnlpArgs);
System.err.println("Most likely a configuration error in the master");
System.err.println("Most likely a configuration error in the controller");
System.err.println(e.getMessage());
System.exit(1);
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/hudson/remoting/jnlp/GuiListener.java
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public void run() {

@Override
public void onDisconnect() {
// discard all the menu items that might have been added by the master.
// discard all the menu items that might have been added by the controller.
SwingUtilities.invokeLater(frame::resetMenuBar);
}

Expand Down
8 changes: 4 additions & 4 deletions src/main/java/hudson/remoting/jnlp/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public class Main {
public boolean noReconnect = false;

@Option(name="-noKeepAlive",
usage="Disable TCP socket keep alive on connection to the master.")
usage="Disable TCP socket keep alive on connection to the controller.")
public boolean noKeepAlive = false;

@Option(name = "-cert",
Expand Down Expand Up @@ -182,7 +182,7 @@ public class Main {
/**
* @since 2.24
*/
@Option(name="-jar-cache",metaVar="DIR",usage="Cache directory that stores jar files sent from the master")
@Option(name="-jar-cache",metaVar="DIR",usage="Cache directory that stores jar files sent from the controller")
public File jarCache = null;

/**
Expand All @@ -194,12 +194,12 @@ public class Main {
public String directConnection;

/**
* The master's instance identity.
* The controller's instance identity.
* @see <a href="https://wiki.jenkins.io/display/JENKINS/Instance+Identity">Instance Identity</a>
* @since 3.34
*/
@Option(name="-instanceIdentity", depends = {"-direct"},
usage="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.")
usage="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.")
public String instanceIdentity;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ public JnlpAgentEndpoint resolve() throws IOException {

if (agentProtocolNames.isEmpty()) {
LOGGER.log(Level.WARNING, "Received the empty list of supported protocols from the server. " +
"All protocols are disabled on the master side OR the 'X-Jenkins-Agent-Protocols' header is corrupted (JENKINS-41730). " +
"All protocols are disabled on the controller side OR the 'X-Jenkins-Agent-Protocols' header is corrupted (JENKINS-41730). " +
"In the case of the header corruption as a workaround you can use the " +
"'org.jenkinsci.remoting.engine.JnlpAgentEndpointResolver.protocolNamesToTry' system property " +
"to define the supported protocols.");
Expand Down Expand Up @@ -409,14 +409,14 @@ public void waitForReady() throws InterruptedException {
return;
}
LOGGER.log(Level.INFO,
"Master isn''t ready to talk to us on {0}. Will try again: response code={1}",
"Controller isn''t ready to talk to us on {0}. Will try again: response code={1}",
new Object[]{url, con.getResponseCode()});
} catch (SocketTimeoutException | ConnectException | NoRouteToHostException e) {
LOGGER.log(INFO, "Failed to connect to the master. Will try again: {0} {1}",
LOGGER.log(INFO, "Failed to connect to the controller. Will try again: {0} {1}",
new String[] { e.getClass().getName(), e.getMessage() });
} catch (IOException e) {
// report the failure
LOGGER.log(INFO, "Failed to connect to the master. Will try again", e);
LOGGER.log(INFO, "Failed to connect to the controller. Will try again", e);
}
}
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/test/java/hudson/remoting/TrafficAnalyzer.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
import java.io.ObjectInputStream;

/**
* A little forensic analysis tool to figure out what information master and agent are exchanging.
* A little forensic analysis tool to figure out what information controller and agent are exchanging.
*
* <p>
* Use the tee command or network packet capturing tool to capture the traffic between the master and
* Use the tee command or network packet capturing tool to capture the traffic between the controller and
* the agent, then run it through this tool to get the dump of what commands are sent between them.
*
* @author Kohsuke Kawaguchi
Expand Down

0 comments on commit 67aac9d

Please sign in to comment.