• Jamey Owens

• Ben Klang

• Ben Langfeld

• Krishna Raman

• N. Harrison Ripps

puppet module install openshift/openshift_origin

Using Parameterized Classes

Please note:

• The Broker needs to be enrolled in the KDC as a host, host/node_fqdn as well as a service, HTTP/node_fqdn

• Keytab should be generated, is located on the Broker machine, and Apache should be able to access it (chown apache <kerberos_keytab>)

• Like the example config below:

  • set broker_auth_plugin to 'kerberos'

  • set broker_krb_keytab and bind_krb_keytab to the absolute file location of the keytab

  • set broker_krb_auth_realms to the kerberos realm that the Broker host is enrolled with

  • set broker_krb_service_name to the FQDN of the enrolled kerberos service, e.g. $hostname

• After setup, to test:

  • authentication: kinit <user> then curl -Ik --negotiate -u : <node_fqdn>

  • GSS-TSIG (should return nil):

    $ cd /var/www/openshift/broker
    $ bundle --local
    $ rails console
    $ d = OpenShift::DnsService.instance
    $ d.register_application "appname", "namespace", "node_fqdn"
    => nil

  • For any errors, on the Broker, check /var/log/openshift/broker/httpd/error_log.

Choose from the following roles to be configured on this node.

• broker - Installs the broker and console.

• node - Installs the node and cartridges.

• msgserver - Installs ActiveMQ message broker.

• datastore - Installs MongoDB (not sharded/replicated)

• nameserver - Installs a BIND dns server configured with a TSIG key for updates.

• load_balancer - Installs HAProxy and Keepalived for Broker API high-availability.

Default: [broker,node,msgserver,datastore,nameserver]

Choose from the following ways to provide packages:

• none - install sources are already set up when the script executes (default)

• yum - set up yum repos manually

  • repos_base

  • os_repo

  • os_updates_repo

  • jboss_repo_base

  • jenkins_repo_base

  • optional_repo

Default: yum

This flag is used to control some module behaviors when an outside utility (like oo-install) is managing the deployment of OpenShift across multiple hosts simultaneously. Some configuration tasks can"t be performed during a multi-host parallel installation and this boolean enables the user to indicate whether or not thos tasks should be attempted.

Default: false

Base path to repository for OpenShift Origin

Nightlies: https://mirror.openshift.com/pub/origin-server/nightly/rhel-6
Release (currently v4): https://mirror.openshift.com/pub/origin-server/release/4/rhel-6

Default: Nightlies

CPU Architecture to use for the definition OpenShift Origin yum repositories

Default: $::architecture fact

Repository path override. Uses dependencies from repos_base but uses override_install_repo path for OpenShift RPMs. Used when doing local builds.

Default: none

The URL for a RHEL/Centos 6 yum repository used with the "yum" install method. Should end in x86_64/os/.

Default: no change

The URL for a RHEL/Centos 6 yum updates repository used with the "yum" install method. Should end in x86_64/.

Default: no change

The URL for a JBoss repositories used with the "yum" install method. Does not install repository if not specified.

The URL for a Jenkins repositories used with the "yum" install method. Does not install repository if not specified.

The URL for a EPEL or optional repositories used with the "yum" install method. Does not install repository if not specified.

Default: example.com The network domain under which apps and hosts will be placed.

Default: the root plus the domain, e.g. broker.example.com - except nameserver=ns1.example.com

These supply the FQDN of the hosts containing these components. Used for configuring the host’s name at install, and also for configuring the broker application to reach the services needed.

Default: undef

IP addresses of the first 3 MongoDB servers in a replica set. Add datastoreX_ip_addr parameters for larger clusters.

IP of a nameserver instance or current IP if installing on this node. This is used by every node to configure its primary name server.

Default: the current IP (at install)

When the nameserver is remote, use this to specify the key for updates. This is the "Key:" field from the .private key file generated by dnssec-keygen. This field is required on all nodes.

When using a BIND key, use this algorithm for the BIND key.

