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

Migrate 'ProcessTreeKiller' from wiki #3321 #3364

Closed

Conversation

bigdevlarry
Copy link

Fix #3321

Description

I migrated the ProcessTreeKiller from Wiki to the Destination on jenkins.io: Using Jenkins -> Long-running agent processes where I created an adoc file to copy the converted Ascii format text

@bigdevlarry bigdevlarry requested a review from a team as a code owner May 26, 2020 19:19
@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label May 26, 2020
@oleg-nenashev
Copy link
Contributor

Thank you for this contribution! It is much appreciated.

Are you doing it as a part of the Jenkins UI/UX Hackfest? If so, please consider reporting this contribution here so that we could facilitate reviews and share the story 👍

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

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

This pull request mixes multiple changes into a single pull request. It needs to be reworked.

@LarrySul I'm happy to host an office hours session or to have a working session in the Gitter chat channel. This is a common challenge for technical writers and it would be good to capture the way to resolve it in a chat session or in an office hours session

@bigdevlarry bigdevlarry force-pushed the long-running-agent-process branch from a263f51 to b6ff82e Compare May 29, 2020 19:36
Copy link
Contributor

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

I suggest cleaning up the obsolete terminology and deprecated features

content/doc/book/using/long-running-agent-process.adoc Outdated Show resolved Hide resolved
content/doc/book/using/long-running-agent-process.adoc Outdated Show resolved Hide resolved
content/doc/book/using/long-running-agent-process.adoc Outdated Show resolved Hide resolved
content/doc/book/using/long-running-agent-process.adoc Outdated Show resolved Hide resolved
content/doc/book/using/long-running-agent-process.adoc Outdated Show resolved Hide resolved
content/doc/book/using/long-running-agent-process.adoc Outdated Show resolved Hide resolved
@bigdevlarry
Copy link
Author

@oleg-nenashev @MarkEWaite @markyjackson-taulia been able to resolve all conversations and made an update . Looking forward to your feedback

content/doc/book/using/long-running-agent-process.adoc Outdated Show resolved Hide resolved
BUILD_ID=dontKillMe /usr/apache/bin/httpd
----

In case of Jenkins Pipeline use `+JENKINS_NODE_COOKIE+` instead of `+BUILD_ID+`
Copy link
Contributor

@MarkEWaite MarkEWaite Jun 29, 2020

Choose a reason for hiding this comment

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

See the comments in jenkinsci/workflow-durable-task-step-plugin#39 for the details that I've tried to reduce to this phrasing.

I would love to have comments or corrections on my updated phrasing from @bitwiseman , @dwnusbaum , or @jglick. I believe I've stated it correctly, but they may see mistakes in my additions.

Suggested change
In case of Jenkins Pipeline use `+JENKINS_NODE_COOKIE+` instead of `+BUILD_ID+`
In case of Jenkins Pipeline use `+JENKINS_NODE_COOKIE+` instead of `+BUILD_ID+`.
Parallel stages of the Jenkins Pipeline may run on the same agent and will use the same `+BUILD_ID+` within a specific Pipeline run.
If `+BUILD_ID+` is set instead of `+JENKINS_NODE_COOKIE+`, then parallel Pipeline stages running on the same agent may stop processes from other stages of the same build.
Use `+JENKINS_NODE_COOKIE+` instead of `+BUILD_ID+` so that processes in parallel Pipeline stages are not unexpectedly stopped by the completion of other stages on that agent.

Copy link
Contributor

Choose a reason for hiding this comment

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

I do not recall offhand and I would not expect any text about this from the wiki to be accurate. Would need to be experimentally revalidated.

Copy link
Contributor

Choose a reason for hiding this comment

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

@LarrySul are you willing to do the experimental validation of my proposed text additions?

Copy link
Author

Choose a reason for hiding this comment

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

@MarkEWaite yes I'm open to doing the experimental validations

Copy link
Contributor

Choose a reason for hiding this comment

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

That's great @LarrySul. Thanks

Things to test include:

  • Is JENKINS_NODE_COOKIE defined inside a Pipeline stage? (should confirm that it is)
  • Are processes on the same agent that are started from different stages of the same job stopped when a single stage stops?
  • Are processes on the same agent that are started from different stages of the same job stopped when the pipeline has completed and all stages are stopped?
  • If JENKINS_NODE_COOKIE is defined with a different value in a stage, do long running processes started in that stage continue running after the stage is complete?
  • If JENKINS_NODE_COOKIE is defined with a different value in a stage, do long running processes started in that stage continue running after the job is complete?
  • If BUILD_ID is defined with a different value in a stage but JENKINS_NODE_COOKIE is unmodified, are long running processes from a stage stopped when the stage completes?
  • If BUILD_ID is defined with a different value in a stage but JENKINS_NODE_COOKIE is unmodified, are long running processes from a stage stopped when the job completes?

Copy link
Contributor

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

I think this is good to go. Sorry for the review delays

@oleg-nenashev oleg-nenashev requested a review from MarkEWaite July 21, 2020 19:40
@MarkEWaite MarkEWaite added stalled Pull requests that are not progressing wiki-migration Jenkins Wiki Migration to jenkins.io and removed stalled Pull requests that are not progressing labels Sep 8, 2022
@MarkEWaite MarkEWaite added the stalled Pull requests that are not progressing label Apr 20, 2023
@kmartens27
Copy link
Contributor

As this pull request has not had any updates since July 2021, and has been marked stalled (as discussed in Jenkins Documentation SIG office hours)[https://docs.google.com/document/d/1ygRZnVtoIvuEKpwNeF_oVRVCV5NKcZD1_HMtWlUZguo/edit#heading=h.cao5dku7jwfn], it will be closed and linked to the original issue that will give others an opportunity to continue the work already started here.

@kmartens27 kmartens27 closed this May 5, 2023
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. stalled Pull requests that are not progressing wiki-migration Jenkins Wiki Migration to jenkins.io
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate 'ProcessTreeKiller' from wiki
6 participants