diff --git a/_data/toc.yaml b/_data/toc.yaml index f326040fc7..9a70d5beb3 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1326,17 +1326,62 @@ reference: path: /compose/reference/overview/ nosync: true -- sectiontitle: Docker Enterprise Edition references +- sectiontitle: Docker Enterprise Edition section: - - title: Trusted Registry API - path: /datacenter/dtr/2.5/reference/api/ + - title: DTR 2.5 API + path: /reference/dtr/2.5/api/ + - sectiontitle: DTR 2.5 CLI + section: + - path: /reference/dtr/2.5/cli/ + title: Overview + - path: /reference/dtr/2.5/cli/backup/ + title: backup + - path: /reference/dtr/2.5/cli/destroy/ + title: destroy + title: images + - path: /reference/dtr/2.5/cli/install/ + title: install + - path: /reference/dtr/2.5/cli/join/ + title: join + - path: /reference/dtr/2.5/cli/reconfigure/ + title: reconfigure + - path: /reference/dtr/2.5/cli/remove/ + title: remove + - path: /reference/dtr/2.5/cli/restore/ + title: restore + - path: /reference/dtr/2.5/cli/upgrade/ + title: upgrade + - title: UCP 3.0 API + path: /datacenter/ucp/3.0/reference/api/ + - sectiontitle: UCP 3.0 CLI + section: + - path: /datacenter/ucp/3.0/reference/cli/ + title: docker/ucp overview + - path: /datacenter/ucp/3.0/reference/cli/backup/ + title: backup + - path: /datacenter/ucp/3.0/reference/cli/dump-certs/ + title: dump-certs + - path: /datacenter/ucp/3.0/reference/cli/example-config/ + title: example-config + - path: /datacenter/ucp/3.0/reference/cli/id/ + title: id + - path: /datacenter/ucp/3.0/reference/cli/images/ + title: images + - path: /datacenter/ucp/3.0/reference/cli/install/ + title: install + - path: /datacenter/ucp/3.0/reference/cli/restart/ + title: restart + - path: /datacenter/ucp/3.0/reference/cli/restore/ + title: restore + - path: /datacenter/ucp/3.0/reference/cli/stop/ + title: stop + - path: /datacenter/ucp/3.0/reference/cli/support/ + title: support + - path: /datacenter/ucp/3.0/reference/cli/uninstall-ucp/ + title: uninstall-ucp + - path: /datacenter/ucp/3.0/reference/cli/upgrade/ + title: upgrade - - title: Trusted Registry CLI - path: /datacenter/dtr/2.5/reference/cli/ - nosync: true - - title: Universal Control Plane CLI - path: /datacenter/ucp/3.0/reference/cli/ - nosync: true - sectiontitle: Application Programming Interfaces (APIs) section: @@ -1603,34 +1648,7 @@ manuals: title: Troubleshoot configurations - path: /datacenter/ucp/3.0/guides/admin/backups-and-disaster-recovery/ title: Backups and disaster recovery - - sectiontitle: CLI reference - section: - - path: /datacenter/ucp/3.0/reference/cli/ - title: docker/ucp overview - - path: /datacenter/ucp/3.0/reference/cli/backup/ - title: backup - - path: /datacenter/ucp/3.0/reference/cli/dump-certs/ - title: dump-certs - - path: /datacenter/ucp/3.0/reference/cli/example-config/ - title: example-config - - path: /datacenter/ucp/3.0/reference/cli/id/ - title: id - - path: /datacenter/ucp/3.0/reference/cli/images/ - title: images - - path: /datacenter/ucp/3.0/reference/cli/install/ - title: install - - path: /datacenter/ucp/3.0/reference/cli/restart/ - title: restart - - path: /datacenter/ucp/3.0/reference/cli/restore/ - title: restore - - path: /datacenter/ucp/3.0/reference/cli/stop/ - title: stop - - path: /datacenter/ucp/3.0/reference/cli/support/ - title: support - - path: /datacenter/ucp/3.0/reference/cli/uninstall-ucp/ - title: uninstall-ucp - - path: /datacenter/ucp/3.0/reference/cli/upgrade/ - title: upgrade + - sectiontitle: Authorize role-based access section: - path: /datacenter/ucp/3.0/guides/authorization/ @@ -1747,8 +1765,6 @@ manuals: path: /datacenter/ucp/3.0/guides/interlock/ops/ - title: Tuning path: /datacenter/ucp/3.0/guides/interlock/ops/tuning/ - - path: /datacenter/ucp/3.0/reference/api/ - title: API reference - path: /datacenter/ucp/3.0/guides/release-notes/ title: Release notes - path: /datacenter/ucp/3.0/guides/get-support/ @@ -2361,27 +2377,6 @@ manuals: title: Troubleshoot batch jobs - path: /datacenter/dtr/2.5/guides/admin/backups-and-disaster-recovery/ title: Backups and disaster recovery - - sectiontitle: CLI reference - section: - - path: /datacenter/dtr/2.5/reference/cli/ - title: Overview - - path: /datacenter/dtr/2.5/reference/cli/backup/ - title: backup - - path: /datacenter/dtr/2.5/reference/cli/destroy/ - title: destroy - title: images - - path: /datacenter/dtr/2.5/reference/cli/install/ - title: install - - path: /datacenter/dtr/2.5/reference/cli/join/ - title: join - - path: /datacenter/dtr/2.5/reference/cli/reconfigure/ - title: reconfigure - - path: /datacenter/dtr/2.5/reference/cli/remove/ - title: remove - - path: /datacenter/dtr/2.5/reference/cli/restore/ - title: restore - - path: /datacenter/dtr/2.5/reference/cli/upgrade/ - title: upgrade - sectiontitle: User guides section: - sectiontitle: Access DTR @@ -2416,8 +2411,6 @@ manuals: title: Create and manage webhooks - path: /datacenter/dtr/2.5/guides/user/create-promotion-policies/ title: Create promotion policies - - path: /datacenter/dtr/2.5/reference/api/ - title: API reference - path: /datacenter/dtr/2.5/guides/release-notes/ title: Release notes - path: /datacenter/dtr/2.5/guides/support/ diff --git a/datacenter/dtr/2.5/guides/admin/backups-and-disaster-recovery.md b/datacenter/dtr/2.5/guides/admin/backups-and-disaster-recovery.md index eca6a97614..3514ce5794 100644 --- a/datacenter/dtr/2.5/guides/admin/backups-and-disaster-recovery.md +++ b/datacenter/dtr/2.5/guides/admin/backups-and-disaster-recovery.md @@ -101,7 +101,7 @@ Where: This prompts you for the UCP password, backups up the DTR metadata and saves the result into a tar archive. You can learn more about the supported flags in -the [reference documentation](../../reference/cli/backup.md). +the [reference documentation](/reference/dtr/2.5/cli/backup.md). The backup command doesn't stop DTR, so that you can take frequent backups without affecting your users. Also, the backup contains sensitive information diff --git a/datacenter/dtr/2.5/guides/admin/install/index.md b/datacenter/dtr/2.5/guides/admin/install/index.md index 20ecc53582..8d90543565 100644 --- a/datacenter/dtr/2.5/guides/admin/install/index.md +++ b/datacenter/dtr/2.5/guides/admin/install/index.md @@ -52,7 +52,7 @@ You can run that snippet on any node where Docker is installed. As an example you can SSH into a UCP node and run the DTR installer from there. By default the installer runs in interactive mode and prompts you for any additional information that is necessary. -[Learn more about the installer](../../../reference/cli/install.md). +[Learn more about the installer](/reference/dtr/2.5/cli/install.md). By default DTR is deployed with self-signed certificates, so your UCP deployment might not be able to pull images from DTR. diff --git a/datacenter/dtr/2.5/guides/admin/install/uninstall.md b/datacenter/dtr/2.5/guides/admin/install/uninstall.md index e4228df28b..ad40aecfb4 100644 --- a/datacenter/dtr/2.5/guides/admin/install/uninstall.md +++ b/datacenter/dtr/2.5/guides/admin/install/uninstall.md @@ -17,7 +17,7 @@ You will be prompted for the UCP URL, UCP credentials, and which replica to destroy. To see what options are available in the destroy command, check the -[destroy command reference documentation](../../../reference/cli/destroy.md). +[destroy command reference documentation](/reference/dtr/2.5/cli/destroy.md). ## Where to go next diff --git a/datacenter/dtr/2.5/guides/admin/monitor-and-troubleshoot/index.md b/datacenter/dtr/2.5/guides/admin/monitor-and-troubleshoot/index.md index 04bb8c4f6f..79b44edac4 100644 --- a/datacenter/dtr/2.5/guides/admin/monitor-and-troubleshoot/index.md +++ b/datacenter/dtr/2.5/guides/admin/monitor-and-troubleshoot/index.md @@ -41,7 +41,7 @@ replicas. ## Cluster status -The `/api/v0/meta/cluster_status` [endpoint](../../../reference/api) +The `/api/v0/meta/cluster_status` [endpoint](/reference/dtr/2.5/api/) requires administrator credentials, and returns a JSON object for the entire cluster as observed by the replica being queried. You can authenticate your requests using HTTP basic auth. diff --git a/datacenter/dtr/2.5/guides/admin/upgrade.md b/datacenter/dtr/2.5/guides/admin/upgrade.md index 0a2aa2ad14..0168dd9c74 100644 --- a/datacenter/dtr/2.5/guides/admin/upgrade.md +++ b/datacenter/dtr/2.5/guides/admin/upgrade.md @@ -73,7 +73,7 @@ $ docker run -it --rm \ By default the upgrade command runs in interactive mode and prompts you for any necessary information. You can also check the -[reference documentation](../../../reference/cli/index.md) for other existing flags. +[reference documentation](/reference/dtr/2.5/cli/index.md) for other existing flags. The upgrade command will start replacing every container in your DTR cluster, one replica at a time. It will also perform certain data migrations. If anything diff --git a/datacenter/dtr/2.5/reference/api/index.html b/reference/dtr/2.5/api/index.html similarity index 100% rename from datacenter/dtr/2.5/reference/api/index.html rename to reference/dtr/2.5/api/index.html diff --git a/datacenter/dtr/2.5/reference/api/main.js b/reference/dtr/2.5/api/main.js similarity index 100% rename from datacenter/dtr/2.5/reference/api/main.js rename to reference/dtr/2.5/api/main.js diff --git a/datacenter/dtr/2.5/reference/api/swagger-ui-bundle.js b/reference/dtr/2.5/api/swagger-ui-bundle.js similarity index 100% rename from datacenter/dtr/2.5/reference/api/swagger-ui-bundle.js rename to reference/dtr/2.5/api/swagger-ui-bundle.js diff --git a/datacenter/dtr/2.5/reference/api/swagger-ui-standalone-preset.js b/reference/dtr/2.5/api/swagger-ui-standalone-preset.js similarity index 100% rename from datacenter/dtr/2.5/reference/api/swagger-ui-standalone-preset.js rename to reference/dtr/2.5/api/swagger-ui-standalone-preset.js diff --git a/datacenter/dtr/2.5/reference/api/swagger-ui.css b/reference/dtr/2.5/api/swagger-ui.css similarity index 100% rename from datacenter/dtr/2.5/reference/api/swagger-ui.css rename to reference/dtr/2.5/api/swagger-ui.css diff --git a/datacenter/dtr/2.5/reference/cli/backup.md b/reference/dtr/2.5/cli/backup.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/backup.md rename to reference/dtr/2.5/cli/backup.md diff --git a/datacenter/dtr/2.5/reference/cli/destroy.md b/reference/dtr/2.5/cli/destroy.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/destroy.md rename to reference/dtr/2.5/cli/destroy.md diff --git a/datacenter/dtr/2.5/reference/cli/images.md b/reference/dtr/2.5/cli/images.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/images.md rename to reference/dtr/2.5/cli/images.md diff --git a/datacenter/dtr/2.5/reference/cli/index.md b/reference/dtr/2.5/cli/index.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/index.md rename to reference/dtr/2.5/cli/index.md diff --git a/datacenter/dtr/2.5/reference/cli/install.md b/reference/dtr/2.5/cli/install.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/install.md rename to reference/dtr/2.5/cli/install.md diff --git a/datacenter/dtr/2.5/reference/cli/join.md b/reference/dtr/2.5/cli/join.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/join.md rename to reference/dtr/2.5/cli/join.md diff --git a/datacenter/dtr/2.5/reference/cli/reconfigure.md b/reference/dtr/2.5/cli/reconfigure.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/reconfigure.md rename to reference/dtr/2.5/cli/reconfigure.md diff --git a/datacenter/dtr/2.5/reference/cli/remove.md b/reference/dtr/2.5/cli/remove.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/remove.md rename to reference/dtr/2.5/cli/remove.md diff --git a/datacenter/dtr/2.5/reference/cli/restore.md b/reference/dtr/2.5/cli/restore.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/restore.md rename to reference/dtr/2.5/cli/restore.md diff --git a/datacenter/dtr/2.5/reference/cli/upgrade.md b/reference/dtr/2.5/cli/upgrade.md similarity index 100% rename from datacenter/dtr/2.5/reference/cli/upgrade.md rename to reference/dtr/2.5/cli/upgrade.md