Default: HMAC-MD5

When the nameserver is remote, Kerberos keytab together with principal can be used instead of the dnssec key for updates.

When the nameserver is remote, this Kerberos principal together with Kerberos keytab can be used instead of the dnssec key for updates.

Example: DNS/broker.example.com@EXAMPLE.COM

This and the next value are Amazon AWS security credentials. The aws_access_key_id is a string which identifies an access credential.

For more info see http://docs.aws.amazon.com/AWSSecurityCredentials/1.0/AboutAWSCredentials.html#AccessCredentials.

This is the secret portion of AWS Access Credentials indicated by the aws_access_key_id

This is the ID string for an AWS Hosted zone which will contain the OpenShift application records.

For more info see http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/CreatingHostedZone.html

List of upstream DNS servers to use when installing a nameserver on this node.

Default: [8.8.8.8]

This is used for the node to record its broker. Also is the default for the nameserver IP if none is given.

Default: the current IP (at install)

An array of broker hostnames that will be load-balanced for high-availability.

Default: undef

An array of Broker IP addresses within the load-balanced cluster.

Default: undef

The virtual IP address that will front-end the Broker cluster.

Default: undef

The hostame that represents the Broker API cluster. This name is associated to broker_virtual_ip_address and added to Named for DNS resolution.

Default: "broker.${domain}"

Sets the state of the load-balancer. Valid options are true or false. true sets the load-balancer as the active listener for the Broker cluster Virtual IP address. Only 1 load_balancer_master is allowed within a Broker cluster.

Default: false

The password used to secure communication between the load-balancers within a Broker cluster.

Default: changeme

This is used for the node to give a public IP, if different from the one on its NIC.

Default: the current IP (at install)

node_profile

node_quota_files

node_quota_blocks

node_max_active_gears

node_no_overcommit_active

node_limits_nproc

node_tc_max_bandwidth

node_tc_user_share

node_cpu_shares

node_cpu_cfs_quota_us

node_memory_limit_in_bytes

node_memsw_limit_in_bytes

node_memory_oom_control

node_throttle_cpu_shares

node_throttle_cpu_cfs_quota_us

node_throttle_apply_period

node_throttle_apply_percent

node_throttle_restore_percent

node_boosted_cpu_cfs_quota_us

node_boosted_cpu_shares

Enabling this configures NTP. It is important that the time be synchronized across hosts because MCollective messages have a TTL of 60 seconds and may be dropped if the clocks are too far out of synch. However, NTP is not necessary if the clock will be kept in synch by some other means.

Default: true

If configure_ntp is set to true (default), ntp_servers allows users to specify an array of NTP servers used for clock synchronization.

Default: [time.apple.com iburst, pool.ntp.org iburst, clock.redhat.com iburst]

Set to true to cluster ActiveMQ for high-availability and scalability of OpenShift message queues.

Default: false

An array of ActiveMQ server hostnames. Required when parameter msgserver_cluster is set to true.

Default: undef

DEPRECATED: use msgserver_cluster_members instead, if both are set they must match

Default: $msgserver_cluster_members

Password used by ActiveMQ’s amquser. The amquser is used to authenticate ActiveMQ inter-cluster communication. Only used when msgserver_cluster is true.

Default "changeme"

This is the admin password for the ActiveMQ admin console, which is not needed by OpenShift but might be useful in troubleshooting.

Default: scrambled

This configures mcollective and activemq to use end-to-end encryption over TLS. Use enabled to support both TLS and non-TLS, or strict to only support TLS.

Default: disabled

The password used to protect the keystore. It must be greater than 6 characters. This is required.

Default: password

Location for certificate ca

Default: /var/lib/puppet/ssl/certs/ca.pem

Location for certificate cert

Default: /var/lib/puppet/ssl/certs/${lower_fqdn}.pem

Location for certificate key

Default: /var/lib/puppet/ssl/private_keys/${lower_fqdn}.pem

This is the user and password shared between broker and node for communicating over the mcollective topic channels in ActiveMQ. Must be the same on all broker and node hosts.

