Skip to content

Latest commit

 

History

History
144 lines (96 loc) · 7.06 KB

CONTRIBUTING.adoc

File metadata and controls

144 lines (96 loc) · 7.06 KB
Raw

Contributing to OpenShift 3

Table of Contents

The OpenShift 3 architecture builds upon the flexibility and scalability of Docker and Kubernetes to deliver a powerful new Platform as a Service system. This article explains how to set up a development environment and get involved with this latest version of OpenShift.

There are multiple ways to start coding OpenShift.

Download from GitHub

The OpenShift team periodically publishes binaries to Github on the Releases page. These are Linux, Windows, or Mac OS X 64bit binaries (note that Mac and Windows are client only). You’ll need Docker installed on your local system (see the installation page if you’ve never installed Docker before).

The tar file for each platform contains a single binary openshift which is the all-in-one OpenShift installation.

  • Use sudo openshift start to launch the server. Root access is required to create services due to the need to modify IPTables. See issue: kubernetes/kubernetes#1859.

  • Use openshift kubectl -h <server> …​ to connect to an OpenShift server

  • Use openshift help to see more about the commands in the binary

Develop locally on your host

You can develop OpenShift 3 on Windows, Mac, or Linux, but you’ll need Docker installed on Linux to actually launch containers.

  • For OpenShift 3 development, install the Go programming language

  • To launch containers, install the Docker platform

Here’s how to get set up:

  1. For Go, Git and optionally also Docker, follow the links below to get to installation information for these tools:

  2. Next, create a Go workspace directory:

    $ mkdir $HOME/go

  3. In your .bashrc file or .bash_profile file, set a GOPATH and update your PATH:

    export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

  4. Open up a new terminal or source the changes in your current terminal, and you’re ready to code.

Develop on virtual machine using Vagrant

To facilitate rapid development we’ve put together a Vagrantfile you can use to stand up a development environment.

  1. Install Vagrant

  2. Clone the project and change into the directory:

    $ git clone git://github.com/openshift/origin
$ cd origin

  3. Bring up the VM:

    $ vagrant up

  4. SSH in:

    $ vagrant ssh

  5. Run a build (ssh puts you into the correct origin directory):

    $ hack/build-go.sh

  6. Start an OpenShift all-in-one server (includes everything you need to try OpenShift)

    $ openshift start
Tip
 In some cases (eg. after git pull), you might run make clean in the origin directory to clean up outdated compiled files.

Development: What’s on the Menu?

Right now you can see what’s happening with OpenShift development in two repositories:

  1. The OpenShift Origin repo: github.com/openshift/origin

  2. The OpenShift Kubernetes fork: github.com/openshift/kubernetes

Here’s a quick summary of what we’re doing there:

The OpenShift Origin Repo

This repo contains the OpenShift 3 Platform-as-a-Service, built on Kubernetes, along with some script-based examples of the openshift utility in action. Kubernetes is included in this repo for ease of development, and the version we include is periodically updated. In the future it will be possible to run OpenShift on top of an existing system.

Hacking OpenShift Origin:
To get started, fork the origin repo and then set up a local copy:

$ go get github.com/openshift/origin
$ cd $GOPATH/src/github.com/openshift/origin
$ git remote add <YOUR_GITHUB_USERNAME> git@github.com:<YOUR_GITHUB_USERNAME>/origin

From here, you can follow the Getting Started section of the README for a brief tour of OpenShift 3 functionality, which includes single and multi-container pod examples.

Ready to play with some code? Hop down and read up on our roadmap for ideas on where you can contribute.

The OpenShift Kubernetes Fork

The OpenShift team is using this fork of the Kubernetes project for two primary purposes:

  • As a staging area for pull requests to the upstream project

  • As a build area for Kubernetes that includes OpenShift-specific features that the upstream community does not want to add to the main project

If you are interested in contributing to Kubernetes directly:
Join the Kubernetes community and check out the contributing guide.

If you are more interested in the OpenShift-specific use of Kubernetes:
First, fork our fork of Kubernetes and make a local copy for yourself:

$ go get github.com/openshift/kubernetes
$ cd $GOPATH/src/github.com/openshift/kubernetes
$ git remote add <YOUR_GITHUB_USERNAME> git@github.com:<YOUR_GITHUB_USERNAME>/kubernetes

From there, head to the Development section of the README for general information on tinkering with Kubernetes.

When you’re ready to get your hands dirty, check out the roadmap info in the next section.

Troubleshooting

If you run into difficulties running OpenShift, start by reading through the troubleshooting guide.

The Roadmap

The OpenShift project roadmap lives on Trello. Of particular interest to those who want to get involved with the OpenShift 3 architecture are the following topics:

These link to active and backlog tasks that the OpenShift team is planning or working on for Kubernetes development.

Stay in Touch

Reach out to the OpenShift team and other community contributors through IRC and our mailing list: