From 0266be38d7123d3bf6c9bd1b009d87d720bd6fbd Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Thu, 6 Jun 2019 21:59:42 +0200 Subject: [PATCH] Move cluster reference docs, and generate from YAML Signed-off-by: Sebastiaan van Stijn Signed-off-by: Sebastiaan van Stijn --- _data/cluster/docker_cluster.yaml | 49 +++++++++++ _data/cluster/docker_cluster_backup.yaml | 60 ++++++++++++++ _data/cluster/docker_cluster_create.yaml | 81 +++++++++++++++++++ _data/cluster/docker_cluster_inspect.yaml | 43 ++++++++++ _data/cluster/docker_cluster_ls.yaml | 43 ++++++++++ _data/cluster/docker_cluster_restore.yaml | 60 ++++++++++++++ _data/cluster/docker_cluster_rm.yaml | 53 ++++++++++++ _data/cluster/docker_cluster_update.yaml | 52 ++++++++++++ _data/cluster/docker_cluster_version.yaml | 42 ++++++++++ _data/toc.yaml | 35 +++++--- cluster/aws.md | 2 +- cluster/overview.md | 4 +- cluster/reference/backup.md | 21 ----- cluster/reference/index.md | 24 ------ cluster/reference/inspect.md | 16 ---- cluster/reference/ls.md | 16 ---- cluster/reference/overview.md | 49 ----------- cluster/reference/restore.md | 20 ----- cluster/reference/rm.md | 16 ---- cluster/reference/update.md | 18 ----- cluster/reference/version.md | 15 ---- engine/reference/commandline/cluster.md | 14 ++++ .../reference/commandline/cluster_backup.md | 13 +++ .../reference/commandline/cluster_create.md | 13 +++ .../reference/commandline/cluster_inspect.md | 13 +++ engine/reference/commandline/cluster_ls.md | 13 +++ .../reference/commandline/cluster_restore.md | 13 +++ engine/reference/commandline/cluster_rm.md | 13 +++ .../reference/commandline/cluster_update.md | 13 +++ .../reference/commandline/cluster_version.md | 13 +++ 30 files changed, 627 insertions(+), 210 deletions(-) create mode 100644 _data/cluster/docker_cluster.yaml create mode 100644 _data/cluster/docker_cluster_backup.yaml create mode 100644 _data/cluster/docker_cluster_create.yaml create mode 100644 _data/cluster/docker_cluster_inspect.yaml create mode 100644 _data/cluster/docker_cluster_ls.yaml create mode 100644 _data/cluster/docker_cluster_restore.yaml create mode 100644 _data/cluster/docker_cluster_rm.yaml create mode 100644 _data/cluster/docker_cluster_update.yaml create mode 100644 _data/cluster/docker_cluster_version.yaml delete mode 100644 cluster/reference/backup.md delete mode 100644 cluster/reference/index.md delete mode 100644 cluster/reference/inspect.md delete mode 100644 cluster/reference/ls.md delete mode 100644 cluster/reference/overview.md delete mode 100644 cluster/reference/restore.md delete mode 100644 cluster/reference/rm.md delete mode 100644 cluster/reference/update.md delete mode 100644 cluster/reference/version.md create mode 100644 engine/reference/commandline/cluster.md create mode 100644 engine/reference/commandline/cluster_backup.md create mode 100644 engine/reference/commandline/cluster_create.md create mode 100644 engine/reference/commandline/cluster_inspect.md create mode 100644 engine/reference/commandline/cluster_ls.md create mode 100644 engine/reference/commandline/cluster_restore.md create mode 100644 engine/reference/commandline/cluster_rm.md create mode 100644 engine/reference/commandline/cluster_update.md create mode 100644 engine/reference/commandline/cluster_version.md diff --git a/_data/cluster/docker_cluster.yaml b/_data/cluster/docker_cluster.yaml new file mode 100644 index 0000000000..6f28780aa0 --- /dev/null +++ b/_data/cluster/docker_cluster.yaml @@ -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 + diff --git a/_data/cluster/docker_cluster_backup.yaml b/_data/cluster/docker_cluster_backup.yaml new file mode 100644 index 0000000000..b7f6c5502d --- /dev/null +++ b/_data/cluster/docker_cluster_backup.yaml @@ -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 + diff --git a/_data/cluster/docker_cluster_create.yaml b/_data/cluster/docker_cluster_create.yaml new file mode 100644 index 0000000000..f6de1d9d73 --- /dev/null +++ b/_data/cluster/docker_cluster_create.yaml @@ -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 + diff --git a/_data/cluster/docker_cluster_inspect.yaml b/_data/cluster/docker_cluster_inspect.yaml new file mode 100644 index 0000000000..a0aa2f3bcf --- /dev/null +++ b/_data/cluster/docker_cluster_inspect.yaml @@ -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 + diff --git a/_data/cluster/docker_cluster_ls.yaml b/_data/cluster/docker_cluster_ls.yaml new file mode 100644 index 0000000000..7f542825c4 --- /dev/null +++ b/_data/cluster/docker_cluster_ls.yaml @@ -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 + diff --git a/_data/cluster/docker_cluster_restore.yaml b/_data/cluster/docker_cluster_restore.yaml new file mode 100644 index 0000000000..5f54e07ae3 --- /dev/null +++ b/_data/cluster/docker_cluster_restore.yaml @@ -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 + diff --git a/_data/cluster/docker_cluster_rm.yaml b/_data/cluster/docker_cluster_rm.yaml new file mode 100644 index 0000000000..1ff30f38e9 --- /dev/null +++ b/_data/cluster/docker_cluster_rm.yaml @@ -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 + diff --git a/_data/cluster/docker_cluster_update.yaml b/_data/cluster/docker_cluster_update.yaml new file mode 100644 index 0000000000..90e59fd516 --- /dev/null +++ b/_data/cluster/docker_cluster_update.yaml @@ -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 + diff --git a/_data/cluster/docker_cluster_version.yaml b/_data/cluster/docker_cluster_version.yaml new file mode 100644 index 0000000000..facf61c08b --- /dev/null +++ b/_data/cluster/docker_cluster_version.yaml @@ -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 + diff --git a/_data/toc.yaml b/_data/toc.yaml index d4e9851492..6a9b5d8e35 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -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/ diff --git a/cluster/aws.md b/cluster/aws.md index 2a3a6ab87f..856f3915a6 100644 --- a/cluster/aws.md +++ b/cluster/aws.md @@ -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) diff --git a/cluster/overview.md b/cluster/overview.md index 0bed1a6932..e367a23ee7 100644 --- a/cluster/overview.md +++ b/cluster/overview.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) diff --git a/cluster/reference/backup.md b/cluster/reference/backup.md deleted file mode 100644 index cd4539d8da..0000000000 --- a/cluster/reference/backup.md +++ /dev/null @@ -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). diff --git a/cluster/reference/index.md b/cluster/reference/index.md deleted file mode 100644 index 040812961c..0000000000 --- a/cluster/reference/index.md +++ /dev/null @@ -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) diff --git a/cluster/reference/inspect.md b/cluster/reference/inspect.md deleted file mode 100644 index ba0149687e..0000000000 --- a/cluster/reference/inspect.md +++ /dev/null @@ -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`. diff --git a/cluster/reference/ls.md b/cluster/reference/ls.md deleted file mode 100644 index 093944e88f..0000000000 --- a/cluster/reference/ls.md +++ /dev/null @@ -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. diff --git a/cluster/reference/overview.md b/cluster/reference/overview.md deleted file mode 100644 index fb3d2ccaf9..0000000000 --- a/cluster/reference/overview.md +++ /dev/null @@ -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) diff --git a/cluster/reference/restore.md b/cluster/reference/restore.md deleted file mode 100644 index e47f70bf51..0000000000 --- a/cluster/reference/restore.md +++ /dev/null @@ -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). diff --git a/cluster/reference/rm.md b/cluster/reference/rm.md deleted file mode 100644 index ad95c788af..0000000000 --- a/cluster/reference/rm.md +++ /dev/null @@ -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`. diff --git a/cluster/reference/update.md b/cluster/reference/update.md deleted file mode 100644 index de694b813f..0000000000 --- a/cluster/reference/update.md +++ /dev/null @@ -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`. diff --git a/cluster/reference/version.md b/cluster/reference/version.md deleted file mode 100644 index 70c3588956..0000000000 --- a/cluster/reference/version.md +++ /dev/null @@ -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`. diff --git a/engine/reference/commandline/cluster.md b/engine/reference/commandline/cluster.md new file mode 100644 index 0000000000..17606a1ccb --- /dev/null +++ b/engine/reference/commandline/cluster.md @@ -0,0 +1,14 @@ +--- +datafolder: cluster +datafile: docker_cluster +title: docker cluster +redirect_from: /cluster/reference/ +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/cluster_backup.md b/engine/reference/commandline/cluster_backup.md new file mode 100644 index 0000000000..8aaeac77dc --- /dev/null +++ b/engine/reference/commandline/cluster_backup.md @@ -0,0 +1,13 @@ +--- +datafolder: cluster +datafile: docker_cluster_backup +title: docker cluster backup +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/cluster_create.md b/engine/reference/commandline/cluster_create.md new file mode 100644 index 0000000000..d037d92893 --- /dev/null +++ b/engine/reference/commandline/cluster_create.md @@ -0,0 +1,13 @@ +--- +datafolder: cluster +datafile: docker_cluster_create +title: docker cluster create +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/cluster_inspect.md b/engine/reference/commandline/cluster_inspect.md new file mode 100644 index 0000000000..c9beb76b5a --- /dev/null +++ b/engine/reference/commandline/cluster_inspect.md @@ -0,0 +1,13 @@ +--- +datafolder: cluster +datafile: docker_cluster_inspect +title: docker cluster inspect +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/cluster_ls.md b/engine/reference/commandline/cluster_ls.md new file mode 100644 index 0000000000..e2ae6d5a93 --- /dev/null +++ b/engine/reference/commandline/cluster_ls.md @@ -0,0 +1,13 @@ +--- +datafolder: cluster +datafile: docker_cluster_ls +title: docker cluster ls +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/cluster_restore.md b/engine/reference/commandline/cluster_restore.md new file mode 100644 index 0000000000..168dce11ac --- /dev/null +++ b/engine/reference/commandline/cluster_restore.md @@ -0,0 +1,13 @@ +--- +datafolder: cluster +datafile: docker_cluster_restore +title: docker cluster restore +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/cluster_rm.md b/engine/reference/commandline/cluster_rm.md new file mode 100644 index 0000000000..ea67e11e0e --- /dev/null +++ b/engine/reference/commandline/cluster_rm.md @@ -0,0 +1,13 @@ +--- +datafolder: cluster +datafile: docker_cluster_rm +title: docker cluster rm +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/cluster_update.md b/engine/reference/commandline/cluster_update.md new file mode 100644 index 0000000000..a2d0a34782 --- /dev/null +++ b/engine/reference/commandline/cluster_update.md @@ -0,0 +1,13 @@ +--- +datafolder: cluster +datafile: docker_cluster_update +title: docker cluster update +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/cluster_version.md b/engine/reference/commandline/cluster_version.md new file mode 100644 index 0000000000..c7ab98597d --- /dev/null +++ b/engine/reference/commandline/cluster_version.md @@ -0,0 +1,13 @@ +--- +datafolder: cluster +datafile: docker_cluster_version +title: docker cluster version +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %}