Skip to content

Latest commit

 

History

History
373 lines (205 loc) · 11.5 KB

REFERENCE.md

File metadata and controls

373 lines (205 loc) · 11.5 KB

Reference

Table of Contents

Functions

Tasks

Plans

Functions

update_trusted_facts::trusted_fact_names

Type: Puppet Language

Returns an array of trusted facts lint:ignore:140chars

update_trusted_facts::trusted_fact_names()

Returns an array of trusted facts lint:ignore:140chars

Returns: Array of trusted facts

Tasks

confirm_primary_server

A short description of this task

Supports noop? false

Parameters

pe_primary_server

Data type: String

Puppet Primary server hostname

ignore_infra_status_error

Data type: Boolean

Ignore puppet infra status stderr

set_csr_attributes

Merges existing trusted fact

Supports noop? false

Parameters

trusted_facts

Data type: Hash

Trusted facts to add

preserve_existing_facts

Data type: Boolean

Preserve existing trusted facts

Plans

update_trusted_facts::update_trusted_facts

lint:ignore:140chars lint:ignore:strict_indent

This plans allows for the easy modification of trusted facts on already deployed nodes via the Puppet Enterprise console. It will preserve the existing trusted facts by reading the existing certificate and merging any proposed changes over existing. This behaviour can be changed by setting the preserve_existing_facts parameter to false We require the Puppet Primary to be specified when runing the plan due to limitations of running plans in orchestor.

To learn more about Puppet plans, see documentation:

Parameters

The following parameters are available in the update_trusted_facts::update_trusted_facts plan:

targets

Data type: TargetSpec

The targets to run on (note this must match the certnames used by Puppet / shown in PE console).

pe_primary_server

Data type: Optional[Stdlib::Fqdn]

The Puppet Enterprise primary server in your PE installation you are running the plan from. Update_trusted_facts will automatically attempt to resolve the primary using the pe_status_check_role fact. Setting this parameter will override that behaviour.

Default value: undef

preserve_existing_facts

Data type: Boolean

Whether to preserve existing facts from the nodes. If set to false all existing facts will be wiped and replaced with those set in the plan. Default: true

Default value: true

ignore_infra_status_error

Data type: Boolean

Ignore errors from 'puppet infrastructure status' command. This is used to verify the primary server. Can be used to allow the plan the run when some PE components are unavaliable. Default: false

Default value: false

noop

Data type: Boolean

Run the plan in noop. csr_attributes.yaml will still generated, however certificates will not be resigned. Default: false

Default value: false

support_legacy_pe

Data type: Boolean

Attempt to support legacy PE. Default: false

Default value: false

pp_role

Data type: Optional[String]

Set the pp_role trusted fact. Default: undef

Default value: undef

pp_uuid

Data type: Optional[String]

Set the pp_uuid trusted fact. Default: undef

Default value: undef

pp_environment

Data type: Optional[String]

Set the pp_environment trusted fact. Default: undef

Default value: undef

pp_apptier

Data type: Optional[String]

Set the pp_apptier trusted fact. Default: undef

Default value: undef

pp_department

Data type: Optional[String]

Set the pp_department trusted fact. Default: undef

Default value: undef

pp_datacenter

Data type: Optional[String]

Set the pp_datacenter trusted fact. Default: undef

Default value: undef

pp_instance_id

Data type: Optional[String]

Set the pp_instance_id trusted fact. Default: undef

Default value: undef

pp_image_name

Data type: Optional[String]

Set the pp_image_name trusted fact. Default: undef

Default value: undef

pp_preshared_key

Data type: Optional[String]

Set the pp_preshared_key trusted fact. Default: undef

Default value: undef

pp_cost_center

Data type: Optional[String]

Set the pp_cost_center trusted fact. Default: undef

Default value: undef

pp_product

Data type: Optional[String]

Set the pp_product trusted fact. Default: undef

Default value: undef

pp_project

Data type: Optional[String]

Set the pp_project trusted fact. Default: undef

Default value: undef

pp_application

Data type: Optional[String]

Set the pp_application trusted fact. Default: undef

Default value: undef

pp_service

Data type: Optional[String]

Set the pp_service trusted fact. Default: undef

Default value: undef

pp_employee

Data type: Optional[String]

Set the pp_employee trusted fact. Default: undef

Default value: undef

pp_created_by

Data type: Optional[String]

Set the pp_created_by trusted fact. Default: undef

Default value: undef

pp_software_version

Data type: Optional[String]

Set the pp_software_version trusted fact. Default: undef

Default value: undef

pp_cluster

Data type: Optional[String]

Set the pp_cluster trusted fact. Default: undef

Default value: undef

pp_provisioner

Data type: Optional[String]

Set the pp_provisioner trusted fact. Default: undef

Default value: undef

pp_region

Data type: Optional[String]

Set the pp_region trusted fact. Default: undef

Default value: undef

pp_zone

Data type: Optional[String]

Set the pp_zone trusted fact. Default: undef

Default value: undef

pp_network

Data type: Optional[String]

Set the pp_network trusted fact. Default: undef

Default value: undef

pp_securitypolicy

Data type: Optional[String]

Set the pp_securitypolicy trusted fact. Default: undef

Default value: undef

pp_cloudplatform

Data type: Optional[String]

Set the pp_cloudplatform trusted fact. Default: undef

Default value: undef

pp_hostname

Data type: Optional[String]

Set the pp_hostname trusted fact. Default: undef

Default value: undef