mirror of https://github.com/docker/docs.git
Move cluster reference docs, and generate from YAML
Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn
parent
9199a58f5d
commit
0266be38d7
|
|
@ -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 *
|
||||
|
|
@ -1293,20 +1314,10 @@ manuals:
|
|||
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)
|
||||
- [Explore the full list of Cluster commands](/engine/reference/commandline/cluster/)
|
||||
- [Cluster configuration file reference](./cluster-file/index.md)
|
||||
|
|
|
|||
|
|
@ -52,9 +52,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)
|
||||
- [Command line reference](/engine/reference/commandline/cluster/)
|
||||
- [Cluster file reference](./cluster-file/index.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`.
|
||||
|
|
@ -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