Skip to content

Commit

Permalink
Merge pull request #4677 from slide/advanced_plugin_deploy
Browse files Browse the repository at this point in the history
Update advanced plugin deployment docs for jenkinsci/jenkins#5862

Included in Jenkins 2.320 and described in the changelog 
https://www.jenkins.io/changelog/#v2.320
  • Loading branch information
MarkEWaite authored Nov 9, 2021
2 parents 40ecbba + ae7dcea commit 65a30c3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions content/doc/book/managing/plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ operated by the Jenkins project which provides an inventory of open source
plugins which have been developed and maintained by various members of the
Jenkins community.

This section will cover everything from the basics of managing plugins within
the Jenkins web UI, to making changes on the <<../glossary#master,master's>>
This section covers everything from the basics of managing plugins within
the Jenkins web UI, to making changes on the <<../glossary#controller,controller's>>
file system.

== Installing a plugin

Jenkins provides a couple of different methods for installing plugins on the master:
Jenkins provides two methods for installing plugins on the controller:

. Using the "Plugin Manager" in the web UI.
. Using the <<install-with-cli,Jenkins CLI>> `install-plugin` command.
Expand Down Expand Up @@ -76,9 +76,9 @@ to the plugin and clicking *Install without restart*.

[CAUTION]
====
If the list of available plugins is empty, the master might be incorrectly
If the list of available plugins is empty, the controller may be incorrectly
configured or has not yet downloaded plugin meta-data from the Update Center.
Clicking the *Check now* button will force Jenkins to attempt to contact its
Clicking the *Check now* button forces Jenkins to attempt to contact its
configured Update Center.
====

Expand Down Expand Up @@ -124,25 +124,25 @@ may upload the file from within the web UI:

. Navigate to the *Manage Jenkins* > *Manage Plugins* page in the web UI.
. Click on the *Advanced* tab.
. Choose the `.hpi` file under the *Upload Plugin* section.
. *Upload* the plugin file.
. Choose the `.hpi` file from your system or enter a URL to the `.hpi` file under the *Deploy Plugin* section.
. *Deploy* the plugin file.

image::managing/plugin-manager-upload.png["Advanced tab in the Plugin Manager", role=center]

Once a plugin file has been uploaded, the Jenkins controller must be manually
restarted in order for the changes to take effect.

==== On the master
==== On the controller

Assuming a `.hpi` file has been explicitly downloaded by a systems
Assuming a `.hpi` file has been explicitly downloaded by a system
administrator, the administrator can manually place the `.hpi` file in a
specific location on the file system.

Copy the downloaded `.hpi`` file into the `JENKINS_HOME/plugins` directory on
the Jenkins controller (for example, on Debian systems `JENKINS_HOME` is generally
`/var/lib/jenkins`).

The master will need to be restarted before the plugin is loaded and
The controller must be restarted before the plugin is loaded and
made available in the Jenkins environment.

[NOTE]
Expand Down Expand Up @@ -183,8 +183,8 @@ image::managing/plugin-manager-uninstall.png["Installed tab in the Plugin Manage


A plugin may also be uninstalled by removing the corresponding `.hpi`
file from the `JENKINS_HOME/plugins` directory on the master. The plugin will
continue to function until the master has been restarted.
file from the `JENKINS_HOME/plugins` directory on the controller. The plugin will
continue to function until the controller has been restarted.

[CAUTION]
====
Expand Down
Binary file modified content/doc/book/resources/managing/plugin-manager-upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 65a30c3

Please sign in to comment.