Welcome to the instructions for running OpenShift Origin , the FOSS PaaS from Red Hat, in a local VM on your machine. On this page you will find instructions on how to use Minishift for local application development with OpenShift.

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.

Install instructions

Please follow the instructions for installing Minishift. Be aware that Minishift is currently in Beta and will be changing rapidly. The Minishift maintainers also appreciate GitHub Issues when you find problems.

We, the OpenShift Evangelists, also have some suggestions that we have found helpful:

  • When you start Minishift for the first time, a configuration file for the VM is placed in a .minishift directory in your home directory. This configuration will be used to create characteristics of the VM, such as memory or CPUs, that lasts until you do
    minishift delete
    We recommend the first time you run Minishift, you pass in the memory and CPUs you want to give to the VM. For example
    minishift start --memory 12048 --cpus 3
    starts a VM with ~12 gigs of RAM and 3 vCPUs. The full list of flags are described here
  • For Windows Users there are still some rough spots:
    1. Hyper-V, the default on Windows, will not work if other virtualization technology is installed. If you want to use VirtualBox your command would look like:
      minishift.exe start --vm-driver virtualbox
    2. If you have already installed Docker Engine, Minishift will grab the VirtualSwitch for Docker Engine as it's network interface. This may or may not work for network access. If it does not work then you will not be able to complete the Minishift installation. To correct this:
      1. execute
        minishift stop
      2. make a new External VirtualSwitch in the Hyper-V console and assign it to the Minishift VM
      3. execute
        minishift start
    3. When you run Minishift from PowerShell, you may need to add your user to the Hyper-V Admin Group or you will have to run PowerShell as an administrator. Here are instructions on how to add your account to the Hyper-V administrator group from the command line. Follow these steps to do it from the GUI:
      • Windows key and then Computer Management
      • Local Users And Groups -> Groups
      • Double click on the Hyper-V admin group
      • Add your account to that group.
      • You have to log out and log in before the changes will take affect.

The old Vagrant based all in one has been retired and is no longer supported. Due to instability in Vagrant builds it became impossible to maintain and troubleshoot the all in one. The old versions are still on Atlas, with instructions here, but are not supported.

Intended Use

This VM is intended for local development on top of OpenShift. It is not intended to be used in production. There is no official support for this image, support is community based and best effort (but we care a lot about you and your happiness).
If you need a supported VM version running on Red Hat Enterprise Linux with OpenShift Container Platform, please use the Container Development Kit (CDK).

WARNING: To allow developers to use any Docker image they want, turning off some security in OpenShift is required. 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.