README.md

CurveAdm

Deploy and manage Curve cluster

NOTE: CurveAdm only support CurveFS now, the CurveBS will be supported later

Table of Contents

• Requirement
• Installation
• Usage
  • Deploy Cluster
  • Mount FileSystem
  • Umount FileSystem
• Devops

Requirement

CurveAdm depends on docker, please install docker first.

Please make sure the docker daemon has running, you can run the below command to verify:

sudo docker run hello-world

This command downloads a test image and runs it in a container. When the container runs, it prints a message and exits.

Installation

sh -c "$(curl -fsSL https://curveadm.nos-eastchina1.126.net/script/install.sh)"

Usage

Deploy Cluster

Prepare cluster topology, you can refer to the sample configuration:

• cluster
• stand-alone

vi topology.yaml

Add cluster with specified topology:

curveadm cluster add c1 -f topology.yaml

Switch cluster:

curveadm cluster checkout c1

Deploy cluster:

curveadm deploy

Mount FileSystem

Prepare client config, you can refer to the sample configuration:

• cluster
• stand-alone

vi client.yaml

Mount filesystem:

sudo curveadm mount NAME-OF-CURVEFS MOUNTPONT -c client.yaml

Umount FileSystem

sudo curveadm umount MOUNTPOINT

Ask for help

If you encounter an unsolvable problem during deployment or using Curve, you can use the support command to seek help from the curve team. After executing this command, all Curve service logs and configuration files will be packaged and collected, and encrypted and uploaded to On our log collection server, so that the Curve team can analyze and solve problems.

curveadm support

After the support command is executed, the logs and config files will be packaged and uploaded. If the upload is successful, a secret key will be returned. You can get help by telling the secret key to the Curve team. You can contact the Curve team by adding the WeChat account opencurve.

Devops

Run curveadm -h for more information.