Vamp CLI

This CLI for vamp replace the old Scala based CLI. Full docs on the vamp.io website

Installation

Vamp CLI is a Node.js package. Install it globally and export the host address of your Vamp installation via VAMP_HOST.
Now you can run commands, e.g. list breeds

npm install -g vamp-cli
export VAMP_HOST=http://vamp-host
vamp list breeds

Using the CLI

For a list of all commands, just run the --help command

$ vamp

  Usage: vamp <command> [options]


  Options:

    -V, --version  output the version number
    -h, --help     output usage information


  Commands:

    create [options] <artifact>                Creates an blueprint or breed artifact based on passed YAML. Returns the created artifact after creation.
    delete <artifact> <name>                   Deletes artifacts like gateways, blueprints, breeds, workflows.
    deploy [options] <blueprint> <deployment>  Creates a deployment, based on a blueprint, with a specified name.
    describe <artifact> <name>                 Describe details of a deployment, gateway, blueprint, breed, workflow
    emit [options] <value>                     Emits an event on the Vamp event bus. Returns the created event on success.
    generate [options] <artifact>              Generate a breed or blueprint based on an existing one.
    list <artifact>                            Lists deployments, gateways, blueprints, breeds, workflows.
    merge <blueprint> <deployment>             Merges a blueprint to a deployment.
    undeploy [options] <deployment>            Removes a deployment or a specific service in a deployment.
    update-gateway [options] <name>            Updates either weight or condition for a gateway and its routes.

Here are some example commands:

# deploy a blueprint
vamp deploy myService:1.0.0 myDeployment

# get the details of a deployment
vamp describe deployment myDeployment

# merge a blueprint to a running deployment
vamp merge myService:1.1.0 myDeployment

# get the details of a gateway
vamp describe gateway myDeployment/myService/web

# set a condition on specific route in a gateway
vamp update-gateway myDeployment/myService/web --route  myDeployment/myCluster/myService:1.1.0/web --condition "User-Agent == Safari" --strength 100%

# set the weight distribution on set of routes in a gateway
vamp update-gateway myDeployment/myService/web --weights myDeployment/myCluster/myService:1.0.0/web@50%,myDeployment/myCluster/myService:1.1.0/web@50%

# undeploy a specific service of a deployment
vamp undeploy myDeployment --service myService:1.0.0 

Using the CLI programmatically

You can include the vamp-cli package in your code. It will expose the api object which you can use to interact with Vamp in your Node.js code.
Configure the host by either setting the VAMP_HOST environment variable or pass in a config object with a host entry

const vamp = require('vamp-cli/src/api')({ host: 'http://localhost:8080'})

vamp.breed.list()
  .then(res => console.info(res))
  
vamp.deployment.get('mydeployment')
.then(res => console.info(res))  
  

Checkout the api.md file for jsDoc styled API docs