Package: powershift-cli
This package provides a pluggable command line client calledpowershift, for working with OpenShift. It acts as a wrapper around
theoccommand line client for OpenShift, providing an easier to use
interface for using selected features of theocclient.In particular,powershiftprovides a plugin which wraps theoc cluster upcommand, used for starting up a local OpenShift cluster using
your local Docker service. This plugin builds on top ofoc cluster up,
to provide profiles, additional security, application persistence and
provisioning for persistent volumes.System RequirementsThis package can be used on MacOS X, Windows and Linux.The package requires the Python language interpreter to be available on
your system. You need to have available Python 2.7, 3.3, 3.4, 3.5 or 3.6,
and will need to have the Python package installerpipinstalled. It is
also recommended that you havevirtualenvavailable and usepipsito install the package into an isolated Python virtual environment. The use
ofpipsiensures that installing the package does not affect your
system Python installation.As thepowershiftclient is a wrapper aroundoc, you need to have
theocprogram for the version of OpenShift you wish to use installed
and available in yourPATH. If you do not already haveocinstalled, thepowershiftclient can help you with it’s installation.Versions ofocfor OpenShift Origin, whichpowershifthas been
tested with are 1.3.2, 1.3.3 and 1.4.0. If using Red Hat OpenShift
Container Platform, you need to have a minimum of version 3.4.0 of theoctool and your system must have access to the Red Hat registry
associated with your Red Hat subscription.Docker installation types which can be used are Docker for Mac, Docker for
Windows or Docker running natively on Linux. You cannot use a Docker
instance configured usingdocker-machine, or the older means of running
Docker on MacOSX based onboot2docker.Installing ‘powershift’It is recommend that you usepipsito installpowershift. This
ensures that it and any Python packages it requires are installed into a
self contained Python virtual environment and will not interfere with any
other Python based applications installed on your system.For the most up to date instructions on how to first installpipsisee:https://pypi.python.org/pypi/pipsiThe recommended way to installpipsiis to run:curl https://raw.githubusercontent.com/mitsuhiko/pipsi/master/get-pipsi.py | pythonThis command will installpipsiand then output the directory which you
should add to yourPATHso that it and any script packages installed
usingpipsican be found.Oncepipsiis installed and in yourPATH, to install this package,
along with currently available plugins, run:pipsi install powershift-cli[all]Additional plugins which are installed will be:powershift-cluster- Adds command providing a layer around theoc cluster upcommand for running a local OpenShift instance with Docker.
These make it easier to manage a local OpenShift cluster, including
default support for application persistence across restarts, multiple
profiles, added security, default persistent volumes, and tools for
adding additional persistent volumes to the local OpenShift cluster.If you are happy to install this package directly into your main Python
installation or have an existing Python virtual environment, you can
instead run:pip install powershift-cli[all]If necessary, run this as root usingsudo, when installing into your
system Python installation.Additional Python packages installed by this package and current plugins
areclickandpasslib.Installing ‘oc’ clientIf you have theocprogram installed already, ensure it is installed
somewhere on your defaultPATH.If you do not yet have theocprogram installed, you can install it
using thepowershiftprogram.As the first step run:powershift client versionsThis will list what versions of theocprogram for OpenShift Origin
the script knows about. You can then install one of these versions.
For example:powershift client install v1.4.0The platform you are using will be automatically detected and the
appropriate binary downloaded and installed. For Linux, only 64 bit
platforms are supported using this command.The output of this command will provide the directory you should then add
to yourPATH.If you would rather have it install theocprogram into an existing
directory already in yourPATH, you can instead use the--bindiroption to specify the directory to install into. For example:powershift client install v1.4.0 --bindir $HOME/binCommand line helpExecuting the command with no arguments will provide a list of the
command groups available.$ powershift
Usage: powershift [OPTIONS] COMMAND [ARGS]...

  PowerShift client for OpenShift.

  This client provides additional functionality useful to users of the
  OpenShift platform. Base functionality is minimal, but can be extended by
  installing additional plugins.

  For more details see:

      https://github.com/getwarped/powershift

Options:
  --help  Show this message and exit.

Commands:
  client      Install/update oc command line tool.
  completion  Output completion script for specified shell.
  console     Open a browser on the OpenShift web console.
  server      Displays the URL for the OpenShift cluster.
  session     Display information about current session.This only shows command groups included with the base package. When you
install additional plugins, the command groups they add will also be shown.You can use the--helpoption with any command group or specific
command to get additional details.Bash shell completionTo enablebashcompletion, runpowershift completion bash--helpand follow the instructions.