Skip to content

oah shell commands

Vinod Panicker edited this page Jun 7, 2017 · 9 revisions

A Shell for OPENAPPHACK (OAH).

The oah shell commands are :

On client Machines

oah --version // list the oah-shell version

oah list // listing of available environments (envs) i.e vm/cluster

oah install [option(-d,-s)] {envname} // install an new environment on oah-vm 

~~ps -v vagrant option is not available for clients , -d or -c will be used depending on the container to be used with oah in future.~~

oah use {envname} // set the current env

oah show [cluster|vm|roles] // show current env/user as well as all the envs installed on the client 


- cluster: nodes of the cluster
- vm : oah-vm installed on the machine
- roles : for oah-roles installed on localhost

oah status [cluster|vm|roles]//status of the vm/nodes in a cluster

- cluster: nodes of the cluster
- vm : oah-vm installed on the machine
- roles : for oah-roles installed on localhost

oah validate {envname} //validate the instance for image identified by envname

oah reset {envname} // reset machine to fresh current env installation

oah remove {envname} // remove the current env and rollback to default oah-vm 

oah update // do a provision of vm

oah selfupdate // update oah-shell to later version

On host machines

oah --version 
// list the oah-shell version

oah list // listing the vm/cluster

oah install [option(-v,-d,-s)] {envname} // vagrant provision

-v vagrant (default)// will be used for testing and creation of cluster
-d docker  (to be added in future after alongwith or instead of runc)// for testing and creating of docker swarms
-s standalone machine (bare bone) / will make use of localhost as inventory


oah show [cluster|vm|roles] //show all the current envs on the host

- cluster: cluster this vm is a node to
- vm : current oah-vm installed on the machine
- roles : for oah-roles installed on localhost


oah status //status of env i.e current status of vm/nodes in a cluster

- cluster: nodes of the cluster
- vm : oah-vm installed on the machine
- roles : for oah-roles installed on localhost

oah up // start a vm/cluster equivalent up

oah halt // destroying a vm

oah destroy // destroying a vm

oah remove {envname} // remove the current env and rollback to default oah-vm 

Few additional OAH Meta Commands

oah create-new-env {envname}

oah create-new-role {rolename}

oah create-new-cluster {clustername}

oah push 

oah remove 

oah pr

oah publish {[role|env|cluster]} 

Clone this wiki locally