Gotea/docker-machine
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Files
708fb63c9e4e7fb8315d75551c6b23a777710b33
docker-machine/docs/drivers/azure.md

125 lines
6.8 KiB
Markdown
Raw Normal View History

First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
<!--[metadata]>
+++
title = "Microsoft Azure"
description = "Microsoft Azure driver for machine"
keywords = ["machine, Microsoft Azure, driver"]
[menu.main]
parent="smn_machine_drivers"
+++
<![end-metadata]-->
# Microsoft Azure
Lint all Markdown documents Signed-off-by: David Gageot <david@gageot.net>
2015-11-27 10:16:42 +01:00
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
You will need an Azure Subscription to use this Docker Machine driver.
[Sign up for a free trial.][trial]
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
azure.md: Address docs comments Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-03-14 17:34:50 -07:00
> **NOTE:** This documentation is for the new version of the Azure driver, which started
> shipping with v0.7.0. This driver is not backwards-compatible with the old
> Azure driver. If you want to continue managing your existing Azure machines, please
> download and use machine versions prior to v0.7.0.
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
[azure]: http://azure.microsoft.com/
[trial]: https://azure.microsoft.com/free/
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
## Authentication
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
azure.md: Address docs comments Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-03-14 17:34:50 -07:00
The first time you try to create a machine, Azure driver will ask you to
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
authenticate:
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
azure.md: Documentation clarification Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-03-11 13:31:03 -08:00
$ docker-machine create --driver azure --azure-subscription-id <subs-id> <machine-name>
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
Running pre-create checks...
Microsoft Azure: To sign in, use a web browser to open the page https://aka.ms/devicelogin.
Enter the code [...] to authenticate.
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
After authenticating, the driver will remember your credentials up to two weeks.
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
azure.md: Add known issue notice Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-03-23 11:42:34 -07:00
> **KNOWN ISSUE:** There is a known issue with Azure Active Directory causing stored
> credentials to expire within hours rather than 14 days when the user logs in with
> personal Microsoft Account (formerly _Live ID_) instead of an Active Directory account.
> Currently, there is no ETA for resolution, however in the meanwhile you can
> [create an AAD account][aad-docs] and login with that as a workaround.
[aad-docs]: https://azure.microsoft.com/documentation/articles/virtual-machines-windows-create-aad-work-id/
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
## Options
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
Azure driver only has a single required argument to make things easier. Please
read the optional flags to configure machine details and placement further.
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
Required:
- `--azure-subscription-id`: **(required)** Your Azure Subscription ID.
Optional:
Specify the format for azure-image specification Signed-off-by: Pradeep Padala <pradeep@containerx.io>
2016-03-16 16:01:43 -07:00
- `--azure-image`: Azure virtual machine image in the format of Publisher:Offer:Sku:Version [[?][vm-image]]
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
- `--azure-location`: Azure region to create the virtual machine. [[?][location]]
- `--azure-resource-group`: Azure Resource Group name to create the resources in.
- `--azure-size`: Size for Azure Virtual Machine. [[?][vm-size]]
- `--azure-ssh-user`: Username for SSH login.
- `--azure-vnet`: Azure Virtual Network name to connect the virtual machine. [[?][vnet]]
- `--azure-subnet`: Azure Subnet Name to be used within the Virtual Network.
azure.md: Improve documentation based on feedback Signed-off-by: Tom Deseyn <tom.deseyn@gmail.com>
2016-04-07 09:12:38 +02:00
- `--azure-subnet-prefix`: Private CIDR block. Used to create subnet if it does not exist. Must match in the case that the subnet does exist.
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
- `--azure-availability-set`: Azure Availability Set to place the virtual machine into. [[?][av-set]]
- `--azure-open-port`: Make additional port number(s) accessible from the Internet [[?][nsg]]
- `--azure-private-ip-address`: Specify a static private IP address for the machine.
azure.md: Improve documentation based on feedback Signed-off-by: Tom Deseyn <tom.deseyn@gmail.com>
2016-04-07 09:12:38 +02:00
- `--azure-use-private-ip`: Use private IP address of the machine to connect. It's useful for managing Docker machines from another machine on the same network e.g. while deploying Swarm.
- `--azure-no-public-ip`: Do not create a public IP address for the machine (implies `--azure-use-private-ip`). Should be used only when creating machines from an Azure VM within the same subnet.
azure: Add --azure-static-public-ip flag This flag creates Azure VMs with static public IPs that don’t get released when the VM is deallocated. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-03-14 21:47:51 -07:00
- `--azure-static-public-ip`: Assign a static public IP address to the machine.
Merge pull request #3339 from ahmetalpbalkan/az-docs-fix azure.md: typo fix (cherry picked from commit a0f3d408d85d49610f71616deeec91bd039b89a9) Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2016-04-20 18:49:19 -07:00
- `--azure-docker-port`: Port number for Docker engine.
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
- `--azure-environment`: Azure environment (e.g. `AzurePublicCloud`, `AzureChinaCloud`).
[vm-image]: https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/
[location]: https://azure.microsoft.com/en-us/regions/
[vm-size]: https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-size-specs/
[vnet]: https://azure.microsoft.com/en-us/documentation/articles/virtual-networks-overview/
[av-set]: https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-manage-availability/
First stage of splitting out Splitting out docs Fixing location of help entering in changes from testing Filling in some missing structure Updating with the comments from Nathan Updating with the comments from Nathan Updating after talk with Evan/Nathan Signed-off-by: Mary Anthony <mary@docker.com>
2015-07-07 09:53:04 -07:00
Environment variables and default values:
Markdown linting Signed-off-by: David Gageot <david@gageot.net>
2015-12-08 09:20:53 +01:00
| CLI option | Environment variable | Default |
| ------------------------------- | ----------------------------- | ------------------ |
| **`--azure-subscription-id`** | `AZURE_SUBSCRIPTION_ID` | - |
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
| `--azure-environment` | `AZURE_ENVIRONMENT` | `AzurePublicCloud` |
Update default image to Ubuntu 15.10 - Default image now is ubuntu server 15.10. This ensures consistency with other cloud drivers. - Better error message when virtual machine already exists. - Change default SSH user from `ubuntu` to `docker-user`. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-03-10 15:38:05 -08:00
| `--azure-image` | `AZURE_IMAGE` | `canonical:UbuntuServer:15.10:latest` |
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
| `--azure-location` | `AZURE_LOCATION` | `westus` |
| `--azure-resource-group` | `AZURE_RESOURCE_GROUP` | `docker-machine` |
| `--azure-size` | `AZURE_SIZE` | `Standard_A2` |
Update default image to Ubuntu 15.10 - Default image now is ubuntu server 15.10. This ensures consistency with other cloud drivers. - Better error message when virtual machine already exists. - Change default SSH user from `ubuntu` to `docker-user`. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-03-10 15:38:05 -08:00
| `--azure-ssh-user` | `AZURE_SSH_USER` | `docker-user` |
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
| `--azure-vnet` | `AZURE_VNET` | `docker-machine` |
| `--azure-subnet` | `AZURE_SUBNET` | `docker-machine` |
| `--azure-subnet-prefix` | `AZURE_SUBNET_PREFIX` | `192.168.0.0/16` |
| `--azure-availability-set` | `AZURE_AVAILABILITY_SET` | `docker-machine` |
| `--azure-open-port` | - | - |
| `--azure-private-ip-address` | - | - |
| `--azure-use-private-ip` | - | - |
| `--azure-no-public-ip` | - | - |
azure: Add --azure-static-public-ip flag This flag creates Azure VMs with static public IPs that don’t get released when the VM is deallocated. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-03-14 21:47:51 -07:00
| `--azure-static-public-ip` | - | - |
New Microsoft Azure docker-machine driver The new driver uses Azure Resource Manager APIs and offers a lot more functionality compared to the old Azure driver. It is also easier to authenticate and does not require user to create and place certificate files. It only has a single required argument. This is a breaking change: The new driver cannot work with machines created with the older Azure driver and vice versa (as the APIs are entirely different and resources are not shared between old/new azure APIs). The new driver addresses many issues about the azure driver reported so far. This resolves #2742, resolves #1368, resolves #1142, resolves #2236, resolves #2408, resolves #1126, resolves #774. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2016-01-27 19:30:01 -08:00
| `--azure-docker-port` | `AZURE_DOCKER_PORT` | `2376` |
## Notes
Azure runs fully on the new [Azure Resource Manager (ARM)][arm] stack. Each
machine created comes with a few more Azure resources associated with it:
* A [Virtual Network][vnet] and a subnet under it is created to place your
machines into. This establishes a local network between your docker machines.
* An [Availability Set][av-set] is created to maximize availability of your
machines.
These are created once when the first machine is created and reused afterwards.
Although they are free resources, driver does a best effort to clean them up
after the last machine using these resources is removed.
Each machine is created with a public dynamic IP address for external
connectivity. All its ports (except Docker and SSH) are closed by default. You
can use `--azure-open-port` argument to specify multiple port numbers to be
accessible from Internet.
Once the machine is created, you can modify [Network Security Group][nsg]
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/
Reference in New Issue Copy Permalink