API/CLI Test Cases

Overview

This page defines test cases for the NDSLabs command line utility (ndslabsctl).

Installation

1. If using the ndslabs-startup/ndslabs-up script, the ndslabsctl is copied to your ~bin directory. A file ~/.ndslabsct.yaml is created in your home directory containing the API server address.
2. If not using the ndslabs-up.sh script, you'll need to manually download the ndslabsctl from Github: https://github.com/nds-org/ndslabs/releases/tag/v1.0-alpha. 
   1. If the API server is running under docker or Kubernetes, you will need to specify the server. This can be done on the commandline using the --server flag or by creating a .ndslabsctl.yaml file in your home directory.  For example:

APISERVER=`kubectl describe svc ndslabs-apiserver | grep ^IP | awk '{print $2}'`

echo "server: http://$APISERVER:8083" > ~/.ndslabsctl.yaml

Preconditions

Help

Authentication/authorization

Login

Logout

Change password

Project administration

Add project (admin only)

Delete project (admin only)

Get project details (admin only)

List projects

Service administration

Add service

List services

Delete service

Get service details

Stack administration

Add stack

List stacks

Delete stack

Get stack details

Start stack

Stop stack

Volume administration

Create volume

Attach volume

Detach volume

Delete volume

Configuration

List stack service configuration

Set stack service configuration option

Other

View stack service logs

Add project (admin)