Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update glossary regarding terminology for Job and Project #3362

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions content/doc/book/glossary/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ Artifact::
An immutable file generated during a <<build,Build>> or <<pipeline,Pipeline>>
run which is *archived* onto the Jenkins <<controller,Controller>> for
later retrieval by users.
Build::
Result of a single execution of a <<project,Project>>
Cloud::
Build:: [[build]]
Result of a single execution of a <<job,Job>>
Cloud:: [[cloud]]
A System Configuration which provides dynamic <<agent,Agent>>
provisioning and allocation, such as that provided by the
plugin:azure-vm-agents[Azure VM Agents]
Expand All @@ -66,30 +66,31 @@ Core::
The primary Jenkins application (`jenkins.war`) which provides
the basic web UI, configuration, and foundation upon which <<plugin, Plugins>>
can be built.
Downstream::
A configured <<pipeline,Pipeline>> or <<project,Project>> which is triggered
as part of the execution of a separate Pipeline or Project.
Executor::
Downstream:: [[downstream]]
A configured <<pipeline,Pipeline>> or <<job,Job>> which is triggered
as part of the execution of a separate Pipeline or Job.
Executor:: [[executor]]
A slot for execution of work defined by a <<pipeline,Pipeline>> or
<<project,Project>> on a <<node, Node>>. A Node may have zero or more
Executors configured which corresponds to how many concurrent Projects or
<<job,Job>> on a <<node, Node>>. A Node may have zero or more
Executors configured which corresponds to how many concurrent Jobs or
Pipelines are able to execute on that Node.
Fingerprint::
A hash considered globally unique to track the usage of an
<<artifact,Artifact>> or other entity across multiple
<<pipeline,Pipelines>> or <<project,Projects>>.
Folder::
<<pipeline,Pipelines>> or <<job,Job>>.
Folder:: [[folder]]
An organizational container for <<pipeline,Pipelines>> and/or
<<project,Projects>>, similar to folders on a file system.
Item::
<<job,jobs>>, similar to folders on a file system.
Item:: [[item]]
An entity in the web UI corresponding to either a:
<<folder,Folder>>, <<pipeline,Pipeline>>, or <<project,Project>>.
<<folder,Folder>>, <<pipeline,Pipeline>>, or <<job,Job>>.
Jenkins URL:: [[jenkins-url]]
The main url for the jenkins application, as visited by a user.
e.g. https://ci.jenkins.io/
Job::
A deprecated term, synonymous with <<project,Project>>.
Label::
Job:: [[job]]
A user-configured description of work which Jenkins should perform, such as
building a piece of software, etc.
Label:: [[label]]
User-defined text for grouping <<agent,Agents>>, typically by similar
functionality or capability. For example `linux` for Linux-based agents or
`docker` for Docker-capable agents.
Expand All @@ -101,12 +102,11 @@ Master::
A deprecated term, synonymous with <<controller,Controller>>.
Node::
A machine which is part of the Jenkins environment and capable
of executing <<pipeline,Pipelines>> or <<project,Projects>>. Both the
<<controller,Controller>> and <<agent,Agents>> are considered to be Nodes.
Project::
A user-configured description of work which Jenkins should perform, such as
building a piece of software, etc.
Pipeline::
of executing <<pipeline,Pipelines>> or <<job,jobs>>. Both the
<<master,Master>> and <<agent,Agents>> are considered to be Nodes.
Project:: [[project]]
A deprecated term, synonymous with <<job,Job>>.
Pipeline:: [[pipeline]]
A user-defined model of a continuous delivery pipeline, for more read the
<<pipeline#,Pipeline chapter>> in this handbook.
Plugin::
Expand All @@ -133,19 +133,19 @@ Stage::
status/progress.
Step::
A single task; fundamentally steps tell Jenkins _what_ to do inside of a
<<pipeline,Pipeline>> or <<project,Project>>.
Trigger::
<<pipeline,Pipeline>> or <<job,Job>>.
Trigger:: [[trigger]]
A criteria for triggering a new <<pipeline,Pipeline>> run or
<<build,Build>>.
Update Center:: [[update-center]]
Hosted inventory of plugins and plugin metadata to enable plugin
installation from within Jenkins.
Upstream::
A configured <<pipeline,Pipeline>> or <<project,Project>> which triggers a
separate Pipeline or Project as part of its execution.
Workspace::
Upstream:: [[upstream]]
A configured <<pipeline,Pipeline>> or <<job,Job>> which triggers a
separate Pipeline or Job as part of its execution.
Workspace:: [[workspace]]
A disposable directory on the file system of a <<node,Node>>
where work can be done by a <<pipeline,Pipeline>> or <<project,Project>>.
where work can be done by a <<pipeline,Pipeline>> or <<job,Job>>.
Workspaces are typically left in place after a <<build,Build>> or
<<pipeline,Pipeline>> run completes unless specific Workspace cleanup policies
have been put in place on the Jenkins <<controller,Controller>>.
Expand Down