docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

UCP Install on Azure Patch (#8522) 

* Fix grammar on the 2nd pre-req, and did markdown formatting on the rest :)

* Correct Pod-CIDR Warning

* Content cleanup

Please check that I haven't changed the meaning of the updated prerequisites.

* Create a new section on configuring the IP Count value, also responded to feedback from Follis, Steve R and Xinfeng.

* Incorporated Steven F's feedback and Issue 8551

* Provide a warning when setting a small IP Count variable

* Final edits

* Update install-on-azure.md

* Following feedback I have expanded on the 0644 azure.json file permissions and Added the --existing-config file to the UCP install command

* Removed Orchestrator Tag Pre Req from Azure Docs

* Clarifying need for 0644 permissions
This commit is contained in:
Olly P 2019-04-18 23:20:00 +01:00 committed by Maria Bermudez
parent a2a825af78
commit ebe21e93be
1 changed files with 157 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

234
ee/ucp/admin/install/install-on-azure.md
View File

@ -4,63 +4,54 @@ description: Learn how to install Docker Universal Control Plane in a Microsoft
keywords: Universal Control Plane, UCP, install, Docker EE, Azure, Kubernetes keywords: Universal Control Plane, UCP, install, Docker EE, Azure, Kubernetes
--- ---
Docker UCP closely integrates into Microsoft Azure for its Kubernetes Networking Docker Universal Control Plane (UCP) closely integrates with Microsoft Azure for its Kubernetes Networking
and Persistent Storage feature set. UCP deploys the Calico CNI provider. In Azure and Persistent Storage feature set. UCP deploys the Calico CNI provider. In Azure,
the Calico CNI leverages the Azure networking infrastructure for data path the Calico CNI leverages the Azure networking infrastructure for data path
networking and the Azure IPAM for IP address management. There are networking and the Azure IPAM for IP address management. There are
infrastructure prerequisites that are required prior to UCP installation for the infrastructure prerequisites required prior to UCP installation for the
Calico / Azure integration. Calico / Azure integration.
## Docker UCP Networking ## Docker UCP Networking
Docker UCP configures the Azure IPAM module for Kubernetes to allocate Docker UCP configures the Azure IPAM module for Kubernetes to allocate IP
IP addresses to Kubernetes pods. The Azure IPAM module requires each Azure addresses for Kubernetes pods. The Azure IPAM module requires each Azure virtual
virtual machine that's part of the Kubernetes cluster to be configured with a pool of machine which is part of the Kubernetes cluster to be configured with a pool of IP
IP addresses. addresses.
There are two options for provisoning IPs for the Kubernetes cluster on Azure There are two options for provisoning IPs for the Kubernetes cluster on Azure:
- Docker UCP provides an automated mechanism to configure and maintain IP pools
for standalone Azure virtual machines. This service runs within the calico-node daemonset - _An automated mechanism provided by UCP which allows for IP pool configuration and maintenance
and by default will provision 128 IP address for each node. This value can be for standalone Azure virtual machines._ This service runs within the
configured through the `azure_ip_count`in the UCP `calico-node` daemonset and provisions 128 IP addresses for each
[configuration file](../configure/ucp-configuration-file) before or after the node by default. For information on customizing this value, see [Adjusting the IP count value](#adjusting-the-ip-count-value).
UCP installation. Note that if this value is reduced post-installation, existing - _Manual provision of additional IP address for each Azure virtual machine._ This
virtual machines will not be reconciled, and you will have to manually edit the IP count could be done through the Azure Portal, the Azure CLI `$ az network nic ip-config create`,
in Azure. or an ARM template. You can find an example of an ARM template
- Manually provision additional IP address for each Azure virtual machine. This could be done [here](#manually-provision-ip-address-as-part-of-an-azure-virtual-machine-scale-set).
as part of an Azure Virtual Machine Scale Set through an ARM template. You can find an example [here](#set-up-ip-configurations-on-an-azure-virtual-machine-scale-set).
Note that the `azure_ip_count` value in the UCP
[configuration file](../configure/ucp-configuration-file) will need to be set
to 0, otherwise UCP's IP Allocator service will provision the IP Address on top of
those you have already provisioned.
## Azure Prerequisites ## Azure Prerequisites
You must meet these infrastructure prerequisites in order You must meet the following infrastructure prerequisites in order
to successfully deploy Docker UCP on Azure to successfully deploy Docker UCP on Azure:
- All UCP Nodes (Managers and Workers) need to be deployed into the same - All UCP Nodes (Managers and Workers) need to be deployed into the same Azure
Azure Resource Group. The Azure Networking (Vnets, Subnets, Security Groups) Resource Group. The Azure Networking components (Virtual Network, Subnets,
components could be deployed in a second Azure Resource Group. Security Groups) could be deployed in a second Azure Resource Group.
- The Azure Vnet and Subnet must be appropriately sized for your - The Azure Virtual Network and Subnet must be appropriately sized for your
environment, and addresses from this pool are consumed by Kubernetes Pods. For more information, see environment, as addresses from this pool will be consumed by Kubernetes Pods.
[Considerations for IPAM For more information, see [Considerations for IPAM
Configuration](#considerations-for-ipam-configuration). Configuration](#considerations-for-ipam-configuration).
- All UCP Nodes (Managers and Workers) need to be attached to the same - All UCP worker and manager nodes need to be attached to the same Azure
Azure Subnet. Subnet.
- All UCP (Managers and Workers) need to be tagged in Azure with the - The Azure Virtual Machine Object Name needs to match the Azure Virtual Machine
`Orchestrator` tag. Note the value for this tag is the Kubernetes version number Computer Name and the Node Operating System's Hostname which is the FQDN of
in the format `Orchestrator=Kubernetes:x.y.z`. This value may change in each the host, including domain names. Note that this requires all characters to be in lowercase.
UCP release. To find the relevant version please see the UCP - An Azure Service Principal with `Contributor` access to the Azure Resource
[Release Notes](../../release-notes). For example for UCP 3.1.0 the tag Group hosting the UCP Nodes. This Service principal will be used by Kubernetes
would be `Orchestrator=Kubernetes:1.11.2`. to communicate with the Azure API. The Service Principal ID and Secret Key are
- The Azure Virtual Machine Object Name needs to match the Azure Virtual Machine needed as part of the UCP prerequisites. If you are using a separate Resource
Computer Name and the Node Operating System's Hostname. Note this applies to the Group for the networking components, the same Service Principal will need
FQDN of the host including domain names. `Network Contributor` access to this Resource Group.
- An Azure Service Principal with `Contributor` access to the Azure Resource
Group hosting the UCP Nodes. Note, if using a separate networking Resource
Group the same Service Principal will need `Network Contributor` access to this
Resource Group.
UCP requires the following information for the installation: UCP requires the following information for the installation:
@ -68,17 +59,18 @@ UCP requires the following information for the installation:
objects are being deployed. objects are being deployed.
- `tenantId` - The Azure Active Directory Tenant ID in which the UCP - `tenantId` - The Azure Active Directory Tenant ID in which the UCP
objects are being deployed. objects are being deployed.
- `aadClientId` - The Azure Service Principal ID - `aadClientId` - The Azure Service Principal ID.
- `aadClientSecret` - The Azure Service Principal Secret Key - `aadClientSecret` - The Azure Service Principal Secret Key.
### Azure Configuration File ### Azure Configuration File
For Docker UCP to integrate into Microsoft Azure, you need to place an Azure For Docker UCP to integrate with Microsoft Azure,each UCP node in your cluster
configuration file within each UCP node in your cluster, at needs an Azure configuration file, `azure.json`. Place the file within
`/etc/kubernetes/azure.json`. The `azure.json` file needs 0644 permissions. `/etc/kubernetes`. Since the config file is owned by `root`, set its permissions
to `0644` to ensure the container user has read access.
See the template below. Note entries that do not contain `****` should not be The following is an example template for `azure.json`. Replace `***` with real values, and leave the other
changed. parameters as is.
``` ```
{ {
@ -105,45 +97,44 @@ changed.
} }
``` ```
There are some optional values for Azure deployments: There are some optional parameters for Azure deployments:
- `"primaryAvailabilitySetName": "****",` - The Worker Nodes availability set. - `primaryAvailabilitySetName` - The Worker Nodes availability set.
- `"vnetResourceGroup": "****",` - If your Azure Network objects live in a - `vnetResourceGroup` - The Virtual Network Resource group, if your Azure Network objects live in a
seperate resource group. seperate resource group.
- `"routeTableName": "****",` - If you have defined multiple Route tables within - `routeTableName` - If you have defined multiple Route tables within
an Azure subnet. an Azure subnet.
More details on this configuration file can be found See [Kubernetes' azure.go](https://github.com/kubernetes/kubernetes/blob/master/pkg/cloudprovider/providers/azure/azure.go) for more details on this configuration file.
[here](https://github.com/kubernetes/kubernetes/blob/master/pkg/cloudprovider/providers/azure/azure.go).
## Considerations for IPAM Configuration ## Considerations for IPAM Configuration
The subnet and the virtual network associated with the primary interface of The subnet and the virtual network associated with the primary interface of the
the Azure virtual machines need to be configured with a large enough address prefix/range. Azure virtual machines need to be configured with a large enough address
The number of required IP addresses depends on the number of pods running prefix/range. The number of required IP addresses depends on the workload and
on each node and the number of nodes in the cluster. the number of nodes in the cluster.
For example, in a cluster of 256 nodes, to run a maximum of 128 pods For example, in a cluster of 256 nodes, make sure that the address space of the subnet and the
concurrently on a node, make sure that the address space of the subnet and the virtual network can allocate at least 128 * 256 IP addresses, in order to run a maximum of 128 pods
virtual network can allocate at least 128 * 256 IP addresses, _in addition to_ concurrently on a node. This would be ***in addition to*** initial IP allocations to virtual machine
initial IP allocations to virtual machine NICs during Azure resource creation. NICs (network interfaces) during Azure resource creation.
Accounting for IP addresses that are allocated to NICs during virtual machine bring-up, set Accounting for IP addresses that are allocated to NICs during virtual machine bring-up, set
the address space of the subnet and virtual network to 10.0.0.0/16. This the address space of the subnet and virtual network to `10.0.0.0/16`. This
ensures that the network can dynamically allocate at least 32768 addresses, ensures that the network can dynamically allocate at least 32768 addresses,
plus a buffer for initial allocations for primary IP addresses. plus a buffer for initial allocations for primary IP addresses.
> Azure IPAM, UCP, and Kubernetes > Azure IPAM, UCP, and Kubernetes
> >
> The Azure IPAM module queries an Azure virtual machine's metadata to obtain > The Azure IPAM module queries an Azure virtual machine's metadata to obtain
> a list of IP addresses that are assigned to the virtual machine's NICs. The > a list of IP addresses which are assigned to the virtual machine's NICs. The
> IPAM module allocates these IP addresses to Kubernetes pods. You configure the > IPAM module allocates these IP addresses to Kubernetes pods. You configure the
> IP addresses as `ipConfigurations` in the NICs associated with a virtual machine > IP addresses as `ipConfigurations` in the NICs associated with a virtual machine
> or scale set member, so that Azure IPAM can provide them to Kubernetes when > or scale set member, so that Azure IPAM can provide them to Kubernetes when
> requested. > requested.
{: .important} {: .important}
## Manually provision IP address as part of an Azure virtual machine scale set ## Manually provision IP address pools as part of an Azure virtual machine scale set
Configure IP Pools for each member of the virtual machine scale set during provisioning by Configure IP Pools for each member of the virtual machine scale set during provisioning by
associating multiple `ipConfigurations` with the scale set’s associating multiple `ipConfigurations` with the scale set’s
@ -204,20 +195,109 @@ for each virtual machine in the virtual machine scale set.
} }
``` ```
## Install UCP ## UCP Installation
Use the following command to install UCP on the manager node. ### Adjust the IP Count Value
The `--pod-cidr` option maps to the IP address range that you configured for
the subnets in the previous sections, and the `--host-address` maps to the
IP address of the master node.
> Note: The `pod-cidr` range must be within an Azure subnet attached to the If you have manually attached additional IP addresses to the Virtual Machines
> host. (via an ARM Template, Azure CLI or Azure Portal) or you want to reduce the
number of IP Addresses automatically provisioned by UCP from the default of 128
addresses, you can alter the `azure_ip_count` variable in the UCP
Configuration file before installation. If you are happy with 128 addresses per
Virtual Machine, proceed to [installing UCP](#install-ucp).
Once UCP has been installed, the UCP [configuration
file](../configure/ucp-configuration-file/) is managed by UCP and populated with
all of the cluster configuration data, such as AD/LDAP information or networking
configuration. As there is no Universal Control Plane deployed yet, we are able
to stage a [configuration file](../configure/ucp-configuration-file/) just
containing the Azure IP Count value. UCP will populate the rest of the cluster
variables during and after the installation.
Below are some example configuration files with just the `azure_ip_count`
variable defined. These 3-line files can be preloaded into a Docker Swarm prior
to installing UCP in order to override the default `azure_ip_count` value of 128 IP
addresses per node. See [UCP configuration file](../configure/ucp-configuration-file/)
to learn more about the configuration file, and other variables that can be staged pre-install.
> Note: Do not set the `azure_ip_count` to a value of less than 6 if you have not
> manually provisioned additional IP addresses for each Virtual Machine. The UCP
> installation will need at least 6 IP addresses to allocate to the core UCP components
> that run as Kubernetes pods. That is in addition to the Virtual
> Machine's private IP address.
If you have manually provisioned additional IP addresses for each Virtual
Machine, and want to disallow UCP from dynamically provisioning IP
addresses for you, then your UCP configuration file would be:
```
$ vi example-config-1
[cluster_config]
azure_ip_count = "0"
```
If you want to reduce the IP addresses dynamically allocated from 128 to a
custom value, then your UCP configuration file would be:
```
$ vi example-config-2
[cluster_config]
azure_ip_count = "20" # This value may be different for your environment
```
See [Considerations for IPAM
Configuration](#considerations-for-ipam-configuration) to calculate an
appropriate value.
To preload this configuration file prior to installing UCP:
1. Copy the configuration file to a Virtual Machine that you wish to become a UCP Manager Node.
2. Initiate a Swarm on that Virtual Machine.
```
$ docker swarm init
```
3. Upload the configuration file to the Swarm, by using a [Docker Swarm Config](/engine/swarm/configs/).
This Swarm Config will need to be named `com.docker.ucp.config`.
```
$ docker config create com.docker.ucp.config <local-configuration-file>
```
4. Check that the configuration has been loaded succesfully.
```
$ docker config list
ID NAME CREATED UPDATED
igca3q30jz9u3e6ecq1ckyofz com.docker.ucp.config 1 days ago 1 days ago
```
5. You are now ready to [install UCP](#install-ucp). As you have already staged
a UCP configuration file, you will need to add `--existing-config` to the
install command below.
If you need to adjust this value post-installation, see [instructions](../configure/ucp-configuration-file/)
on how to download the UCP configuration file, change the value, and update the configuration via the API.
If you reduce the value post-installation, existing virtual machines will not be
reconciled, and you will have to manually edit the IP count in Azure.
### Install UCP
Run the following command to install UCP on a manager node. The `--pod-cidr`
option maps to the IP address range that you have configured for the Azure
subnet, and the `--host-address` maps to the private IP address of the master
node. Finally if you have set the [Ip Count
Value](#adjusting-the-ip-count-value) you will need to add `--existing-config`
to the install command below.
> Note: The `pod-cidr` range must match the Azure Virtual Network's Subnet
> attached the hosts. For example, if the Azure Virtual Network had the range
> `172.0.0.0/16` with Virtual Machines provisioned on an Azure Subnet of
> `172.0.1.0/24`, then the Pod CIDR should also be `172.0.1.0/24`.
```bash ```bash
docker container run --rm -it \ docker container run --rm -it \
--name ucp \ --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \ --volume /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} install \ {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} install \
--host-address <ucp-ip> \ --host-address <ucp-ip> \
--pod-cidr <ip-address-range> \ --pod-cidr <ip-address-range> \