Skip to content

Commit e439b0c

Browse files
committed
(gh-19) Update REFERENCE.md
..with configure task and new type docs.
1 parent a3edcc4 commit e439b0c

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

REFERENCE.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,61 @@
44

55
## Table of Contents
66

7+
### Data types
8+
9+
* [`OpenvoxBootstrap::CerShortNames`](#OpenvoxBootstrap--CerShortNames): Certificate extension request short names. These are the allowed short names documented for Puppet(TM) extension requests per [csr_attributes
10+
* [`OpenvoxBootstrap::CsrAttributes`](#OpenvoxBootstrap--CsrAttributes): [csr_attributes.yaml](https://help.puppet.com/core/current/Content/PuppetCore/config_file_csr_attributes.htm)
11+
* [`OpenvoxBootstrap::IniFile`](#OpenvoxBootstrap--IniFile): Simple type for data to be transformed to an INI file format.
12+
* [`OpenvoxBootstrap::Oid`](#OpenvoxBootstrap--Oid): Object Identifier per https://en.wikipedia.org/wiki/Object_identifier
13+
714
### Tasks
815

916
* [`check`](#check): Check whether a Puppet(tm) implementation is installed. Optionally checks the version.
17+
* [`configure`](#configure): Provides initial configuration for a freshly installed openvox-agent.
1018
* [`install`](#install): Installs an openvox package. By default, this will be the latest openvox-agent from the latest collection.
1119
* [`install_build_artifact`](#install_build_artifact): Downloads and installs a package directly from the openvox build artifact server.
1220

21+
## Data types
22+
23+
### <a name="OpenvoxBootstrap--CerShortNames"></a>`OpenvoxBootstrap::CerShortNames`
24+
25+
Certificate extension request short names.
26+
These are the allowed short names documented for Puppet(TM)
27+
extension requests per [csr_attributes.yaml](https://help.puppet.com/core/current/Content/PuppetCore/config_file_csr_attributes.htm)
28+
29+
Alias of `Enum['pp_uuid', 'pp_instance_id', 'pp_image_name', 'pp_preshared_key', 'pp_cost_center', 'pp_product', 'pp_project', 'pp_application', 'pp_service', 'pp_employee', 'pp_created_by', 'pp_environment', 'pp_role', 'pp_software_version', 'pp_department', 'pp_cluster', 'pp_provisioner', 'pp_region', 'pp_datacenter', 'pp_zone', 'pp_network', 'pp_securitypolicy', 'pp_cloudplatform', 'pp_apptier', 'pp_hostname', 'pp_authorization', 'pp_auth_role']`
30+
31+
### <a name="OpenvoxBootstrap--CsrAttributes"></a>`OpenvoxBootstrap::CsrAttributes`
32+
33+
[csr_attributes.yaml](https://help.puppet.com/core/current/Content/PuppetCore/config_file_csr_attributes.htm)
34+
35+
Alias of
36+
37+
```puppet
38+
Struct[{
39+
Optional['custom_attributes'] => Hash[
40+
OpenvoxBootstrap::Oid,
41+
String
42+
],
43+
Optional['extension_requests'] => Hash[
44+
Variant[OpenvoxBootstrap::Oid,OpenvoxBootstrap::CerShortNames],
45+
String
46+
],
47+
}]
48+
```
49+
50+
### <a name="OpenvoxBootstrap--IniFile"></a>`OpenvoxBootstrap::IniFile`
51+
52+
Simple type for data to be transformed to an INI file format.
53+
54+
Alias of `Hash[String, Hash[String, String]]`
55+
56+
### <a name="OpenvoxBootstrap--Oid"></a>`OpenvoxBootstrap::Oid`
57+
58+
Object Identifier per https://en.wikipedia.org/wiki/Object_identifier
59+
60+
Alias of `Pattern[/\d+(\.\d+)*/]`
61+
1362
## Tasks
1463

1564
### <a name="check"></a>`check`
@@ -32,6 +81,38 @@ Data type: `Enum['eq', 'lt', 'le', 'gt', 'ge']`
3281

3382
Version comparison operator.
3483

84+
### <a name="configure"></a>`configure`
85+
86+
Provides initial configuration for a freshly installed openvox-agent.
87+
88+
**Supports noop?** false
89+
90+
#### Parameters
91+
92+
##### `puppet_conf`
93+
94+
Data type: `Optional[OpenvoxBootstrap::IniFile]`
95+
96+
Hash of puppet configuration settings to write to the puppet.conf ini file. NOTE: This will completely overwrite any existing settings in the file; there is no merging behavior in this task.
97+
98+
##### `csr_attributes`
99+
100+
Data type: `Optional[OpenvoxBootstrap::CsrAttributes]`
101+
102+
Hash of CSR attributes (custom_attributes and extension_requests) to write to the csr_attributes.yaml file. NOTE: This will completely overwrite any existing settings in the file; there is no merging behavior in this task.
103+
104+
##### `puppet_service_running`
105+
106+
Data type: `Boolean`
107+
108+
Whether the Puppet service should be running after this task completes. Defaults to true.
109+
110+
##### `puppet_service_enabled`
111+
112+
Data type: `Boolean`
113+
114+
Whether the Puppet service should be enabled to start on boot after this task completes. Defaults to true.
115+
35116
### <a name="install"></a>`install`
36117

37118
Installs an openvox package. By default, this will be the latest openvox-agent from the latest collection.

0 commit comments

Comments
 (0)