Default: mcollective/marionette

These are the username and password of the administrative user that will be created in the MongoDB datastore. These credentials are not used by in this script or by OpenShift, but an administrative user must be added to MongoDB in order for it to enforce authentication.

Default: admin/mongopass

These are the username and password of the normal user that will be created for the broker to connect to the MongoDB datastore. The broker application’s MongoDB plugin is also configured with these values.

Default: openshift/mongopass

This is the name of the database in MongoDB in which the broker will store data.

Default: openshift_broker

The TCP port used for MongoDB to listen on.

Default: 27017

Enable/disable MongoDB replica sets for database high-availability.

Default: false

The MongoDB replica set name when $mongodb_replicasets is true.

Default: openshift

Set the host as the primary with true or secondary with false. Must be set on one and only one host within the mongodb_replicasets_members array.

Default: undef

The IP address of the Primary host within the MongoDB replica set.

Default: undef

An array of [host:port] of replica set hosts. Example: [10.10.10.10:27017, 10.10.10.11:27017, 10.10.10.12:27017]

Default: undef

The file containing the $mongodb_key used to authenticate MongoDB replica set members.

Default: /etc/mongodb.keyfile

The key used by members of a MongoDB replica set to authenticate one another.

Default: changeme

This user and password are entered in the /etc/openshift/htpasswd file as a demo/test user. You will likely want to remove it after installation (or just use a different auth method).

Default: demo/changeme

Salt and private keys used when generating secure authentication tokens for Application to Broker communication. Requests like scale up/down and jenkins builds use these authentication tokens. This value must be the same on all broker nodes.

Default: Self signed keys are generated. Will not work with multi-broker setup.

Customize default app templates for specified framework cartridges. Space-separated list of elements <cartridge-name>|<git url> - URLs must be available for all nodes. URL will be cloned as the git repository for the cartridge at app creation unless the user specifies their own. e.g.: DEFAULT_APP_TEMPLATES=php-5.3|http://example.com/php.git perl-5.10|file:///etc/openshift/cart.conf.d/templates/perl.git WARNING: do not include private credentials in any URL; they would be visible in every app’s cloned repository.

Default: ''

Enumerate the set of valid gear sizes for a given cartridge. If not specified, its assumed the cartridge can run on any defined gear size. Space-separated list of elements <cartridge-name>|<size1,size2> e.g.: VALID_GEAR_SIZES_FOR_CARTRIDGE="php-5.3|medium,large jbossews-2.0|large"

Default: ''

Relative path to product logo URL

Default: if ose_version == undef /assets/logo-origin.svg if ose_version != undef /assets/logo-enterprise-horizontal.svg

OpenShift Instance Name

Default: if ose_version == undef OpenShift Origin if ose_version != undef Openshift Enterprise

This setting is applied on a per-scalable-application basis. When set to true, OpenShift will allow multiple instances of the HAProxy gear for a given scalable app to be established on the same node. Otherwise, on a per-scalable-application basis, a maximum of one HAProxy gear can be created for every node in the deployment (this is the default behavior, which protects scalable apps from single points of failure at the Node level).

Default: false

Session secrets used to encode cookies used by console and broker. This value must be the same on all broker nodes.

Default: undef

Prefix/Suffix used for Highly Available application URL http://${ha_dns_prefix}${app_name}-${domain_name}${ha_dns_suffix}.${cloud_domain}

Default prefix: ha- Default suffix: ''

List of all gear sizes this will be used in this OpenShift installation.

Default: [small]

Default gear size if one is not specified.

Default: small

List of all gear sizes that newly created users will be able to create.

Default: [small]

Default max number of domains a user is allowed to use

Default: 10

Default max number of gears a user is allowed to use

Default: 100

Default region if one is not specified.

Default: ""

Should the user be allowed to select the region the application is placed in.

Default: true

When true, new gear UUIDs (and thus gear usernames) are created with the format: <domain_namespace>­<app_name>­<gear_index>

