Resource Model Sources provide the means to retrieve Node resources for a Project. You can implement a Resource Model Source using a Java Plugin Type or a Script Plugin Type.
The ResourceModelSource (javadoc) service allows the plugins to be configured via the Rundeck Web GUI. You are thus able to declare configuration properties for your plugin, which will be displayed as a web form when the Project is configured, or can be manually configured in the project.properties file.
A ResourceModelSource provider is actually a Factory class.
An instance of your ResourceModelSource provider will be re-used, so each time a new ResourceModelSource with a new configuration is required, your Factory class will be invoked to produce it.
Your provider class must implement the interface ResourceModelSourceFactory:
public interface ResourceModelSourceFactory {
/**
* Return a resource model source for the given configuration
*/
public ResourceModelSource createResourceModelSource(Properties configuration)
throws ConfigurationException;
}
See Plugin Development - Java Plugins - Descriptions to learn how to create configuration properties for your ResourceModelSource plugin.
See the Script Plugin Development for the basics of developing script-based plugins for Rundeck.
Script-based plugins are described using entries in the plugin.yaml file. You can use these metadata entries to declare properties about your plugin.
Create a config entry in each provider definition, containing a sequence of map entries for each configuration property you want to define. In the map entry include:
type - The type of property. Must be one of:StringBoolean value must be "true" or "false"IntegerLongSelect must be on of a set of valuesFreeSelect may be one of a set of valuesname - Name to identify the propertytitle - Title to display in the GUI (optional)description - Description to display in the GUI (optional)required - (true/false) if true, require a non-empty value (optional)default - A default value to use (optional)values - A comma-separated list of values to use for Select or FreeSelect. Required for Select/FreeSelect.When your script is invoked, each configuration property defined for the plugin will be set as RD_CONFIG_[PROPERTY] variables passed to your script (see below). "PROPERTY" refers to your plugin property name in uppercase. A plugin property named "foo" will translate to the shell variable RD_CONFIG_FOO.
Here is an example plugin.yaml script-based ResourceModelSource plugin declaring a provider clled "mysource" that produces resource-format resourceyaml output. The provider declares three config properties (account, url, region) and illustrates the use of three different types (Integer, String, FreeSelect).
Example: plugin.yaml
name: My Resource Model Source
version: 1.0
rundeckPluginVersion: 1.0
author: alexh
date: 05/10/12
providers:
- name: mysource
service: ResourceModelSource
plugin-type: script
script-interpreter: bash -c
script-file: nodes.sh
resource-format: resourceyaml
config:
- type: Integer
name: account
title: Account
description: Enter the account number.
- type: String
name: url
title: URL
description: Enter the URL to the inventory service.
- type: FreeSelect
name: region
title: Region
description: Select a region.
required: true
default: east
values: east,north,south,west
The script-file entry on line 11 references a script called "nodes.sh" referencing the plugin properties (see script below).
Example script-file: nodes.sh
#!/usr/bin/env bash
# variables set by plugin properties:
: ${RD_CONFIG_ACCOUNT:?"account plugin property not specified"}
: ${RD_CONFIG_REGION:?"region plugin property not specified"}
: ${RD_CONFIG_URL:?"url plugin property not specified"}
#
# Generate node data here.
#
exit $?
The ResourceModelSource service has expectations about the way your provider script behaves.
Exit code:
Script output:
STDOUT will be captured and passed to a ResourceFormatParser for the specified resource-format to create the Node definitions.