|
40 | 40 |
|
41 | 41 | ### Data types
|
42 | 42 |
|
| 43 | +* [`Peadm::Ldap_config`](#peadmldap_config) |
43 | 44 | * [`Peadm::Pe_version`](#peadmpe_version)
|
44 | 45 | * [`Peadm::Pem`](#peadmpem)
|
45 | 46 | * [`Peadm::Recovery_opts`](#peadmrecovery_opts)
|
|
51 | 52 | * [`agent_upgrade`](#agent_upgrade): Upgrade the target system using upgrade.bash from a master
|
52 | 53 | * [`backup_classification`](#backup_classification): A task to call the classification api and write to file
|
53 | 54 | * [`cert_data`](#cert_data): Return certificate data related to the Puppet agent
|
| 55 | +* [`cert_valid_status`](#cert_valid_status): Check primary for valid state of a certificate |
54 | 56 | * [`code_manager`](#code_manager): Perform various code manager actions
|
55 | 57 | * [`code_sync_status`](#code_sync_status): A task to confirm code is in sync accross the cluster for clusters with code manager configured
|
56 | 58 | * [`divert_code_manager`](#divert_code_manager): Divert the code manager live-dir setting
|
|
62 | 64 | * [`mkdir_p_file`](#mkdir_p_file): Create a file with the specified content at the specified location
|
63 | 65 | * [`mv`](#mv): Wrapper task for mv command
|
64 | 66 | * [`pe_install`](#pe_install): Install Puppet Enterprise from a tarball
|
| 67 | +* [`pe_ldap_config`](#pe_ldap_config): Set the ldap config in the PE console |
65 | 68 | * [`pe_uninstall`](#pe_uninstall): Uninstall Puppet Enterprise
|
66 | 69 | * [`precheck`](#precheck): Return pre-check information about a system
|
67 | 70 | * [`provision_replica`](#provision_replica): Execute the replica provision puppet command
|
@@ -111,6 +114,7 @@ Supported use cases:
|
111 | 114 | * `peadm::util::insert_csr_extension_requests`
|
112 | 115 | * `peadm::util::retrieve_and_upload`
|
113 | 116 | * `peadm::util::sanitize_pg_pe_conf`
|
| 117 | +* `peadm::util::sync_global_hiera` |
114 | 118 | * `peadm::util::update_classification`: Configure classification
|
115 | 119 | * `peadm::util::update_db_setting`: Make updates to PuppetDB database settings
|
116 | 120 |
|
@@ -770,6 +774,40 @@ Data type: `TargetSpec`
|
770 | 774 |
|
771 | 775 | ## Data types
|
772 | 776 |
|
| 777 | +### <a name="peadmldap_config"></a>`Peadm::Ldap_config` |
| 778 | + |
| 779 | +The Peadm::Ldap_config data type. |
| 780 | + |
| 781 | +Alias of |
| 782 | + |
| 783 | +```puppet |
| 784 | +Struct[{ |
| 785 | + base_dn => String, |
| 786 | + connect_timeout => Integer, |
| 787 | + disable_ldap_matching_rule_in_chain => Boolean, |
| 788 | + display_name => String, |
| 789 | + group_lookup_attr => String, |
| 790 | + group_member_attr => String, |
| 791 | + group_name_attr => String, |
| 792 | + group_object_class => String, |
| 793 | + Optional[group_rdn] => Optional[String], |
| 794 | + Optional[help_link] => Optional[String], |
| 795 | + hostname => String, |
| 796 | + Optional[login] => Optional[String], |
| 797 | + Optional[password] => Optional[String], |
| 798 | + port => Integer, |
| 799 | + search_nested_groups => Boolean, |
| 800 | + ssl => Boolean, |
| 801 | + ssl_hostname_validation => Boolean, |
| 802 | + ssl_wildcard_validation => Boolean, |
| 803 | + start_tls => Boolean, |
| 804 | + user_display_name_attr => String, |
| 805 | + user_email_attr => String, |
| 806 | + user_lookup_attr => String, |
| 807 | + Optional[user_rdn] => Optional[String], |
| 808 | +}] |
| 809 | +``` |
| 810 | + |
773 | 811 | ### <a name="peadmpe_version"></a>`Peadm::Pe_version`
|
774 | 812 |
|
775 | 813 | The Peadm::Pe_version data type.
|
@@ -877,6 +915,20 @@ Return certificate data related to the Puppet agent
|
877 | 915 |
|
878 | 916 | **Supports noop?** false
|
879 | 917 |
|
| 918 | +### <a name="cert_valid_status"></a>`cert_valid_status` |
| 919 | + |
| 920 | +Check primary for valid state of a certificate |
| 921 | + |
| 922 | +**Supports noop?** false |
| 923 | + |
| 924 | +#### Parameters |
| 925 | + |
| 926 | +##### `certname` |
| 927 | + |
| 928 | +Data type: `String` |
| 929 | + |
| 930 | +The certifcate name to check validation of |
| 931 | + |
880 | 932 | ### <a name="code_manager"></a>`code_manager`
|
881 | 933 |
|
882 | 934 | Perform various code manager actions
|
@@ -1093,6 +1145,26 @@ Data type: `Optional[Enum['stopped']]`
|
1093 | 1145 |
|
1094 | 1146 | If 'stopped', ensure the Puppet agent is not running when install completes
|
1095 | 1147 |
|
| 1148 | +### <a name="pe_ldap_config"></a>`pe_ldap_config` |
| 1149 | + |
| 1150 | +Set the ldap config in the PE console |
| 1151 | + |
| 1152 | +**Supports noop?** false |
| 1153 | + |
| 1154 | +#### Parameters |
| 1155 | + |
| 1156 | +##### `ldap_config` |
| 1157 | + |
| 1158 | +Data type: `Peadm::Ldap_config` |
| 1159 | + |
| 1160 | +The hash of options for ldap. |
| 1161 | + |
| 1162 | +##### `pe_main` |
| 1163 | + |
| 1164 | +Data type: `String` |
| 1165 | + |
| 1166 | +The PE Main server |
| 1167 | + |
1096 | 1168 | ### <a name="pe_uninstall"></a>`pe_uninstall`
|
1097 | 1169 |
|
1098 | 1170 | Uninstall Puppet Enterprise
|
@@ -1465,6 +1537,7 @@ The following parameters are available in the `peadm::install` plan:
|
1465 | 1537 | * [`internal_compiler_a_pool_address`](#internal_compiler_a_pool_address)
|
1466 | 1538 | * [`internal_compiler_b_pool_address`](#internal_compiler_b_pool_address)
|
1467 | 1539 | * [`pe_installer_source`](#pe_installer_source)
|
| 1540 | +* [`ldap_config`](#ldap_config) |
1468 | 1541 | * [`primary_host`](#primary_host)
|
1469 | 1542 | * [`replica_host`](#replica_host)
|
1470 | 1543 | * [`compiler_hosts`](#compiler_hosts)
|
@@ -1524,6 +1597,17 @@ URL given.
|
1524 | 1597 |
|
1525 | 1598 | Default value: ``undef``
|
1526 | 1599 |
|
| 1600 | +##### <a name="ldap_config"></a>`ldap_config` |
| 1601 | + |
| 1602 | +Data type: `Optional[Peadm::Ldap_config]` |
| 1603 | + |
| 1604 | +If specified, configures PE RBAC DS with the supplied configuration hash. |
| 1605 | +The parameter should be set to a valid set of connection settings as |
| 1606 | +documented for the PE RBAC /ds endpoint. See: |
| 1607 | +https://puppet.com/docs/pe/latest/rbac_api_v1_directory.html#put_ds-request_format |
| 1608 | + |
| 1609 | +Default value: ``undef`` |
| 1610 | + |
1527 | 1611 | ##### <a name="primary_host"></a>`primary_host`
|
1528 | 1612 |
|
1529 | 1613 | Data type: `Peadm::SingleTargetSpec`
|
|
0 commit comments