mirror of https://github.com/docker/docs.git
Fixing some formatting and command params
This commit is contained in:
art
Joao Fernandes
parent
86fb652d05
commit
73c8ff17a9
|
|
@ -9,6 +9,7 @@ Docker Enterprise Edition for IBM Cloud (Beta) comes with a variety of integrati
|
|||
Use the Docker EE for IBM Cloud CLI plug-in (`bx d4ic`) to provision swarm mode clusters and resources. Manage your cluster with the `bx d4ic` plug-in and the Docker EE Universal Control Plane (UCP) web UI.
|
||||
|
||||
## Create swarms
|
||||
|
||||
Create a Docker EE swarm cluster in IBM Cloud.
|
||||
|
||||
> Your beta license allows you to provision up to 20 nodes
|
||||
|
|
@ -71,7 +72,9 @@ To create a Docker EE for IBM Cloud cluster from the CLI:
|
|||
> You can set your infrastructure API credentials and Docker EE installation URL as environment variables so that you do not have to include them as options when using `bx d4ic` commands. For example:
|
||||
>
|
||||
> export SOFTLAYER_USERNAME=user.name.1234567
|
||||
>
|
||||
> export SOFTLAYER_API_KEY=api-key
|
||||
>
|
||||
> export D4IC_DOCKER_EE_URL=my_docker-ee-url
|
||||
|
||||
|
||||
|
|
@ -83,27 +86,27 @@ To create a Docker EE for IBM Cloud cluster from the CLI:
|
|||
> First, the manager node is deployed. Then, the additional infrastructure resources are deployed, including the worker nodes, DTR nodes, load balancers, subnet, and NFS volume.
|
||||
|
||||
* **Provisioning Stage 1**: Check the status of the manager node:
|
||||
{% raw %}
|
||||
{% raw %}
|
||||
```bash
|
||||
$ docker logs cluster-name_ID
|
||||
$ docker logs cluster-name_ID
|
||||
|
||||
Apply complete! Resources: 3 added, 0 changed, 0 destroyed.
|
||||
Apply complete! Resources: 3 added, 0 changed, 0 destroyed.
|
||||
|
||||
The state of your infrastructure has been saved to the path
|
||||
below. This state is required to modify and destroy your
|
||||
infrastructure, so keep it safe. To inspect the complete state
|
||||
use the `terraform show` command.
|
||||
The state of your infrastructure has been saved to the path
|
||||
below. This state is required to modify and destroy your
|
||||
infrastructure, so keep it safe. To inspect the complete state
|
||||
use the `terraform show` command.
|
||||
|
||||
State path:
|
||||
State path:
|
||||
|
||||
Outputs:
|
||||
Outputs:
|
||||
|
||||
manager_public_ip = 169.##.###.##
|
||||
swarm_d4ic_id = ID
|
||||
swarm_name = cluster-name
|
||||
ucp_password = UCP-password
|
||||
```
|
||||
{% endraw %}
|
||||
manager_public_ip = 169.##.###.##
|
||||
swarm_d4ic_id = ID
|
||||
swarm_name = cluster-name
|
||||
ucp_password = UCP-password
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
* **Provisioning Stage 2**: Check the status of the cluster infrastructure:
|
||||
{% raw %}
|
||||
|
|
@ -146,9 +149,11 @@ To create a Docker EE for IBM Cloud cluster from the CLI:
|
|||
After creating the cluster, [log in to Docker UCP and download the Docker UCP client certificate bundle](#use-the-universal-control-plane).
|
||||
|
||||
## Use the Universal Control Plane
|
||||
|
||||
Docker EE for IBM Cloud uses [Docker Universal Control Plane (UCP)](/datacenter/ucp/2.2/guides/) to provide integrated container management and security, from development to production.
|
||||
|
||||
### Access UCP
|
||||
|
||||
Before you begin, [create a cluster](#create-swarms). Note the its **Name** and **ID**.
|
||||
|
||||
1. Retrieve your UCP password by using the cluster **Name** and **ID** that you made when you [created the cluster](#create-swarms).
|
||||
|
|
@ -172,6 +177,7 @@ Before you begin, [create a cluster](#create-swarms). Note the its **Name** and
|
|||
4. Log in to UCP. Your credentials are `admin` and the UCP password from the `docker logs` command, or the credentials that your admin created for you.
|
||||
|
||||
### Download client certificates
|
||||
|
||||
[Download the client certificate bundle](/datacenter/ucp/2.2/guides/user/access-ucp/cli-based-access/#download-client-certificates) to create objects and deploy services from a local Docker client.
|
||||
|
||||
1. [Access UCP](#access-ucp).
|
||||
|
|
@ -207,30 +213,35 @@ Before you begin, [create a cluster](#create-swarms). Note the its **Name** and
|
|||
## View swarm resources
|
||||
|
||||
### Cluster-level resources
|
||||
|
||||
To review resources used within a particular Docker EE cluster, use the CLI or UCP.
|
||||
|
||||
**CLI**: The `bx d4ic` CLI lists, modifies, and automates cluster infrastructure, as well as the URLs to access UCP, DTR, or exposed Docker services.
|
||||
|
||||
* Use `bx d4ic list --sl-user user.name.1234567 --sl-api-key api_key` to review a list of your clusters and their UCP URLs.
|
||||
* Use `bx d4ic show --swarm-name my_swarm --sl-user user.name.1234567 --sl-api-key api_key` to review details about the cluster, such as the IP address of manager nodes or the status of the cluster load balancers.
|
||||
* To review a list of your clusters and their UCP URLs: `bx d4ic list --sl-user user.name.1234567 --sl-api-key api_key`.
|
||||
* To review details about the cluster, such as the IP address of manager nodes or the status of the cluster load balancers: `bx d4ic show --swarm-name my_swarm --sl-user user.name.1234567 --sl-api-key api_key`.
|
||||
|
||||
**UCP**: The Docker EE Universal Control Plane provides a web-based GUI to manage swarm users and deployed applications. You can view swarm-related stacks, services, containers, images, nodes, networks, volumes, and secrets.
|
||||
**UCP**: The Docker EE Universal Control Plane provides a web UI to manage swarm users and deployed applications. You can view swarm-related stacks, services, containers, images, nodes, networks, volumes, and secrets.
|
||||
|
||||
### Account-level resources
|
||||
|
||||
For an account-level view of services and infrastructure that can be used in your swarm, log in to your [IBM Cloud](https://console.bluemix.net/) account.
|
||||
|
||||
* The IBM Cloud dashboard provides information on connected IBM Cloud services in the account, such as Watson and Internet of Things.
|
||||
* The IBM Cloud infrastructure portal shows account infrastructure resources such as virtual devices, storage, and networking.
|
||||
|
||||
### Other resources
|
||||
|
||||
To gather logging and metric data from your swarm, first [enable logging for the cluster](logging.md), and then access the data in your IBM Cloud organization and space.
|
||||
|
||||
## UCP and CLIs
|
||||
|
||||
Docker EE for IBM Cloud employs a flexible architecture and integration with IBM Cloud that you can use to leverage IBM Cloud resources and customize your swarm environment. Docker EE UCP exposes the standard Docker API, and as such, includes certain functions that instead should be done by using Docker EE for IBM Cloud capabilities.
|
||||
|
||||
> Self-healing capabilities so you don't have to modify cluster infrastructure.
|
||||
>
|
||||
> Docker EE for IBM Cloud uses the InfraKit toolkit to support self-healing infrastructure. After you create the swarm, the cluster maintains that specified number of nodes. If a manager node fails, you do not need to promote a worker node to manager; the swarm self-recovers the manager node.
|
||||
>
|
||||
> Do not use UCP to modify a cluster's underlying infrastructure, such as adding or promoting worker nodes to managers.
|
||||
|
||||
The table outlines when to use UCP and when to use the `bx d4ic` CLI for various types of tasks.
|
||||
|
|
@ -250,11 +261,13 @@ The table outlines when to use UCP and when to use the `bx d4ic` CLI for various
|
|||
| Logging | UCP and CLI | From UCP, can send logs to a remote syslog server. From the CLI, [enable logging and monitoring](logging.md) to IBM Cloud and access by using Grafana and Kibana GUIs. |
|
||||
|
||||
## Grant user access
|
||||
|
||||
For IBM Cloud account access management, consult the [IBM Cloud Identity and Access Management documentation](https://console.bluemix.net/docs/iam/quickstart.html#getstarted).
|
||||
|
||||
For Docker EE cluster access management, use the [UCP Access Control documentation](/datacenter/ucp/2.2/guides/access-control/).
|
||||
|
||||
## Delete swarms
|
||||
|
||||
Before you begin:
|
||||
|
||||
* Log in to [IBM Cloud infrastructure](https://control.softlayer.com/), select your user profile, and under the **API Access Information** section retrieve your **API Username** and **Authentication Key**.
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ Steps:
|
|||
|
||||
```bash
|
||||
$ bx d4ic list --sl-user user.name.1234567 --sl-api-key api_key
|
||||
$ bx d4ic show --swarm-name mycluster
|
||||
$ bx d4ic show --swarm-name mycluster --sl-user user.name.1234567 --sl-api-key api_key
|
||||
...
|
||||
Load Balancers
|
||||
ID Name Address Type
|
||||
|
|
|
|||
|
|
@ -123,16 +123,6 @@ The Docker EE for IBM Cloud CLI plug-in simplifies your interaction with IBM Clo
|
|||
|
||||
Instead of including these in each command, you can [set your environment variables](/docker-for-ibm-cloud/index.md#set-infrastructure-environment-variables).
|
||||
|
||||
## Why do swarm cluster provisioning or `docker node` commands fail?
|
||||
|
||||
Make sure that you have [set up all the necessary accounts](/docker-for-ibm-cloud/index.md), including your Docker EE subscription URL, IBM Cloud account, and IBM Cloud infrastructure credentials.
|
||||
|
||||
Set your [infrastructure credentials to your environment variables](/docker-for-ibm-cloud/index.md#set-infrastructure-environment-variables), or include them in the `bx d4ic create` command when [provisioning your cluster](administering-swarms.md#create-swarms).
|
||||
|
||||
When provisioning the swarm or using `docker node` commands, you might encounter error messages similar to `Discovery error: No cluster leader` or `Error response from daemon: No elected primary cluster manager`, or `Leader Election: Cluster leadership lost`.
|
||||
|
||||
Docker EE for IBM Cloud uses Docker Swarm for container orchestration. Swarm uses an external discovery backend, which means that there might be additional time during provisioning. To account for this, [increase the TTL delay](/swarm/reference/manage/#--replication-ttl--leader-lock-release-time-on-failure) to a minimum of 20s.
|
||||
|
||||
## Can I manually change the load balancer configuration?
|
||||
|
||||
No. If you make any manual changes to the load balancer, they are removed the next time that the load balancer is updated or swarm changes are made. This is because the swarm service configuration is the source of record for service ports. If you add listeners to the load balancer manually, they could conflict with what is in cluster, and cause issues.
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ Log in to Docker (whether by the registry log-in, token, or other method) before
|
|||
## Create a container using an IBM Cloud Container Registry image
|
||||
You can create a container using a registry image. You might want to run the image locally to test it before [creating a swarm service](#create-a-swarm-service-using-an-ibm-cloud-container-registry-image) based on the image.
|
||||
|
||||
**Before you begin**:
|
||||
Before you begin:
|
||||
|
||||
- [Install the registry CLI and set up a namespace](#install-the-cli-and-set-up-a-namespace).
|
||||
- [Add an image in your registry namespace](https://console.bluemix.net/docs/services/Registry/registry_images_.html#registry_images_) to use to create the swarm service.
|
||||
|
|
@ -69,7 +69,7 @@ To create a local container that uses an IBM Cloud Container Registry image:
|
|||
## Create a swarm service using an IBM Cloud Container Registry image
|
||||
You can create a service that schedules tasks to spawn containers that are based on an image in your IBM Cloud Container Registry.
|
||||
|
||||
**Before you begin**:
|
||||
Before you begin:
|
||||
|
||||
- Install the Docker for IBM Cloud CLI.
|
||||
- [Install the registry CLI and set up a namespace](#install-the-cli-and-set-up-a-namespace).
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ redirect_from:
|
|||
|
||||
Docker EE for IBM Cloud is an unmanaged, native Docker environment within IBM Cloud that runs Docker Enterprise Edition software. Docker EE for IBM Cloud is available on **December 20th 2017 as a closed Beta**.
|
||||
|
||||
[Request access to the beta here](https://www.ibm.com/us-en/marketplace/docker-for-ibm-cloud). In the welcome email you receive, you are given the Docker EE installation URL that you use for the beta.
|
||||
[Request access to the closed beta here](https://www.ibm.com/us-en/marketplace/docker-for-ibm-cloud). In the welcome email you receive, you are given the Docker EE installation URL that you use for the beta.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ on that port to your service.
|
|||
1. Connect to your Docker EE for IBM Cloud swarm. Navigate to the directory where you [downloaded the UCP credentials](administering-swarms.md#download-client-certificates) and run the script. For example:
|
||||
|
||||
```bash
|
||||
$ cd filepath/to/certificate/repo && source env.
|
||||
$ cd filepath/to/certificate/repo && source env.sh
|
||||
```
|
||||
|
||||
2. Create the service specifying the port on which you want the service exposed. For example:
|
||||
|
|
|
|||
|
|
@ -156,12 +156,13 @@ Before you begin:
|
|||
- [Set up file storage for persistent data](#set-up-file-storage-for-persistent-data-volumes).
|
||||
|
||||
Create a service that specifies the volume you want to use. The example creates _my_service_ that schedules a task to spawn swarm containers based on the Alpine image, creates 3 repliacs, mounts to _my_volume_, and sets the volume destination (dst) path within each container to the _/dst/directory_.
|
||||
```bash
|
||||
$ docker service create
|
||||
--name my_service
|
||||
--mount type=volume,source=my_volume,dst=/dst/directory,volume-driver=d4ic-volume
|
||||
--replicas=3 alpine ping 8.8.8.8
|
||||
```
|
||||
|
||||
```bash
|
||||
$ docker service create --name my_service \
|
||||
--mount type=volume,source=my_volume,dst=/dst/directory,volume-driver=d4ic-volume \
|
||||
--replicas=3 \
|
||||
alpine ping 8.8.8.8
|
||||
```
|
||||
|
||||
> Do not provision a volume when you create a Docker service
|
||||
>
|
||||
|
|
@ -178,9 +179,9 @@ Before you begin:
|
|||
|
||||
Create a task that specifies the volume you want to use. The example creates a task that spawns an image based on the Busybox image, mounts it to _my_volume_, and creates the volume path within the container to the _/dst/directory_.
|
||||
|
||||
```bash
|
||||
$ docker run -it --volume my_volume:/dst/directory busybox sh
|
||||
```
|
||||
```bash
|
||||
$ docker run -it --volume my_volume:/dst/directory busybox sh
|
||||
```
|
||||
|
||||
## Clean up volumes in your swarm
|
||||
|
||||
|
|
@ -212,4 +213,4 @@ You can disconnect a particular IBM Cloud infrastructure file storage volume.
|
|||
|
||||
1. Log in to your IBM Cloud infrastructure account and access the file storage volume that you want to disconnect.
|
||||
|
||||
2. Under notes, delete the `docker_volume_name:my_volume;docker_swarm_id:my_swarmID` entry.
|
||||
2. Under notes, delete the entry `docker_volume_name:my_volume;docker_swarm_id:my_swarmID`.
|
||||
|
|
|
|||
|
|
@ -8,6 +8,8 @@ title: Docker EE for IBM Cloud (Beta) Quick Start
|
|||
|
||||
Are you ready to orchestrate Docker Enterprise Edition swarm clusters that are enhanced with the full suite of secure IBM Cloud platform, infrastructure, and Watson services? Great! Let's get you started.
|
||||
|
||||
To request access to the closed beta, [contact us](https://www.ibm.com/us-en/marketplace/docker-for-ibm-cloud).
|
||||
|
||||
|
||||
|
||||
## Step 1: Get all your accounts in order
|
||||
|
|
@ -61,7 +63,7 @@ Now we're ready to get to the fun stuff: making a cluster!
|
|||
|
||||
## Step 3: Create clusters
|
||||
|
||||
Create a Docker EE swarm cluster in IBM Cloud. For beta, your cluster can have a maximum of 20 nodes, up to 14 of which can be worker nodes.
|
||||
Create a Docker EE swarm cluster in IBM Cloud. During the beta, your cluster can have a maximum of 20 nodes, up to 14 of which can be worker nodes. If you need more nodes than this, work with your Docker representative to acquire an additional Docker EE license.
|
||||
|
||||
|
||||
1. Log in to the IBM Cloud CLI. If you have a federated ID, use the `--sso` option.
|
||||
|
|
@ -80,9 +82,9 @@ Create a Docker EE swarm cluster in IBM Cloud. For beta, your cluster can have a
|
|||
|
||||
```bash
|
||||
$ bx d4ic create --swarm-name my_swarm \
|
||||
--ssh-label my_ssh_label \
|
||||
--sl-user user.name.1234567 \
|
||||
--sl-api-key api_key \
|
||||
--ssh-label my_ssh_label \
|
||||
--ssh-key filepath_to_my_ssh_key \
|
||||
--docker-ee-url my_docker-ee-url
|
||||
```
|
||||
|
|
@ -98,7 +100,7 @@ Congrats! Your Docker EE for IBM Cloud cluster is provisioning. First, the manag
|
|||
|
||||
## Step 4: Use UCP
|
||||
|
||||
Check it out: Docker for IBM Cloud uses [Docker Universal Control Plane (UCP)](/datacenter/ucp/2.2/guides/) to help you manage your cluster through a simple interface!
|
||||
Check it out: Docker for IBM Cloud uses [Docker Universal Control Plane (UCP)](/datacenter/ucp/2.2/guides/) to help you manage your cluster through a simple web UI!
|
||||
|
||||
### Step 4a: Access UCP
|
||||
|
||||
|
|
@ -141,7 +143,7 @@ We're almost done! We just need to download the UCP certificate bundle so that y
|
|||
>
|
||||
> Move the certificate environment variable directory to a safe and accessible location on your machine. You'll use it a lot!
|
||||
|
||||
5. From the client bundle directory, update your `DOCKER_HOST` and `DOCKER_CERT_PATH` environment variables by running the `env.sh` script:
|
||||
5. From the client bundle directory, update your `DOCKER_HOST` and `DOCKER_CERT_PATH` environment variables by loading the `env.sh` script contents into your environment.:
|
||||
|
||||
```bash
|
||||
$ source env.sh
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Steps:
|
|||
4. Get the public IP address of the leader node, replacing _my_swarm_ with the swarm you want to scale:
|
||||
|
||||
```bash
|
||||
$ bx d4ic show my_swarm --sl-user user.name.1234567 --sl-api-key api_key
|
||||
$ bx d4ic show --swarm-name my_swarm --sl-user user.name.1234567 --sl-api-key api_key
|
||||
```
|
||||
|
||||
5. Connect to the leader node using the _leaderIP_ you previously retrieved:
|
||||
|
|
|
|||
Loading…
Reference in New Issue