|
39 | 39 |
|
40 | 40 | ### Data types
|
41 | 41 |
|
| 42 | +* [`Peadm::Pe_version`](#peadmpe_version) |
42 | 43 | * [`Peadm::Pem`](#peadmpem)
|
43 | 44 | * [`Peadm::SingleTargetSpec`](#peadmsingletargetspec): A SingleTargetSpec represents any String, Target or single-element array of one or the other that can be passed to get_targets() to return an
|
44 | 45 |
|
45 | 46 | ### Tasks
|
46 | 47 |
|
47 | 48 | * [`agent_install`](#agent_install): Install the Puppet agent from a master
|
48 | 49 | * [`agent_upgrade`](#agent_upgrade): Upgrade the target system using upgrade.bash from a master
|
| 50 | +* [`backup_classification`](#backup_classification): A task to call the classification api and write to file |
49 | 51 | * [`cert_data`](#cert_data): Return certificate data related to the Puppet agent
|
50 | 52 | * [`code_manager`](#code_manager): Perform various code manager actions
|
51 | 53 | * [`code_sync_status`](#code_sync_status): A task to confirm code is in sync accross the cluster for clusters with code manager configured
|
|
74 | 76 |
|
75 | 77 | #### Public Plans
|
76 | 78 |
|
| 79 | +* [`peadm::backup`](#peadmbackup): Backup the core user settings for puppet infrastructure |
77 | 80 | * [`peadm::convert`](#peadmconvert): Convert an existing PE cluster to a PEAdm-managed cluster
|
78 | 81 | * [`peadm::install`](#peadminstall): Install a new PE cluster
|
79 | 82 | * [`peadm::modify_certificate`](#peadmmodify_certificate): Modify the certificate of one or more targets
|
@@ -741,6 +744,16 @@ Data type: `TargetSpec`
|
741 | 744 |
|
742 | 745 | ## Data types
|
743 | 746 |
|
| 747 | +### <a name="peadmpe_version"></a>`Peadm::Pe_version` |
| 748 | + |
| 749 | +The Peadm::Pe_version data type. |
| 750 | + |
| 751 | +Alias of |
| 752 | + |
| 753 | +```puppet |
| 754 | +Pattern[/^\d+\.\d+\.\d+(-.+)?$/] |
| 755 | +``` |
| 756 | + |
744 | 757 | ### <a name="peadmpem"></a>`Peadm::Pem`
|
745 | 758 |
|
746 | 759 | The Peadm::Pem data type.
|
@@ -801,6 +814,20 @@ Data type: `String`
|
801 | 814 |
|
802 | 815 | The resolvable name of the Puppet server to upgrade from
|
803 | 816 |
|
| 817 | +### <a name="backup_classification"></a>`backup_classification` |
| 818 | + |
| 819 | +A task to call the classification api and write to file |
| 820 | + |
| 821 | +**Supports noop?** false |
| 822 | + |
| 823 | +#### Parameters |
| 824 | + |
| 825 | +##### `directory` |
| 826 | + |
| 827 | +Data type: `String` |
| 828 | + |
| 829 | +The directory to write the classification output to. Directory must exist |
| 830 | + |
804 | 831 | ### <a name="cert_data"></a>`cert_data`
|
805 | 832 |
|
806 | 833 | Return certificate data related to the Puppet agent
|
@@ -1199,6 +1226,85 @@ Which port to query the status API on
|
1199 | 1226 |
|
1200 | 1227 | ## Plans
|
1201 | 1228 |
|
| 1229 | +### <a name="peadmbackup"></a>`peadm::backup` |
| 1230 | + |
| 1231 | +This plan can backup data as outlined at insert doc |
| 1232 | + |
| 1233 | +#### Parameters |
| 1234 | + |
| 1235 | +The following parameters are available in the `peadm::backup` plan: |
| 1236 | + |
| 1237 | +* [`primary_host`](#primary_host) |
| 1238 | +* [`backup_orchestrator`](#backup_orchestrator) |
| 1239 | +* [`backup_rbac`](#backup_rbac) |
| 1240 | +* [`backup_activity`](#backup_activity) |
| 1241 | +* [`backup_ca_ssl`](#backup_ca_ssl) |
| 1242 | +* [`backup_puppetdb`](#backup_puppetdb) |
| 1243 | +* [`backup_classification`](#backup_classification) |
| 1244 | +* [`output_directory`](#output_directory) |
| 1245 | + |
| 1246 | +##### <a name="primary_host"></a>`primary_host` |
| 1247 | + |
| 1248 | +Data type: `Peadm::SingleTargetSpec` |
| 1249 | + |
| 1250 | + |
| 1251 | + |
| 1252 | +##### <a name="backup_orchestrator"></a>`backup_orchestrator` |
| 1253 | + |
| 1254 | +Data type: `Boolean` |
| 1255 | + |
| 1256 | + |
| 1257 | + |
| 1258 | +Default value: ``true`` |
| 1259 | + |
| 1260 | +##### <a name="backup_rbac"></a>`backup_rbac` |
| 1261 | + |
| 1262 | +Data type: `Boolean` |
| 1263 | + |
| 1264 | + |
| 1265 | + |
| 1266 | +Default value: ``true`` |
| 1267 | + |
| 1268 | +##### <a name="backup_activity"></a>`backup_activity` |
| 1269 | + |
| 1270 | +Data type: `Boolean` |
| 1271 | + |
| 1272 | + |
| 1273 | + |
| 1274 | +Default value: ``true`` |
| 1275 | + |
| 1276 | +##### <a name="backup_ca_ssl"></a>`backup_ca_ssl` |
| 1277 | + |
| 1278 | +Data type: `Boolean` |
| 1279 | + |
| 1280 | + |
| 1281 | + |
| 1282 | +Default value: ``true`` |
| 1283 | + |
| 1284 | +##### <a name="backup_puppetdb"></a>`backup_puppetdb` |
| 1285 | + |
| 1286 | +Data type: `Boolean` |
| 1287 | + |
| 1288 | + |
| 1289 | + |
| 1290 | +Default value: ``false`` |
| 1291 | + |
| 1292 | +##### <a name="backup_classification"></a>`backup_classification` |
| 1293 | + |
| 1294 | +Data type: `Boolean` |
| 1295 | + |
| 1296 | + |
| 1297 | + |
| 1298 | +Default value: ``true`` |
| 1299 | + |
| 1300 | +##### <a name="output_directory"></a>`output_directory` |
| 1301 | + |
| 1302 | +Data type: `String` |
| 1303 | + |
| 1304 | + |
| 1305 | + |
| 1306 | +Default value: `'/tmp'` |
| 1307 | + |
1202 | 1308 | ### <a name="peadmconvert"></a>`peadm::convert`
|
1203 | 1309 |
|
1204 | 1310 | This plan sets required certificate extensions on PE nodes, and configures
|
@@ -1407,7 +1513,7 @@ Data type: `String`
|
1407 | 1513 |
|
1408 | 1514 | ##### <a name="version"></a>`version`
|
1409 | 1515 |
|
1410 |
| -Data type: `String` |
| 1516 | +Data type: `Peadm::Pe_version` |
1411 | 1517 |
|
1412 | 1518 |
|
1413 | 1519 |
|
@@ -1713,7 +1819,7 @@ Default value: ``undef``
|
1713 | 1819 |
|
1714 | 1820 | ##### <a name="version"></a>`version`
|
1715 | 1821 |
|
1716 |
| -Data type: `String` |
| 1822 | +Data type: `Peadm::Pe_version` |
1717 | 1823 |
|
1718 | 1824 |
|
1719 | 1825 |
|
|
0 commit comments