Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.42 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.42 KB
Raw

nebula-cmd

Travis CI unit tests & auto build status: Build Status

command line tool for managing nebula clusters, only tested the CLI on Linux but should also work on Mac's.

refer to the cmd part of the guide in readthedocs for more details on how to use, --help is also an option as it's pretty self explanatory.

Quick walk-through

Install

sudo wget https://github.com/nebula-orchestrator/nebula-cmd/raw/master/dist/nebulactl -O  /usr/local/bin/nebulactl && sudo chmod +x /usr/local/bin/nebulactl

Login

After installing "nebulactl" you have to configure it by pointing it to your cluster, you do it by running the following command

nebulactl login (--username <root> --password <password> | --token <token>) (--host_uri <manager URI> | --host <nebula.host.com> [--port <80> --protocol <http/https>])

or if you prefer a guided questions login just run:

nebulactl login

Either of these 2 methods creates a file in ~/.nebula.json with the login details. nebulactl checks this file every time it runs a command against the nebula API. Also note that the file is per user so if you have multiple users you will have to either copy this file or run the nebulactl login command for each of them.

Use

The --help argument will give you the needed parameters for each command, most commands will also prompt interactively if a required parameter is missing to ease first time users.

nebulactl --help

Usage: nebulactl.py [OPTIONS] COMMAND [ARGS]...

  Connect to a Nebula orcherstrator management endpoint, Create Nebula apps
  and Manage them all from a simple CLI.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  apps           Manage nebula apps.
  cron-jobs      Manage nebula cron_jobs.
  device-groups  Manage nebula device_groups.
  login          login to nebula
  logout         logout of nebula, useful when you want to make sure to...
  ping           check nebula api responds
  prune          Prune images.
  reports        List nebula device reports.
  user-groups    Manage nebula user groups.
  users          Manage nebula users.

For example the command below will list all Nebula apps:

nebulactl apps list