REFERENCE.md 9.85 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

**Classes**

* [`freeipa`](#freeipa): Manages IPA masters, replicas and clients.
* [`freeipa::config`](#freeipaconfig): A short summary of the purpose of this class
* [`freeipa::config::admin_user`](#freeipaconfigadmin_user): Configures admin user
* [`freeipa::config::webui`](#freeipaconfigwebui): Configures port and redirect overrides for the IPA server web UI.
* [`freeipa::helpers`](#freeipahelpers): A short summary of the purpose of this class
* [`freeipa::install`](#freeipainstall): Installs the packages needed for servers and clients
* [`freeipa::install::autofs`](#freeipainstallautofs): A short summary of the purpose of this class
* [`freeipa::install::client`](#freeipainstallclient): A short summary of the purpose of this class
* [`freeipa::install::server`](#freeipainstallserver): Defines options for the ipa install command
* [`freeipa::install::server::master`](#freeipainstallservermaster): Installs freeipa server as master
* [`freeipa::install::server::replica`](#freeipainstallserverreplica): Installs freeipa server as replica
* [`freeipa::install::sssd`](#freeipainstallsssd): A short summary of the purpose of this class

**Defined types**

* [`freeipa::helpers::flushcache`](#freeipahelpersflushcache): A short summary of the purpose of this defined type.

## Classes

### freeipa

A description of what this class does
Manages IPA masters, replicas and clients.

Parameters
----------
34 35 36 37 38 39 40
Also, triggers the install of the required dns server packages.
and passed to the IPA installer.
and passed to the IPA installer.
requests whose HTTP_HOST variable match the parameter 'webio_proxy_external_fqdn'. This allows the IPA Web UI to work on a
proxied port, while allowing IPA client access to  function as normal.
the Web UI to be accessed from different ports and hostnames than the default.
This is necessary to allow the WebUI to be accessed behind a reverse proxy when using nonstandard ports.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

#### Examples

##### 

```puppet
include freeipa
```

#### Parameters

The following parameters are available in the `freeipa` class.

##### `domain`

56
Data type: `Stdlib::Fqdn`
57 58 59 60 61

The name of the IPA domain to create or join.

##### `ipa_role`

Scott Barthelemy's avatar
Scott Barthelemy committed
62
Data type: `Enum['master','replica','client']`
63 64 65 66 67

What role the node will be. Options are 'master', 'replica', and 'client'.

##### `admin_password`

Scott Barthelemy's avatar
Scott Barthelemy committed
68
Data type: `String[8]`
69 70 71 72 73

Password which will be assigned to the IPA account named 'admin'.

##### `directory_services_password`

Scott Barthelemy's avatar
Scott Barthelemy committed
74
Data type: `String[8]`
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

Password which will be passed into the ipa setup's parameter named "--ds-password".

##### `autofs_package_name`

Data type: `String`

Name of the autofs package to install if enabled.

Default value: 'autofs'

##### `client_install_ldaputils`

Data type: `Boolean`

If true, then the ldaputils packages are installed if ipa_role is set to client.

Default value: `false`

##### `configure_dns_server`

Data type: `Boolean`

98
If true, then the parameter '--setup-dns' is passed to the IPA server installer.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117

Default value: `true`

##### `configure_ntp`

Data type: `Boolean`

If false, then the parameter '--no-ntp' is passed to the IPA server installer.

Default value: `true`

##### `custom_dns_forwarders`

Data type: `Array[String]`

Each element in this array is prefixed with '--forwarder' and passed to the IPA server installer.

Default value: []

Scott Barthelemy's avatar
Scott Barthelemy committed
118
##### `principal_usedto_joindomain`
119 120 121 122 123

Data type: `String`

The principal (usually username) used to join a client or replica to the IPA domain.

Scott Barthelemy's avatar
Scott Barthelemy committed
124
Default value: 'admin'
125

Scott Barthelemy's avatar
Scott Barthelemy committed
126
##### `password_usedto_joindomain`
127 128 129 130 131

Data type: `String`

The password for the domain_join_principal.

Scott Barthelemy's avatar
Scott Barthelemy committed
132
Default value: $directory_services_password
133 134 135 136 137

##### `enable_hostname`

Data type: `Boolean`

138
If true, then the parameter '--hostname' is populated with the parameter 'ipa_server_fqdn'
139 140 141 142 143 144 145

Default value: `true`

##### `enable_ip_address`

Data type: `Boolean`

146
If true, then the parameter '--ip-address' is populated with the parameter 'ip_address'
147 148 149 150 151 152 153 154 155 156 157 158 159

Default value: `false`

##### `fixed_primary`

Data type: `Boolean`

If true, then the parameter '--fixed-primary' is passed to the IPA installer.

Default value: `false`

##### `idstart`

Scott Barthelemy's avatar
Scott Barthelemy committed
160
Data type: `Integer[10000]`
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

From the IPA man pages: "The starting user and group id number".

Default value: 10000

##### `install_autofs`

Data type: `Boolean`

If true, then the autofs packages are installed.

Default value: `false`

##### `install_epel`

Data type: `Boolean`

If true, then the epel repo is installed. The epel repo is usually required for sssd packages.

Default value: `true`

##### `install_kstart`

Data type: `Boolean`

If true, then the kstart packages are installed.

Default value: `true`

##### `install_sssdtools`

Data type: `Boolean`

If true, then the sssdtools packages are installed.

Default value: `true`

##### `ipa_client_package_name`

Data type: `String`

Name of the IPA client package.

Scott Barthelemy's avatar
Scott Barthelemy committed
204
Default value: $facts['os']['family']
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

##### `ipa_server_package_name`

Data type: `String`

Name of the IPA server package.

Default value: 'ipa-server'

##### `install_ipa_client`

Data type: `Boolean`

If true, then the IPA client packages are installed if the parameter 'ipa_role' is set to 'client'.

Default value: `true`

##### `install_ipa_server`

Data type: `Boolean`

If true, then the IPA server packages are installed if the parameter 'ipa_role' is not set to 'client'.

Default value: `true`

##### `install_sssd`

Data type: `Boolean`

If true, then the sssd packages are installed.

Default value: `true`

##### `ip_address`

240
Data type: `Stdlib::IP::Address::V4`
241 242 243 244 245

IP address to pass to the IPA installer.

##### `ipa_server_fqdn`

246
Data type: `Stdlib::Fqdn`
247 248 249

Actual fqdn of the IPA server or client.

Scott Barthelemy's avatar
Scott Barthelemy committed
250
Default value: $facts['fqdn']
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265

##### `kstart_package_name`

Data type: `String`

Name of the kstart package.

Default value: 'kstart'

##### `ldaputils_package_name`

Data type: `String`

Name of the ldaputils package.

Scott Barthelemy's avatar
Scott Barthelemy committed
266
Default value: $facts['os']['family']
267 268 269

##### `ipa_master_fqdn`

270
Data type: `Stdlib::Fqdn`
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299

FQDN of the server to use for a client or replica domain join.

##### `manage_host_entry`

Data type: `Boolean`

If true, then a host entry is created using the parameters 'ipa_server_fqdn' and 'ip_address'.

Default value: `false`

##### `mkhomedir`

Data type: `Boolean`

If true, then the parameter '--mkhomedir' is passed to the IPA client installer.

Default value: `true`

##### `no_ui_redirect`

Data type: `Boolean`

If true, then the parameter '--no-ui-redirect' is passed to the IPA server installer.

Default value: `false`

##### `realm`

300
Data type: `Stdlib::Fqdn`
301 302 303

The name of the IPA realm to create or join.

Scott Barthelemy's avatar
Scott Barthelemy committed
304
Default value: $domain
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333

##### `server_install_ldaputils`

Data type: `Boolean`

If true, then the ldaputils packages are installed if ipa_role is not set to client.

Default value: `true`

##### `sssd_package_name`

Data type: `String`

Name of the sssd package.

Default value: 'sssd-common'

##### `sssdtools_package_name`

Data type: `String`

Name of the sssdtools package.

Default value: 'sssd-tools'

##### `webui_disable_kerberos`

Data type: `Boolean`

334
If true, then /etc/httpd/conf.d/ipa.conf is written to exclude kerberos support for incoming
335 336 337 338 339 340 341

Default value: `false`

##### `webui_enable_proxy`

Data type: `Boolean`

342
If true, then httpd is configured to act as a reverse proxy for the IPA Web UI. This allows
343 344 345 346 347 348 349

Default value: `false`

##### `webui_force_https`

Data type: `Boolean`

350
If true, then /etc/httpd/conf.d/ipa-rewrite.conf is modified to force all connections to https.
351 352 353 354 355

Default value: `false`

##### `webui_proxy_external_fqdn`

356
Data type: `Stdlib::Fqdn`
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525

The public or external FQDN used to access the IPA Web UI behind the reverse proxy.

Default value: 'localhost'

##### `webui_proxy_https_port`

Data type: `String`

The HTTPS port to use for the reverse proxy. Cannot be 443.

Default value: '8440'

### freeipa::config

A description of what this class does

#### Examples

##### 

```puppet
include freeipa::config
```

### freeipa::config::admin_user

A description of what this class does
Configures admin user

#### Examples

##### 

```puppet
include freeipa::config::admin_user
```

### freeipa::config::webui

A description of what this class does
Configures port and redirect overrides for the IPA server web UI.

#### Examples

##### 

```puppet
include freeipa::config::webui
```

### freeipa::helpers

A description of what this class does

#### Examples

##### 

```puppet
include freeipa::helpers
```

### freeipa::install

A description of what this class does
Installs the packages needed for servers and clients

#### Examples

##### 

```puppet
include freeipa::install
```

### freeipa::install::autofs

A description of what this class does
Installs and start autofs

#### Examples

##### 

```puppet
include freeipa::install::autofs
```

### freeipa::install::client

A description of what this class does
Install freeipa client

#### Examples

##### 

```puppet
include freeipa::install::client
```

### freeipa::install::server

A description of what this class does
This class mainly defines options for the ipa install command, then install master or replica regarding the role set.

#### Examples

##### 

```puppet
include freeipa::install::server
```

### freeipa::install::server::master

A description of what this class does
Installs freeipa server as master

#### Examples

##### 

```puppet
include freeipa::install::server::master
```

### freeipa::install::server::replica

A description of what this class does
Installs freeipa server as replica

#### Examples

##### 

```puppet
include freeipa::install::server::replica
```

### freeipa::install::sssd

A description of what this class does
Install sssd package

#### Examples

##### 

```puppet
include freeipa::install::sssd
```

## Defined types

### freeipa::helpers::flushcache

A description of what this defined type does
Flushcache sss for Debian and RedHat only

#### Examples

##### 

```puppet
freeipa::helpers::flushcache { 'namevar': }
```