diff --git a/_data/toc.yaml b/_data/toc.yaml index e10eefc6f0..a19e03bf86 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1436,6 +1436,8 @@ manuals: title: Upgrade offline - path: /datacenter/ucp/2.2/guides/admin/install/uninstall/ title: Uninstall + - path: /datacenter/ucp/2.2/guides/admin/install/architecture-specific-images/ + title: Architecture-specific images - sectiontitle: Configure section: - path: /datacenter/ucp/2.2/guides/admin/configure/add-labels-to-cluster-nodes/ diff --git a/datacenter/ucp/2.2/guides/admin/install/architecture-specific-images.md b/datacenter/ucp/2.2/guides/admin/install/architecture-specific-images.md new file mode 100644 index 0000000000..e890aa9dcb --- /dev/null +++ b/datacenter/ucp/2.2/guides/admin/install/architecture-specific-images.md @@ -0,0 +1,41 @@ +--- +title: Architecture-specific images +description: Learn how to use images that are specific to particular hardware architectures in Docker Universal Control Plane. +keywords: UCP, Docker EE, image, IBM z, Windows +--- + +Docker Universal Control Plane deploys images for a number of different +hardware architectures, including IBM z systems. Some architectures require +pulling images that have specific tags or names indicating the target +architecture. + +## Tag for IBM z Systems + +Append the string `-s390x` to a UCP system image tag to pull the appropriate +image for IBM z Systems. For example, you can modify the CLI command for getting +a [UCP support dump](..\..\get-support.md) to use an environment variable +that indicates the current architecture: + +```bash +[[ $(docker info --format='{{.Architecture}}') == s390x ]] && export _ARCH='-s390x' || export _ARCH='' + +docker container run --rm \ + --name ucp \ + -v /var/run/docker.sock:/var/run/docker.sock \ + --log-driver none \ + {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }}${_ARCH} \ + support > docker-support.tgz +``` + +In this example, the environment variable is named `_ARCH`, but you can use any +valid shell name. + +## OS-specific component names + +Some UCP component names depend on the node's operating system. Use the +following table to ensure that you're pulling the right images for each node. + +| UCP component base name | Windows name | IBM z Systems name | +|-------------------------|----------------|--------------------| +| ucp-agent | ucp-agent-win | ucp-agent-s390x | +| ucp-dsinfo | ucp-dsinfo-win | ucp-dsinfo-s390x | diff --git a/datacenter/ucp/2.2/guides/architecture.md b/datacenter/ucp/2.2/guides/architecture.md index 9fdc606efb..503c633528 100644 --- a/datacenter/ucp/2.2/guides/architecture.md +++ b/datacenter/ucp/2.2/guides/architecture.md @@ -60,37 +60,44 @@ Once this service is running, it deploys containers with other UCP components, and it ensures they keep running. The UCP components that are deployed on a node depend on whether the node is a manager or a worker. +> OS-specific component names +> +> Some UCP component names depend on the node's operating system. For example, +> on Windows, the `ucp-agent` component is named `ucp-agent-win`. +> [Learn about architecture-specific images](admin/install/architecture-specific-images.md). + ### UCP components in manager nodes Manager nodes run all UCP services, including the web UI and data stores that persist the state of UCP. These are the UCP services running on manager nodes: -| UCP component | Description | -|:--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ucp-agent | Monitors the node and ensures the right UCP services are running | -| ucp-reconcile | When ucp-agent detects that the node is not running the right UCP components, it starts the ucp-reconcile container to converge the node to its desired state. It is expected for the ucp-reconcile container to remain in an exited state when the node is healthy. | -| ucp-auth-api | The centralized service for identity and authentication used by UCP and DTR | -| ucp-auth-store | Stores authentication configurations and data for users, organizations, and teams | -| ucp-auth-worker | Performs scheduled LDAP synchronizations and cleans authentication and authorization data | -| ucp-client-root-ca | A certificate authority to sign client bundles | -| ucp-cluster-root-ca | A certificate authority used for TLS communication between UCP components | -| ucp-controller | The UCP web server | -| ucp-kv | Used to store the UCP configurations. Don't use it in your applications, since it's for internal use only | -| ucp-metrics | Used to collect and process metrics for a node, like the disk space available | -| ucp-proxy | A TLS proxy. It allows secure access to the local Docker Engine to UCP components | -| ucp-swarm-manager | Used to provide backwards-compatibility with Docker Swarm | - +| UCP component | Description | +| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ucp-agent | Monitors the node and ensures the right UCP services are running | +| ucp-reconcile | When ucp-agent detects that the node is not running the right UCP components, it starts the ucp-reconcile container to converge the node to its desired state. It is expected for the ucp-reconcile container to remain in an exited state when the node is healthy. | +| ucp-auth-api | The centralized service for identity and authentication used by UCP and DTR | +| ucp-auth-store | Stores authentication configurations and data for users, organizations, and teams | +| ucp-auth-worker | Performs scheduled LDAP synchronizations and cleans authentication and authorization data | +| ucp-client-root-ca | A certificate authority to sign client bundles | +| ucp-cluster-root-ca | A certificate authority used for TLS communication between UCP components | +| ucp-controller | The UCP web server | +| ucp-dsinfo | Docker system information collection script to assist with troubleshooting | +| ucp-kv | Used to store the UCP configurations. Don't use it in your applications, since it's for internal use only | +| ucp-metrics | Used to collect and process metrics for a node, like the disk space available | +| ucp-proxy | A TLS proxy. It allows secure access to the local Docker Engine to UCP components | +| ucp-swarm-manager | Used to provide backwards-compatibility with Docker Swarm | ### UCP components in worker nodes Worker nodes are the ones where you run your applications. These are the UCP services running on worker nodes: -| UCP component | Description | -|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ucp-agent | Monitors the node and ensures the right UCP services are running | -| ucp-reconcile | When ucp-agent detects that the node is not running the right UCP components, it starts the ucp-reconcile container to converge the node to its desired state. It is expected for the ucp-reconcile container to remain in an exited state when the node is healthy. | -| ucp-proxy | A TLS proxy. It allows secure access to the local Docker Engine to UCP components | +| UCP component | Description | +| :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ucp-agent | Monitors the node and ensures the right UCP services are running | +| ucp-dsinfo | Docker system information collection script to assist with troubleshooting | +| ucp-reconcile | When ucp-agent detects that the node is not running the right UCP components, it starts the ucp-reconcile container to converge the node to its desired state. It is expected for the ucp-reconcile container to remain in an exited state when the node is healthy. | +| ucp-proxy | A TLS proxy. It allows secure access to the local Docker Engine to UCP components | ## Volumes used by UCP