From 6f974182422d6572a355d605ca3bc7bd7590a9ea Mon Sep 17 00:00:00 2001 From: Jesse Glick Date: Wed, 25 Oct 2023 13:36:15 -0400 Subject: [PATCH] Refresh of inline docs --- .../ContainerTemplate/help-image.html | 8 +++---- .../ContainerTemplate/help-name.html | 4 ++-- .../kubernetes/KubernetesCloud/config.jelly | 4 ++-- .../help-directConnection.html | 23 +++---------------- .../KubernetesCloud/help-jnlpregistry.html | 4 ++-- .../plugins/kubernetes/Messages.properties | 4 ++-- .../PodTemplate/help-slaveConnectTimeout.html | 2 +- .../help-defaultContainer.html | 2 +- 8 files changed, 16 insertions(+), 35 deletions(-) diff --git a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/ContainerTemplate/help-image.html b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/ContainerTemplate/help-image.html index ae26fe007b..98889adef7 100644 --- a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/ContainerTemplate/help-image.html +++ b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/ContainerTemplate/help-image.html @@ -1,5 +1,3 @@ -Docker image ID for a jenkins JNLP agent. -This image is responsible to run a jenkins jnlp bootstrap agent and connect to Jenkins controller. -Secret key and agent name as well as jenkins callback URL are passed as argument as expected -by hudson.remoting.jnlp.Main. - +Container image (repository, name, and tag) for a Jenkins inbound agent. +Connection details will be passed as environment variables as per +documentation. diff --git a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/ContainerTemplate/help-name.html b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/ContainerTemplate/help-name.html index 3029029eb2..3009bc9847 100644 --- a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/ContainerTemplate/help-name.html +++ b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/ContainerTemplate/help-name.html @@ -1,5 +1,5 @@ The name for the container to be run. -One container is automatically created with name jnlp, and runs the Jenkins JNLP agent service. +One container is automatically created with the name jnlp, and runs the Jenkins agent. -In order to replace the default JNLP agent, the name of the container with the custom JNLP image must be jnlp. +In order to replace the default agent image, the container with the agent must be named jnlp. diff --git a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/config.jelly b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/config.jelly index 69aaabf1d1..f8e4865a76 100644 --- a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/config.jelly +++ b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/config.jelly @@ -46,11 +46,11 @@ THE SOFTWARE. - + - + diff --git a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-directConnection.html b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-directConnection.html index 24bce1b24c..5c64e7e9dc 100644 --- a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-directConnection.html +++ b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-directConnection.html @@ -1,34 +1,17 @@

With this option it is possible to connect directly to the TCP agent listener port. - This skips the connect to an HTTP(S) port to retrieve the connection information. + This skips the connection to an HTTP(S) port to retrieve some metadata.

This is useful in scenarios where the controller does not expose an HTTP(S) port, for example - Jenkinsfile Runner. -

- -

- Here is an example how the connect on agent side would look like. Most parameters are provided automatically when you enable the Direct Connection option. - 

-  java -cp agent.jar hudson.remoting.jnlp.Main \
-    -headless \
-    -workDir <WORK_DIRECTORY> \
-    -direct <MASTER_HOST:TCP_AGENT_LISTENER_PORT> \
-    -protocols JNLP4-connect \
-    -instanceIdentity <INSTANCE_IDENTITY> \
-    <SECRET_STRING> <AGENT_NAME>
-
-

- -

- You find more information in the Jenkins Remoting project. + Jenkinsfile Runner, + but more commonly if you simply wish to optimize the connection slightly.

Note: In Direct Connection mode agents will not be able to reconnect to a restarted controller if a Random 'TCP port for inbound agents' is configured!
- Note: Direct Connection requires a inbound-agent image with a version equal or higher than 3.35-5.
Note: Direct Connection does not work with the currently available jenkins/inbound-agent:windowsservercore-1809 image.

diff --git a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-jnlpregistry.html b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-jnlpregistry.html index 4f78d3d19d..0ae6b0ff03 100644 --- a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-jnlpregistry.html +++ b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-jnlpregistry.html @@ -1,3 +1,3 @@
- Provide the docker registry you want to use to pull the JNLP image if none is specified -
\ No newline at end of file + Provide the Docker registry you want to use to pull the agent image if none is specified +
diff --git a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/Messages.properties b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/Messages.properties index ce43dbc89a..19aaf270c2 100644 --- a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/Messages.properties +++ b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/Messages.properties @@ -4,8 +4,8 @@ KubernetesSlave.AgentIsProvisionedFromTemplate=Agent {0} is provisioned from tem RFC1123.error=Container Names MUST match RFC 1123 - They can only contain lowercase letters, numbers or dashes: {0} label.error=Labels must follow required specs - https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set: {0} KubernetesFolderProperty.displayName=Kubernetes -KubernetesSlave.HomeWarning=[WARNING] HOME is set to / in the jnlp container. You may encounter \ +KubernetesSlave.HomeWarning=[WARNING] HOME is set to / in the agent container. You may encounter \ troubles when using tools or ssh client. This usually happens if the uid doesn't have any \ entry in /etc/passwd. Please add a user to your Dockerfile or set the HOME environment \ variable to a valid directory in the pod template definition. -KubernetesCloudNotAllowed.Description=Kubernetes cloud {0} is not allowed for folder containing job {1} \ No newline at end of file +KubernetesCloudNotAllowed.Description=Kubernetes cloud {0} is not allowed for folder containing job {1} diff --git a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/PodTemplate/help-slaveConnectTimeout.html b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/PodTemplate/help-slaveConnectTimeout.html index 716e03c7dc..e4bc874d58 100644 --- a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/PodTemplate/help-slaveConnectTimeout.html +++ b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/PodTemplate/help-slaveConnectTimeout.html @@ -1,4 +1,4 @@

- Specify time in seconds up to which Jenkins should wait for the JNLP agent to establish a connection.
+ Specify time in seconds up to which Jenkins should wait for the agent to establish a connection.
Value must be a positive integer.

diff --git a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesDeclarativeAgent/help-defaultContainer.html b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesDeclarativeAgent/help-defaultContainer.html index 1864784ed6..bfd172a103 100644 --- a/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesDeclarativeAgent/help-defaultContainer.html +++ b/src/main/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesDeclarativeAgent/help-defaultContainer.html @@ -1,4 +1,4 @@

Name of the default container steps will be run in.

When using this option, all steps will be executed within an implicit container(name) {...} block instead - of the jnlp container.

+ of the jnlp container.