janna-api

module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2018 License: MIT

README

janna-api

Janna provides a REST API interface for some VMware/vSphere functions. Like deploy Virtual Machnine from OVA, manage snapshots.

Quick start

  • Choose a docker tag
  • Pull image docker pull vterdunov/janna-api:<tag>
  • Pass desired environment variables using --env or --env-file directives. And run it:
docker run -d --name=janna-api --env-file=envfile vterdunov/janna-api:<tag>

Configuration

Janna accept environment variables as its config.
See available environment variables examples in .env.example. E.g.:

export VMWARE_URL=username:password@vsphere.address.com
export VMWARE_INSECURE=1
export VMWARE_DATACENTER=DC1
export VMWARE_FOLDER=DevVMs

Development

  • Copy cp .env.example .env and change env file.

  • Compile and Run

make start

or using Docker and Docker Compose

make dc

API docs

See OpenAPI file

Directories

Path Synopsis
cmd
internal
endpoint
nolint: dupl
nolint: dupl
status
status used to add and get information such as current deploy progress, deploy error messages, etc.
status used to add and get information such as current deploy progress, deploy error messages, etc.
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL