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

[JENKINS-39161] - Remoting documentation upgrade for the 3.0 release #121

Merged
merged 11 commits into from
Oct 23, 2016

Conversation

oleg-nenashev
Copy link
Member

@oleg-nenashev oleg-nenashev commented Oct 21, 2016

Plan:

  • UPD: Readme
  • UPD: Changelog
  • NEW: Contributing page with release creation guides
  • NEW: Compatibility Notes change
  • NEW: Protocols description page
  • POSTPONED: -NEW: Jenkins Specifics page with configuration guidelines: configuring protocols, restricting versions, using in Docker, etc.-
  • UPD: System Properties page

@reviewbybees @jenkinsci/code-reviewers

https://issues.jenkins-ci.org/browse/JENKINS-39161

Major changes:

* Java 7 is a new target JVM, the new remoting version is not guaranteed to work properly on Java 9 and versions below Java 7
* <code>JNLP4-connect</code> and <code>JNLP4-plaintext</code> protocols, which offers a high-performance communication layer
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: "protocols"

Copy link
Member

@stephenc stephenc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text on jnlp4-plaintext needs rework

* Introduced in: Remoting 3.0, [JENKINS-36871](https://issues.jenkins-ci.org/browse/JENKINS-36871)
* Use with caution

The protocol is similar to <code>JNLP4-plaintext</code>,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean JNLP-connect

### JNLP4-plaintext

* Introduced in: Remoting 3.0, [JENKINS-36871](https://issues.jenkins-ci.org/browse/JENKINS-36871)
* Use with caution
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This protocol was developed to allow for like for like performance comparison between the original NIO engine used by JNLP2-connect and the new NIO engine used by JNLP4. As this protocol is plaintext it is not for use outside of like for like performance testing

but it does not setup the TLS encryption between agent and master.
In particular cases it may expose the secret data.

On the other had, the protocol allows to get extra performance in the case when the remoting layer does not need its own encryption
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this text. The protocol is only to enable like for like performance testing and to allow for focused performance tuning of the stack outside of the performance tuning complexity of SSLEngine that the TLS layer introduces, i.e. By removing the TLS layer we can amplify the effect of IO tuning on system as we have reduced the CPU load

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. I will remove it according to our discussion yesterday

@oleg-nenashev
Copy link
Member Author

@reviewbybees @stephenc Ready for the final review

@ghost
Copy link

ghost commented Oct 22, 2016

This pull request originates from a CloudBees employee. At CloudBees, we require that all pull requests be reviewed by other CloudBees employees before we seek to have the change accepted. If you want to learn more about our process please see this explanation.

Copy link
Member

@stephenc stephenc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's obly a sbelling misbake.

* `JnlpProtocol` / `JnlpProtocol1` / `JnlpProtocol2` / `JnlpProtocol3` classes were removed.
Their functionality has been moved to the <code>JnlpProtocolHandler</code> class and its subclasses.
* <code>JnlpServerHandshake</code> class and all its subclasses have been removed from the library
* Several debendent internal classes have been removed or modified
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dependent is not spelled with a B

@oleg-nenashev
Copy link
Member Author

@reviewbybees @jenkinsci/code-reviewers I'm using my maintainer superpower to merge this PR in order to add links to the Jenkins changelog. This PR does not impact the code && does not go into the release immediately. If you see any other issues in the text, please comment an I will follow-up in other pull requests

@oleg-nenashev oleg-nenashev merged commit c6260ed into jenkinsci:master Oct 23, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants