This Help Center is no longer being updated. It stays available as a reference for the classic ZEDEDA Cloud GUI. For the new console and current releases, see the ZEDEDA documentation at docs.zededa.com for doc updates and info about new releases.

Deploy the Compose Runtime Application

Introduction

Docker Compose is a tool for defining and managing multi-container Docker applications. It allows developers to configure all application services, including their dependencies, networks, and storage settings, within a single declarative YAML file, typically named compose.yaml.

By consolidating configuration and orchestration into one file, Docker Compose simplifies the deployment process. Rather than launching each container manually with individual commands, Compose enables you to bring up the entire application stack with a single command, ensuring consistency across development and production environments.

The ZEDEDA Compose Runtime app includes:

  1. The Compose App Instance Control: The process that translates edge app instance management operations into compose app instance actions: start, stop, restart, purge and update, and delete. The agent uses a closed-loop management system and continuously monitors the status of the running app instances.
  2. The Runtime Stack: The container runtime stack is the core software running on the host machine that creates and manages the containers.
  3. The Compose Tool: The built-in Docker command (docker compose) that reads your YAML file.

In summary, the Compose Runtime includes both the Container Runtime Stack (the Docker Engine) and the ability to translate and execute the instructions in your compose.yaml file.

This article describes how to deploy the Compose Runtime as an edge app instance on your edge node. This is a series of articles. You will likely follow them in this order.

  1. Docker Compose Overview
  2. Add a Compose Runtime Image
  3. Deploy the Compose Runtime Application (you are here)
  4. Attach an Existing ZFS Pool to the Compose Runtime (ZFS variant only)
  5. Compose App Instance Control Overview
  6. Add a Docker Compose as an Edge App Type
  7. Troubleshooting Docker Compose

Prerequisites

  • You have the SysManager role in your enterprise.
  • A Compose Runtime edge app in your local marketplace, imported from the Global Marketplace or created yourself. See Add a Compose Runtime Image.
  • Your edge node is running EVE-OS (Edge Virtualization Engine) version 14.5.0 LTS or greater.
  • For the ZFS variant on an edge node that uses ZFS persistent storage: a 16.0.x LTS release of EVE-OS or greater. Edge nodes that use ext4 persistent storage do not have this additional requirement.
  • You have created a Switch network instance and a Local air-gapped network instance on the edge node.
  • For the ZFS variant: the existing ZFS pool volume instance is present on the edge node and you have completed Attach an Existing ZFS Pool to the Compose Runtime.

Before You Deploy

The Compose Runtime edge app must exist in your local marketplace before you deploy it. ZEDEDA publishes it in two variants, standard and ZFS, each in more than one size. To choose a variant, import it from the Global Marketplace, or build the edge app from a QCOW2 file, see Add a Compose Runtime Image. The deployment procedure that follows is the same for both variants.

Deploy the Compose Runtime App

NOTE: While multiple Docker Compose apps can be deployed on an edge node, you can deploy only one Compose Runtime app per edge node.

Configure the edge app and edge nodes

This process is based on Deploy an Edge Application Instance. See that article if you need further details about deployment in general.

  1. From the Marketplace, select Edge Apps.
  2. Select the Deploy icon (at bottom right) of your Compose Runtime edge app card. Confirm that you selected the variant you intend to deploy. The ZFS variant has -zfs in its name.
  3. As the Edge App, select your Compose Runtime edge app, if not auto-populated.
  4. Select your Project from the dropdown.
  5. Select the Name of the edge node where you want to deploy the app instance.
  6. Select Next.

Configure the edge app instance identity

  1. There are no specific requirements for the Name and Title of the edge app instance, so configure them as you wish.
  2. For the Persistence Storage Size, make sure that the size is equivalent to your VM drive size, such as 20 GB, since the default might be larger than some smaller edge nodes can hold. A persistent data volume of this size is created as part of deploying the runtime. It stores the runtime's own container state, such as Docker volumes created by compose apps, and its data is maintained across upgrades of the runtime software. This disk is not the same as an attached ZFS pool, which already exists on the edge node and is imported rather than created.
  3. Select Next.

Configure the adapters and networks

  1. Select your Switch network instance for the first adapter.
  2. Select your Local air-gapped network instance for the second adapter.
  3. Select Next.

Configure the custom configuration

  1. In the Compose User Parameters fields, enter the Compose user name and Compose user password.

    NOTE: These credentials enable users who are already logged in to EVE-OS to establish an SSH connection into the runtime for troubleshooting purposes. You will use Edge View to establish an SSH connection to the air-gapped Ethernet port. See Initial User Setup and Connecting to the Edge App in the Troubleshooting Docker Compose article for details.

    WARNING: Record these credentials immediately and store them securely. This password is not recoverable through Edge Infrastructure Services or any other method. Losing these credentials requires a full reinstallation of the Compose Runtime.

  2. If you are using a static IP on the air-gapped interface, set Configure Static IP to Yes. Otherwise, the default is DHCP.
  3. Enter the IPv4 Address with Mask, for example 192.168.0.11/24.
  4. Enter the Default Gateway.
  5. Enter the DNS Server IP address.
  6. Enter the NTP Server IP address.
  7. Select Next.

For the ZFS variant, the pool import and dataset discovery settings are not entered here. They live in the custom configuration template on the edge app itself, which you edit before deployment. If you have not done so, cancel and complete Attach an Existing ZFS Pool to the Compose Runtime first.

Review and deploy

  1. Review the deployment details, such as the image name, max size, and edge node.
  2. For the ZFS variant, confirm that two drives are listed: the runtime image and the ZFS pool volume referenced by label.
  3. Select Deploy.

Verify the Deployment

  1. Select Edge App Instances in the left panel.
  2. Locate the Compose Runtime instance and confirm its run state shows Online.
  3. Open the instance and confirm the expected state and uptime.
  4. For the ZFS variant, confirm the imported datasets are mounted inside the runtime as described in the verification section of Attach an Existing ZFS Pool to the Compose Runtime.

Deactivate or Delete the Runtime

You can deactivate a Compose Runtime instance after all of its Docker Compose app instances are halted. Deleting the runtime still requires deleting the Docker Compose app instances first.

NOTE: From release 21.2.6, drives for a runtime instance come only from the edge app. Drives supplied in a deployment request are rejected. An edge app version bump that changes nothing no longer purges the runtime.

Next Steps

This is a series of articles. You will likely follow them in this order.

  1. Docker Compose Overview
  2. Add a Compose Runtime Image
  3. Deploy the Compose Runtime Application (you are here)
  4. Attach an Existing ZFS Pool to the Compose Runtime (ZFS variant only)
  5. Compose App Instance Control Overview
  6. Add a Docker Compose as an Edge App Type
  7. Troubleshooting Docker Compose

After you have completed the series, you might be interested in Manage your edge nodes and edge apps.

Was this article helpful?
0 out of 0 found this helpful