Merge pull request #9239 from hamiltont/document-machine-advisory

Adding advisory warnings about docker-machine
2019-11-18 14:22:40 -08:00 · 2019-11-18 14:22:40 -08:00 · 5b918f715c
parent 60f463d5fc 3697b94c9f
commit 5b918f715c
29 changed files with 34 additions and 4 deletions
--- a/_data/advisories.yaml
+++ b/_data/advisories.yaml
@ -17,7 +17,7 @@ texts:
  swarm: "See [Swarm mode overview](/engine/swarm/) for the orchestration features introduced in Docker Engine 1.12. Only refer to the Docker Swarm documents below for information on the standalone Swarm product."
  swarm-standalone: "**You are viewing docs for legacy standalone Swarm.** These topics describe standalone Docker Swarm. In Docker 1.12 and higher, [Swarm mode](/engine/swarm/) is integrated with Docker Engine. Most users should use integrated Swarm mode &#8212; a good place to start is [Getting started with swarm mode](/engine/swarm/swarm-tutorial/), [Swarm mode CLI commands](/engine/swarm/index.md#swarm-mode-cli-commands), and the [Get started with Docker walkthrough](/get-started/)). Standalone Docker Swarm is not integrated into the Docker Engine API and CLI commands."
  engine: "This site contains documentation for the v1.12 release candidate version of Docker Engine. For the Docker Engine v1.11 docs, see [https://docs.docker.com/v1.11/](https://docs.docker.com/v1.11/). Docker Desktop for Mac and Docker Desktop for Windows are currently in Beta."
-
+  machine: "As of July 2018, Docker Machine is in [maintenance mode](https://github.com/docker/machine/issues/4537). Only bugfixes will be added. Provisioning on a variety of cloud providers is better achieved using [infrakit](https://github.com/docker/deploykit)." 

 # URL based advisories
 # any URL that begins with "/engine/" will get the "engine" advisory
--- a/_data/glossary.yaml
+++ b/_data/glossary.yaml
@ -195,6 +195,7 @@
  makes it really easy to create Docker hosts on  your computer, on
  cloud providers and inside your own data center. It creates servers,
  installs Docker on them, then configures the Docker client to talk to them.
+  As of July 2018, Docker Machine is in maintenance mode. Only bugfixes will be added

  *Also known as : docker-machine*
 <a class="glossary" name="namespace">namespace</a>: |
--- a/machine/concepts.md
+++ b/machine/concepts.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Understand concepts for Docker Machine, including drivers, base OS, IP addresses, environment variables
 keywords: docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale
 title: Machine concepts and getting help
--- a/machine/drivers/aws.md
+++ b/machine/drivers/aws.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Amazon Web Services driver for machine
 keywords: machine, Amazon Web Services, driver
 title: Amazon Web Services
--- a/machine/drivers/azure.md
+++ b/machine/drivers/azure.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Microsoft Azure driver for machine
 keywords: machine, Microsoft Azure, driver
 title: Microsoft Azure
@ -116,4 +117,4 @@ rules and open ports of the machine from the [Azure Portal][portal].

 [arm]:    https://azure.microsoft.com/en-us/documentation/articles/resource-group-overview/
 [nsg]:    https://azure.microsoft.com/en-us/documentation/articles/virtual-networks-nsg/
-[portal]: https://portal.azure.com/
+[portal]: https://portal.azure.com/
--- a/machine/drivers/digital-ocean.md
+++ b/machine/drivers/digital-ocean.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: DigitalOcean driver for machine
 keywords: machine, digitalocean, driver
 title: DigitalOcean
--- a/machine/drivers/exoscale.md
+++ b/machine/drivers/exoscale.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Exoscale driver for machine
 keywords: machine, exoscale, driver
 title: Exoscale
--- a/machine/drivers/gce.md
+++ b/machine/drivers/gce.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Google Compute Engine driver for machine
 keywords: machine, Google Compute Engine, driver
 title: Google Compute Engine
--- a/machine/drivers/generic.md
+++ b/machine/drivers/generic.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Generic driver for machine
 keywords: machine, Generic, driver
 title: Generic
--- a/machine/drivers/hyper-v.md
+++ b/machine/drivers/hyper-v.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Microsoft Hyper-V driver for machine
 keywords: machine, Microsoft Hyper-V, driver
 title: Microsoft Hyper-V
--- a/machine/drivers/index.md
+++ b/machine/drivers/index.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Reference for drivers Docker Machine supports
 keywords: machine, drivers, supports
 title: Machine drivers
--- a/machine/drivers/linode.md
+++ b/machine/drivers/linode.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Linode driver for machine
 keywords: machine, Linode, driver
 title: Linode
--- a/machine/drivers/openstack.md
+++ b/machine/drivers/openstack.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: OpenStack driver for machine
 keywords: machine, OpenStack, driver
 title: OpenStack
