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

[4565] Rewrite/enhance controller-isolation page #4635

Closed

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Oct 14, 2021

Implement #4565 .

  • Change title. "Controller isolation" is the point but it seems confusing to use this as a title rather than the "distributed builds" terminology that is used everywhere else.
  • Moved this page so it will be the first section after index.adoc (after the securing-jenkins.adoc file is removed, with its information moved into other files.
  • Rewrote and expanded the information about why this is an important security issue and merged this information with the material that was previously in the index.adoc file. We may have too much redundancy in this material and a couple of superflous points; I need other opinions about this. And it would be good to expand the information about not running agents in the same Docker container as the controller.
  • Added definitions of controller, node, agent, and executor. These long definitions might better be placed in the "Managing Nodes" page with a briefer list here but I added them here for now.
  • Restructured/expanded information about implementing distributed builds and made it a separate sub-section.
  • Rewrote information about the Agent -> Controller Access filter
  • Moved the cautionary note about periodically reviewing security settings so it will be after the general introduction to the "Configure Global Security" page that will be in the managing-security.adoc file
  • Removed the introductory note in managing-security.adoc file about Jenkins 1.x not having many of these security protections.

@daniel-beck @Wadeck @MarkEWaite

@StackScribe StackScribe requested a review from a team as a code owner October 14, 2021 09:41
@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Oct 14, 2021
@StackScribe StackScribe changed the title [4565] Rewrite/enhance controller-isolation page [4565] [WIP] Rewrite/enhance controller-isolation page Oct 14, 2021
@daniel-beck
Copy link
Contributor

not ready for review

You should be able to mark this PR as draft to make this even clearer.

@StackScribe StackScribe changed the title [4565] [WIP] Rewrite/enhance controller-isolation page [4565] Rewrite/enhance controller-isolation page Oct 14, 2021
@StackScribe
Copy link
Contributor Author

@daniel-beck This is ready for review now. I just saw something I wanted to change so marked it WIP for about an hour while I did that.

@@ -2,14 +2,13 @@
sections:
# index - implied overview

- access-control

# Legacy sections
Copy link
Contributor

Choose a reason for hiding this comment

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

Obsolete comment now, I guess, if we're keeping these two pages around? (Why?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I plan to remove the access-control section and replace it by sections about Security Realm /Authentication and another one about Authorization. Just trying to make incremental changes, one smallish PR at a time. Is there a better way for me to go about this? Should you and I have a chat about the changes you want for this chapter? I started out just trying to incorporate some information I learned from you and to make the terminology match what shows on the UI pages but I am happy to do anything you like.

Copy link
Contributor

Choose a reason for hiding this comment

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

Should you and I have a chat about the changes you want for this chapter?

Yep, I think that's a good idea, see Gitter 😃

@daniel-beck daniel-beck self-requested a review October 14, 2021 19:14
@StackScribe
Copy link
Contributor Author

This content was moved to commit 033a397 so I am closing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants