Use the ZEDEDA CLI to Manage an Edge Node Cluster

Introduction

After you create an edge node cluster, you can manage it. This article explains how to manage edge node cluster instances using ZEDEDA CLI, including creation, updates, and deletion commands, with examples for each action.

Prerequisites

ZCLI v14.5 is running

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

  1. Edge Node Cluster Overview
  2. Create an Edge Node Cluster 
  3. Manage an Edge Node Cluster
  4. Use the ZEDEDA CLI to Manage an Edge Node Cluster - You are here!
  5. Edge Node Cluster App Instance Failover Behavior 

Create an Edge Node Cluster

Create an edge node cluster from ZCLI.

zcli edge-node-cluster create <name> --project=<project> --nodes=<node_name:cluster_interface>... [--title=<title>] [--description=<description>] [--tags=<key:value>...] [--cluster_prefix=<cluster_prefix>]
Example
zcli edge-node-cluster create MY_CLUSTER --project=MY_PROJECT --nodes=MY_NODE1:eth2 --nodes=MY_NODE2:eth2 --nodes=MY_NODE3:eth2

View Edge Node Cluster Status

After you create an edge node cluster, you can show the status.

zcli edge-node-cluster status [<name> | --uuid=<uuid>] [--raw]
Example
 zcli edge-node-cluster status MY_CLUSTER

Update an Edge Node Cluster

After you create an edge node cluster, you can update the identity details or replace an edge node with a new node whenever things change.

zcli edge-node-cluster update <name> --nodes=<node_name:cluster_interface>... [--title=<title>] [--description=<description>] [--tags=<key:value>...]
Example
zcli edge-node-cluster update MY_CLUSTER --nodes=MY_NODE1:eth2 --nodes=MY_NODE2:eth2 --nodes=MY_NEW_NODE:eth2

Add or Delete an Edge Node

Adding or deleting an edge node to or from the cluster is not supported. Only replace is supported.

Delete an Edge Node Cluster

After you add an edge node cluster, you can delete it if you no longer need it. When the edge node cluster is deleted, every node in the cluster reboots and reconfigures itself to a single node mode.

zcli edge-node-cluster delete <name>
Example
zcli edge-node-cluster delete MY_CLUSTER

Upgrade an Edge Node Cluster

After you add an edge node cluster, you can upgrade the EVE-OS image on each node. It’s necessary to update EVE-OS from a single operation on the edge-node-cluster level instead of the 'edge-node eveimage-update' operation to ensure only one cluster node is taken down at a time.

zcli edge-node-cluster upgrade <name> --image=<image>
Example
zcli edge-node-cluster upgrade MY_CLUSTER_INST --image=XXXXXXX

View Edge Node Cluster Upgrade Status

After you upgrade an edge node cluster, you can view the status of the upgrade. Note that an upgrade could potentially take hours to complete, depending on how much data needs to be transferred between nodes to rebuild replicated cluster volumes which only reside on a single remaining replica on the node in question. Node operations are blocked when a clustered volume has no replica redundancy. This is further defined in the Edge Node Cluster App Instance Failover Behavior.

zcli edge-node-cluster show [<name> | --uuid=<uuid>] [--upgrade]
Example
zcli edge-node-cluster show MY_CLUSTER --upgrade

This outputs a table of each node with a series of columns: NodeID, UpgradeableEveOS, Status, CreatedAt, UpdatedAt.

Next Steps

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

  1. Edge Node Cluster Overview
  2. Create an Edge Node Cluster 
  3. Manage an Edge Node Cluster
  4. Use the ZEDEDA CLI to Manage an Edge Node Cluster - You are here!
  5. Edge Node Cluster App Instance Failover Behavior

After you’ve completed the series, you might be interested in the following articles. 

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