Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2101 from orrc/JENKINS-33364
[JENKINS-33364] Core documentation: Agent configuration
- Loading branch information
Showing
45 changed files
with
244 additions
and
183 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 22 additions & 10 deletions
32
core/src/main/resources/hudson/model/Node/help-labelString.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,23 @@ | ||
<div> | ||
Labels (AKA tags) are used for grouping multiple agents into one logical group. | ||
Use spaces between each label. For instance 'regression java6' will assign a | ||
node the labels 'regression' and 'java6'. | ||
|
||
<p> | ||
For example, if you have multiple Windows agents and you have jobs that require | ||
Windows, then you can configure all your Windows agents to have the label 'windows', | ||
then tie the job to the 'windows' label. This allows your job to run on any | ||
of your Windows agents but not on anywhere else. | ||
</div> | ||
Labels (or tags) are used to group multiple agents into one logical group. | ||
<p> | ||
For example, if you have multiple Windows agents and you have a job that | ||
must run on Windows, then you could configure all your Windows agents to have | ||
the label <tt>windows</tt>, and then tie that job to this label. | ||
<br> | ||
This would ensure that your job runs on one of your Windows agents, but not on | ||
any agents without this label. | ||
<p> | ||
Labels do not necessarily have to represent the operating system on the agent; | ||
you can also use labels to note the CPU architecture, or that a certain tool | ||
is installed on the agent. | ||
<p> | ||
Multiple labels must be separated by a space. For example, | ||
<tt>windows docker</tt> would assign two labels to the agent: <tt>windows</tt> | ||
and <tt>docker</tt>. | ||
<p> | ||
Labels may contain any non-space characters, but you should avoid special | ||
characters such as any of these: <tt>!&|<>()</tt>, as other Jenkins | ||
features allow for defining label expressions, where these characters may be | ||
used. | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,10 @@ | ||
<div> | ||
Name that uniquely identifies a agent within this Jenkins installation. | ||
|
||
Name that uniquely identifies an agent within this Jenkins installation. | ||
<p> | ||
This value could be any string, and doesn't have to be the same as the agent host name, | ||
but it's often convenient to make them the same. | ||
This does not have to be the same as the agent hostname (where applicable), | ||
but it is often convenient to make them the same. | ||
<p> | ||
The name may not contain any characters from this list: | ||
<tt>?*/\%!@#$^&|<>[]:;</tt> | ||
<!-- See jenkins.model.Jenkins#checkGoodName --> | ||
</div> |
25 changes: 14 additions & 11 deletions
25
core/src/main/resources/hudson/model/Node/help-numExecutors.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,18 @@ | ||
<div> | ||
This controls the number of concurrent builds that Jenkins can perform. So the value | ||
affects the overall system load Jenkins may incur. | ||
A good value to start with would be the number of processors on your system. | ||
|
||
The maximum number of concurrent builds that Jenkins may perform on this | ||
agent. | ||
<p> | ||
Increasing this value beyond that would cause each build to take longer, but it could increase | ||
the overall throughput, because it allows CPU to build one project while another build is waiting | ||
for I/O. | ||
|
||
A good value to start with would be the number of CPU cores on the machine. | ||
Setting a higher value would cause each build to take longer, but could | ||
increase the overall throughput. For example, one build might be CPU-bound, | ||
while a second build running at the same time might be I/O-bound — so | ||
the second build could take advantage of the spare I/O capacity at that | ||
moment. | ||
<p> | ||
When using Jenkins in the master/agent mode, setting this value to 0 would prevent the master | ||
from doing any building on its own. Agents may not have zero executors, but may be | ||
temporarily disabled using the button on the agent's status page. | ||
Agents must have at least one executor. To temporarily prevent any builds from | ||
being executed on an agent, use the <i>Mark this node temporarily offline</i> | ||
button on the agent's page. | ||
<p> | ||
This does not apply to the Jenkins master — setting the number of | ||
executors to zero will prevent any builds from being executed on the master. | ||
</div> |
38 changes: 18 additions & 20 deletions
38
core/src/main/resources/hudson/model/Slave/help-remoteFS.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,34 @@ | ||
<div> | ||
<p> | ||
An agent needs to have a directory dedicated to Jenkins. Specify | ||
the path of this work directory on the agent. It is best to use | ||
an absolute path, such as '/var/jenkins' or 'c:\jenkins'. This | ||
should be a path local to the agent machine. There's no need for | ||
this path to be visible from the master, under normal circumstances. | ||
|
||
the path to this directory on the agent. It is best to use | ||
an absolute path, such as <tt>/var/jenkins</tt> or <tt>c:\jenkins</tt>. | ||
This should be a path local to the agent machine. There is no need for | ||
this path to be visible from the master. | ||
<p> | ||
Agents do not maintain important data (other than active workspaces | ||
of projects last built on it), so you can possibly set the agent | ||
workspace to a temporary directory. The only downside of doing this | ||
is that you may lose the up-to-date workspace if the agent is turned off. | ||
|
||
Agents do not maintain important data; all job configurations, build logs and | ||
artifacts are stored on the master, so it would be possible to use a temporary | ||
directory as the agent root directory. | ||
<br> | ||
However, by giving an agent a directory that is not deleted after a machine | ||
reboot, for example, the agent can cache data such as tool installations, or | ||
build workspaces. This prevents unnecessary downloading of tools, or checking | ||
out source code again when builds start to run on this agent again after a | ||
reboot. | ||
<p> | ||
If you use a relative path, such as './jenkins-slave', the path will | ||
be relative to the current working directory that the launcher provides. | ||
If you use a relative path, such as <tt>./jenkins-agent</tt>, the path will be | ||
relative to the working directory provided by the <i>Launch method</i>. | ||
<ul> | ||
<li>For launchers where Jenkins controls starting the agent process, such | ||
as SSH, the current working directory will typically be consistent, | ||
<i>e.g.</i> the user's home directory. This means that Jenkins will be able to | ||
rely on the caching of tool installations and workspaces from previous | ||
builds. | ||
</li> | ||
e.g. the user's home directory.</li> | ||
<li>For launchers where Jenkins has no control over starting the agent | ||
process, such as JNLP when launched from either the command line or via | ||
a web browser link, the current working directory may change between | ||
launches of the agent and use of a relative path may prove problematic. | ||
<br> | ||
The principal issue encountered when using relative paths with launchers | ||
like JNLP is the proliferation of stale workspaces and tool installation | ||
on the agent machine. This can cause disk space issues. | ||
<i>Note: there are some cloud providers that specifically use relative | ||
paths with the JNLP launcher to allow for dynamically provisioned pools | ||
of semi-heterogeneous agents.</i></li> | ||
on the agent machine. This can cause disk space issues.</li> | ||
</ul> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ca.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# This file is under the MIT License by authors | ||
|
||
name=nom | ||
value=valor | ||
Name=nom | ||
Value=valor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_es_AR.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# This file is under the MIT License by authors | ||
|
||
name=nombre | ||
value=valor | ||
Name=nombre | ||
Value=valor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_he.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# This file is under the MIT License by authors | ||
|
||
List\ of\ key-value\ pairs=\u05E8\u05E9\u05D9\u05DE\u05D4 \u05E9\u05DC \u05E9\u05D3\u05D4-\u05E2\u05E8\u05DA | ||
name=\u05E9\u05DD | ||
value=\u05E2\u05E8\u05DA | ||
List\ of\ variables=\u05E8\u05E9\u05D9\u05DE\u05D4 \u05E9\u05DC \u05E9\u05D3\u05D4-\u05E2\u05E8\u05DA | ||
Name=\u05E9\u05DD | ||
Value=\u05E2\u05E8\u05DA |
6 changes: 3 additions & 3 deletions
6
core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_it.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# This file is under the MIT License by authors | ||
|
||
List\ of\ key-value\ pairs=Lista di coppie chiave-valore | ||
name=nome | ||
value=valore | ||
List\ of\ variables=Lista di coppie chiave-valore | ||
Name=nome | ||
Value=valore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ko.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# This file is under the MIT License by authors | ||
|
||
List\ of\ key-value\ pairs=\uD0A4-\uAC12 \uBAA9\uB85D | ||
name=\uC774\uB984 | ||
value=\uAC12 | ||
List\ of\ variables=\uD0A4-\uAC12 \uBAA9\uB85D | ||
Name=\uC774\uB984 | ||
Value=\uAC12 |
4 changes: 2 additions & 2 deletions
4
core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_lt.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# This file is under the MIT License by authors | ||
|
||
name=pavadinimas | ||
value=reik\u0161m\u0117 | ||
Name=pavadinimas | ||
Value=reik\u0161m\u0117 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_pl.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# This file is under the MIT License by authors | ||
|
||
List\ of\ key-value\ pairs=Lista par klucz-warto\u015B\u0107 | ||
name=nazwa | ||
value=warto\u015B\u0107 | ||
List\ of\ variables=Lista par klucz-warto\u015B\u0107 | ||
Name=nazwa | ||
Value=warto\u015B\u0107 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
...src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_pt_PT.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# This file is under the MIT License by authors | ||
|
||
List\ of\ key-value\ pairs=Lista de pares chave-valor | ||
name=nome | ||
value=valor | ||
List\ of\ variables=Lista de pares chave-valor | ||
Name=nome | ||
Value=valor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_sk.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# This file is under the MIT License by authors | ||
|
||
List\ of\ key-value\ pairs=Zoznam p\u00E1rov k\u013E\u00FA\u010D - hodnota | ||
name=k\u013E\u00FA\u010D | ||
value=hodnota | ||
List\ of\ variables=Zoznam p\u00E1rov k\u013E\u00FA\u010D - hodnota | ||
Name=k\u013E\u00FA\u010D | ||
Value=hodnota |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.