Resource Model Source Plugin

About

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.

Plugin configuration

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.

Java Plugin Type

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;
}

Plugin properties

See Plugin Development - Java Plugins - Descriptions
to learn how to create configuration properties for your ResourceModelSource plugin.

Script Plugin Type

See the Script Plugin Development
for the basics of developing script-based plugins for Rundeck.

Instance scope properties

Instance scoped properties for ResourceModelSources are loaded from the project's Resource Model Source entries. A project can define multiple entries, and at execution time, the Instance scoped values come from those entries.

Example

Here is an example plugin.yaml script-based ResourceModelSource plugin
declaring a provider called "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 $?

Example: Connecting to a linux node by password

name: My Resource Model Source
version: 1.0
rundeckPluginVersion: 1.2
author: Pagerduty
date: 01/01/23
providers:
    - name: My Linux Source
        service: ResourceModelSource
        plugin-type: script
        script-interpreter: bash -c
        script-file: script.sh
        resource-format: resourceyaml
        config:
          - type: String
            name: password
            title: Password
            description: Password from key storage.
          - type: String
            name: username
            title: Username
            description: Username of node.
          - type: String
            name: hostname
            title: Hostname
            description: Hostname of node.

Example script-file: script.sh

#!/bin/bash
echo "linux-node:
  description: Linux node
  hostname: $RD_CONFIG_HOSTNAME
  nodename: linux-node
  username: $RD_CONFIG_USERNAME
  osArch: x86_64
  osFamily: Linux
  osName: Ubuntu
  osVersion: 7.4.1708
  ssh-port: 22
  ssh-authentication: password
  ssh-password-storage-path: $RD_CONFIG_PASSWORD"
exit $?

Provider Script Requirements

The ResourceModelSource service has expectations about the way your provider script behaves.

Exit code:

• Exit code of 0 indicates success.
• Any other exit code indicates failure.

Script output:

• All output on STDOUT will be captured and passed to a
  ResourceFormatParser for the specified resource-format to create the Node definitions.