Puppet Class: docker_ucp

Defined in:
manifests/init.pp

Overview

== Class: docker_ucp

Installs or removes the Docker Universal Control Plane application using the official UCP installer.

=== Parameters

[ensure] Whether to install or uninstall Docker UCP. Defaults to present. Valid values are present or absent.

[controller] Whether to install the controller or a normal UCP node. Defaults to false.

[subject_alternative_names] An array of additional Subject Alternative Names for certificates.

[host_address] Specify the visible IP/hostname for this node (override automatic detection).

[swarm_port] Select what port to run the local Swarm manager on.

[controller_port] Select what port to run the local Controller on.

[dns_servers] Set custom DNS servers for the UCP infrastructure containers.

[dns_options] Set DNS options for the UCP infrastructure containers.

[dns_search_domains] Set custom DNS search domains for the UCP infrastructure containers.

[tracking] Whether or not to allow UCP to collect anonymous tracking and analytics information. Defaults to true

[usage] Whether or not to allow UCP to collect anonymous usage information. Defaults to true

[version] Specify a specific UCP version.

[external_ca] Set up UCP with an external CA.

[preserve_certs] Whether or not to (re)generate certs on the host if existing ones are found. Defaults to false.

[swarm_scheduler] Specify a specific Swarm scheduler. Valid values are spead, binpack or random.

[ucp_url] The HTTPS URL for the UCP controller, used by nodes to join the cluster. Required for nodes.

[ucp_id] The ID for the UCP. Used when deleting UCP with ensure => absent.

[fingerprint] The certificate fingerprint for the UCP controller. Required for nodes.

[replica] Whether or not this is a replica of the controller. Defaults to false. Only applicable for nodes.

[username] A username to authenticate a node with the UCP controller. Required for nodes.

[password] The password used to authenticate a node with the UCP controller. Required for nodes.

[license_file] A path to a valid Docker UCP license file. You can set this as part of installation or upload via the web interface at a later date.

Parameter Summary