Using Plugins in Your Application
Get the latest docsYou are looking at documentation for an older release. Not what you want? Go to the current release documentation.
Installing Plugins in the Cloudify CLI
To use plugins in the Cloudify CLI, install them via Wagon’s command-line interface itself (which is installed alongside Cloudify CLI).
To install a plugin, run:
wagon install -s /path/to/wagon/archive.wgn ... INFO - Installing cloudify_aws_plugin-1.4.1.dev0-py27-none-linux_x86_64-none-none.wgn ...
sudo privileges might be required to use a Cloudify CLI package.
To configure a plugin to work with your application, you ensure that required application-specific details, for example login credentials, are accessible to the plugin. There are three methods you can use to achieve this.
Point to the secret storage in which the credentials are configured. This method enables you to store sensitive information such as login usernames and passwords that you might not want to expose to users who can access the details of the plugin in a secret safe. When a deployment is being executed, the plugin retrieves the data from the secret storage.
Point to a blueprint inputs file in which the details are specified.
Specify the pathfile of the required inputs.
Uploading Plugins to Cloudify Manager
You can upload and download plugins to and from Cloudify Manager, and can delete and list plugins already on a Manager. These functions are exposed by the REST client via the REST API, and through the CLI.
Go to the downloads page to view the list of downloadable plugin packages.
To upload a plugin to Cloudify Manager, run the following command.
$ cfy plugins upload /path/to/wagon/archive.wgn ... Validating /path/to/wagon/archive.wgn Plugin validated successfully Uploading plugin '/path/to/wagon/archive.wgn' to management server x.x.x.215 Uploaded plugin successfully, plugin's id is: f82610f0-42d6-4ce4-9efa-9ad21e4fd557 ...
cfy plugins command exposes additional commands such as downloading and listing the plugins found on Cloudify Manager.
When a plugin is uploaded to Cloudify Manager, if it matches the Manager architecture, it is installed on it. The plugin
can then be used globally by all deployments that require it, as a
Conversely, when a plugin is deleted from Cloudify Manager, it is also uninstalled, unless it is being used by at least one
deployment, in which case the
delete request fails.
Uploading Wagons via the CLI
For instructions about uploading wagons via the CLI, click here
Using Wagons in a Blueprint
After you have installed/uploaded a plugin, it is available for use in the blueprints in which the plugin is defined. For more information about defining a plugin in a blueprint, click here.
Uploading plugins during bootstrap
Cloudify enables plugins to be uploaded to Cloudify Manager during bootstrap. For more information, see Plugin Resources.