Use the ZEDEDA CLI to Manage a Volume Instance

Updated

Introduction

A volume instance provides key services to the edge nodes, such as storing the applications, storing data generated by the apps, and enabling apps on the same node to share data with each other. This article explains how to manage volume instances using the ZEDEDA CLI, including creating, viewing, updating, and deleting them.

Prerequisites

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

  1. Volume Instance Overview
  2. Create a Volume Instance
  3. Manage a Volume Instance
  4. Use the ZEDEDA CLI to Manage a Volume Instance - You are here!

Create a Volume Instance

Create a volume instance from the ZCLI.

zcli volume-instance create <name> --volume-type=<volume-type> --project=<project> (--edge-node=<edge-node> | --edge-node-cluster=<edge-node-cluster>) --size=<size> --access-mode=<access-mode> [--content-tree=<name>] [--label=<label>] [--image=<image>] [--title=<title>] [--description=<description>]
Single Node Example:
zcli volume-instance create MY-VOL-INST --volume-type=CONTENT_TREE --project=MY-PROJECT --edge-node=MY-EDGE-NODE --size=100 --access-mode=READWRITE
Edge Node Cluster Example:
zcli volume-instance create MY-VOL-INST --volume-type=CONTENT_TREE --project=MY-PROJECT --edge-node-cluster=MY-CLUSTER --size=100 --access-mode=READWRITE

 

View a Volume Instance

After you create volume instances, you can view them.

zcli volume-instance show [[[<name> | --uuid=<uuid>] [--detail]] | [[--name-pattern=<name-pattern>] [--summary] [--page-size=<page-size>] [--project=<project> [--edge-node=<edge-node> | --edge-node-cluster=<edge-node-cluster>]]]]

For example, the show command for volume instances displays the following output:

All Example:
zcli volume-instance show
Single Node Example:
zcli volume-instance show --edge-node=MY-NODE
Edge Node Cluster Example:
zcli volume-instance show --edge-node-cluster

 

Update a Volume Instance

After you create a volume instance, you can update it whenever things change.

zcli volume-instance update <name> [--title=<title>] [--description=<description>]
Example:
zcli volume-instance update MY-VOL-INST --title=MY-NEW-VOL-INST-TITLE

 

Delete a Volume Instance

After you add a volume instance, you can delete it if you no longer need it. If you don’t use the
-f option, you’ll be prompted to confirm.

zcli volume-instance delete <name> [-f]
Example:
zcli volume-instance delete MY-VOL-INST -f

Next Steps

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

  1. Volume Instance Overview
  2. Create a Volume Instance
  3. Manage a Volume Instance
  4. Use the ZEDEDA CLI to Manage a Volume Instance - You are here!

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

  1. See create an edge app in the marketplace.
Was this article helpful?
0 out of 0 found this helpful