Default: false

When true, gear placement will fail if there are no available districts with the correct gear profile.

Default: true

When true, gear placement will fail if there are no available zones with the correct gear profile.

Default: false

desired minimum number of zones between which gears in application gear groups are distributed.

Default: 1

When true, enable access to the administration console. Authentication for the Administration Console is only handled via the ldap Broker Auth Plugin, using <code>broker_ldap_admin_console_uri</code>

Default: false

DNS plugin used by the broker to register application DNS entries. Options:

• nsupdate - nsupdate based plugin. Supports TSIG and GSS-TSIG based authentication. Uses bind_key for TSIG and bind_krb_keytab, bind_krb_principal for GSS_TSIG auth.

• avahi - sets up a MDNS based DNS resolution. Works only for all-in-one installations.

• route53 - use AWS Route53 for dynamic DNS service. Requires AWS key ID and secret and a delegated zone ID

Default: nsupdate

Authentication setup for users of the OpenShift service. Options:

• mongo - Stores username and password in mongo.

• kerberos - Kerberos based authentication. Uses broker_krb_service_name, broker_krb_auth_realms, broker_krb_keytab values.

• htpasswd - Stores username/password in a htaccess file.

• ldap - LDAP based authentication. Uses broker_ldap_uri.

Default: htpasswd

The KrbServiceName value for mod_auth_kerb configuration. This value will be prefixed with HTTP/ to create the krb5 service principal.

Default: hostname

The KrbAuthRealms value for mod_auth_kerb configuration

The Krb5KeyTab value of mod_auth_kerb is not configurable — the keytab is expected in /var/www/openshift/broker/httpd/conf.d/http.keytab

