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

Missing "Uninstall" plugin section #1531

Open
dduportal opened this issue Dec 16, 2022 · 4 comments · May be fixed by #1538
Open

Missing "Uninstall" plugin section #1531

dduportal opened this issue Dec 16, 2022 · 4 comments · May be fixed by #1538

Comments

@dduportal
Copy link
Contributor

Describe your use-case which is not covered by existing documentation.

The section https://github.com/jenkinsci/docker#preinstalling-plugins describes pretty well how to add plugin to a Jenkins controller image.

The "install / update" plugin is really easy, but the removal of a plugin can be cumbersome if you are not an expert in "how the image and its entrypoint works".

As a user, I would like to have a simple example on how to properly remove a plugin on my existing installation.

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

The section should give the following insights:

  • Plugin removal should start by the plugins.txt (or equivalent jenkins-plugin-cli call) on the custom Dockerfile. The plugin should then be absent from the /usr/share/jenkins/ref/plugins directory

    • A command for self-diagnosing this step should be provided
  • However, the plugin is still in the $JENKINS_HOME/plugins/ (data volume or bind mounted volume) because the entrypoint script does NOT delete plugins. We have to tell end user to remove the plugin (either through the Jenkins UI or by removing the files and restarting the container)

As discussed with @gounthar and @MarkEWaite during the SIG Platform meeting, the example of removing the "WMI" windows-slave plugin could be a great example for this documentation

@dduportal
Copy link
Contributor Author

Hello @ritikbanger , given that you did a valuable pull request (#1530 ) around the documentation, would you be willing to also take this one on a separate PR?

I offer my help if you want it (but if you feel like to do it yourself or not doing, I won't mind at all)

@gounthar
Copy link
Contributor

gounthar commented Dec 16, 2022

The SIG meeting Damien refers to is there: https://community.jenkins.io/t/platform-sig-december-16-2022/4997

If ever you want some help for this documentation PR, I'm available.

@ritikbanger
Copy link
Contributor

Hello @ritikbanger , given that you did a valuable pull request (#1530 ) around the documentation, would you be willing to also take this one on a separate PR?

I offer my help if you want it (but if you feel like to do it yourself or not doing, I won't mind at all)

@dduportal @gounthar
Would be glad to raise another PR for this, I will have a look and let you know if I need anything.

@gounthar
Copy link
Contributor

Thanks a lot. 🙏

@ritikbanger ritikbanger linked a pull request Dec 25, 2022 that will close this issue
5 tasks
@MarkEWaite MarkEWaite linked a pull request Jan 27, 2023 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants