--- title: CLI-based access description: Learn how to access Docker Universal Control Plane from the CLI. keywords: ucp, cli, administration redirect_from: - /ee/ucp/user/access-ucp/cli-based-access/ --- With Universal Control Plane you can continue using the tools you know and love like the Docker CLI client and kubectl. You just need to download and use a UCP client bundle. A client bundle contains a private and public key pair that authorizes your requests in UCP. It also contains utility scripts you can use to configure your Docker and kubectl client tools to talk to your UCP deployment. ## Get the Docker CLI client Download the Docker CLI client by using the UCP web UI. The web UI ensures that you have the right version of the CLI tools for the current version of UCP. 1. From the dashboard, click **Learn more** in the **Docker CLI** card at the bottom of the page. ![](../images/cli-based-access-2.png){: .with-border} 2. On the **Create and manage services using the CLI** page, click **Download Linux client binary** or **Download MacOS client binary**. ![](../images/cli-based-access-3.png){: .with-border} 3. Unzip the `docker` archive. ## Download client certificates To use the Docker CLI with UCP, download a client certificate bundle by using the UCP web UI. 1. Navigate to the **My Profile** page. 2. In the left pane, click **Client Bundles** and choose **New Client Bundle** to download the certificate bundle. ![](../images/cli-based-access-1.png){: .with-border} ## Use client certificates Once you've downloaded a client certificate bundle to your local computer, you can use it to authenticate your requests. Navigate to the directory where you downloaded the user bundle, and extract the zip file into a directory. Then use the utility script appropriate for your system:
```bash cd client-bundle && eval "$(
```cmd REM Run this from an elevated prompt session cd client-bundle && env.cmd ```
```cmd # Run this from an elevated PowerShell session cd client-bundle; Import-Module .\env.ps1 ```
The client bundle utility scripts update the environment variables `DOCKER_HOST` to make your client tools communicate with your UCP deployment, and the `DOCKER_CERT_PATH` environment variable to use the client certificates that are included in the client bundle you downloaded. The utility scripts also run the `kubectl config` command to configure kubectl. To confirm that your client tools are now communicating with UCP, run:
```bash {% raw %} docker version --format '{{.Server.Version}}' {% endraw %} ```
```bash kubectl config current-context ```
The expected Docker server version starts with `ucp/`, and the expected kubectl context name starts with `ucp_`. You can now use the Docker and kubectl clients to create resources in UCP. ### Use client certificates with Docker contexts In Docker Enterprise 3.0, new files are contained in the UCP bundle. These changes support the use of `.zip` files with `docker context import` and allow you to directly change your context using the bundle `.zip` file. Navigate to the directory where you downloaded the user bundle and use `docker context import` to add the new context: ```bash cd client-bundle && docker context import myucp ucp-bundle-$USER.zip" ``` > **Note**: Refer to [Working with Contexts](/engine/context/working-with-contexts/) for more information on using Docker contexts. ## Client certificates for administrators UCP issues different types of certificates depending on the user: * User certificate bundles: only allow running docker commands through a UCP manager node. * Admin user certificate bundles: allow running docker commands on the Docker Engine of any node. ## Download client certificates by using the REST API You can also download client bundles by using the [UCP REST API](/reference/ucp/3.0/api/). In this example, we use `curl` to make the web requests to the API, `jq` to parse the responses, and `unzip` to unpack the zip archive. To install these tools on an Ubuntu distribution, you can run: ```bash sudo apt-get update && sudo apt-get install curl jq unzip ``` Then you get an authentication token from UCP and use it to download the client certificates. ```bash # Create an environment variable with the user security token AUTHTOKEN=$(curl -sk -d '{"username":"","password":""}' https:///auth/login | jq -r .auth_token) # Download the client certificate bundle curl -k -H "Authorization: Bearer $AUTHTOKEN" https:///api/clientbundle -o bundle.zip # Unzip the bundle. unzip bundle.zip # Run the utility script. eval "$(", "password":""}' -Uri https://`/auth/login -Method POST).Content)|ConvertFrom-Json|select auth_token -ExpandProperty auth_token [io.file]::WriteAllBytes("ucp-bundle.zip", ((Invoke-WebRequest -Uri https://`/api/clientbundle -Headers @{"Authorization"="Bearer $AUTHTOKEN"}).Content)) ``` ## Docker Build and UCP When using a UCP client bundle and buildkit, follow the instructions provided in [Restrict services to worker nodes](/ee/ucp/admin/configure/restrict-services-to-worker-nodes/) to make sure that builds are not accidentally scheduled on manager nodes. For additional information on 'docker build' and buildkit, refer to [build command documentation](/engine/reference/commandline/build/) and [buildkit documentation](/develop/develop-images/build_enhancements/). ## Where to go next - [Deploy a service](../swarm.md)