mayaserver

command module
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Mar 3, 2017 License: Apache-2.0 Imports: 5 Imported by: 0

README

Maya API Server (Work In Progress)

Maya exposes its APIs here

A service exposing Elastic Block Store i.e. EBS APIs, thus making openebs storage compatible with EBS APIs.

Use Cases

Serving EBS compatibility

Maya server adapts itself like an Amazon EBS server. This makes it super simple for operators and admins to get into the usage of OpenEBS without much of learning curve.

Note

This is very much a work in progress. Once the code base executes few of the mentioned features, the WIP tag will be removed.

Development of Mayaserver

These are some of the steps to start off with development.

  • git clone https://github.com/openebs/mayaserver.git
  • cd to above cloned folder i.e mayaserver
    • vagrant up
    • vagrant ssh
  • from within the vagrant VM run below steps:
    • make init
    • make
    • make release
    • To run the mayaserver at default bind address:
      • sudo nohup mayaserver up &>mserver.log &
    • To run the mayaserver at a particular bind address:
      • sudo nohup mayaserver up -bind=172.28.128.4 &>mserver.log &

Troubleshoot

  • Check if mayaserver is running ?
    • Watch out for the process with 5656 as the port
    • 5656 is the default tcp port on which mayaserver's services are exposed
# use netstat command
$ netstat -tnlp

(Not all processes could be identified, non-owned process info
 will not be shown, you would have to be root to see it all.)
Active Internet connections (only servers)
Proto Recv-Q Send-Q Local Address           Foreign Address         State       PID/Program name
tcp        0      0 0.0.0.0:22              0.0.0.0:*               LISTEN      -
tcp        0      0 127.0.0.1:5656          0.0.0.0:*               LISTEN      -
tcp6       0      0 :::22                   :::*                    LISTEN      -

# sudo will display the PID details
$ sudo netstat -tnlp

Active Internet connections (only servers)
Proto Recv-Q Send-Q Local Address           Foreign Address         State       PID/Program name
tcp        0      0 0.0.0.0:22              0.0.0.0:*               LISTEN      1258/sshd
tcp        0      0 127.0.0.1:5656          0.0.0.0:*               LISTEN      3078/mayaserver 
tcp6       0      0 :::22                   :::*                    LISTEN      1258/sshd

# use curl to check the services
curl http://$IP:5656/latest/meta-data/instance-id

Licensing

Mayaserver is completely open source and bears an Apache license. Mayaserver's core components and designs are a derivative of other open sourced libraries like Nomad and Kubernetes.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
lib
api
Package api contains the latest (or "internal") version of the Mayaserver API objects.
Package api contains the latest (or "internal") version of the Mayaserver API objects.
api/v1
Description provided at doc.go NOTE: There are references to Kubernetes (K8s) types & links.
Description provided at doc.go NOTE: There are references to Kubernetes (K8s) types & links.
orchprovider/nomad
This file transforms a Nomad scheduler as an orchestration platform for persistent volume placement.
This file transforms a Nomad scheduler as an orchestration platform for persistent volume placement.
volume
This file exposes volume plugin related contracts.
This file exposes volume plugin related contracts.
volume/jiva
This file provides the necessary implementation to establish jiva as a mayaserver volume plugin.
This file provides the necessary implementation to establish jiva as a mayaserver volume plugin.
util

Jump to

Keyboard shortcuts

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