Skip to content

Commit

Permalink
(maint) Document additional container ENV vars
Browse files Browse the repository at this point in the history 
 - There were a number of inconsistencies in what was available as an
   ENV var, per the note on #55.

   To make this a reality, each container needed to be updated with
   the missing variables to make them settable. This includes:

  pe-puppetserver
    - PUPPETSERVER_PORT (was there but didn't do anything)
    - PUPPETSERVER_LOG_LEVEL
  pe-orchestration-services
    - PCP_BROKER_PORT
    - PE_ORCHESTRATION_SERVICES_PORT
    - PUPPETSERVER_PORT
    - PUPPETDB_SSL_PORT
		- POSTGRES_PORT
  pe-console-services
    - PE_ORCHESTRATION_SERVICES_PORT
  pe-bolt-server
    - PUPPETSERVER_PORT
  puppetdb
    - PUPPETDB_SSL_PORT
    - PUPPETDB_LOG_LEVEL
    - PUPPETSERVER_PORT
  postgres
    - PGPORT (already present but not documented)
    - PUPPETSERVER_PORT

  This should make dependency relationships clearer in documentation
  • Loading branch information
@Iristyle
Iristyle committed Mar 6, 2020
1 parent 43b612b commit 5748132
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 8 deletions.
16 changes: 15 additions & 1 deletion commercial/2019.1.3/docker-compose.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ services:
hostname: puppet.test
environment:
- CERTNAME=puppet.test
- PUPPETSERVER_PORT=8140
- PUPPETSERVER_LOG_LEVEL=info
- PUPPETDB_HOSTNAME=puppetdb.test
- PE_CONSOLE_SERVICES_HOSTNAME=pe-console-services.test
- PE_ORCHESTRATION_SERVICES_HOSTNAME=pe-orchestration-services.test
# puppet::enterprise class parameters written to hiera.yaml
- PUPPETSERVER_PORT=8140
- POSTGRES_HOSTNAME=postgres.test
- PUPPETDB_SSL_PORT=8081
- PE_ORCHESTRATION_SERVICES_PORT=8143
Expand Down Expand Up @@ -37,9 +38,14 @@ services:
hostname: pe-orchestration-services.test
environment:
- CERTNAME=pe-orchestration-services.test
- PCP_BROKER_PORT=8142
- PE_ORCHESTRATION_SERVICES_PORT=8143
- PUPPETSERVER_HOSTNAME=puppet.test
- PUPPETSERVER_PORT=8140
- PUPPETDB_HOSTNAME=puppetdb.test
- PUPPETDB_SSL_PORT=8081
- POSTGRES_HOSTNAME=postgres.test
- POSTGRES_PORT=5432
- PE_BOLT_SERVER_HOSTNAME=pe-bolt-server.test
- PE_CONSOLE_SERVICES_HOSTNAME=pe-console-services.test
- PUPPERWARE_ADMIN_PASSWORD=pupperware
Expand All @@ -61,6 +67,7 @@ services:
hostname: pe-console-services.test
environment:
- CERTNAME=pe-console-services.test
- PE_CONSOLE_SERVICES_LOG_LEVEL=info
- PUPPETSERVER_HOSTNAME=puppet.test
- PUPPETSERVER_CERTNAME=puppet.test
- PUPPETSERVER_PORT=8140
Expand All @@ -71,6 +78,7 @@ services:
- POSTGRES_PORT=5432
- PE_ORCHESTRATION_SERVICES_HOSTNAME=pe-orchestration-services.test
- PE_ORCHESTRATION_SERVICES_CERTNAME=pe-orchestration-services.test
- PE_ORCHESTRATION_SERVICES_PORT=8143
volumes:
- console-services:/opt/puppetlabs/server/data/console-services
restart: always
Expand All @@ -97,6 +105,7 @@ services:
environment:
- CERTNAME=pe-bolt-server.test
- PUPPETSERVER_HOSTNAME=puppet.test
- PUPPETSERVER_PORT=8140
- PE_BOLT_SERVER_LOGLEVEL=${PE_BOLT_SERVER_LOGLEVEL:-info}
- WHITELIST_HOSTNAME.0=pe-bolt-server.test
- WHITELIST_HOSTNAME.1=pe-orchestration-services.test
Expand All @@ -111,8 +120,11 @@ services:
hostname: puppetdb.test
environment:
- CERTNAME=puppetdb.test
- PUPPETDB_SSL_PORT=8081
- PUPPETDB_LOG_LEVEL=info
- USE_PUPPETSERVER=true
- PUPPETSERVER_HOSTNAME=puppet.test
- PUPPETSERVER_PORT=8140
- PUPPETDB_POSTGRES_HOSTNAME=postgres.test
- PUPPETDB_POSTGRES_PORT=5432
- PUPPETDB_PASSWORD=puppetdb
Expand All @@ -138,9 +150,11 @@ services:
image: ${DOCKER_REGISTRY_PATH}pe-postgres:pe-2019.1.3
hostname: postgres.test
environment:
- PGPORT=5432
- CERTNAME=postgres.test
- POSTGRES_PASSWORD=puppetdb
- PUPPETSERVER_HOSTNAME=puppet.test
- PUPPETSERVER_PORT=8140
- PUPPETDB_CERTNAME=puppetdb.test
- PE_CONSOLE_SERVICES_CERTNAME=pe-console-services.test
- PE_ORCHESTRATION_SERVICES_CERTNAME=pe-orchestration-services.test
Expand Down
26 changes: 20 additions & 6 deletions commercial/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,10 @@ The following values, many of which are already overriden in the `docker-compose
|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **CERTNAME** | The DNS name used on the masters SSL certificate<br><br>`pe-puppetserver` |
| **DNS_ALT_NAMES** | Additional DNS names to add to the masters SSL certificate |
| **PUPPETSERVER_PORT** | The listening port of the puppet master<br><br>`8140` |
| **PUPPETSERVER_LOG_LEVEL** | The logging level to use for this service<br><br>`info` |
| **PUPPETDB_HOSTNAME** | The DNS hostname of the puppetdb service<br><br>`puppetdb` |
| **PUPPETDB_SSL_PORT** | The port for the puppetdb service<br>Also written to Hiera data to be consumed by `puppet::enterprise` class<br><br>`8081` |
| **PUPPETDB_SSL_PORT** | The SSL port for the puppetdb service<br>Also written to Hiera data to be consumed by `puppet::enterprise` class<br><br>`8081` |
| **POSTGRES_HOSTNAME** | The DNS hostname of the postgres service<br>Also written to Hiera data to be consumed by `puppet::enterprise` class<br><br>`postgres` |
| **PE_CONSOLE_SERVICES_HOSTNAME** | The DNS hostname of the pe-console-services service<br><br>`pe-console-services` |
| **PE_ORCHESTRATION_SERVICES_HOSTNAME** | The DNS hostname of the pe-orchestration-services service<br><br>`pe-orchestration-services` |
Expand All @@ -122,9 +124,14 @@ The following values, many of which are already overriden in the `docker-compose
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **CERTNAME** | The DNS name used on this services SSL certificate<br><br>`pe-orchestration-services` |
| **DNS_ALT_NAMES** | Additional DNS names to add to the services SSL certificate (Dockers `hostname` and FQDN are already included)<br><br>`${HOSTNAME},$(hostname -s),$(hostname -f),${DNS_ALT_NAMES}` |
| **PCP_BROKER_PORT** | The listening port for the pcp-broker service<br><br>`8142` |
| **PE_ORCHESTRATION_SERVICES_PORT** | The listening port for the pe-orchestration-services service<br><br>`8143` |
| **PUPPETSERVER_HOSTNAME** | The DNS hostname of the puppet master<br><br>`puppet` |
| **PUPPETSERVER_PORT** | The port of the puppet master<br><br>`8140` |
| **PUPPETDB_HOSTNAME** | The DNS hostname of the puppetdb service<br><br>`puppetdb` |
| **PUPPETDB_SSL_PORT** | The SSL port of the puppetdb<br><br>`8081` |
| **POSTGRES_HOSTNAME** | The DNS hostname of the postgres service<br><br>`postgres` |
| **POSTGRES_PORT** | The port for postgres<br><br>`5432` |
| **PE_BOLT_SERVER_HOSTNAME** | The DNS hostname of the pe-bolt-server service<br><br>`pe-bolt-server` |
| **PE_CONSOLE_SERVICES_HOSTNAME** | The DNS hostname of the pe-console-services service<br><br>`pe-console-services` |
| **PUPPERWARE_ADMIN_PASSWORD** | Log into the PE console using the username `admin` and this password value, once all containers are healthy<br><br>`pupperware` |
Expand All @@ -140,14 +147,15 @@ The following values, many of which are already overriden in the `docker-compose
| **DNS_ALT_NAMES** | Additional DNS names to add to the services SSL certificate (Dockers `hostname` and FQDN are already included)<br><br>`${HOSTNAME},$(hostname -s),$(hostname -f),${DNS_ALT_NAMES}` |
| **PUPPETSERVER_HOSTNAME** | The DNS hostname of the puppet master<br><br>`puppet` |
| **PUPPETSERVER_CERTNAME** | The primary DNS name on the puppet master certificate<br><br>`pe-puppetserver` |
| **PUPPETSERVER_PORT** | The listening port of the puppet master<br><br>`8140` |
| **PUPPETSERVER_PORT** | The port of the puppet master<br><br>`8140` |
| **PUPPETDB_HOSTNAME** | The DNS hostname of the puppetdb service<br><br>`puppetdb` |
| **PUPPETDB_CERTNAME** | The primary DNS name on the puppetdb certificate<br><br>`pe-puppetdb` |
| **PUPPETDB_SSL_PORT** | The listening port for puppetdb<br><br>`8081` |
| **PUPPETDB_SSL_PORT** | The SSL port for puppetdb<br><br>`8081` |
| **POSTGRES_HOSTNAME** | The DNS hostname of the postgres service<br><br>`postgres` |
| **POSTGRES_PORT** | The listening port for postgres<br><br>`5432` |
| **POSTGRES_PORT** | The port for postgres<br><br>`5432` |
| **PE_ORCHESTRATION_SERVICES_HOSTNAME** | The DNS hostname of the pe-orchestration-services service<br><br>`pe-orchestration-services` |
| **PE_ORCHESTRATION_SERVICES_CERTNAME** | The primary DNS name on the pe-orchestration-services certificate<br><br>`pe-orchestration-services` |
| **PE_ORCHESTRATION_SERVICES_PORT** | The port for the pe-orchestration-services service<br><br>`8143` |
| **PE_CONSOLE_SERVICES_LOG_LEVEL** | The logging level to use for this service<br><br>`info` |
| **PE_CONSOLE_SERVICES_JAVA_ARGS** | Arguments passed directly to the JVM when starting the service<br><br>`-Xmx192m` |

Expand All @@ -158,6 +166,7 @@ The following values, many of which are already overriden in the `docker-compose
| **CERTNAME** | The DNS name used on this services SSL certificate<br><br>`pe-bolt-server` |
| **DNS_ALT_NAMES** | Additional DNS names to add to the services SSL certificate (Dockers `hostname` and FQDN are already included)<br><br>`${HOSTNAME},$(hostname -s),$(hostname -f),${DNS_ALT_NAMES}` |
| **PUPPETSERVER_HOSTNAME** | The DNS hostname of the puppet master<br><br>`puppet` |
| **PUPPETSERVER_PORT** | The port of the puppet master<br><br>`8140` |
| **PE_BOLT_SERVER_LOGLEVEL** | The logging level to use for this service<br><br>`info` |
| **WHITELIST_HOSTNAME.0** | The DNS hostnamesof all services allowed to connect to this service<br><br>`pe-orchestration-services` |
| **WHITELIST_HOSTNAME.1** | Additional services may be added as **WHITELIST_HOSTNAME.#** starting with `2` for `#`, etc<br><br>`pe-bolt-server` |
Expand All @@ -168,10 +177,13 @@ The following values, many of which are already overriden in the `docker-compose
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **CERTNAME** | The DNS name used on this services SSL certificate<br><br>`pe-puppetdb` |
| **DNS_ALT_NAMES** | Additional DNS names to add to the services SSL certificate (Dockers `hostname` and FQDN are already included)<br><br>`${HOSTNAME},$(hostname -s),$(hostname -f),${DNS_ALT_NAMES}` |
| **PUPPETDB_SSL_PORT** | The listening SSL port for puppetdb<br><br>`8081` |
| **PUPPETDB_LOGLEVEL** | The logging level to use for this service<br><br>`info` |
| **USE_PUPPETSERVER** | Should always be set to `true`<br><br>`true` |
| **PUPPETSERVER_HOSTNAME** | The DNS hostname of the puppet master<br><br>`puppet` |
| **PUPPETSERVER_PORT** | The port of the puppet master<br><br>`8140` |
| **PUPPETDB_POSTGRES_HOSTNAME** | The DNS hostname of the postgres service<br><br>`postgres` |
| **PUPPETDB_POSTGRES_PORT** | The listening port for postgres<br><br>`5432` |
| **PUPPETDB_POSTGRES_PORT** | The port for postgres<br><br>`5432` |
| **PUPPETDB_POSTGRES_DATABASE** | The name of the puppetdb database in postgres<br><br>`puppetdb` |
| **PUPPETDB_USER** | The puppetdb database user<br><br>`puppetdb` |
| **PUPPETDB_PASSWORD** | The puppetdb database password<br><br>`puppetdb` |
Expand All @@ -186,11 +198,13 @@ The following values, many of which are already overriden in the `docker-compose
| Name | Usage / Default |
|-----------------------------------------|--------------------------------------------------------------------------------------------------------|
| **CERTNAME** | The DNS name used on this services SSL certificate<br><br>`postgres` |
| **PGPORT** | The listening port for postgres<br><br>`5432`
| **DNS_ALT_NAMES** | Additional DNS names to add to the services SSL certificate |
| **PGPORT** | The listening port for postgres<br><br>`5432` |
| **POSTGRES_DB** | The name of the puppetdb database in postgres<br><br>`puppetdb` |
| **POSTGRES_USER** | The puppetdb database user<br><br>`puppetdb` |
| **POSTGRES_PASSWORD** | The puppetdb database password<br><br>`puppetdb` |
| **PUPPETSERVER_HOSTNAME** | The DNS hostname of the puppet master<br><br>`puppet` |
| **PUPPETSERVER_PORT** | The port of the puppet master<br><br>`8140` |
| **PUPPETDB_CERTNAME** | The primary DNS name on the puppetdb certificate<br><br>`pe-puppetdb` |
| **PE_CONSOLE_SERVICES_CERTNAME** | The primary DNS name of the pe-console-services certificate<br><br>`pe-console-services` |
| **PE_ORCHESTRATION_SERVICES_CERTNAME** | The primary DNS name on the pe-orchestration-services certificate<br><br>`pe-orchestration-services` |
Expand Down
Loading

0 comments on commit 5748132

Please sign in to comment.