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.

Sign up for GitHub

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

Improve remoting documentation #6994

Merged
merged 3 commits into from
Jan 8, 2024
Merged

Improve remoting documentation #6994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed32dd0
Improve remoting redirects
MarkEWaite Jan 8, 2024
70e80df
Redirect to current remoting changelog
MarkEWaite Jan 8, 2024
dbfcb83
Minor phrasing improvements
MarkEWaite Jan 8, 2024
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
14 changes: 7 additions & 7 deletions content/projects/remoting/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ links:
googlegroup: 'jenkinsci-dev'
---

Jenkins Remoting is a library, and executable Java archive, which implements the communication layer in Jenkins.
This includes the TCP-based communication protocols, remote procedure calls, class loading, data streaming, etc.
Jenkins Remoting is a library, and executable Java archive, which implements the communication layer in Jenkins.
This includes the TCP-based communication protocols, remote procedure calls, class loading, data streaming, etc.
Currently Remoting is primarily used in communications between the Jenkins controller and Jenkins agents.

The Remoting sub-project includes the Remoting library itself, package for agents, and a number of Remoting-specific plugins and core modules.
Expand All @@ -22,16 +22,16 @@ The Remoting sub-project includes the Remoting library itself, package for agent

== Remoting Usage in Jenkins

* Agent executables (`remoting.jar` is a named `agent.jar` or `slave.jar` in Jenkins)
* Controller to Agent communication protocols being used in various Agent types, including Java Web Start (aka JNLP) and plugin:ssh-slaves[SSH] agents
* Agent executables (`remoting.jar` is named `agent.jar` or `slave.jar` in Jenkins)
* Controller to Agent communication protocols being used in various Agent types, including inbound (JNLP) and plugin:ssh-slaves[SSH] agents
* link:/doc/book/managing/cli/[Jenkins CLI], Remoting mode is **deprecated since 2.54** (link:/blog/2017/04/11/new-cli/[announcement])
* Communication with Maven instance in the plugin:maven-plugin[Maven Integration plugin].

== Project Components

=== Remoting Library

Remoting Library is the main component of the the sub-project.
Remoting Library is the main component of the sub-project.
The code base is located in a link:https://github.com/jenkinsci/remoting[separate repository],
which also contains Remoting developer and user documentation.
This library also has an independent release cycle and LTS release lines.
Expand All @@ -45,10 +45,10 @@ Links:

=== Jenkins Core and Modules

Although Remoting library is a standalone component,
Although Remoting library is a standalone component,
Jenkins core includes some extensions and modules for working with Remoting.
Core extensions also allow implementing custom protocols on-demand (e.g. for Jenkins CLI).
There is ongoing activity on detaching these core components to Jenkins plugins
There is ongoing activity on detaching these core components to Jenkins plugins
(see jira:JENKINS-44099[]),
but in the meantime upgrading of Jenkins core may be required to fix Remoting issues.

Expand Down
2 changes: 1 addition & 1 deletion content/redirect/project/remoting/changelog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
layout: redirect
redirect_url: https://github.com/jenkinsci/remoting/blob/master/CHANGELOG.md
redirect_url: https://github.com/jenkinsci/remoting/releases
---
2 changes: 1 addition & 1 deletion content/redirect/project/remoting/protocols/jnlp2-errata.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
layout: redirect
redirect_url: https://github.com/jenkinsci/remoting/blob/master/docs/protocols.md#jnlp2-connect-errata
redirect_url: https://github.com/jenkinsci/remoting/blob/master/docs/protocols.md
---
2 changes: 1 addition & 1 deletion content/redirect/project/remoting/protocols/jnlp3-errata.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
layout: redirect
redirect_url: https://github.com/jenkinsci/remoting/blob/master/docs/protocols.md#jnlp2-connect-errata
redirect_url: https://github.com/jenkinsci/remoting/blob/master/docs/protocols.md
---