mirror of https://github.com/docker/docs.git
Merge pull request #1140 from thaJeztah/cluster_reference_docs
Move cluster reference docs, and generate from YAML
This commit is contained in:
paigehargrave
GitHub
commit
deb40062fd
|
|
@ -0,0 +1,49 @@
|
|||
command: docker cluster
|
||||
short: Docker Cluster
|
||||
long: A tool to build and manage Docker Clusters.
|
||||
pname: docker
|
||||
plink: docker.yaml
|
||||
cname:
|
||||
- docker cluster backup
|
||||
- docker cluster create
|
||||
- docker cluster inspect
|
||||
- docker cluster ls
|
||||
- docker cluster restore
|
||||
- docker cluster rm
|
||||
- docker cluster update
|
||||
- docker cluster version
|
||||
clink:
|
||||
- docker_cluster_backup.yaml
|
||||
- docker_cluster_create.yaml
|
||||
- docker_cluster_inspect.yaml
|
||||
- docker_cluster_ls.yaml
|
||||
- docker_cluster_restore.yaml
|
||||
- docker_cluster_rm.yaml
|
||||
- docker_cluster_update.yaml
|
||||
- docker_cluster_version.yaml
|
||||
options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
command: docker cluster backup
|
||||
short: Backup a running cluster
|
||||
long: Backup a running cluster
|
||||
usage: docker cluster backup [OPTIONS] cluster
|
||||
pname: docker cluster
|
||||
plink: docker_cluster.yaml
|
||||
options:
|
||||
- option: env
|
||||
shorthand: e
|
||||
value_type: stringSlice
|
||||
default_value: '[]'
|
||||
description: Set environment variables
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: file
|
||||
value_type: string
|
||||
default_value: backup.tar.gz
|
||||
description: Cluster backup filename
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: passphrase
|
||||
value_type: string
|
||||
description: Cluster backup passphrase
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
command: docker cluster create
|
||||
short: Create a new Docker Cluster
|
||||
long: Create a new Docker Cluster
|
||||
usage: docker cluster create [OPTIONS]
|
||||
pname: docker cluster
|
||||
plink: docker_cluster.yaml
|
||||
options:
|
||||
- option: env
|
||||
shorthand: e
|
||||
value_type: stringSlice
|
||||
default_value: '[]'
|
||||
description: Set environment variables
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: example
|
||||
value_type: string
|
||||
default_value: aws
|
||||
description: Display an example cluster declaration
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: file
|
||||
shorthand: f
|
||||
value_type: string
|
||||
default_value: cluster.yml
|
||||
description: Cluster declaration
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: name
|
||||
shorthand: "n"
|
||||
value_type: string
|
||||
description: Name for the cluster
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: switch-context
|
||||
shorthand: s
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Switch context after cluster create.
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
command: docker cluster inspect
|
||||
short: Display detailed information about a cluster
|
||||
long: Display detailed information about a cluster
|
||||
usage: docker cluster inspect [OPTIONS] cluster
|
||||
pname: docker cluster
|
||||
plink: docker_cluster.yaml
|
||||
options:
|
||||
- option: all
|
||||
shorthand: a
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Display complete info about cluster
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
command: docker cluster ls
|
||||
short: List all available clusters
|
||||
long: List all available clusters
|
||||
usage: docker cluster ls [OPTIONS]
|
||||
pname: docker cluster
|
||||
plink: docker_cluster.yaml
|
||||
options:
|
||||
- option: quiet
|
||||
shorthand: q
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Only display numeric IDs
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
command: docker cluster restore
|
||||
short: Restore a cluster from a backup
|
||||
long: Restore a cluster from a backup
|
||||
usage: docker cluster restore [OPTIONS] cluster
|
||||
pname: docker cluster
|
||||
plink: docker_cluster.yaml
|
||||
options:
|
||||
- option: env
|
||||
shorthand: e
|
||||
value_type: stringSlice
|
||||
default_value: '[]'
|
||||
description: Set environment variables
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: file
|
||||
value_type: string
|
||||
default_value: backup.tar.gz
|
||||
description: Cluster backup filename
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: passphrase
|
||||
value_type: string
|
||||
description: Cluster backup passphrase
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
command: docker cluster rm
|
||||
short: Remove a cluster
|
||||
long: Remove a cluster
|
||||
usage: docker cluster rm [OPTIONS] cluster
|
||||
pname: docker cluster
|
||||
plink: docker_cluster.yaml
|
||||
options:
|
||||
- option: env
|
||||
shorthand: e
|
||||
value_type: stringSlice
|
||||
default_value: '[]'
|
||||
description: Set environment variables
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: force
|
||||
shorthand: f
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Force removal of the cluster files
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
command: docker cluster update
|
||||
short: Update a running cluster's desired state
|
||||
long: Update a running cluster's desired state
|
||||
usage: docker cluster update [OPTIONS] cluster
|
||||
pname: docker cluster
|
||||
plink: docker_cluster.yaml
|
||||
options:
|
||||
- option: env
|
||||
shorthand: e
|
||||
value_type: stringSlice
|
||||
default_value: '[]'
|
||||
description: Set environment variables
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: file
|
||||
shorthand: f
|
||||
value_type: string
|
||||
description: Cluster definition
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
command: docker cluster version
|
||||
short: Print Version, Commit, and Build type
|
||||
long: Print Version, Commit, and Build type
|
||||
usage: docker cluster version
|
||||
pname: docker cluster
|
||||
plink: docker_cluster.yaml
|
||||
options:
|
||||
- option: json
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Formats output as JSON. Implies '--log-level error'
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Skip provisioning resources
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: log-level
|
||||
value_type: string
|
||||
default_value: warn
|
||||
description: |
|
||||
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
|
|
@ -629,6 +629,27 @@ reference:
|
|||
title: docker checkpoint ls
|
||||
- path: /engine/reference/commandline/checkpoint_rm/
|
||||
title: docker checkpoint rm
|
||||
|
||||
- sectiontitle: docker cluster *
|
||||
section:
|
||||
- path: /engine/reference/commandline/cluster/
|
||||
title: docker cluster
|
||||
- path: /engine/reference/commandline/cluster_backup/
|
||||
title: docker cluster backup
|
||||
- path: /engine/reference/commandline/cluster_create/
|
||||
title: docker cluster create
|
||||
- path: /engine/reference/commandline/cluster_inspect/
|
||||
title: docker cluster inspect
|
||||
- path: /engine/reference/commandline/cluster_ls/
|
||||
title: docker cluster ls
|
||||
- path: /engine/reference/commandline/cluster_restore/
|
||||
title: docker cluster restore
|
||||
- path: /engine/reference/commandline/cluster_rm/
|
||||
title: docker cluster rm
|
||||
- path: /engine/reference/commandline/cluster_update/
|
||||
title: docker cluster update
|
||||
- path: /engine/reference/commandline/cluster_version/
|
||||
title: docker cluster version
|
||||
- path: /engine/reference/commandline/commit/
|
||||
title: docker commit
|
||||
- sectiontitle: docker config *
|
||||
|
|
@ -1287,26 +1308,16 @@ manuals:
|
|||
nosync: true
|
||||
- sectiontitle: Docker Cluster
|
||||
section:
|
||||
- path: /cluster/overview/
|
||||
- path: /cluster/
|
||||
title: Overview
|
||||
- path: /cluster/aws/
|
||||
title: Docker Cluster on AWS
|
||||
- path: /cluster/cluster-file/
|
||||
title: Cluster file structure
|
||||
- path: /cluster/reference/
|
||||
title: Subcommands
|
||||
- path: /cluster/reference/envvars/
|
||||
title: Environment variables
|
||||
- path: /cluster/reference/ls/
|
||||
title: List clusters
|
||||
- path: /cluster/reference/inspect/
|
||||
title: Inspect clusters
|
||||
- path: /cluster/reference/update/
|
||||
title: Update clusters
|
||||
- path: /cluster/reference/remove/
|
||||
title: Remove clusters
|
||||
- path: /cluster/reference/version/
|
||||
title: Version information
|
||||
- path: /cluster/reference/
|
||||
title: Subcommands
|
||||
- sectiontitle: Docker Engine - Enterprise
|
||||
section:
|
||||
- path: /ee/supported-platforms/
|
||||
|
|
|
|||
|
|
@ -398,5 +398,5 @@ All provisioned resources are destroyed and the context for the cluster is remov
|
|||
## Where to go next
|
||||
|
||||
- View the quick start guide for [Azure](azure.md) or [vSphere](vsphere.md)
|
||||
- [Explore the full list of Cluster commands](./reference/index.md)
|
||||
- [Cluster configuration file reference](./cluster-file/index.md)
|
||||
- [Explore the full list of Cluster commands](/engine/reference/commandline/cluster/)
|
||||
- [Cluster configuration file reference](./cluster-file.md)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,529 @@
|
|||
---
|
||||
description: Cluster file reference and guidelines
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: Cluster file version 1 reference
|
||||
toc_max: 5
|
||||
toc_min: 1
|
||||
---
|
||||
|
||||
This topic describes version 1 of the Cluster file format.
|
||||
|
||||
## Cluster file structure and examples
|
||||
|
||||
<div class="panel panel-default">
|
||||
<div class="panel-heading collapsed" data-toggle="collapse" data-target="#collapseSample1" style="cursor: pointer">
|
||||
Example Cluster file version 1
|
||||
<i class="chevron fa fa-fw"></i></div>
|
||||
<div class="collapse block" id="collapseSample1">
|
||||
<pre><code>
|
||||
variable:
|
||||
domain: "YOUR DOMAIN, e.g. docker.com"
|
||||
subdomain: "A SUBDOMAIN, e.g. cluster"
|
||||
region: "THE AWS REGION TO DEPLOY, e.g. us-east-1"
|
||||
email: "YOUR.EMAIL@COMPANY.COM"
|
||||
ucp_password:
|
||||
type: prompt
|
||||
provider:
|
||||
acme:
|
||||
email: ${email}
|
||||
server_url: https://acme-staging-v02.api.letsencrypt.org/directory
|
||||
aws:
|
||||
region: ${region}
|
||||
cluster:
|
||||
dtr:
|
||||
version: docker/dtr:2.6.5
|
||||
engine:
|
||||
version: ee-stable-18.09.5
|
||||
ucp:
|
||||
username: admin
|
||||
password: ${ucp_password}
|
||||
version: docker/ucp:3.1.6
|
||||
resource:
|
||||
aws_instance:
|
||||
managers:
|
||||
instance_type: t2.xlarge
|
||||
os: Ubuntu 16.04
|
||||
quantity: 3
|
||||
registry:
|
||||
instance_type: t2.xlarge
|
||||
os: Ubuntu 16.04
|
||||
quantity: 3
|
||||
workers:
|
||||
instance_type: t2.xlarge
|
||||
os: Ubuntu 16.04
|
||||
quantity: 3
|
||||
aws_lb:
|
||||
apps:
|
||||
domain: ${subdomain}.${domain}
|
||||
instances:
|
||||
- workers
|
||||
ports:
|
||||
- 80:8080
|
||||
- 443:8443
|
||||
dtr:
|
||||
domain: ${subdomain}.${domain}
|
||||
instances:
|
||||
- registry
|
||||
ports:
|
||||
- 443:443
|
||||
ucp:
|
||||
domain: ${subdomain}.${domain}
|
||||
instances:
|
||||
- managers
|
||||
ports:
|
||||
- 443:443
|
||||
- 6443:6443
|
||||
aws_route53_zone:
|
||||
dns:
|
||||
domain: ${domain}
|
||||
subdomain: ${subdomain}
|
||||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
The topics on this reference page are organized alphabetically by top-level keys
|
||||
to reflect the structure of the Cluster file. Top-level keys that define
|
||||
a section in the configuration file, such as `cluster`, `provider`, and `resource`,
|
||||
are listed with the options that support them as sub-topics. This information
|
||||
maps to the indent structure of the Cluster file.
|
||||
|
||||
### cluster
|
||||
Specifies components to install and configure for a cluster.
|
||||
|
||||
The following components are available:
|
||||
|
||||
- `subscription`: (Optional) A string value representing the subscription ID.
|
||||
- `license`: (Optional) A path to the cluster's license file.
|
||||
- `cloudstor`: (Optional) Configuration options for Docker CloudStor
|
||||
- `dtr`: (Optional) Configuration options for Docker Trusted Registry
|
||||
- `engine`: (Optional) Configuration options for Docker Engine
|
||||
- `ucp`: (Optional) Configuration options for Docker Universal Control Plane
|
||||
- `registry`: (Optional) Configuration options for authenticating nodes with a registry to pull Docker images.
|
||||
|
||||
#### cloudstor
|
||||
Customizes the installation of Docker Cloudstor.
|
||||
|
||||
- `version`: (Optional) The version of Cloudstor to install. Default is `1.0`
|
||||
- `use_efs`: (Optional) Specifies whether an Elastic File System should be provisioned. Defaults to `false`.
|
||||
|
||||
#### dtr
|
||||
Customizes the installation of Docker Trusted Registry.
|
||||
```yaml
|
||||
cluster:
|
||||
dtr:
|
||||
version: "docker/dtr:2.6.5"
|
||||
install_options:
|
||||
- "--debug"
|
||||
- "--enable-pprof"
|
||||
```
|
||||
|
||||
The following optional elements can be specified:
|
||||
|
||||
- `version`: (Optional) The version of DTR to install. Defaults to `docker/dtr:2.6.5`.
|
||||
- `ca`: (Optional) The path to a root CA public certificate.
|
||||
- `key`: (Optional) The path to a TLS private key.
|
||||
- `cert`: (Optional) The path to a public key certificate.
|
||||
- `install_options`: (Optional) Additional [DTR install options](https://docs.docker.com/reference/dtr/2.6/cli/install/)
|
||||
|
||||
#### engine
|
||||
Customizes the installation of Docker Enterprise Engine.
|
||||
```yaml
|
||||
cluster:
|
||||
engine:
|
||||
channel: "stable"
|
||||
edition: "ee"
|
||||
version: "19.03"
|
||||
```
|
||||
|
||||
The following optional elements can be specified:
|
||||
- `version`: (Optional) The version of the Docker Engine to install. Defaults to `19.03`.
|
||||
- `edition`: (Optional) The family of Docker Engine to install. Defaults to `ee` for Enterprise edition.
|
||||
- `channel`: (Optional) The channel on the repository to pull updated packages. Defaults to `stable`.
|
||||
- `url`: (Optional) Defaults to "https://storebits.docker.com/ee".
|
||||
- `storage_driver`: (Optional) The storage driver to use for the storage volume. Default
|
||||
value is dependent on the operating system.
|
||||
- Amazon Linux 2 is `overlay2`.
|
||||
- Centos is `overlay2`.
|
||||
- Oracle Linux is `overlay2`.
|
||||
- RedHat is `overlay2`.
|
||||
- SLES is `btrfs`.
|
||||
- Ubuntu is `overlay2`.
|
||||
- `storage_fstype`: (Optional) File system to use for storage volume. Default value is dependent on the operating system.
|
||||
- Amazon Linux 2 is `xfs`.
|
||||
- Centos is `xfs`.
|
||||
- Oracle Linux is `xfs`.
|
||||
- RedHat is `xfs`.
|
||||
- SLES is `btrfs`.
|
||||
- Ubuntu is `ext4`.
|
||||
- `storage_volume`: (Optional) Docker storage volume path for `/var/lib/docker` Default value is provider dependent.
|
||||
- AWS
|
||||
- non-NVME is `/dev/xvdb`.
|
||||
- NVME disks are one of `/dev/nvme[0-26]n1`.
|
||||
- Azure is `/dev/disk/azure/scsi1/lun0`.
|
||||
- `daemon`: (Optional) Provides docker daemon options. Defaults to "".
|
||||
- `ca`: (dev) Defaults to "".
|
||||
- `key`: (dev) Defaults to "".
|
||||
- `enable_remote_tcp`: (dev) Enables direct access to docker engine. Defaults to `false`.
|
||||
|
||||
*dev indicates that the functionality is only for development and testing.
|
||||
|
||||
#### kubernetes
|
||||
Enables provider-specific options for Kubernetes support.
|
||||
|
||||
##### AWS Kubernetes options
|
||||
|
||||
- `cloud_provider`: (Optional)Enable cloud provider support for Kubernetes. Defaults to `false`.
|
||||
- `ebs_persistent_volumes`: (Optional) Enable persistent volume support with EBS volumes. Defaults to `false`.
|
||||
- `efs_persistent_volumes`: (Optional) Enable persistent volume support with EFS. Defaults to `false`.
|
||||
- `load_balancer`: (Optional) Enable Kubernetes pods to instantiate a load-balancer. Defaults to `false`.
|
||||
- `nfs_storage`: (Optional) Install additional packages on node for NFS support. Defaults to `false`.
|
||||
- `lifecycle`: (Optional) Defaults to `owned`.
|
||||
|
||||
#### registry
|
||||
Customizes the registry from which the installation should pull images. By default, Docker Hub and credentials to access Docker Hub are used.
|
||||
|
||||
```yaml
|
||||
cluster:
|
||||
registry:
|
||||
password: ${base64decode("TVJYeTNDQWpTSk5HTW1ZRzJQcE1kM0tVRlQ=")}
|
||||
url: https://index.docker.io/v1/
|
||||
username: user
|
||||
```
|
||||
|
||||
The following optional elements can be specified:
|
||||
- `username`: The username for logging in to the registry on each node. Default value is the current docker user.
|
||||
- `url`: The registry to use for pulling Docker images. Defaults to "https://index.docker.io/v1/".
|
||||
- `password`: The password for logging in to the registry on each node. Default value is the current docker user's password base64 encoded and wrapped in a call to base64decode.
|
||||
|
||||
#### ucp
|
||||
|
||||
- `version`: Specifies the version of UCP to install. Defaults to `docker/ucp:3.1.6`.
|
||||
- `username`: Specifies the username of the first user to create in UCP. Defaults to `admin`.
|
||||
- `password`: Specifies the password of the first user to create in UCP. Defaults to `dockerdocker`.
|
||||
- `ca`: Specifies a path to a root CA public certificate.
|
||||
- `key`: Specifies a path to a TLS private key.
|
||||
- `cert`: Specifies a path to a public key certificate.
|
||||
- `install_options`: Lists additional [UCP install options](https://docs.docker.com/reference/ucp/3.1/cli/install/)
|
||||
|
||||
##### Additional UCP configuration options:
|
||||
Docker Cluster also accepts all UCP configuration options and creates the initial UCP config on
|
||||
installation. The following list provides supported options:
|
||||
- `anonymize_tracking`: Anonymizes analytic data. Specify 'true' to hide the license ID. Defaults to 'false'.
|
||||
- `audit_level`: Specifies the audit logging level. Leave empty for disabling audit logs (default).
|
||||
Other valid values are 'metadata' and 'request'.
|
||||
- `auto_refresh`: Specify 'true' to enable attempted automatic license renewal when the license
|
||||
nears expiration. If disabled, you must manually upload renewed license after expiration. Defaults to 'true'.
|
||||
- `azure_ip_count`: Sets the IP count for azure allocator to allocate IPs per Azure virtual machine.
|
||||
- `backend`: Specifie the name of the authorization backend to use, either 'managed' or 'ldap'. Defaults to 'managed'.
|
||||
- `calico_mtu`: Specifies the MTU (maximum transmission unit) size for the Calico plugin. Defaults to '1480'.
|
||||
- `cloud_provider`: Specifies the cloud provider for the kubernetes cluster.
|
||||
- `cluster_label`: Specifies a label to be included with analytics/.
|
||||
- `cni_installer_url`: Specifies the URL of a Kubernetes YAML file to be used for installing a CNI plugin.
|
||||
Only applies during initial installation. If empty, the default CNI plugin is used.
|
||||
- `controller_port`: Configures the port that the 'ucp-controller' listens to. Defaults to '443'.
|
||||
- `custom_header_name`: Specifies the name of the custom header with 'name' = '*X-Custom-Header-Name*'.
|
||||
- `custom_header_value`: Specifies the value of the custom header with 'value' = '*Custom Header Value*'.
|
||||
- `default_new_user_role`: Specifies the role that new users get for their private resource sets.
|
||||
Values are 'admin', 'viewonly', 'scheduler', 'restrictedcontrol', or 'fullcontrol'. Defaults to 'restrictedcontrol'.
|
||||
- `default_node_orchestrator`: Specifies the type of orchestrator to use for new nodes that are
|
||||
joined to the cluster. Can be 'swarm' or 'kubernetes'. Defaults to 'swarm'.
|
||||
- `disable_tracking`: Specify 'true' to disable analytics of API call information. Defaults to 'false'.
|
||||
- `disable_usageinfo`: Specify 'true' to disable analytics of usage information. Defaults to 'false'.
|
||||
- `dns`: Specifies a CSV list of IP addresses to add as nameservers.
|
||||
- `dns_opt`: Specifies a CSV list of options used by DNS resolvers.
|
||||
- `dns_search`: Specifies a CSV list of domain names to search when a bare unqualified hostname is
|
||||
used inside of a container.
|
||||
- `enable_admin_ucp_scheduling`: Specify 'true' to allow admins to schedule on containers on manager nodes.
|
||||
Defaults to 'false'.
|
||||
- `external_service_lb`: Specifies an optional external load balancer for default links to services with
|
||||
exposed ports in the web interface.
|
||||
- `host_address`: Specifies the address for connecting to the DTR instance tied to this UCP cluster.
|
||||
- `log_host`: Specifies a remote syslog server to send UCP controller logs to. If omitted, controller
|
||||
logs are sent through the default docker daemon logging driver from the 'ucp-controller' container.
|
||||
- `idpMetadataURL`: Specifies the Identity Provider Metadata URL.
|
||||
- `image_repository`: Specifies the repository to use for UCP images.
|
||||
- `install_args`: Specifies additional arguments to pass to the UCP installer.
|
||||
- `ipip_mtu`: Specifies the IPIP MTU size for the calico IPIP tunnel interface.
|
||||
- `kube_apiserver_port`: Configures the port to which the Kubernetes API server listens.
|
||||
- `kv_snapshot_count`: Sets the key-value store snapshot count setting. Defaults to '20000'.
|
||||
- `kv_timeout`: Sets the key-value store timeout setting, in milliseconds. Defaults to '5000'.
|
||||
- `lifetime_minutes`: Specifies the initial session lifetime, in minutes. Defaults to `4320`, which is 72 hours.
|
||||
- `local_volume_collection_mapping`: Stores data about collections for volumes in UCP's local KV store
|
||||
instead of on the volume labels. This is used for enforcing access control on volumes.
|
||||
- `log_level`: Specifies the logging level for UCP components. Values are syslog priority
|
||||
levels (https://linux.die.net/man/5/syslog.conf): 'debug', 'info', 'notice', 'warning', 'err', 'crit', 'alert',
|
||||
and 'emerg'.
|
||||
- `managedPasswordDisabled`: Indicates if managed password is disabled. Defaults to false.
|
||||
- `managedPasswordFallbackUser`: The fallback user when the managed password authentication is disabled. Defaults to "".
|
||||
- `manager_kube_reserved_resources`: Specifies reserve resources for Docker UCP and Kubernetes components
|
||||
that are running on manager nodes.
|
||||
- `metrics_disk_usage_interval`: Specifies the interval for how frequently storage metrics are gathered.
|
||||
This operation can impact performance when large volumes are present.
|
||||
- `metrics_retention_time`: Adjusts the metrics retention time.
|
||||
- `metrics_scrape_interval`: Specifies the interval for how frequently managers gather metrics from nodes in the cluster.
|
||||
- `nodeport_range`: Specifies the port range that for Kubernetes services of type NodePort can be exposed in.
|
||||
Defaults to '32768-35535'.
|
||||
- `per_user_limit`: Specifies the maximum number of sessions that a user can have active simultaneously. If
|
||||
the creation of a new session would put a user over this limit, the least recently used session is deleted.
|
||||
A value of zero disables limiting the number of sessions that users can have. Defaults to `5`.
|
||||
- `pod_cidr`: Specifies the subnet pool from which the IP for the Pod should be allocated from the CNI ipam plugin.
|
||||
- `profiling_enabled`: Specify 'true' to enable specialized debugging endpoints for profiling UCP performance.
|
||||
Defaults to 'false'.
|
||||
- `log_protocol`: Specifies the protocol to use for remote logging. Values are 'tcp' and 'udp'. Defaults to 'tcp'.
|
||||
- `renewal_threshold_minutes`: Specifies the length of time, in minutes, before the expiration of a
|
||||
session. When used, a session is extended by the current configured lifetime from that point in time. A zero value disables session extension. Defaults to `1440`, which is 24 hours.
|
||||
- `require_content_trust`: Specify 'true' to require images be signed by content trust. Defaults to 'false'.
|
||||
- `require_signature_from`: Specifies a csv list of users or teams required to sign images.
|
||||
- `rethinkdb_cache_size`: Sets the size of the cache used by UCP's RethinkDB servers. TDefaults to 1GB,
|
||||
but leaving this field empty or specifying `auto` instructs RethinkDB to determine a cache size automatically.
|
||||
- `rootCerts`: Defaults to empty.
|
||||
- `samlEnabled`: Indicates if saml is used.
|
||||
- `samlLoginText`: Specifies the customized SAML login button text.
|
||||
- `service_id`: Specifies the DTR instance's OpenID Connect Client ID, as registered with the Docker
|
||||
authentication provider.
|
||||
- `spHost`: Specifies the Service Provider Host.
|
||||
- `storage_driver`: Specifies the UCP storage driver to install.
|
||||
- `support_dump_include_audit_logs`: When set to `true`, support dumps include audit logs in the logs
|
||||
of the 'ucp-controller' container of each manager node. Defaults to 'false'.
|
||||
- `swarm_port`: Configures the port that the 'ucp-swarm-manager' listens to. Defaults to '2376'.
|
||||
- `swarm_strategy`: Configures placement strategy for container scheduling.
|
||||
This doesn't affect swarm-mode services. Values are 'spread', 'binpack', and 'random'.
|
||||
- `tlsSkipVerify`: Specifies TLS Skip verify for IdP Metadata.
|
||||
- `unmanaged_cni`: Defaults to 'false'.
|
||||
- `worker_kube_reserved_resources`: Reserves resources for Docker UCP and Kubernetes components
|
||||
that are running on worker nodes.
|
||||
- `custom_kube_api_server_flags`: Specifies the configuration options for the Kubernetes API server. (dev)
|
||||
- `custom_kube_controller_manager_flags`: Specifies the configuration options for the Kubernetes controller manager. (dev)
|
||||
- `custom_kube_scheduler_flags`: Specifies the configuration options for the Kubernetes scheduler. (dev)
|
||||
- `custom_kubelet_flags`: Specifies the configuration options for Kubelets. (dev)
|
||||
|
||||
*dev indicates that the functionality is only for development and testing. Arbitrary Kubernetes configuration parameters are not tested and supported under the Docker Enterprise Software Support Agreement.
|
||||
|
||||
### provider
|
||||
Defines where the cluster's resources are provisioned, as well as provider-specific configuration such as tags.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
provider:
|
||||
acme:
|
||||
email: ${email}
|
||||
server_url: https://acme-staging-v02.api.letsencrypt.org/directory
|
||||
aws:
|
||||
region: ${region}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
#### acme
|
||||
The Automated Certificate Management Environment (ACME) is an evolving standard for the automation of a domain-validated certificate authority. Docker Cluster uses the ACME provider to create SSL certificates that are signed by [Let's Encrypt](https://letsencrypt.org/).
|
||||
|
||||
The ACME provider Configuration for the ACME provider supports arguments that closely align with the [Terraform ACME provider](https://www.terraform.io/docs/providers/acme/index.html):
|
||||
|
||||
The following elements can be specified:
|
||||
- `email`: (Required) The email to associate the certificates with.
|
||||
- `server_url`: (Optional) The URL to the ACME endpoint's directory. Default is "https://acme-v02.api.letsencrypt.org/directory"
|
||||
|
||||
#### aws
|
||||
Configuration for the AWS provider supports arguments that closely align with the [Terraform AWS provider](https://www.terraform.io/docs/providers/aws/index.html).
|
||||
|
||||
```yaml
|
||||
aws:
|
||||
region: "us-east-1"
|
||||
tags:
|
||||
Owner: "Infra"
|
||||
Environment: "Test"
|
||||
```
|
||||
The following elements can be specified:
|
||||
- `region` - (Required) This is the AWS region. It can be sourced from the `AWS_DEFAULT_REGION` environment variables, or
|
||||
via a shared credentials file if `profile` is specified.
|
||||
- `tags` - (Optional) Additional name value pairs to assign to every resource (which
|
||||
supports tagging) in the cluster.
|
||||
- `access_key` - (Required) This is the AWS access key. It can be sourced from
|
||||
the `AWS_ACCESS_KEY_ID` environment variable, or via
|
||||
a shared credentials file if `profile` is specified.
|
||||
- `secret_key` - (Required) This is the AWS secret key. It can be sourced from
|
||||
the `AWS_SECRET_ACCESS_KEY` environment variable, or
|
||||
via a shared credentials file if `profile` is specified.
|
||||
- `profile` - (Optional) This is the AWS profile name as set in the shared credentials
|
||||
file.
|
||||
- `assume_role` - (Optional) An `assume_role` block (documented below). Only one
|
||||
`assume_role` block can be in the configuration.
|
||||
- `endpoints` - (Optional) Configuration block for customizing service endpoints. See the
|
||||
[Custom Service Endpoints Guide](/docs/providers/aws/guides/custom-service-endpoints.html)
|
||||
for more information about connecting to alternate AWS endpoints or AWS compatible solutions.
|
||||
- `shared_credentials_file` = (Optional) This is the path to the shared
|
||||
credentials file. If this is not set and a profile is specified,
|
||||
`~/.aws/credentials` is used.
|
||||
- `token` - (Optional) Session token for validating temporary credentials.
|
||||
Typically provided after successful identity federation or Multi-Factor
|
||||
Authentication (MFA) login. With MFA login, this is the session token
|
||||
provided afterwards, not the 6 digit MFA code used to get temporary
|
||||
credentials. It can also be sourced from the `AWS_SESSION_TOKEN`
|
||||
environment variable.
|
||||
- `max_retries` - (Optional) This is the maximum number of times an API
|
||||
call is retried, in the case where requests are being throttled or
|
||||
experiencing transient failures. The delay between the subsequent API
|
||||
calls increases exponentially.
|
||||
- `allowed_account_ids` - (Optional) List of allowed, white listed, AWS
|
||||
account IDs to prevent you from mistakenly using an incorrect one (and
|
||||
potentially end up destroying a live environment). Conflicts with
|
||||
`forbidden_account_ids`.
|
||||
- `forbidden_account_ids` - (Optional) List of forbidden, blacklisted,
|
||||
AWS account IDs to prevent you mistakenly using a wrong one (and
|
||||
potentially end up destroying a live environment). Conflicts with
|
||||
`allowed_account_ids`.
|
||||
- `insecure` - (Optional) Explicitly allows the provider to
|
||||
perform "insecure" SSL requests. If omitted, defaults to `false`.
|
||||
- `skip_credentials_validation` - (Optional) Skips the credentials
|
||||
validation via the STS API. Useful for AWS API implementations that do
|
||||
not have STS available or implemented.
|
||||
- `skip_get_ec2_platforms` - (Optional) Skips getting the supported EC2
|
||||
platforms. Used by users that don't have `ec2:DescribeAccountAttributes`
|
||||
permissions.
|
||||
- `skip_region_validation` - (Optional) Skips validation of provided region name.
|
||||
Useful for AWS-like implementations that use their own region names
|
||||
or to bypass the validation for regions that aren't publicly available yet.
|
||||
|
||||
### resource
|
||||
Resources to provision for a cluster. Resources are organized as shown in the following example:
|
||||
|
||||
```yaml
|
||||
resource:
|
||||
type:
|
||||
name:
|
||||
parameters
|
||||
```
|
||||
For a given `type`, there may be more one or more named resources to provision.
|
||||
|
||||
For a given `name`, a resource may have one or more parameters.
|
||||
|
||||
#### aws_instance
|
||||
|
||||
```yaml
|
||||
resource:
|
||||
aws_instance:
|
||||
workers:
|
||||
instance_type: t2.xlarge
|
||||
price: 0.25
|
||||
os: Ubuntu 16.04
|
||||
```
|
||||
- `quantity`: (Required) The number of instances to create.
|
||||
- `os`: An alias that is expanded by `docker cluster` to the AMI owner and AMI name to install.
|
||||
The following aliases are supported by `docker cluster`:
|
||||
- `CentOS 7`
|
||||
- `RHEL 7.1`
|
||||
- `RHEL 7.2`
|
||||
- `RHEL 7.3`
|
||||
- `RHEL 7.4`
|
||||
- `RHEL 7.5`
|
||||
- `RHEL 7.6`
|
||||
- `Oracle Linux 7.3`
|
||||
- `Oracle Linux 7.4`
|
||||
- `Oracle Linux 7.5`
|
||||
- `SLES 12.2`
|
||||
- `SLES 12.3`
|
||||
- `SLES 15`
|
||||
- `Ubuntu 14.04`
|
||||
- `Ubuntu 16.04`
|
||||
- `Ubuntu 18.04`
|
||||
- `Windows Server 2016`
|
||||
- `Windows Server 1709`
|
||||
- `Windows Server 1803`
|
||||
- `Windows Server 2019`
|
||||
> Note: Make sure the OS you select is [compatible](https://success.docker.com/article/compatibility-matrix)
|
||||
with the product you're installing. Docker Cluster validates the support during installation.
|
||||
- `instance_type`: Specifies the [AWS instance type](https://aws.amazon.com/ec2/instance-types/) to provision.
|
||||
- `key_name`: By default, Docker Cluster creates an [AWS EC2 Key Pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) and registers it with AWS for the cluster.
|
||||
To use an existing AWS EC2 Key Pair, set this value to the name of the AWS EC2 Key Pair.
|
||||
- `ssh_private_key`: By default, Docker Cluster creates an [AWS EC2 Key Pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) and registers it with AWS for the cluster. To use an existing AWS EC2 Key Pair, set this value to the path of the private SSH key.
|
||||
- `username`: Specifies the username for the node with Administrative privileges. By default, the `os` option
|
||||
sets this to the well-known username for the AMIs (which can change by distribution):
|
||||
- Amazon Linux 2 is `ec2-user`.
|
||||
- Centos is `centos`.
|
||||
- Oracle Linux is `ec2-user`.
|
||||
- RedHat is `ec2-user`.
|
||||
- SLES is `ec2-user`.
|
||||
- Ubuntu is `ubuntu`.
|
||||
- Windows is `Administrator`.
|
||||
- `password`: This value is only used by Windows nodes. By default, Windows nodes have a random password generated.
|
||||
- `ami`: Specifies a custom AMI, or one that's not currently available as an OS. Specify either the id or
|
||||
the owner/name to query for the latest.
|
||||
- `id`: Specifies the ID of the AMI. For example, `ami-0510c89f1a2691cf2`.
|
||||
- `owner`: Specifies the AWS account ID of the image owner. For example, `099720109477`.
|
||||
- `name`: Specifies the name of the AMI that was provided during image creation. For example, `ubuntu/images/hvm-ssd/ubuntu-xenial-16.04-amd64-server-*`.
|
||||
- `platform`: Specify `windows` for Windows instances.
|
||||
- `tags`: (Optional) Specifies additional name value pairs to assign to every instance.
|
||||
- `swarm_labels`: (Optional) Specifies additional key value pairs that represent swarm labels to apply to every node.
|
||||
|
||||
#### aws_spot_instance_request
|
||||
|
||||
Provisions a spot instance request in AWS to dramatically reduce the cost of instances. Spot instance
|
||||
availability is not guaranteed. Therefore, it is recommended to use `aws_spot_instance_request` for
|
||||
additional worker nodes and not for mission-critical nodes like managers and registry.
|
||||
|
||||
```yaml
|
||||
resource:
|
||||
aws_spot_instance_request:
|
||||
workers:
|
||||
instance_type: t2.xlarge
|
||||
price: 0.25
|
||||
os: Ubuntu 16.04
|
||||
quantity: 3
|
||||
```
|
||||
|
||||
Supports the same set of parameters as [aws_instance](index.md#aws_instance), with the addition of an optional price to limit the max bid for a spot instance.
|
||||
- `price`: (Optional) Specifies a maximum price to bid on the spot instance.
|
||||
|
||||
#### aws_lb
|
||||
Provisions an AWS Load Balancer.
|
||||
```yaml
|
||||
resource:
|
||||
aws_lb:
|
||||
ucp:
|
||||
domain: "example.com"
|
||||
instances:
|
||||
- managers
|
||||
ports:
|
||||
- 443:443
|
||||
- 6443:6443
|
||||
```
|
||||
The following options are supported:
|
||||
|
||||
- `instances`: (Required) Specifies a list of `aws_instance` and `aws_spot_instance_request` names to
|
||||
attach to the load balancer.
|
||||
- `ports`: (Required) Specifies a list of `listening port[/protocol]:target port[/protocol]` mappings
|
||||
to define how the load balancer should route traffic. By default, the protocol is `tcp`.
|
||||
- `domain`: Specifies the domain in which to create DNS records for this load balancer. The record is named the
|
||||
same as this resource, appended by the domain. For example, if the resource is `ucp` and the domain is `example.com`,
|
||||
the `A` record is `ucp.example.com`.
|
||||
- `internal`: (Optional) Defaults to `false`.
|
||||
- `type`: (Optional) Defaults to `network`.
|
||||
- `enable_cross_zone_load_balancing`: (Optional) Defaults to `false`.
|
||||
|
||||
#### aws_route53_zone
|
||||
Creates a subdomain in an AWS route53 zone. The following example creates a public zone for `testing.example.com`:
|
||||
|
||||
```yaml
|
||||
resource:
|
||||
aws_route53_zone:
|
||||
dns:
|
||||
domain: example.com
|
||||
subdomain: testing
|
||||
```
|
||||
The following elements are required:
|
||||
- `domain`: (Required) Specifies the name of the hosted zone.
|
||||
- `subdomain`: (Required) Specifies the subdomain to create in the `domain` hosted zone.
|
||||
|
||||
### variable
|
||||
Docker cluster supports basic parameterization. The variable section defines a make of keys and values. A key can have a sub-key named `type`, which changes the behavior of the variable.
|
||||
|
||||
```yaml
|
||||
variable:
|
||||
region: "us-east-1"
|
||||
password:
|
||||
type: prompt
|
||||
```
|
||||
|
||||
Variables are referenced in the cluster definition as `${variable_name}`. For example, `${region}` is substituted as `us-east-2` through the cluster definition.
|
||||
|
||||
The type defines how the variable behaves. This is currently limited in scope to:
|
||||
- `prompt`: Requests the value from the user and does not echo characters as the value is entered.
|
||||
|
|
@ -1,527 +0,0 @@
|
|||
---
|
||||
description: Cluster file reference and guidelines
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: Cluster file version 1 reference
|
||||
toc_max: 5
|
||||
toc_min: 1
|
||||
---
|
||||
|
||||
This topic describes version 1 of the Cluster file format.
|
||||
|
||||
## Cluster file structure and examples
|
||||
```
|
||||
<div class="panel panel-default">
|
||||
<div class="panel-heading collapsed" data-toggle="collapse" data-target="#collapseSample1" style="cursor: pointer">
|
||||
Example Cluster file version 1
|
||||
<i class="chevron fa fa-fw"></i></div>
|
||||
<div class="collapse block" id="collapseSample1">
|
||||
<pre><code>
|
||||
variable:
|
||||
domain: "YOUR DOMAIN, e.g. docker.com"
|
||||
subdomain: "A SUBDOMAIN, e.g. cluster"
|
||||
region: "THE AWS REGION TO DEPLOY, e.g. us-east-1"
|
||||
email: "YOUR.EMAIL@COMPANY.COM"
|
||||
ucp_password:
|
||||
type: prompt
|
||||
provider:
|
||||
acme:
|
||||
email: ${email}
|
||||
server_url: https://acme-staging-v02.api.letsencrypt.org/directory
|
||||
aws:
|
||||
region: ${region}
|
||||
cluster:
|
||||
dtr:
|
||||
version: docker/dtr:2.6.5
|
||||
engine:
|
||||
version: ee-stable-18.09.5
|
||||
ucp:
|
||||
username: admin
|
||||
password: ${ucp_password}
|
||||
version: docker/ucp:3.1.6
|
||||
resource:
|
||||
aws_instance:
|
||||
managers:
|
||||
instance_type: t2.xlarge
|
||||
os: Ubuntu 16.04
|
||||
quantity: 3
|
||||
registry:
|
||||
instance_type: t2.xlarge
|
||||
os: Ubuntu 16.04
|
||||
quantity: 3
|
||||
workers:
|
||||
instance_type: t2.xlarge
|
||||
os: Ubuntu 16.04
|
||||
quantity: 3
|
||||
aws_lb:
|
||||
apps:
|
||||
domain: ${subdomain}.${domain}
|
||||
instances:
|
||||
- workers
|
||||
ports:
|
||||
- 80:8080
|
||||
- 443:8443
|
||||
dtr:
|
||||
domain: ${subdomain}.${domain}
|
||||
instances:
|
||||
- registry
|
||||
ports:
|
||||
- 443:443
|
||||
ucp:
|
||||
domain: ${subdomain}.${domain}
|
||||
instances:
|
||||
- managers
|
||||
ports:
|
||||
- 443:443
|
||||
- 6443:6443
|
||||
aws_route53_zone:
|
||||
dns:
|
||||
domain: ${domain}
|
||||
subdomain: ${subdomain}
|
||||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
The topics on this reference page are organized alphabetically by top-level keys
|
||||
to reflect the structure of the Cluster file. Top-level keys that define
|
||||
a section in the configuration file, such as `cluster`, `provider`, and `resource`,
|
||||
are listed with the options that support them as sub-topics. This information
|
||||
maps to the indent structure of the Cluster file.
|
||||
|
||||
### cluster
|
||||
Specifies components to install and configure for a cluster.
|
||||
|
||||
The following components are available:
|
||||
|
||||
- `subscription`: (Optional) A string value representing the subscription ID.
|
||||
- `license`: (Optional) A path to the cluster's license file.
|
||||
- `cloudstor`: (Optional) Configuration options for Docker CloudStor
|
||||
- `dtr`: (Optional) Configuration options for Docker Trusted Registry
|
||||
- `engine`: (Optional) Configuration options for Docker Engine
|
||||
- `ucp`: (Optional) Configuration options for Docker Universal Control Plane
|
||||
- `registry`: (Optional) Configuration options for authenticating nodes with a registry to pull Docker images.
|
||||
|
||||
#### cloudstor
|
||||
Customizes the installation of Docker Cloudstor.
|
||||
|
||||
- `version`: (Optional) The version of Cloudstor to install. Default is `1.0`
|
||||
- `use_efs`: (Optional) Specifies whether an Elastic File System should be provisioned. Defaults to `false`.
|
||||
|
||||
#### dtr
|
||||
Customizes the installation of Docker Trusted Registry.
|
||||
```yaml
|
||||
cluster:
|
||||
dtr:
|
||||
version: "docker/dtr:2.6.5"
|
||||
install_options:
|
||||
- "--debug"
|
||||
- "--enable-pprof"
|
||||
```
|
||||
|
||||
The following optional elements can be specified:
|
||||
|
||||
- `version`: (Optional) The version of DTR to install. Defaults to `docker/dtr:2.6.5`.
|
||||
- `ca`: (Optional) The path to a root CA public certificate.
|
||||
- `key`: (Optional) The path to a TLS private key.
|
||||
- `cert`: (Optional) The path to a public key certificate.
|
||||
- `install_options`: (Optional) Additional [DTR install options](https://docs.docker.com/reference/dtr/2.6/cli/install/)
|
||||
|
||||
#### engine
|
||||
Customizes the installation of Docker Enterprise Engine.
|
||||
```yaml
|
||||
cluster:
|
||||
engine:
|
||||
channel: "stable"
|
||||
edition: "ee"
|
||||
version: "19.03"
|
||||
```
|
||||
|
||||
The following optional elements can be specified:
|
||||
- `version`: (Optional) The version of the Docker Engine to install. Defaults to `19.03`.
|
||||
- `edition`: (Optional) The family of Docker Engine to install. Defaults to `ee` for Enterprise edition.
|
||||
- `channel`: (Optional) The channel on the repository to pull updated packages. Defaults to `stable`.
|
||||
- `url`: (Optional) Defaults to "https://storebits.docker.com/ee".
|
||||
- `storage_driver`: (Optional) The storage driver to use for the storage volume. Default
|
||||
value is dependent on the operating system.
|
||||
- Amazon Linux 2 is `overlay2`.
|
||||
- Centos is `overlay2`.
|
||||
- Oracle Linux is `overlay2`.
|
||||
- RedHat is `overlay2`.
|
||||
- SLES is `btrfs`.
|
||||
- Ubuntu is `overlay2`.
|
||||
- `storage_fstype`: (Optional) File system to use for storage volume. Default value is dependent on the operating system.
|
||||
- Amazon Linux 2 is `xfs`.
|
||||
- Centos is `xfs`.
|
||||
- Oracle Linux is `xfs`.
|
||||
- RedHat is `xfs`.
|
||||
- SLES is `btrfs`.
|
||||
- Ubuntu is `ext4`.
|
||||
- `storage_volume`: (Optional) Docker storage volume path for `/var/lib/docker` Default value is provider dependent.
|
||||
- AWS
|
||||
- non-NVME is `/dev/xvdb`.
|
||||
- NVME disks are one of `/dev/nvme[0-26]n1`.
|
||||
- Azure is `/dev/disk/azure/scsi1/lun0`.
|
||||
- `daemon`: (Optional) Provides docker daemon options. Defaults to "".
|
||||
- `ca`: (dev) Defaults to "".
|
||||
- `key`: (dev) Defaults to "".
|
||||
- `enable_remote_tcp`: (dev) Enables direct access to docker engine. Defaults to `false`.
|
||||
|
||||
*dev indicates that the functionality is only for development and testing.
|
||||
|
||||
#### kubernetes
|
||||
Enables provider-specific options for Kubernetes support.
|
||||
|
||||
##### AWS Kubernetes options
|
||||
|
||||
- `cloud_provider`: (Optional)Enable cloud provider support for Kubernetes. Defaults to `false`.
|
||||
- `ebs_persistent_volumes`: (Optional) Enable persistent volume support with EBS volumes. Defaults to `false`.
|
||||
- `efs_persistent_volumes`: (Optional) Enable persistent volume support with EFS. Defaults to `false`.
|
||||
- `load_balancer`: (Optional) Enable Kubernetes pods to instantiate a load-balancer. Defaults to `false`.
|
||||
- `nfs_storage`: (Optional) Install additional packages on node for NFS support. Defaults to `false`.
|
||||
- `lifecycle`: (Optional) Defaults to `owned`.
|
||||
|
||||
#### registry
|
||||
Customizes the registry from which the installation should pull images. By default, Docker Hub and credentials to access Docker Hub are used.
|
||||
|
||||
```yaml
|
||||
cluster:
|
||||
registry:
|
||||
password: ${base64decode("TVJYeTNDQWpTSk5HTW1ZRzJQcE1kM0tVRlQ=")}
|
||||
url: https://index.docker.io/v1/
|
||||
username: user
|
||||
```
|
||||
|
||||
The following optional elements can be specified:
|
||||
- `username`: The username for logging in to the registry on each node. Default value is the current docker user.
|
||||
- `url`: The registry to use for pulling Docker images. Defaults to "https://index.docker.io/v1/".
|
||||
- `password`: The password for logging in to the registry on each node. Default value is the current docker user's password base64 encoded and wrapped in a call to base64decode.
|
||||
|
||||
#### ucp
|
||||
|
||||
- `version`: Specifies the version of UCP to install. Defaults to `docker/ucp:3.1.6`.
|
||||
- `username`: Specifies the username of the first user to create in UCP. Defaults to `admin`.
|
||||
- `password`: Specifies the password of the first user to create in UCP. Defaults to `dockerdocker`.
|
||||
- `ca`: Specifies a path to a root CA public certificate.
|
||||
- `key`: Specifies a path to a TLS private key.
|
||||
- `cert`: Specifies a path to a public key certificate.
|
||||
- `install_options`: Lists additional [UCP install options](https://docs.docker.com/reference/ucp/3.1/cli/install/)
|
||||
|
||||
##### Additional UCP configuration options:
|
||||
Docker Cluster also accepts all UCP configuration options and creates the initial UCP config on
|
||||
installation. The following list provides supported options:
|
||||
- `anonymize_tracking`: Anonymizes analytic data. Specify 'true' to hide the license ID. Defaults to 'false'.
|
||||
- `audit_level`: Specifies the audit logging level. Leave empty for disabling audit logs (default).
|
||||
Other valid values are 'metadata' and 'request'.
|
||||
- `auto_refresh`: Specify 'true' to enable attempted automatic license renewal when the license
|
||||
nears expiration. If disabled, you must manually upload renewed license after expiration. Defaults to 'true'.
|
||||
- `azure_ip_count`: Sets the IP count for azure allocator to allocate IPs per Azure virtual machine.
|
||||
- `backend`: Specifie the name of the authorization backend to use, either 'managed' or 'ldap'. Defaults to 'managed'.
|
||||
- `calico_mtu`: Specifies the MTU (maximum transmission unit) size for the Calico plugin. Defaults to '1480'.
|
||||
- `cloud_provider`: Specifies the cloud provider for the kubernetes cluster.
|
||||
- `cluster_label`: Specifies a label to be included with analytics/.
|
||||
- `cni_installer_url`: Specifies the URL of a Kubernetes YAML file to be used for installing a CNI plugin.
|
||||
Only applies during initial installation. If empty, the default CNI plugin is used.
|
||||
- `controller_port`: Configures the port that the 'ucp-controller' listens to. Defaults to '443'.
|
||||
- `custom_header_name`: Specifies the name of the custom header with 'name' = '*X-Custom-Header-Name*'.
|
||||
- `custom_header_value`: Specifies the value of the custom header with 'value' = '*Custom Header Value*'.
|
||||
- `default_new_user_role`: Specifies the role that new users get for their private resource sets.
|
||||
Values are 'admin', 'viewonly', 'scheduler', 'restrictedcontrol', or 'fullcontrol'. Defaults to 'restrictedcontrol'.
|
||||
- `default_node_orchestrator`: Specifies the type of orchestrator to use for new nodes that are
|
||||
joined to the cluster. Can be 'swarm' or 'kubernetes'. Defaults to 'swarm'.
|
||||
- `disable_tracking`: Specify 'true' to disable analytics of API call information. Defaults to 'false'.
|
||||
- `disable_usageinfo`: Specify 'true' to disable analytics of usage information. Defaults to 'false'.
|
||||
- `dns`: Specifies a CSV list of IP addresses to add as nameservers.
|
||||
- `dns_opt`: Specifies a CSV list of options used by DNS resolvers.
|
||||
- `dns_search`: Specifies a CSV list of domain names to search when a bare unqualified hostname is
|
||||
used inside of a container.
|
||||
- `enable_admin_ucp_scheduling`: Specify 'true' to allow admins to schedule on containers on manager nodes.
|
||||
Defaults to 'false'.
|
||||
- `external_service_lb`: Specifies an optional external load balancer for default links to services with
|
||||
exposed ports in the web interface.
|
||||
- `host_address`: Specifies the address for connecting to the DTR instance tied to this UCP cluster.
|
||||
- `log_host`: Specifies a remote syslog server to send UCP controller logs to. If omitted, controller
|
||||
logs are sent through the default docker daemon logging driver from the 'ucp-controller' container.
|
||||
- `idpMetadataURL`: Specifies the Identity Provider Metadata URL.
|
||||
- `image_repository`: Specifies the repository to use for UCP images.
|
||||
- `install_args`: Specifies additional arguments to pass to the UCP installer.
|
||||
- `ipip_mtu`: Specifies the IPIP MTU size for the calico IPIP tunnel interface.
|
||||
- `kube_apiserver_port`: Configures the port to which the Kubernetes API server listens.
|
||||
- `kv_snapshot_count`: Sets the key-value store snapshot count setting. Defaults to '20000'.
|
||||
- `kv_timeout`: Sets the key-value store timeout setting, in milliseconds. Defaults to '5000'.
|
||||
- `lifetime_minutes`: Specifies the initial session lifetime, in minutes. Defaults to `4320`, which is 72 hours.
|
||||
- `local_volume_collection_mapping`: Stores data about collections for volumes in UCP's local KV store
|
||||
instead of on the volume labels. This is used for enforcing access control on volumes.
|
||||
- `log_level`: Specifies the logging level for UCP components. Values are syslog priority
|
||||
levels (https://linux.die.net/man/5/syslog.conf): 'debug', 'info', 'notice', 'warning', 'err', 'crit', 'alert',
|
||||
and 'emerg'.
|
||||
- `managedPasswordDisabled`: Indicates if managed password is disabled. Defaults to false.
|
||||
- `managedPasswordFallbackUser`: The fallback user when the managed password authentication is disabled. Defaults to "".
|
||||
- `manager_kube_reserved_resources`: Specifies reserve resources for Docker UCP and Kubernetes components
|
||||
that are running on manager nodes.
|
||||
- `metrics_disk_usage_interval`: Specifies the interval for how frequently storage metrics are gathered.
|
||||
This operation can impact performance when large volumes are present.
|
||||
- `metrics_retention_time`: Adjusts the metrics retention time.
|
||||
- `metrics_scrape_interval`: Specifies the interval for how frequently managers gather metrics from nodes in the cluster.
|
||||
- `nodeport_range`: Specifies the port range that for Kubernetes services of type NodePort can be exposed in.
|
||||
Defaults to '32768-35535'.
|
||||
- `per_user_limit`: Specifies the maximum number of sessions that a user can have active simultaneously. If
|
||||
the creation of a new session would put a user over this limit, the least recently used session is deleted.
|
||||
A value of zero disables limiting the number of sessions that users can have. Defaults to `5`.
|
||||
- `pod_cidr`: Specifies the subnet pool from which the IP for the Pod should be allocated from the CNI ipam plugin.
|
||||
- `profiling_enabled`: Specify 'true' to enable specialized debugging endpoints for profiling UCP performance.
|
||||
Defaults to 'false'.
|
||||
- `log_protocol`: Specifies the protocol to use for remote logging. Values are 'tcp' and 'udp'. Defaults to 'tcp'.
|
||||
- `renewal_threshold_minutes`: Specifies the length of time, in minutes, before the expiration of a
|
||||
session. When used, a session is extended by the current configured lifetime from that point in time. A zero value disables session extension. Defaults to `1440`, which is 24 hours.
|
||||
- `require_content_trust`: Specify 'true' to require images be signed by content trust. Defaults to 'false'.
|
||||
- `require_signature_from`: Specifies a csv list of users or teams required to sign images.
|
||||
- `rethinkdb_cache_size`: Sets the size of the cache used by UCP's RethinkDB servers. TDefaults to 1GB,
|
||||
but leaving this field empty or specifying `auto` instructs RethinkDB to determine a cache size automatically.
|
||||
- `rootCerts`: Defaults to empty.
|
||||
- `samlEnabled`: Indicates if saml is used.
|
||||
- `samlLoginText`: Specifies the customized SAML login button text.
|
||||
- `service_id`: Specifies the DTR instance's OpenID Connect Client ID, as registered with the Docker
|
||||
authentication provider.
|
||||
- `spHost`: Specifies the Service Provider Host.
|
||||
- `storage_driver`: Specifies the UCP storage driver to install.
|
||||
- `support_dump_include_audit_logs`: When set to `true`, support dumps include audit logs in the logs
|
||||
of the 'ucp-controller' container of each manager node. Defaults to 'false'.
|
||||
- `swarm_port`: Configures the port that the 'ucp-swarm-manager' listens to. Defaults to '2376'.
|
||||
- `swarm_strategy`: Configures placement strategy for container scheduling.
|
||||
This doesn't affect swarm-mode services. Values are 'spread', 'binpack', and 'random'.
|
||||
- `tlsSkipVerify`: Specifies TLS Skip verify for IdP Metadata.
|
||||
- `unmanaged_cni`: Defaults to 'false'.
|
||||
- `worker_kube_reserved_resources`: Reserves resources for Docker UCP and Kubernetes components
|
||||
that are running on worker nodes.
|
||||
- `custom_kube_api_server_flags`: Specifies the configuration options for the Kubernetes API server. (dev)
|
||||
- `custom_kube_controller_manager_flags`: Specifies the configuration options for the Kubernetes controller manager. (dev)
|
||||
- `custom_kube_scheduler_flags`: Specifies the configuration options for the Kubernetes scheduler. (dev)
|
||||
- `custom_kubelet_flags`: Specifies the configuration options for Kubelets. (dev)
|
||||
|
||||
*dev indicates that the functionality is only for development and testing. Arbitrary Kubernetes configuration parameters are not tested and supported under the Docker Enterprise Software Support Agreement.
|
||||
|
||||
### provider
|
||||
Defines where the cluster's resources are provisioned, as well as provider-specific configuration such as tags.
|
||||
|
||||
```yaml
|
||||
provider:
|
||||
acme:
|
||||
email: ${email}
|
||||
server_url: https://acme-staging-v02.api.letsencrypt.org/directory
|
||||
aws:
|
||||
region: ${region}
|
||||
```
|
||||
|
||||
#### acme
|
||||
The Automated Certificate Management Environment (ACME) is an evolving standard for the automation of a domain-validated certificate authority. Docker Cluster uses the ACME provider to create SSL certificates that are signed by [Let's Encrypt](https://letsencrypt.org/).
|
||||
|
||||
The ACME provider Configuration for the ACME provider supports arguments that closely align with the [Terraform ACME provider](https://www.terraform.io/docs/providers/acme/index.html):
|
||||
|
||||
The following elements can be specified:
|
||||
- `email`: (Required) The email to associate the certificates with.
|
||||
- `server_url`: (Optional) The URL to the ACME endpoint's directory. Default is "https://acme-v02.api.letsencrypt.org/directory"
|
||||
|
||||
#### aws
|
||||
Configuration for the AWS provider supports arguments that closely align with the [Terraform AWS provider](https://www.terraform.io/docs/providers/aws/index.html).
|
||||
|
||||
```yaml
|
||||
aws:
|
||||
region: "us-east-1"
|
||||
tags:
|
||||
Owner: "Infra"
|
||||
Environment: "Test"
|
||||
```
|
||||
The following elements can be specified:
|
||||
- `region` - (Required) This is the AWS region. It can be sourced from the `AWS_DEFAULT_REGION` environment variables, or
|
||||
via a shared credentials file if `profile` is specified.
|
||||
- `tags` - (Optional) Additional name value pairs to assign to every resource (which
|
||||
supports tagging) in the cluster.
|
||||
- `access_key` - (Required) This is the AWS access key. It can be sourced from
|
||||
the `AWS_ACCESS_KEY_ID` environment variable, or via
|
||||
a shared credentials file if `profile` is specified.
|
||||
- `secret_key` - (Required) This is the AWS secret key. It can be sourced from
|
||||
the `AWS_SECRET_ACCESS_KEY` environment variable, or
|
||||
via a shared credentials file if `profile` is specified.
|
||||
- `profile` - (Optional) This is the AWS profile name as set in the shared credentials
|
||||
file.
|
||||
- `assume_role` - (Optional) An `assume_role` block (documented below). Only one
|
||||
`assume_role` block can be in the configuration.
|
||||
- `endpoints` - (Optional) Configuration block for customizing service endpoints. See the
|
||||
[Custom Service Endpoints Guide](/docs/providers/aws/guides/custom-service-endpoints.html)
|
||||
for more information about connecting to alternate AWS endpoints or AWS compatible solutions.
|
||||
- `shared_credentials_file` = (Optional) This is the path to the shared
|
||||
credentials file. If this is not set and a profile is specified,
|
||||
`~/.aws/credentials` is used.
|
||||
- `token` - (Optional) Session token for validating temporary credentials.
|
||||
Typically provided after successful identity federation or Multi-Factor
|
||||
Authentication (MFA) login. With MFA login, this is the session token
|
||||
provided afterwards, not the 6 digit MFA code used to get temporary
|
||||
credentials. It can also be sourced from the `AWS_SESSION_TOKEN`
|
||||
environment variable.
|
||||
- `max_retries` - (Optional) This is the maximum number of times an API
|
||||
call is retried, in the case where requests are being throttled or
|
||||
experiencing transient failures. The delay between the subsequent API
|
||||
calls increases exponentially.
|
||||
- `allowed_account_ids` - (Optional) List of allowed, white listed, AWS
|
||||
account IDs to prevent you from mistakenly using an incorrect one (and
|
||||
potentially end up destroying a live environment). Conflicts with
|
||||
`forbidden_account_ids`.
|
||||
- `forbidden_account_ids` - (Optional) List of forbidden, blacklisted,
|
||||
AWS account IDs to prevent you mistakenly using a wrong one (and
|
||||
potentially end up destroying a live environment). Conflicts with
|
||||
`allowed_account_ids`.
|
||||
- `insecure` - (Optional) Explicitly allows the provider to
|
||||
perform "insecure" SSL requests. If omitted, defaults to `false`.
|
||||
- `skip_credentials_validation` - (Optional) Skips the credentials
|
||||
validation via the STS API. Useful for AWS API implementations that do
|
||||
not have STS available or implemented.
|
||||
- `skip_get_ec2_platforms` - (Optional) Skips getting the supported EC2
|
||||
platforms. Used by users that don't have `ec2:DescribeAccountAttributes`
|
||||
permissions.
|
||||
- `skip_region_validation` - (Optional) Skips validation of provided region name.
|
||||
Useful for AWS-like implementations that use their own region names
|
||||
or to bypass the validation for regions that aren't publicly available yet.
|
||||
|
||||
### resource
|
||||
Resources to provision for a cluster. Resources are organized as shown in the following example:
|
||||
|
||||
```yaml
|
||||
resource:
|
||||
type:
|
||||
name:
|
||||
parameters
|
||||
```
|
||||
For a given `type`, there may be more one or more named resources to provision.
|
||||
|
||||
For a given `name`, a resource may have one or more parameters.
|
||||
|
||||
#### aws_instance
|
||||
|
||||
```yaml
|
||||
resource:
|
||||
aws_instance:
|
||||
workers:
|
||||
instance_type: t2.xlarge
|
||||
price: 0.25
|
||||
os: Ubuntu 16.04
|
||||
```
|
||||
- `quantity`: (Required) The number of instances to create.
|
||||
- `os`: An alias that is expanded by `docker cluster` to the AMI owner and AMI name to install.
|
||||
The following aliases are supported by `docker cluster`:
|
||||
- `CentOS 7`
|
||||
- `RHEL 7.1`
|
||||
- `RHEL 7.2`
|
||||
- `RHEL 7.3`
|
||||
- `RHEL 7.4`
|
||||
- `RHEL 7.5`
|
||||
- `RHEL 7.6`
|
||||
- `Oracle Linux 7.3`
|
||||
- `Oracle Linux 7.4`
|
||||
- `Oracle Linux 7.5`
|
||||
- `SLES 12.2`
|
||||
- `SLES 12.3`
|
||||
- `SLES 15`
|
||||
- `Ubuntu 14.04`
|
||||
- `Ubuntu 16.04`
|
||||
- `Ubuntu 18.04`
|
||||
- `Windows Server 2016`
|
||||
- `Windows Server 1709`
|
||||
- `Windows Server 1803`
|
||||
- `Windows Server 2019`
|
||||
> Note: Make sure the OS you select is [compatible](https://success.docker.com/article/compatibility-matrix)
|
||||
with the product you're installing. Docker Cluster validates the support during installation.
|
||||
- `instance_type`: Specifies the [AWS instance type](https://aws.amazon.com/ec2/instance-types/) to provision.
|
||||
- `key_name`: By default, Docker Cluster creates an [AWS EC2 Key Pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) and registers it with AWS for the cluster.
|
||||
To use an existing AWS EC2 Key Pair, set this value to the name of the AWS EC2 Key Pair.
|
||||
- `ssh_private_key`: By default, Docker Cluster creates an [AWS EC2 Key Pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) and registers it with AWS for the cluster. To use an existing AWS EC2 Key Pair, set this value to the path of the private SSH key.
|
||||
- `username`: Specifies the username for the node with Administrative privileges. By default, the `os` option
|
||||
sets this to the well-known username for the AMIs (which can change by distribution):
|
||||
- Amazon Linux 2 is `ec2-user`.
|
||||
- Centos is `centos`.
|
||||
- Oracle Linux is `ec2-user`.
|
||||
- RedHat is `ec2-user`.
|
||||
- SLES is `ec2-user`.
|
||||
- Ubuntu is `ubuntu`.
|
||||
- Windows is `Administrator`.
|
||||
- `password`: This value is only used by Windows nodes. By default, Windows nodes have a random password generated.
|
||||
- `ami`: Specifies a custom AMI, or one that's not currently available as an OS. Specify either the id or
|
||||
the owner/name to query for the latest.
|
||||
- `id`: Specifies the ID of the AMI. For example, `ami-0510c89f1a2691cf2`.
|
||||
- `owner`: Specifies the AWS account ID of the image owner. For example, `099720109477`.
|
||||
- `name`: Specifies the name of the AMI that was provided during image creation. For example, `ubuntu/images/hvm-ssd/ubuntu-xenial-16.04-amd64-server-*`.
|
||||
- `platform`: Specify `windows` for Windows instances.
|
||||
- `tags`: (Optional) Specifies additional name value pairs to assign to every instance.
|
||||
- `swarm_labels`: (Optional) Specifies additional key value pairs that represent swarm labels to apply to every node.
|
||||
|
||||
#### aws_spot_instance_request
|
||||
|
||||
Provisions a spot instance request in AWS to dramatically reduce the cost of instances. Spot instance
|
||||
availability is not guaranteed. Therefore, it is recommended to use `aws_spot_instance_request` for
|
||||
additional worker nodes and not for mission-critical nodes like managers and registry.
|
||||
|
||||
```yaml
|
||||
resource:
|
||||
aws_spot_instance_request:
|
||||
workers:
|
||||
instance_type: t2.xlarge
|
||||
price: 0.25
|
||||
os: Ubuntu 16.04
|
||||
quantity: 3
|
||||
```
|
||||
|
||||
Supports the same set of parameters as [aws_instance](index.md#aws_instance), with the addition of an optional price to limit the max bid for a spot instance.
|
||||
- `price`: (Optional) Specifies a maximum price to bid on the spot instance.
|
||||
|
||||
#### aws_lb
|
||||
Provisions an AWS Load Balancer.
|
||||
```yaml
|
||||
resource:
|
||||
aws_lb:
|
||||
ucp:
|
||||
domain: "example.com"
|
||||
instances:
|
||||
- managers
|
||||
ports:
|
||||
- 443:443
|
||||
- 6443:6443
|
||||
```
|
||||
The following options are supported:
|
||||
|
||||
- `instances`: (Required) Specifies a list of `aws_instance` and `aws_spot_instance_request` names to
|
||||
attach to the load balancer.
|
||||
- `ports`: (Required) Specifies a list of `listening port[/protocol]:target port[/protocol]` mappings
|
||||
to define how the load balancer should route traffic. By default, the protocol is `tcp`.
|
||||
- `domain`: Specifies the domain in which to create DNS records for this load balancer. The record is named the
|
||||
same as this resource, appended by the domain. For example, if the resource is `ucp` and the domain is `example.com`,
|
||||
the `A` record is `ucp.example.com`.
|
||||
- `internal`: (Optional) Defaults to `false`.
|
||||
- `type`: (Optional) Defaults to `network`.
|
||||
- `enable_cross_zone_load_balancing`: (Optional) Defaults to `false`.
|
||||
|
||||
#### aws_route53_zone
|
||||
Creates a subdomain in an AWS route53 zone. The following example creates a public zone for `testing.example.com`:
|
||||
|
||||
```yaml
|
||||
resource:
|
||||
aws_route53_zone:
|
||||
dns:
|
||||
domain: example.com
|
||||
subdomain: testing
|
||||
```
|
||||
The following elements are required:
|
||||
- `domain`: (Required) Specifies the name of the hosted zone.
|
||||
- `subdomain`: (Required) Specifies the subdomain to create in the `domain` hosted zone.
|
||||
|
||||
### variable
|
||||
Docker cluster supports basic parameterization. The variable section defines a make of keys and values. A key can have a sub-key named `type`, which changes the behavior of the variable.
|
||||
|
||||
```yaml
|
||||
variable:
|
||||
region: "us-east-1"
|
||||
password:
|
||||
type: prompt
|
||||
```
|
||||
|
||||
Variables are referenced in the cluster definition as `${variable_name}`. For example, `${region}` is substituted as `us-east-2` through the cluster definition.
|
||||
|
||||
The type defines how the variable behaves. This is currently limited in scope to:
|
||||
- `prompt`: Requests the value from the user and does not echo characters as the value is entered.
|
||||
|
|
@ -19,30 +19,34 @@ Using Docker Cluster is a three-step process:
|
|||
|
||||
A `cluster.yml` file resembles the following example:
|
||||
|
||||
variable:
|
||||
region: us-east-2
|
||||
ucp_password:
|
||||
type: prompt
|
||||
{% raw %}
|
||||
```yaml
|
||||
variable:
|
||||
region: us-east-2
|
||||
ucp_password:
|
||||
type: prompt
|
||||
|
||||
provider:
|
||||
aws:
|
||||
region: ${region}
|
||||
provider:
|
||||
aws:
|
||||
region: ${region}
|
||||
|
||||
cluster:
|
||||
engine:
|
||||
version: "ee-stable-18.09.5"
|
||||
ucp:
|
||||
version: "docker/ucp:3.1.6"
|
||||
username: "admin"
|
||||
password: ${ucp_password}
|
||||
cluster:
|
||||
engine:
|
||||
version: "ee-stable-18.09.5"
|
||||
ucp:
|
||||
version: "docker/ucp:3.1.6"
|
||||
username: "admin"
|
||||
password: ${ucp_password}
|
||||
|
||||
resource:
|
||||
aws_instance:
|
||||
managers:
|
||||
quantity: 1
|
||||
resource:
|
||||
aws_instance:
|
||||
managers:
|
||||
quantity: 1
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
For more information about Cluster files, refer to the
|
||||
[Cluster file reference](cluster-file/index.md).
|
||||
[Cluster file reference](cluster-file.md).
|
||||
|
||||
Docker Cluster has commands for managing the whole lifecycle of your cluster:
|
||||
|
||||
|
|
@ -52,9 +56,9 @@ Docker Cluster has commands for managing the whole lifecycle of your cluster:
|
|||
* View the status of clusters
|
||||
* Backup and Restore clusters
|
||||
|
||||
## Cluster documentation
|
||||
## Cluster reference pages
|
||||
|
||||
- [Get started with Docker Cluster on AWS](aws.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Cluster file reference](./cluster-file/index.md)
|
||||
- [Command line reference](/engine/reference/commandline/cluster/)
|
||||
- [Cluster file reference](./cluster-file.md)
|
||||
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
description: Back up a running cluster
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: docker cluster backup
|
||||
notoc: true
|
||||
---
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker cluster backup [OPTIONS] cluster
|
||||
```
|
||||
|
||||
Use the following options as needed to back up a running cluster:
|
||||
|
||||
- `--dry-run`: Skips resource provisioning.
|
||||
- `--file string`: Specifies a cluster backup filename. Defaults to `backup.tar.gz`.
|
||||
- `--log-level string`: Specifies the logging level. Valid values include: `trace`,`debug`,`info`,`warn`,`error`, and `fatal`.
|
||||
Defaults to `warn`.
|
||||
- `--passphrase string`: Specifies a cluster backup passphrase.
|
||||
|
||||
The backup command performs a full Docker Cluster backup following the steps found in [Backup and Restore Best Practices](https://success.docker.com/article/backup-restore-best-practices).
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
description: Cluster CLI reference
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: Cluster command-line reference
|
||||
notoc: true
|
||||
---
|
||||
|
||||
The following pages describe the usage information for the [docker cluster](overview) subcommands. You can also view this information by running `docker cluster [subcommand] --help` from the command line.
|
||||
|
||||
* [docker cluster](overview)
|
||||
* [backup](backup)
|
||||
* [create](create)
|
||||
* [inspect](inspect)
|
||||
* [logs](logs)
|
||||
* [ls](ls)
|
||||
* [restore](restore)
|
||||
* [rm](rm)
|
||||
* [update](update)
|
||||
* [version](version)
|
||||
|
||||
## Where to go next
|
||||
|
||||
* [CLI environment variables](envvars)
|
||||
* [docker cluster command](overview)
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
description: Inspect clusters
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: docker cluster inspect
|
||||
notoc: true
|
||||
---
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker cluster inspect [OPTIONS] cluster
|
||||
```
|
||||
Use the following options as needed to display detailed information about a cluster:
|
||||
|
||||
- `-a, --all`: Displays complete information about the cluster.
|
||||
- `--dry-run`: Skips resource provisioning.
|
||||
- `--log-level string`: Specifies the logging level. Valid values include: `trace`,`debug`,`info`,`warn`,`error`, and `fatal`. Defaults to `warn`.
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
description: List all available clusters
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: docker cluster ls
|
||||
notoc: true
|
||||
---
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker cluster ls [OPTIONS]
|
||||
```
|
||||
Use the following options as needed to list all available clusters:
|
||||
|
||||
- `--dry-run`: Skips resource provisioning.
|
||||
- `--log-level string`: Specifies the logging level. Valid values include: `trace`,`debug`,`info`,`warn`,`error`, and `fatal`. Defaults to `warn`.
|
||||
- `-q`, `--quiet`: Displays only numeric IDs.
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
---
|
||||
description: Overview of docker cluster CLI
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: Overview of docker cluster CLI
|
||||
---
|
||||
|
||||
This page provides usage information for the `docker cluster` CLI plugin command options.
|
||||
|
||||
You can also view this information by running `docker cluster --help` from the
|
||||
command line.
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker cluster [Options] [Commands]
|
||||
```
|
||||
|
||||
Options:
|
||||
|
||||
- `--dry-run`: Skips resource provisioning.
|
||||
- `--log-level string`: Specifies the logging level. Valid values include: `trace`,`debug`,`info`,`warn`,`error`, and `fatal`. Defaults to `warn`.
|
||||
|
||||
Commands:
|
||||
|
||||
- `backup`: Backs up a running cluster.
|
||||
- `begin`: Creates an example cluster declaration.
|
||||
- `create`: Creates a new Docker cluster.
|
||||
- `inspect`: Provides detailed information about a cluster.
|
||||
- `logs`:TODO: Fetches cluster logs.
|
||||
- `ls`: Lists all available clusters.
|
||||
- `restore`: Restores a cluster from a backup.
|
||||
- `rm`: Removes a cluster.
|
||||
- `update`: Updates a running cluster's desired state.
|
||||
- `version`: Displays Version, Commit, and Build type.
|
||||
|
||||
Run 'docker cluster [Command] --help' for more information about a command.
|
||||
```
|
||||
|
||||
## Specify name and path of one or more cluster files
|
||||
|
||||
Use the `-f` flag to specify the location of a cluster configuration file.
|
||||
|
||||
## Set up environment variables
|
||||
|
||||
You can set [environment variables](envvars) for various
|
||||
`docker cluster` options, including the `-f` and `-p` flags.
|
||||
|
||||
## Where to go next
|
||||
|
||||
* [CLI environment variables](envvars)
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
description: Restore to a running cluster
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: docker cluster restore
|
||||
notoc: true
|
||||
---
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker cluster restore [OPTIONS] cluster
|
||||
```
|
||||
Use the following options as needed to restore a cluster from a backup:
|
||||
|
||||
- `--dry-run`: Skips resource provisioning.
|
||||
- `--file string`: Specifies a cluster backup filename. Defaults to `backup.tar.gz`.
|
||||
- `--log-level string`: Specifies the logging level. Valid values include:
|
||||
`trace`,`debug`,`info`,`warn`,`error`, and `fatal`. Defaults to `warn`.
|
||||
- `--passphrase string`: Specifies a cluster backup passphrase.
|
||||
|
||||
The restore command performs a full Docker Cluster restore following the steps found in [Backup and Restore Best Practices](https://success.docker.com/article/backup-restore-best-practices).
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
description: Remove a cluster
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: docker cluster rm
|
||||
notoc: true
|
||||
---
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker cluster rm [OPTIONS] cluster
|
||||
```
|
||||
Use the following options as needed when removing a cluster:
|
||||
|
||||
- `--dry-run`: Skips resource provisioning.
|
||||
- `-f`, `--force`: Forces removal of the cluster files.
|
||||
- `--log-level string`: Specifies the logging level. Valid values include: `trace`,`debug`,`info`,`warn`,`error`, and `fatal`. Defaults to `warn`.
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
description: Update a cluster
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: docker cluster update
|
||||
notoc: true
|
||||
---
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker cluster update [Options] cluster
|
||||
```
|
||||
Use the following options as needed to update a running cluster's desired state:
|
||||
|
||||
Options:
|
||||
|
||||
- `--dry-run`: Skips resource provisioning.
|
||||
- `-f`, `--file string`: Specfies cluster definition.
|
||||
- `--log-level string`: Specifies the logging level. Valid values include: `trace`,`debug`,`info`,`warn`,`error`, and `fatal`. Defaults to `warn`.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
description: Print Version
|
||||
keywords: documentation, docs, docker, cluster, infrastructure, automation
|
||||
title: docker cluster version
|
||||
notoc: true
|
||||
---
|
||||
|
||||
## Usage
|
||||
```
|
||||
docker cluster version
|
||||
```
|
||||
Use the following options as needed for printing Version, Commit, and Build type:
|
||||
|
||||
- `--dry-run`: Skips resource provisioning.
|
||||
- `--log-level string`: Specifies the logging level. Valid values include: `trace`,`debug`,`info`,`warn`,`error`, and `fatal`. Defaults to `warn`.
|
||||
|
|
@ -20,7 +20,7 @@ keywords: engine enterprise, ucp, dtr, desktop enterprise, whats new, release no
|
|||
| [Docker App (Experimental)](/app/working-with-app/) |CLI | 0.8.0 |
|
||||
| [Docker Assemble (Experimental)](/assemble/install/) | CLI | 0.36.0 |
|
||||
| [Docker Buildx (Experimental)](/buildx/working-with-buildx/)| CLI | 0.2.2 |
|
||||
| [Docker Cluster](/cluster/overview/) | CLI | 1.0.0 |
|
||||
| [Docker Cluster](/cluster/) | CLI | 1.0.0 |
|
||||
| [Docker Template CLI (Experimental)](/app-template/working-with-template/) | CLI | 0.1.4 |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster
|
||||
title: docker cluster
|
||||
redirect_from: /cluster/reference/
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster_backup
|
||||
title: docker cluster backup
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster_create
|
||||
title: docker cluster create
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster_inspect
|
||||
title: docker cluster inspect
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster_ls
|
||||
title: docker cluster ls
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster_restore
|
||||
title: docker cluster restore
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster_rm
|
||||
title: docker cluster rm
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster_update
|
||||
title: docker cluster update
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: cluster
|
||||
datafile: docker_cluster_version
|
||||
title: docker cluster version
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
||||
Loading…
Reference in New Issue