|
69 | 69 | * [`puppet_runonce`](#puppet_runonce): Run the Puppet agent one time |
70 | 70 | * [`rbac_token`](#rbac_token): Get and save an rbac token for the root user, admin rbac user |
71 | 71 | * [`read_file`](#read_file): Read the contents of a file |
| 72 | +* [`restore_classification`](#restore_classification): A short description of this task |
72 | 73 | * [`sign_csr`](#sign_csr): Submit a certificate signing request |
73 | 74 | * [`ssl_clean`](#ssl_clean): Clean an agent's certificate |
74 | 75 | * [`submit_csr`](#submit_csr): Submit a certificate signing request |
| 76 | +* [`transform_classification_groups`](#transform_classification_groups): Transform the user groups from a source backup to a list of groups on the target server |
75 | 77 | * [`wait_until_service_ready`](#wait_until_service_ready): Return when the orchestrator service is healthy, or timeout after 15 seconds |
76 | 78 |
|
77 | 79 | ### Plans |
78 | 80 |
|
79 | 81 | #### Public Plans |
80 | 82 |
|
81 | 83 | * [`peadm::add_database`](#peadmadd_database) |
82 | | -* [`peadm::backup`](#peadmbackup): Backup the core user settings for puppet infrastructure |
83 | 84 | * [`peadm::convert`](#peadmconvert): Convert an existing PE cluster to a PEAdm-managed cluster |
84 | 85 | * [`peadm::install`](#peadminstall): Install a new PE cluster |
85 | 86 | * [`peadm::modify_certificate`](#peadmmodify_certificate): Modify the certificate of one or more targets |
|
93 | 94 | Supported use cases: |
94 | 95 | 1: The existing replica is broken, we have a fresh new VM we want to provision the replica to. |
95 | 96 | The new replica should have the same certname as the broken one. |
| 97 | +* `peadm::backup`: Backup the core user settings for puppet infrastructure |
96 | 98 | * `peadm::misc::divert_code_manager`: This plan exists to account for a scenario where a PE XL |
97 | 99 | * `peadm::modify_cert_extensions` |
| 100 | +* `peadm::restore`: Restore the core user settings for puppet infrastructure from backup |
98 | 101 | * `peadm::subplans::component_install`: Install a new PEADM component |
99 | 102 | * `peadm::subplans::configure`: Configure first-time classification and DR setup |
100 | 103 | * `peadm::subplans::db_populate`: Destructively (re)populates a new or existing database with the contents or a known good source |
@@ -1202,6 +1205,20 @@ Data type: `String` |
1202 | 1205 |
|
1203 | 1206 | Path to the file to read |
1204 | 1207 |
|
| 1208 | +### <a name="restore_classification"></a>`restore_classification` |
| 1209 | + |
| 1210 | +A short description of this task |
| 1211 | + |
| 1212 | +**Supports noop?** false |
| 1213 | + |
| 1214 | +#### Parameters |
| 1215 | + |
| 1216 | +##### `classification_file` |
| 1217 | + |
| 1218 | +Data type: `String` |
| 1219 | + |
| 1220 | +The full path to a backed up or transformed classification file |
| 1221 | + |
1205 | 1222 | ### <a name="sign_csr"></a>`sign_csr` |
1206 | 1223 |
|
1207 | 1224 | Submit a certificate signing request |
@@ -1244,6 +1261,26 @@ Data type: `Optional[Array[String]]` |
1244 | 1261 |
|
1245 | 1262 | DNS Alternative Names to request for the certificate |
1246 | 1263 |
|
| 1264 | +### <a name="transform_classification_groups"></a>`transform_classification_groups` |
| 1265 | + |
| 1266 | +Transform the user groups from a source backup to a list of groups on the target server |
| 1267 | + |
| 1268 | +**Supports noop?** false |
| 1269 | + |
| 1270 | +#### Parameters |
| 1271 | + |
| 1272 | +##### `source_directory` |
| 1273 | + |
| 1274 | +Data type: `String` |
| 1275 | + |
| 1276 | +Location of Source node group yaml file |
| 1277 | + |
| 1278 | +##### `working_directory` |
| 1279 | + |
| 1280 | +Data type: `String` |
| 1281 | + |
| 1282 | +Location of target node group yaml file and where to create the transformed file |
| 1283 | + |
1247 | 1284 | ### <a name="wait_until_service_ready"></a>`wait_until_service_ready` |
1248 | 1285 |
|
1249 | 1286 | Return when the orchestrator service is healthy, or timeout after 15 seconds |
@@ -1313,40 +1350,6 @@ Data type: `Optional[Enum[ |
1313 | 1350 |
|
1314 | 1351 | Default value: ``undef`` |
1315 | 1352 |
|
1316 | | -### <a name="peadmbackup"></a>`peadm::backup` |
1317 | | - |
1318 | | -This plan can backup data as outlined at insert doc |
1319 | | - |
1320 | | -#### Parameters |
1321 | | - |
1322 | | -The following parameters are available in the `peadm::backup` plan: |
1323 | | - |
1324 | | -* [`targets`](#targets) |
1325 | | -* [`backup`](#backup) |
1326 | | -* [`output_directory`](#output_directory) |
1327 | | - |
1328 | | -##### <a name="targets"></a>`targets` |
1329 | | - |
1330 | | -Data type: `Peadm::SingleTargetSpec` |
1331 | | - |
1332 | | - |
1333 | | - |
1334 | | -##### <a name="backup"></a>`backup` |
1335 | | - |
1336 | | -Data type: `Peadm::Recovery_opts` |
1337 | | - |
1338 | | - |
1339 | | - |
1340 | | -Default value: `{}` |
1341 | | - |
1342 | | -##### <a name="output_directory"></a>`output_directory` |
1343 | | - |
1344 | | -Data type: `String` |
1345 | | - |
1346 | | - |
1347 | | - |
1348 | | -Default value: `'/tmp'` |
1349 | | - |
1350 | 1353 | ### <a name="peadmconvert"></a>`peadm::convert` |
1351 | 1354 |
|
1352 | 1355 | This plan sets required certificate extensions on PE nodes, and configures |
@@ -1461,6 +1464,7 @@ The following parameters are available in the `peadm::install` plan: |
1461 | 1464 | * [`compiler_pool_address`](#compiler_pool_address) |
1462 | 1465 | * [`internal_compiler_a_pool_address`](#internal_compiler_a_pool_address) |
1463 | 1466 | * [`internal_compiler_b_pool_address`](#internal_compiler_b_pool_address) |
| 1467 | +* [`pe_installer_source`](#pe_installer_source) |
1464 | 1468 | * [`primary_host`](#primary_host) |
1465 | 1469 | * [`replica_host`](#replica_host) |
1466 | 1470 | * [`compiler_hosts`](#compiler_hosts) |
@@ -1509,6 +1513,17 @@ architectures. |
1509 | 1513 |
|
1510 | 1514 | Default value: ``undef`` |
1511 | 1515 |
|
| 1516 | +##### <a name="pe_installer_source"></a>`pe_installer_source` |
| 1517 | + |
| 1518 | +Data type: `Optional[String]` |
| 1519 | + |
| 1520 | +The URL to download the Puppet Enterprise installer media from. If not |
| 1521 | +specified, PEAdm will attempt to download PE installation media from its |
| 1522 | +standard public source. When specified, PEAdm will download directly from the |
| 1523 | +URL given. |
| 1524 | + |
| 1525 | +Default value: ``undef`` |
| 1526 | + |
1512 | 1527 | ##### <a name="primary_host"></a>`primary_host` |
1513 | 1528 |
|
1514 | 1529 | Data type: `Peadm::SingleTargetSpec` |
@@ -1780,6 +1795,7 @@ The following parameters are available in the `peadm::upgrade` plan: |
1780 | 1795 | * [`compiler_pool_address`](#compiler_pool_address) |
1781 | 1796 | * [`internal_compiler_a_pool_address`](#internal_compiler_a_pool_address) |
1782 | 1797 | * [`internal_compiler_b_pool_address`](#internal_compiler_b_pool_address) |
| 1798 | +* [`pe_installer_source`](#pe_installer_source) |
1783 | 1799 | * [`primary_host`](#primary_host) |
1784 | 1800 | * [`replica_host`](#replica_host) |
1785 | 1801 | * [`compiler_hosts`](#compiler_hosts) |
@@ -1821,6 +1837,17 @@ architectures. |
1821 | 1837 |
|
1822 | 1838 | Default value: ``undef`` |
1823 | 1839 |
|
| 1840 | +##### <a name="pe_installer_source"></a>`pe_installer_source` |
| 1841 | + |
| 1842 | +Data type: `Optional[String]` |
| 1843 | + |
| 1844 | +The URL to download the Puppet Enterprise installer media from. If not |
| 1845 | +specified, PEAdm will attempt to download PE installation media from its |
| 1846 | +standard public source. When specified, PEAdm will download directly from the |
| 1847 | +URL given. |
| 1848 | + |
| 1849 | +Default value: ``undef`` |
| 1850 | + |
1824 | 1851 | ##### <a name="primary_host"></a>`primary_host` |
1825 | 1852 |
|
1826 | 1853 | Data type: `Peadm::SingleTargetSpec` |
|
0 commit comments