README
¶
Oshinko Cli
Command line interface for spark cluster management application.
Oshinko Application
The Oshinko application manages Apache Spark clusters on OpenShift. The application consists of a REST server (Oshinko-rest) and a web UI. It is designed to run in an OpenShift project. This repository contains tools to launch the Oshinko application
Using the Oshinko CLI
The easiest way to get started using the Oshinko CLI is to use a release version which can be found here. There are releases for linux32 or 64 and MacOS. To use a release either untar/unzip the precompiled Oshinko binary and use this to call commands to create, delete or modify clusters.
oshinko <command>
Creating a cluster
To create an oshinko cluster through the cli you use the command create
oshinko create <cluster name>
Deleting a cluster
To delete a cluster you use the delete command:
oshinko delete <name of cluster>
Scaling a cluster
You may need to scale a cluster out to provide more resources or scale down to save money to do this you can use the command:
oshinko scale <name of cluster> [options]
Options include scaling the number of masters or workers.
Further reading
For a full set of commands and parameters please use:
oshinko help
Please see the CONTRIBUTING.md and HACKING.md docs for more information about working with this codebase and the docs directory for more general information on usage.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
core
|
|
|
pkg
|
|
|
apis/radanalytics.io/v1
+k8s:deepcopy-gen=package +groupName=radanalytics.io
|
+k8s:deepcopy-gen=package +groupName=radanalytics.io |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/radanalytics.io/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/radanalytics.io/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
rest
|
|
|
helpers/errors
Package errors contains primitives for working with oshinko errors easier.
|
Package errors contains primitives for working with oshinko errors easier. |
|
helpers/flags
Package flags provides helper functions for accessing command line flags.
|
Package flags provides helper functions for accessing command line flags. |
|
helpers/logging
Package logging provides primitives for configuring and creating logs.
|
Package logging provides primitives for configuring and creating logs. |
|
helpers/uuid
Package uuid provides a function for creating version 4 uuid strings
|
Package uuid provides a function for creating version 4 uuid strings |
|
restapi
Package restapi Oshinko REST Server
|
Package restapi Oshinko REST Server |