Add warning about the impact of not following the config guidelines

This commit is contained in:
Traci Morrison 2019-08-23 11:02:53 -04:00
parent 77b485dce2
commit da3d4996b5
1 changed files with 39 additions and 30 deletions

View File

@ -33,8 +33,7 @@ There are two options for provisoning IPs for the Kubernetes cluster on Azure:
## Azure Prerequisites ## Azure Prerequisites
You must meet the following infrastructure prerequisites in order You must meet the following infrastructure prerequisites to successfully deploy Docker UCP on Azure. **Failure to meet these prerequisites may result in significant errors during the installation process.**
to successfully deploy Docker UCP on Azure:
- All UCP Nodes (Managers and Workers) need to be deployed into the same Azure - All UCP Nodes (Managers and Workers) need to be deployed into the same Azure
Resource Group. The Azure Networking components (Virtual Network, Subnets, Resource Group. The Azure Networking components (Virtual Network, Subnets,
@ -104,7 +103,13 @@ an Azure subnet.
See the [Kubernetes Azure Cloud Provider Config](https://github.com/kubernetes/cloud-provider-azure/blob/master/docs/cloud-provider-config.md) for more details on this configuration file. See the [Kubernetes Azure Cloud Provider Config](https://github.com/kubernetes/cloud-provider-azure/blob/master/docs/cloud-provider-config.md) for more details on this configuration file.
## Considerations for IPAM Configuration ## Guidelines for IPAM Configuration
> **Warning**
>
> You must follow these guidelines and either use the appropriate size network in Azure or take the proper action to fit within the subnet.
> Failure to follow these guidelines may cause significant issues during the
> installation process.
The subnet and the virtual network associated with the primary interface of the The subnet and the virtual network associated with the primary interface of the
Azure virtual machines need to be configured with a large enough address Azure virtual machines need to be configured with a large enough address
@ -217,7 +222,9 @@ to installing UCP in order to override the default `azure_ip_count` value of 128
addresses per node. See [UCP configuration file](../configure/ucp-configuration-file/) 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. 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 > **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 > 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 > 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 > that run as Kubernetes pods. That is in addition to the Virtual
@ -289,7 +296,9 @@ node. Finally if you have set the [Ip Count
Value](#adjusting-the-ip-count-value) you will need to add `--existing-config` Value](#adjusting-the-ip-count-value) you will need to add `--existing-config`
to the install command below. to the install command below.
> Note: The `pod-cidr` range must match the Azure Virtual Network's Subnet > **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 > 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.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`. > `172.0.1.0/24`, then the Pod CIDR should also be `172.0.1.0/24`.