From 3ca13855ad89263bca5dfc9b5edfa47f71c6dee2 Mon Sep 17 00:00:00 2001 From: Joao Fernandes Date: Wed, 22 Nov 2017 15:56:23 -0800 Subject: [PATCH] Update DTR cli reference (#5379) --- datacenter/dtr/2.4/reference/cli/backup.md | 2 -- datacenter/dtr/2.4/reference/cli/destroy.md | 2 -- datacenter/dtr/2.4/reference/cli/install.md | 5 +---- datacenter/dtr/2.4/reference/cli/join.md | 2 -- datacenter/dtr/2.4/reference/cli/reconfigure.md | 3 --- datacenter/dtr/2.4/reference/cli/remove.md | 2 -- datacenter/dtr/2.4/reference/cli/restore.md | 3 --- datacenter/dtr/2.4/reference/cli/upgrade.md | 2 -- 8 files changed, 1 insertion(+), 20 deletions(-) diff --git a/datacenter/dtr/2.4/reference/cli/backup.md b/datacenter/dtr/2.4/reference/cli/backup.md index a2f4f3854e..bee8b2615a 100644 --- a/datacenter/dtr/2.4/reference/cli/backup.md +++ b/datacenter/dtr/2.4/reference/cli/backup.md @@ -40,8 +40,6 @@ Note: | Option | Environment Variable | Description | |:------------------------------|:--------------------------|:-------------------------------------------------------------------------------------| | `--debug` | $DEBUG | Enable debug mode for additional logs. | -| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. | -| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. | | `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. | | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. | | `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https:///ca, and use --ucp-ca "$(cat ca.pem)". | diff --git a/datacenter/dtr/2.4/reference/cli/destroy.md b/datacenter/dtr/2.4/reference/cli/destroy.md index 3a4dd8d498..b24252fb94 100644 --- a/datacenter/dtr/2.4/reference/cli/destroy.md +++ b/datacenter/dtr/2.4/reference/cli/destroy.md @@ -35,6 +35,4 @@ Use the 'remove' command to gracefully scale down your DTR cluster. | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. | | `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. | | `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https:///ca, and use --ucp-ca "$(cat ca.pem)". | -| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. | -| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. | diff --git a/datacenter/dtr/2.4/reference/cli/install.md b/datacenter/dtr/2.4/reference/cli/install.md index 9e814ff86f..78ebf9b66c 100644 --- a/datacenter/dtr/2.4/reference/cli/install.md +++ b/datacenter/dtr/2.4/reference/cli/install.md @@ -24,7 +24,7 @@ command. Example usage: -$ docker run -it --rm dtr-internal.caas.docker.io/caas/dtr:2.4.0-tp5-008777_g5f14189-dirty install \ +$ docker run -it --rm docker/dtr:2.4.1 install \ --ucp-node \ --ucp-insecure-tls @@ -41,9 +41,6 @@ Note: Use --ucp-ca "$(cat ca.pem)" instead of --ucp-insecure-tls for a productio | `--dtr-key` | $DTR_KEY | Use a PEM-encoded TLS private key for DTR.By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS private key with --dtr-key "$(cat ca.pem)". | | `--dtr-storage-volume` | $DTR_STORAGE_VOLUME | Customize the volume to store Docker images.By default DTR creates a volume to store the Docker images in the local filesystem of the node where DTR is running, without high-availability. Use this flag to specify a full path or volume name for DTR to store images. For high-availability, make sure all DTR replicas can read and write data on this volume. If you're using NFS, use --nfs-storage-url instead. | | `--enable-pprof` | $DTR_PPROF | Enables pprof profiling of the server.Once DTR is deployed with this flag, you can access the pprof endpoint for the api server at /debug/pprof, and the registry endpoint at /registry_debug_pprof/debug/pprof. | -| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. | -| `--enzi-host` | $ENZI_HOST | The Enzi host. Format host[:port]. | -| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. | | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. | | `--http-proxy` | $DTR_HTTP_PROXY | The HTTP proxy used for outgoing requests. | | `--https-proxy` | $DTR_HTTPS_PROXY | The HTTPS proxy used for outgoing requests. | diff --git a/datacenter/dtr/2.4/reference/cli/join.md b/datacenter/dtr/2.4/reference/cli/join.md index f2da841470..4e8123e4c7 100644 --- a/datacenter/dtr/2.4/reference/cli/join.md +++ b/datacenter/dtr/2.4/reference/cli/join.md @@ -22,8 +22,6 @@ For setting DTR for high-availability, create 3, 5, or 7 replicas of DTR. | Option | Environment Variable | Description | |:------------------------------|:--------------------------|:-------------------------------------------------------------------------------------| | `--debug` | $DEBUG | Enable debug mode for additional logs. | -| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. | -| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. | | `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. | | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. | | `--replica-http-port` | $REPLICA_HTTP_PORT | The public HTTP port for the DTR replica. Default is 80.This allows you to customize the HTTP port where users can reach DTR. Once users access the HTTP port, they are redirected to use an HTTPS connection, using the port specified with --replica-https-port. This port can also be used for unencrypted health checks. | diff --git a/datacenter/dtr/2.4/reference/cli/reconfigure.md b/datacenter/dtr/2.4/reference/cli/reconfigure.md index 4b499acad3..a836829c9f 100644 --- a/datacenter/dtr/2.4/reference/cli/reconfigure.md +++ b/datacenter/dtr/2.4/reference/cli/reconfigure.md @@ -33,9 +33,6 @@ time, configure your DTR for high-availability. | `--dtr-key` | $DTR_KEY | Use a PEM-encoded TLS private key for DTR.By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS private key with --dtr-key "$(cat ca.pem)". | | `--dtr-storage-volume` | $DTR_STORAGE_VOLUME | Customize the volume to store Docker images.By default DTR creates a volume to store the Docker images in the local filesystem of the node where DTR is running, without high-availability. Use this flag to specify a full path or volume name for DTR to store images. For high-availability, make sure all DTR replicas can read and write data on this volume. If you're using NFS, use --nfs-storage-url instead. | | `--enable-pprof` | $DTR_PPROF | Enables pprof profiling of the server.Once DTR is deployed with this flag, you can access the pprof endpoint for the api server at /debug/pprof, and the registry endpoint at /registry_debug_pprof/debug/pprof. | -| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. | -| `--enzi-host` | $ENZI_HOST | The Enzi host. Format host[:port]. | -| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. | | `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. | | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. | | `--http-proxy` | $DTR_HTTP_PROXY | The HTTP proxy used for outgoing requests. | diff --git a/datacenter/dtr/2.4/reference/cli/remove.md b/datacenter/dtr/2.4/reference/cli/remove.md index 7b8dc5a3f7..929d5df019 100644 --- a/datacenter/dtr/2.4/reference/cli/remove.md +++ b/datacenter/dtr/2.4/reference/cli/remove.md @@ -26,8 +26,6 @@ this operation. | Option | Environment Variable | Description | |:------------------------------|:--------------------------|:-------------------------------------------------------------------------------------| | `--debug` | $DEBUG | Enable debug mode for additional logs. | -| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. | -| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. | | `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. | | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. | | `--replica-id` | $DTR_REMOVE_REPLICA_ID | DEPRECATED Alias for --replica-ids. | diff --git a/datacenter/dtr/2.4/reference/cli/restore.md b/datacenter/dtr/2.4/reference/cli/restore.md index dbfaa1aa66..73a371f9f1 100644 --- a/datacenter/dtr/2.4/reference/cli/restore.md +++ b/datacenter/dtr/2.4/reference/cli/restore.md @@ -38,9 +38,6 @@ After restoring, you can add more DTR replicas by using the the 'join' command. | `--dtr-key` | $DTR_KEY | Use a PEM-encoded TLS private key for DTR.By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS private key with --dtr-key "$(cat ca.pem)". | | `--dtr-storage-volume` | $DTR_STORAGE_VOLUME | Customize the volume to store Docker images.By default DTR creates a volume to store the Docker images in the local filesystem of the node where DTR is running, without high-availability. Use this flag to specify a full path or volume name for DTR to store images. For high-availability, make sure all DTR replicas can read and write data on this volume. If you're using NFS, use --nfs-storage-url instead. | | `--enable-pprof` | $DTR_PPROF | Enables pprof profiling of the server.Once DTR is deployed with this flag, you can access the pprof endpoint for the api server at /debug/pprof, and the registry endpoint at /registry_debug_pprof/debug/pprof. | -| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. | -| `--enzi-host` | $ENZI_HOST | The Enzi host. Format host[:port]. | -| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. | | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. | | `--http-proxy` | $DTR_HTTP_PROXY | The HTTP proxy used for outgoing requests. | | `--https-proxy` | $DTR_HTTPS_PROXY | The HTTPS proxy used for outgoing requests. | diff --git a/datacenter/dtr/2.4/reference/cli/upgrade.md b/datacenter/dtr/2.4/reference/cli/upgrade.md index 6be1b22816..676a458511 100644 --- a/datacenter/dtr/2.4/reference/cli/upgrade.md +++ b/datacenter/dtr/2.4/reference/cli/upgrade.md @@ -24,8 +24,6 @@ This command upgrades DTR 2.3.x to the current version of this image. | Option | Environment Variable | Description | |:------------------------------|:--------------------------|:-------------------------------------------------------------------------------------| | `--debug` | $DEBUG | Enable debug mode for additional logs. | -| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. | -| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. | | `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. | | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. | | `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https:///ca, and use --ucp-ca "$(cat ca.pem)". |