URI to the LDAP server (e.g. ldap://ldap.example.com:389/ou=People,dc=my-domain,dc=com?uid?sub?(objectClass=*)). Set <code>broker_auth_plugin</code> to <code>ldap</code> to enable this feature.

LDAP DN (Distinguished name) of user to bind to the directory with. (e.g. cn=administrator,cn=Users,dc=domain,dc=com) Default is anonymous bind.

Password of bind user set in broker_ldap_bind_dn. Default is anonymous bind with a blank password.

URI to the LDAP server for admin console access (e.g. ldap://ldap.example.com:389/ou=People,dc=my-domain,dc=com?uid?sub?(objectClass=*)). Set <code>broker_external_access_admin_console</code> to enable this feature

kernel.shmmax sysctl setting for /etc/sysctl.conf

This setting should work for most deployments but if this is desired to be tuned higher, the general recommendations are as follows:

shmmax is not recommended to be a value higher than 80% of total available RAM on the system (expressed in BYTES).

Default: kernel.shmmax = 68719476736

kernel.shmall sysctl setting for /etc/sysctl.conf, this defaults to 2097152 BYTES

This parameter sets the total amount of shared memory pages that can be used system wide. Hence, SHMALL should always be at least ceil(shmmax/PAGE_SIZE).

Default: kernel.shmall = 4294967296

Specify the container type to use on the node. * selinux - This is the default OpenShift Origin container type. At this time there are no other supported plugins.

Default: selinux

Specify one or more plugins to use register HTTP and web-socket connections for applications. Options:

• apache-mod-rewrite - Mod-Rewrite based plugin for HTTP and HTTPS requests. Well suited for installations with a lot of creates/deletes/scale actions. Deprecated in OSE 2.2.

• apache-vhost - VHost based plugin for HTTP and HTTPS. Suited for installations with less app create/delete activity. Easier to customize. If apache-mod-rewrite is also selected, apache-vhost will be ignored

• nodejs-websocket - Web-socket proxy listening on ports 8000/8444

• haproxy-sni-proxy - TLS proxy using SNI routing on ports 2303 through 2308 requires /usr/sbin/haproxy15 (haproxy-1.5-dev19 or later).

Default: [apache-vhost,nodejs-websocket]

List of user names who have UIDs in the range of OpenShift gears but must be excluded from OpenShift gear setups.

Default: []

External facing network device. Used for routing and traffic control setup.

Default: eth0

Number of proxy ports available per gear.

Default: 5

Public and private keys used for gears on the default domain. Both values must be defined or default self signed keys will be generated.

Default: Self signed keys are generated.

Name of supplementary UNIX group to add a gear to.

Enable/Disable the OpenShift Node watchman service

Default: true

Number of restarts to attempt before waiting RETRY_PERIOD

Default: 3

Number of seconds to wait before accepting another gear restart

Default: 300

Number of seconds to wait before resetting retries

Default: 28800

Number of seconds a gear must remain inconsistent with it’s state before Watchman attempts to reset state

Default: 900

Wait at least this number of seconds since last check before checking gear state on the Node. Use this to reduce Watchman’s GearStatePlugin’s impact on the system.

Default: 0

Define a custom MOTD to be displayed to users who connect to their gears directly. If undef, uses the default MOTD included with the node package.

Default: undef

Set development mode and extra logging.

Default: false

Setup DNS entries for this host in a locally installed bind DNS instance.

Default: false

The name of a zone to create which will contain OpenShift infrastructure. If this is unset then no infrastructure zone or other artifacts will be created.

Default: ""

A dnssec symmetric key which will grant update access to the infrastucture zone resource records.

This is ignored unless dns_infrastructure_zone is set.

Default: ""

When using a BIND key, use this algorithm for the infrastructure BIND key.

This is ignored unless dns_infrastructure_zone is set.

Default: HMAC-MD5

An array of hashes containing hostname and IP Address pairs to populate the infrastructure zone.

This value is ignored unless dns_infrastructure_zone is set.

Hostnames can be simple names or fully qualified domain name (FQDN).

Simple names will be placed in the dns_infrastructure_zone. Matching FQDNs will be placed in the _dns_infrastructure_zone. Hostnames anchored with a dot (.) will be added verbatim.

Default: []

Indicate whether or not this module will configure the firewall for you

Default: false

Direct logs to syslog rather than log files. Get more details on https://blog.openshift.com/central-log-management-openshift-enterprise/

Default: undef

Host name of the central log server where rsyslog logs will be forwarded to.

List of cartridges to be installed on the node. Options:

• 10gen-mms-agent not available in OpenShift Enterprise

• cron

• diy

• haproxy

• mongodb

• nodejs

• perl

• php

• phpmyadmin not available in OpenShift Enterprise

• postgresql

• python

• ruby

• jenkins

• jenkins-client

• mysql for CentOS / RHEL deployments

• jbosseap requires OpenShift Enterprise JBoss EAP add-on

• jbossas not available in OpenShift Enterprise

• jbossews

Default: [10gen-mms-agent,cron,diy,haproxy,mongodb, nodejs,perl,php,phpmyadmin,postgresql, python,ruby,jenkins,jenkins-client,mysql] OSE Default : [cron,diy,haproxy,mongodb,nodejs,perl, php,postgresql,python,ruby,jenkins, jenkins-client,mysql],

Default in OpenShift Enterprise: [cron,diy,haproxy,mongodb,nodejs,perl,php, postgresql,python,ruby,jenkins,jenkins-client, jbossews,mysql],

install_cartridges_recommended_deps

install_cartridges_optional_deps

Indicate whether or not this module will configure resolv.conf and network for you.

Default: true

Set this to the X.Y (ie: 2.2) version of Openshift Enterprise to ensure an Openshift Enterprise supported configuration is used.

See README_OSE.asciidoc distributed with the openshift_origin puppet module for more details.

Default: undef

Set this to true in order to allow Openshift Enterprise unsupported configurations. Only appropriate for proof of concept environments.

This parameter is only used when ose_version is set.

Default: false

JSON content to be deployed into /etc/openshift/quickstarts.json

Default: undef, which on Origin will deploy the contents of templates/broker/quickstarts.json.erb

OSE Default: undef and will not deploy any quickstarts