Skip to content

Commit 64c1e45

Browse files
committed
Merge pull request puppetlabs#737 from jbondpdx/master
correcting formatting error in README
2 parents 1dd7806 + cddfd66 commit 64c1e45

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -229,13 +229,14 @@ postgresql::server::pg_ident_rule{ 'Map the SSL certificate of the backup server
229229
system_username => 'repli1.example.com',
230230
database_username => 'replication',
231231
}
232+
```
232233

233234
This would create a user name map in `pg_ident.conf` similar to:
234235

235236
```
236-
# Rule Name: Map the SSL certificate of the backup server as a replication user
237-
# Description: none
238-
# Order: 150
237+
#Rule Name: Map the SSL certificate of the backup server as a replication user
238+
#Description: none
239+
#Order: 150
239240
sslrepli repli1.example.com replication
240241
```
241242

@@ -280,10 +281,9 @@ recovery_min_apply_delay = 0
280281

281282
Only the specified parameters are recognized in the template. The `recovery.conf` is only be created if at least one parameter is set **and** [manage_recovery_conf](#manage_recovery_conf) is set to true.
282283

283-
284284
### Validate connectivity
285285

286-
To validate client connections to a remote PostgreSQL database before starting dependent tasks, use the `postgresql::validate_db_connection` resource. You can use this on any node where the PostgreSQL client software is installed. It is often chained to other tasks such as starting an application server or performing a database migration.
286+
To validate client connections to a remote PostgreSQL database before starting dependent tasks, use the `postgresql::validate_db_connection` resource. You can use this on any node where the PostgreSQL client software is installed. It is often chained to other tasks such as starting an application server or performing a database migration.
287287

288288
Example usage:
289289

@@ -299,11 +299,11 @@ exec { 'rake db:migrate':
299299
}
300300
```
301301

302-
## Reference
302+
## Reference
303303

304304
The posgresql module comes with many options for configuring the server. While you are unlikely to use all of the settings below, they provide a decent amount of control over your security settings.
305305

306-
Classes:
306+
**Classes:**
307307

308308
* [postgresql::client](#postgresqlclient)
309309
* [postgresql::globals](#postgresqlglobals)
@@ -316,7 +316,7 @@ Classes:
316316
* [postgresql::server::contrib](#postgresqlservercontrib)
317317
* [postgresql::server::postgis](#postgresqlserverpostgis)
318318

319-
Defined Types:
319+
**Defined Types:**
320320

321321
* [postgresql::server::config_entry](#postgresqlserverconfig_entry)
322322
* [postgresql::server::database](#postgresqlserverdatabase)
@@ -332,13 +332,13 @@ Defined Types:
332332
* [postgresql::server::tablespace](#postgresqlservertablespace)
333333
* [postgresql::validate_db_connection](#postgresqlvalidate_db_connection)
334334

335-
Types:
335+
**Types:**
336336

337337
* [postgresql_psql](#custom-resource-postgresql_psql)
338338
* [postgresql_replication_slot](#custom-resource-postgresql_replication_slot)
339339
* [postgresql_conf](#custom-resource-postgresql_conf)
340340

341-
Functions:
341+
**Functions:**
342342

343343
* [postgresql_password](#function-postgresql_password)
344344
* [postgresql_acls_to_resources_hash](#function-postgresql_acls_to_resources_hashacl_array-id-order_offset)
@@ -367,7 +367,7 @@ Specifies the path to validate the connection script. Default: '/usr/local/bin/v
367367

368368
Installs PostgreSQL bindings for Postgres-Docs. Set the following parameters if you have a custom version you would like to install.
369369

370-
>**Note:** Make sure to add any necessary yum or apt repositories if specifying a custom version.
370+
**Note:** Make sure to add any necessary yum or apt repositories if specifying a custom version.
371371

372372
##### `package_name`
373373

@@ -379,7 +379,7 @@ Whether the PostgreSQL docs package resource should be present. Valid values: 'p
379379

380380
#### postgresql::globals
381381

382-
>**Note:** Most server-specific defaults should be overriden in the `postgresql::server` class. This class should be used only if you are using a non-standard OS, or if you are changing elements that can only be changed here, such as `version` or `manage_package_repo`.
382+
**Note:** Most server-specific defaults should be overriden in the `postgresql::server` class. This class should be used only if you are using a non-standard OS, or if you are changing elements that can only be changed here, such as `version` or `manage_package_repo`.
383383

384384
##### `bindir`
385385

@@ -405,7 +405,7 @@ Overrides the default PostgreSQL contrib package name. Default: OS dependent.
405405

406406
Overrides the default PostgreSQL data directory for the target platform. Default: OS dependent.
407407

408-
>**Note:** Changing the datadir after installation causes the server to come to a full stop before making the change. For RedHat systems, the data directory must be labeled appropriately for SELinux. On Ubuntu, you must explicitly set `needs_initdb = true` to allow Puppet to initialize the database in the new datadir (`needs_initdb` defaults to true on other systems).
408+
**Note:** Changing the datadir after installation causes the server to come to a full stop before making the change. For RedHat systems, the data directory must be labeled appropriately for SELinux. On Ubuntu, you must explicitly set `needs_initdb = true` to allow Puppet to initialize the database in the new datadir (`needs_initdb` defaults to true on other systems).
409409

410410
**Warning:** If datadir is changed from the default, Puppet does not manage purging of the original data directory, which causes it to fail if the data directory is changed back to the original.
411411

@@ -545,11 +545,11 @@ Overrides the `ensure` parameter during package installation. Defaults to `prese
545545

546546
Overrides the default package name for the distribution you are installing to. Defaults to `postgresql-devel` or `postgresql<version>-devel` depending on your distro.
547547

548-
####postgresql::lib::java
548+
#### postgresql::lib::java
549549

550550
Installs PostgreSQL bindings for Java (JDBC). Set the following parameters if you have a custom version you would like to install.
551551

552-
>**Note:** Make sure to add any necessary yum or apt repositories if specifying a custom version.
552+
**Note:** Make sure to add any necessary yum or apt repositories if specifying a custom version.
553553

554554
##### `package_ensure`
555555

@@ -583,7 +583,7 @@ Specifies the name of the postgresql PL/Python package.
583583

584584
Specifies whether the package is present. Valid values: 'present', 'absent'. Default: 'present'.
585585

586-
####postgresql::lib::python
586+
#### postgresql::lib::python
587587

588588
Installs PostgreSQL Python libraries.
589589

@@ -595,7 +595,7 @@ Specifies whether the package is present. Valid values: 'present', 'absent'. Def
595595

596596
The name of the PostgreSQL Python package.
597597

598-
####postgresql::server
598+
#### postgresql::server
599599

600600
##### `createdb_path`
601601

@@ -1108,7 +1108,6 @@ Specifies whether to grant super user capability for the new role. Default: fals
11081108

11091109
Defines the username of the role to create. Defaults to the namevar.
11101110

1111-
11121111
#### postgresql::server::schema
11131112

11141113
Creates a schema.

0 commit comments

Comments
 (0)