copyright | lastupdated | ||
---|---|---|---|
|
2018-11-14 |
{:new_window: target="_blank"} {:shortdesc: .shortdesc} {:screen: .screen} {:pre: .pre} {:table: .aria-labeledby="caption"} {:codeblock: .codeblock} {:tip: .tip} {:note: .note} {:important: .important} {:deprecated: .deprecated} {:download: .download}
{: #regions-and-zones}
A region is a specific geographical location where you can deploy apps, services, and other {{site.data.keyword.Bluemix}} resources. {{site.data.keyword.Bluemix_notm}} regions differ from {{site.data.keyword.containerlong}} regions. Regions consist of one or more zones, which are physical data centers that host the compute, network, and storage resources and related cooling and power that host services and applications. Zones are isolated from each other, which ensures no shared single point of failure. {:shortdesc}
{{site.data.keyword.containerlong_notm}} regions and zones
{{site.data.keyword.Bluemix_notm}} is hosted worldwide. Services within {{site.data.keyword.Bluemix_notm}} might be available globally, or within a specific region. When you create a Kubernetes cluster in {{site.data.keyword.containerlong_notm}}, its resources remain in the region that you deploy the cluster to.
You can create standard clusters in every supported {{site.data.keyword.containerlong_notm}} region. Free clusters are available only in select regions. {: note}
{{site.data.keyword.containerlong_notm}} region | Corresponding {{site.data.keyword.Bluemix_notm}} location |
---|---|
AP North (standard clusters only) | Tokyo |
AP South | Sydney |
EU Central | Frankfurt |
UK South | London |
US East (standard clusters only) | Washington DC |
US South | Dallas |
{: caption="Table: Supported Kubernetes Service regions and corresponding IBM Cloud locations." caption-side="top"} |
{: #bluemix_regions}
You can organize your resources across {{site.data.keyword.Bluemix_notm}} services by using {{site.data.keyword.Bluemix_notm}} locations, also called regions. For example, you can create a Kubernetes cluster by using a private Docker image that is stored in your {{site.data.keyword.registryshort_notm}} of the same location. {:shortdesc}
To check which {{site.data.keyword.Bluemix_notm}} location you are currently in, run ibmcloud info
and review the Region field.
{{site.data.keyword.Bluemix_notm}} locations can be accessed by specifying the region API endpoint when you log in. If you do not specify a region endpoint, you are automatically logged in to the region that is closest to you.
For example, you can use the following commands to log in to {{site.data.keyword.Bluemix_notm}} region API endpoints:
-
Dallas
ibmcloud login -a api.ng.bluemix.net
{: pre}
-
Washington DC
ibmcloud login -a api.us-east.bluemix.net
{: pre}
-
Sydney and Tokyo
ibmcloud login -a api.au-syd.bluemix.net
{: pre}
-
Frankfurt
ibmcloud login -a api.eu-de.bluemix.net
{: pre}
-
London
ibmcloud login -a api.eu-gb.bluemix.net
{: pre}
{: #container_regions}
By using {{site.data.keyword.containerlong_notm}} regions, you can create or access Kubernetes clusters in a region other than the {{site.data.keyword.Bluemix_notm}} region that you are logged in to. {{site.data.keyword.containerlong_notm}} region endpoints refer specifically to the {{site.data.keyword.containerlong_notm}}, not {{site.data.keyword.Bluemix_notm}} as a whole. {:shortdesc}
You can create standard clusters in every supported {{site.data.keyword.containerlong_notm}} region. Free clusters are available only in select regions. {: note}
Supported {{site.data.keyword.containerlong_notm}} regions:
- AP North (standard clusters only)
- AP South
- EU Central
- UK South
- US East (standard clusters only)
- US South
You can access the {{site.data.keyword.containerlong_notm}} through one global endpoint: https://containers.bluemix.net/v1
.
- To check which {{site.data.keyword.containerlong_notm}} region you are currently in, run
ibmcloud ks region
. - To retrieve a list of available regions and their endpoints, run
ibmcloud ks regions
.
To use the API with the global endpoint, in all your requests, pass the region name in the X-Region
header.
{: tip}
{: #container_login_endpoints}
You can change regions by using the {{site.data.keyword.containerlong_notm}} CLI. {:shortdesc}
You might want to log in to another {{site.data.keyword.containerlong_notm}} region for the following reasons:
- You created {{site.data.keyword.Bluemix_notm}} services or private Docker images in one region and want to use them with {{site.data.keyword.containerlong_notm}} in another region.
- You want to access a cluster in a region that is different from the default {{site.data.keyword.Bluemix_notm}} region that you are logged in to.
To quickly switch regions, run ibmcloud ks region-set
.
{: #containers_api}
To interact with the {{site.data.keyword.containerlong_notm}} API, enter the command type and append /v1/command
to the global endpoint.
{:shortdesc}
Example of GET /clusters
API:
GET https://containers.bluemix.net/v1/clusters
{: codeblock}
To use the API with the global endpoint, in all your requests, pass the region name in the X-Region
header. To list available regions, run ibmcloud ks regions
.
{: tip}
To view documentation on the API commands, view https://containers.bluemix.net/swagger-api/.
{: #zones}
Zones are physical data centers that are available within an {{site.data.keyword.Bluemix_notm}} region. Regions are a conceptual tool to organize zones, and can include zones (data centers) in different countries. The following table displays the zones available by region. {:shortdesc}
- Multizone Metro City: Worker nodes in clusters that are created in a multizone metro city can be spread across zones. Additionally, if you create a Kubernetes version 1.10 or later cluster in a multizone metro city, the highly available masters are spread across zones.
- Single Zone City: Worker nodes in clusters that are created in a single zone city stay within one zone. You cannot spread worker nodes across multiple zones. The highly available master includes three replicas on separate hosts, but is not spread across zones.
Region | Multizone Metro City | Single Zone City |
---|---|---|
AP North | Tokyo: tok02, tok04, tok05 | Hong Kong S.A.R. of the PRC: hkg02 Seoul: seo01 Singapore: sng01 |
AP South | None | Sydney: syd01, syd04 Melbourne: mel01 |
EU Central | Frankfurt: fra02, fra04, fra05 | Amsterdam: ams03 Milan: mil01 Oslo: osl01 Paris: par01 |
UK South | London: lon04, lon05, lon06 **Note**: lon05 replaces lon02. New clusters must use lon05, and only lon05 supports highly available masters spread across zones. | |
US East | Washington DC: wdc04, wdc06, wdc07 | Montreal: mon01 Toronto: tor01 |
US South | Dallas: dal10, dal12, dal13 | San Jose: sjc03, sjc04 São Paulo: sao01 |
{: #single_zone}
In a single-zone cluster, your cluster's resources remain in the zone in which the cluster is deployed. The following image highlights the relationship of single-zone cluster components within an example region of US East:
Understanding where your single-zone cluster resources are.
-
Your cluster's resources, including the master and worker nodes, are in the same zone that you deployed the cluster to. When you initiate local container orchestration actions, such as
kubectl
commands, the information is exchanged between your master and worker nodes within the same zone. -
If you set up other cluster resources, such as storage, networking, compute, or apps running in pods, the resources and their data remain in the zone that you deployed your cluster to.
-
When you initiate cluster management actions, such as using
ibmcloud ks
commands, basic information about the cluster (such as name, ID, user, the command) is routed through a regional endpoint.
{: #multizone}
In a multizone cluster, the master node is deployed in a multizone-capable zone and your cluster's resources are spread across multiple zones.
-
Worker nodes are spread across multiple zones in one region to provide more availability for your cluster. The master remains in the same multizone-capable zone that you deployed the cluster to. When you initiate local container orchestration actions, such as
kubectl
commands, the information is exchanged between your master and worker nodes through a regional endpoint. -
Other cluster resources, such as storage, networking, compute, or apps running in pods, vary in how they deploy to the zones in your multizone cluster. For more information, review these topics:
-
When you initiate cluster management actions, such as using
ibmcloud ks
commands, basic information about the cluster (such as name, ID, user, the command) is routed through a regional endpoint.