Skip to content

Latest commit

 

History

History
447 lines (230 loc) · 8.42 KB

REFERENCE.md

File metadata and controls

447 lines (230 loc) · 8.42 KB
Raw

Reference

Table of Contents

Tasks

Plans

Tasks

abs

Provision/Tear down a machine using abs

Supports noop? false

Parameters

action

Data type: Enum[provision, tear_down]

Action to perform, tear_down or provision

inventory

Data type: Optional[String[1]]

Location of the inventory file

node_name

Data type: Optional[String[1]]

The name of the node

platform

Data type: Optional[Variant[String[1],Hash]]

Provision a single platform or a Hash of platforms specifying the number of instances. eg 'ubuntu-1604-x86_64 or '{ "centos-7-x86_64":1, "centos-6-x86_64":2 }'

vars

Data type: Optional[String[1]]

key/value pairs to add to the vars section

docker

Provision/Tear down a machine on docker

Supports noop? false

Parameters

action

Data type: Enum[provision, tear_down]

Action to perform, tear_down or provision

inventory

Data type: Optional[String[1]]

Location of the inventory file

node_name

Data type: Optional[String[1]]

The name of the node

platform

Data type: Optional[String[1]]

Platform to provision, eg ubuntu:14.04

vars

Data type: Optional[String[1]]

YAML string of key/value pairs to add to the inventory vars section

docker_exp

Provision/Tear down a machine on docker

Supports noop? false

Parameters

action

Data type: Enum[provision, tear_down]

Action to perform, tear_down or provision

inventory

Data type: Optional[String[1]]

Location of the inventory file

node_name

Data type: Optional[String[1]]

The name of the node

platform

Data type: Optional[String[1]]

Platform to provision, eg ubuntu:14.04

vars

Data type: Optional[String[1]]

YAML string of key/value pairs to add to the inventory vars section

fix_secure_path

Add puppet agent bin directory to sudo secure_path

Supports noop? false

Parameters

path

Data type: Optional[String[1]]

Puppet agent bin directory path

install_pe

Installs PE on a target

Supports noop? false

Parameters

version

Data type: Optional[String[1]]

The release of PE you want to install e.g. 2018.1 (Default: 2019.2)

install_puppetserver

install puppetserver community edition

Supports noop? false

Parameters

collection

Data type: Optional[String[1]]

The name of the node

platform

Data type: Optional[String[1]]

The name of the node

retry

Data type: Optional[Integer]

The number of retries in case of network connectivity failures

provision_service

Provision/Tear down a list of machines using the provisioning service

Supports noop? false

Parameters

action

Data type: Enum[provision, tear_down]

Action to perform, tear_down or provision

platform

Data type: Optional[String[1]]

Needed by litmus

node_name

Data type: Optional[String[1]]

Needed by litmus

inventory

Data type: Optional[String[1]]

Location of the inventory file

vars

Data type: Optional[String[1]]

The address of the provisioning service

retry_attempts

Data type: Optional[Integer[1]]

The number of times to retry the provisioning if it fails

run_tests

Run rspec tests against a target machine

Supports noop? false

Parameters

sut

Data type: String[1]

The target SUT to run tests against

test_path

Data type: Optional[String[1]]

Location of the test files. Defaults to './spec/acceptance'

update_node_pp

Creates a manifest file for a target node on pe server

Supports noop? false

Parameters

manifest

Data type: String[1]

The manifest code

target_node

Data type: String[1]

The target node

update_site_pp

Updates the site.pp on a target

Supports noop? false

Parameters

manifest

Data type: String[1]

The manifest code

vagrant

Provision/Tear down a machine on vagrant

Supports noop? false

Parameters

action

Data type: Enum[provision, tear_down]

Action to perform, tear_down or provision

inventory

Data type: Optional[String[1]]

Location of the inventory file

node_name

Data type: Optional[String[1]]

The name of the node

platform

Data type: Optional[String[1]]

Platform to provision, eg ubuntu:14.04

provider

Data type: Optional[String[1]]

Provider to use provision, eg virtualbox

cpus

Data type: Optional[Integer]

Number of CPUs. Eg 2

memory

Data type: Optional[Integer]

MB Memory. Eg 4000

hyperv_vswitch

Data type: Optional[String[1]]

The Hyper-V virtual switch to spin the vagrant image up on

hyperv_smb_username

Data type: Optional[String[1]]

The username on the Hyper-V machine to use for authenticating the shared folder. Required to use Hyper-V with a synced folder.

hyperv_smb_password

Data type: Optional[String[1]]

The password on the Hyper-V machine to use for authenticating the shared folder. Required to use Hyper-V with a synced folder.

enable_synced_folder

Data type: Optional[Boolean]

Whether to use the vagrant synced folder for the provisioned machine

box_url

Data type: Optional[String[1]]

Path to the Vagrant Box URL

password

Data type: Optional[String[1]]

Password to use for Vagrant boxes without the default Vagrant insecure key

Plans

provision::agents

The provision::agents class.

provision::agents_setup

The provision::agents_setup class.

Parameters

The following parameters are available in the provision::agents_setup plan:

collection

Data type: Optional[String]

Default value: 'puppet7'

provision::provisioner

The provision::provisioner class.

provision::puppetserver_setup

The provision::puppetserver_setup class.

Parameters

The following parameters are available in the provision::puppetserver_setup plan:

collection

Data type: Optional[String]

Default value: 'puppet7'

provision::server_setup

The provision::server_setup class.

provision::teardown

The provision::teardown class.

provision::tester

The provision::tester class.

provision::tests_against_agents

The provision::tests_against_agents class.