--- a/machine/drivers/os-base.md
+++ b/machine/drivers/os-base.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Identify active machines
 keywords: machine, driver, base, operating system
 title: Driver options and operating system defaults
--- a/machine/drivers/rackspace.md
+++ b/machine/drivers/rackspace.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Rackspace driver for machine
 keywords: machine, Rackspace, driver
 title: Rackspace
--- a/machine/drivers/soft-layer.md
+++ b/machine/drivers/soft-layer.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: IBM Softlayer driver for machine
 keywords: machine, IBM Softlayer, driver
 title: IBM Softlayer
--- a/machine/drivers/virtualbox.md
+++ b/machine/drivers/virtualbox.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Oracle VirtualBox driver for machine
 keywords: machine, Oracle VirtualBox, driver
 title: Oracle VirtualBox
--- a/machine/drivers/vm-cloud.md
+++ b/machine/drivers/vm-cloud.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: VMware vCloud Air driver for machine
 keywords: machine, VMware vCloud Air, driver
 title: VMware vCloud Air
@ -48,4 +49,4 @@ The VMware vCloud Air driver uses the `Ubuntu Server 12.04 LTS (amd64 20140927)`
 | `--vmwarevcloudair-publicip`      | `VCLOUDAIR_PUBLICIP`      | -                                          |
 | `--vmwarevcloudair-ssh-port`      | `VCLOUDAIR_SSH_PORT`      | `22`                                       |
 | **`--vmwarevcloudair-username`**  | `VCLOUDAIR_USERNAME`      | -                                          |
-| `--vmwarevcloudair-vdcid`         | `VCLOUDAIR_VDCID`         | -                                          |
+| `--vmwarevcloudair-vdcid`         | `VCLOUDAIR_VDCID`         | -                                          |
--- a/machine/drivers/vm-fusion.md
+++ b/machine/drivers/vm-fusion.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: VMware Fusion driver for machine
 keywords: machine, VMware Fusion, driver
 title: VMware Fusion
--- a/machine/drivers/vsphere.md
+++ b/machine/drivers/vsphere.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: VMware vSphere driver for machine
 keywords: machine, VMware vSphere, driver
 title: VMware vSphere
--- a/machine/examples/aws.md
+++ b/machine/examples/aws.md
@ -1,9 +1,12 @@
 ---
+advisory: machine
 description: Using Docker Machine to provision hosts on AWS
 keywords: docker, machine, cloud, aws
 title: Amazon Web Services (AWS) EC2 example
 ---

+> docker-machine is unable to launch Amazon Linux machines, including ECS-Optimized instances. [Github issue](https://github.com/docker/machine/issues/3098)
+
 Follow along with this example to create a Dockerized [Amazon Web Services (AWS)](https://aws.amazon.com/) EC2 instance.

 ### Step 1. Sign up for AWS and configure credentials
--- a/machine/examples/ocean.md
+++ b/machine/examples/ocean.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Using Docker Machine to provision hosts on DigitalOcean
 keywords: docker, machine, cloud, digitalocean
 title: DigitalOcean example
--- a/machine/get-started-cloud.md
+++ b/machine/get-started-cloud.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Using Docker Machine to provision hosts on cloud providers
 keywords: docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale
 title: Use Docker Machine to provision hosts on cloud providers
--- a/machine/index.md
+++ b/machine/index.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Introduction and Overview of Machine
 keywords: docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale
 title: Docker Machine
--- a/machine/install-machine.md
+++ b/machine/install-machine.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: How to install Docker Machine
 keywords: machine, orchestration, install, installation, docker, documentation, uninstall Docker Machine, uninstall
 title: Install Docker Machine
--- a/machine/migrate-to-machine.md
+++ b/machine/migrate-to-machine.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Migrate from Boot2Docker to Docker Machine
 keywords: machine, commands, boot2docker, migrate, docker
 title: Migrate from Boot2Docker to Machine
--- a/machine/overview.md
+++ b/machine/overview.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Introduction and Overview of Machine
 keywords: docker, machine, amazonec2, azure, digitalocean, google, openstack, rackspace, softlayer, virtualbox, vmwarefusion, vmwarevcloudair, vmwarevsphere, exoscale
 title: Docker Machine Overview
--- a/machine/reference/index.md
+++ b/machine/reference/index.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 description: Docker Machine Commands Overview
 keywords: machine, commands
 title: Docker Machine command-line reference
@ -24,4 +25,4 @@ title: Docker Machine command-line reference
 -   [status](status.md)
 -   [stop](stop.md)
 -   [upgrade](upgrade.md)
-   [url](url.md)
+-   [url](url.md)
--- a/release-notes/docker-machine.md
+++ b/release-notes/docker-machine.md
@ -1,4 +1,5 @@
 ---
+advisory: machine
 title: Docker Machine release notes
 description: Release notes for Docker Machine
 keywords: release notes, machine