Welcome to the all-in-one VM for OpenShift Origin , the FOSS PaaS from Red Hat. On this page you will find links to download:

 

  • A Vagrant VirtualBox VM
  • OpenShift client tools (oc) that match the release
  • A document to help you run through some of the basic steps to exercise this image

 

This image is based off of OpenShift Origin and is a fully functioning OpenShift instance with an integrated Docker registry. The intent of this project is to allow Web developers and other interested parties to run OpenShift V3 on their own computer. Given the way it is configured, the VM will appear to your local machine as if it was running somewhere off the machine.

If you are looking for an image that matches the current version of OpenShift Online please go to the instructions for the 1.2 origin image.

This VM is built using the tools and scripts found in this Github repository. This VM is built by the OpenShift Evangelists so they can:

  1. Have a method to try out developer builds before they are released
  2. Track the latest version of Origin
  3. Provide a VM Evangelists or others can use for Workshop and demos, emphasizing ease of use for the user and the least dependencies
  4. As a means to carry out local development for projects that will eventually be deployed to an OpenShift cluster

There are other free means to get OpenShift installed on your development machine:

  1. If you want to get OpenShift Container Platform on RHEL - which means only released products rather than upstream software, you should use the Red Hat Container Development Kit (CDK). This is a maintained product with a large development team behind it.
  2. If you don't installing OpenShift into your local Docker engine, we highly reccomend "oc cluster up". The basic idea is you download the client tools from down below and then execute the command "oc cluster up". The command then proceeds to download all the Container Images required to run OpenShift and sets them up on your local machine. For more information you can do "oc cluster up -h"

     

    The OpenShift Master, Node, Docker Registry, Metrics, Cockpit, and other pieces are running in one VM. Given it's focus on application developers, it should NOT be used in production. While the Vagrantfile only specifies 4 gigs of RAM, you can edit the file to increase or decrease this setting depending on how many containers you want to run in your instance.

     

    WARNING: We wanted to allow developers to use any Docker image they want, which required us turning off some security in OpenShift. By default, OpenShift will not allow a container to run as root or even a non-random container assigned userid. Most Docker images in the Dockerhub do not follow this best practice and instead run as root. As a double negative, a large majority of Dockerhub images are not patched for well known vulnerabilities. Therefore, please use images from Dockerhub with caution. We think some of the risk is mitigated because you are running OpenShift in a VM, but still - be careful which Docker images you run.

     

    NOTE: As this is based off the Origin project and not the commercial OpenShift Enterprise product, support is limited to community effort.

     

    Install instructions
    After you have installed Vagrant and VirtualBox, please:
    Easiest instructions

    1. Go to an empty directory
    2. In the directory, at the command line, run
      $ vagrant init openshift/origin-all-in-one
    3. Optional You can edit the generated Vagrantfile to give your machine more resources
    4. Then run
      $ vagrant up --provider=virtualbox

     

    Updating previous versions

    1. Go to the directory where you previously ran
      $ vagrant up
    2. Run the following command
      $ vagrant box update --box openshift/origin-all-in-one
    3. You need to destroy and create the environment again
    4. $ vagrant destroy --force 
    5. $ vagrant up --provider=virtualbox 

     

    Uninstall
    To remove a previous installation please do the following commands:

    1. Change to the directory with your Vagrantfile
    2. $ vagrant halt
    3. $ vagrant destroy --force
    4. $ vagrant box remove --force openshift/origin-all-in-one
    5. Follow the normal installation instructions if you want to re-install

Downloads

Required files:

  • Vagrant (may also be offered in your distro) - We have tested with 1.7.2, 1.7.4. Right now we are seeing a BAD SSH bug with 1.8.5, please get Vagrant 1.8.4
  • VirtualBox (again, may be offered in your distro) - We have tested with 4.3.30, 5.0.4. Do NOT get 5.1.x as that does NOT work with Vagrant yet. We would love to get feedback on newer versions.

 

Client tools (scroll down after clicking the link to get the client downloads):

Feedback

Please send any and all feedback to TheSteve0, but please note this is not an "officially supported" product.

 

You can also come chat about it in IRC at FreeNode, #openshift channel with thesteve0 or jmorales