|
...
|
...
|
@@ -1,22 +1,21 @@
|
|
1
|
|
-= Contributing to OpenShift v3
|
|
|
1
|
+= Contributing to OpenShift 3
|
|
2
|
2
|
OpenShift Developers <dev@lists.openshift.redhat.com>
|
|
3
|
3
|
:data-uri:
|
|
4
|
4
|
:icons:
|
|
5
|
5
|
:toc2:
|
|
6
|
6
|
:sectanchors:
|
|
7
|
7
|
|
|
8
|
|
-The OpenShift v3 architecture builds upon the flexibility and scalability of https://docker.com/[Docker] and https://github.com/GoogleCloudPlatform/kubernetes[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.
|
|
|
8
|
+The OpenShift 3 architecture builds upon the flexibility and scalability of https://docker.com/[Docker] and https://github.com/GoogleCloudPlatform/kubernetes[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.
|
|
9
|
9
|
|
|
10
|
10
|
== Prerequisites
|
|
11
|
|
-You can develop OpenShift v3 anywhere that you can run the following utilites:
|
|
|
11
|
+You can develop OpenShift 3 on Windows, Mac, or Linux, but you'll need Docker installed on Linux to actually launch containers.
|
|
12
|
12
|
|
|
13
|
|
-* The http://golang.org/[Go] programming language
|
|
14
|
|
-* The https://docker.com/[Docker] platform
|
|
15
|
|
-* The https://github.com/coreos/etcd[etcd] key-value store system
|
|
|
13
|
+* For OpenShift 3 development, install the http://golang.org/[Go] programming language
|
|
|
14
|
+* To launch containers, install the https://docker.com/[Docker] platform
|
|
16
|
15
|
|
|
17
|
16
|
Here's how to get set up:
|
|
18
|
17
|
|
|
19
|
|
-1. For Go and Docker, follow the links below to get to installation information for these tools: +
|
|
|
18
|
+1. For Go and optionally also Docker, follow the links below to get to installation information for these tools: +
|
|
20
|
19
|
** http://golang.org/doc/install[Installing Go]
|
|
21
|
20
|
** https://docs.docker.com/installation/#installation[Installing Docker]
|
|
22
|
21
|
2. Next, create a Go workspace directory: +
|
|
...
|
...
|
@@ -30,24 +29,20 @@ $ mkdir $HOME/go
|
|
30
|
30
|
export GOPATH=$HOME/go
|
|
31
|
31
|
export PATH=$PATH:$GOPATH/bin
|
|
32
|
32
|
----
|
|
33
|
|
-4. Now you can install `etcd` directly from GitHub: +
|
|
34
|
|
-+
|
|
35
|
|
-$ go get github.com/coreos/etcd
|
|
|
33
|
+4. Open up a new terminal or source the changes in your current terminal, and you're ready to code.
|
|
36
|
34
|
|
|
37
|
35
|
== Development: What's on the Menu?
|
|
38
|
|
-Right now you can see what's happening with Origin development in two repositories:
|
|
|
36
|
+Right now you can see what's happening with OpenShift development in two repositories:
|
|
39
|
37
|
|
|
40
|
|
-1. The Origin repo: https://github.com/openshift/origin[github.com/openshift/origin]
|
|
|
38
|
+1. The OpenShift Origin repo: https://github.com/openshift/origin[github.com/openshift/origin]
|
|
41
|
39
|
2. The OpenShift Kubernetes fork: https://github.com/openshift/kubernetes[github.com/openshift/kubernetes]
|
|
42
|
40
|
|
|
43
|
41
|
Here's a quick summary of what we're doing there:
|
|
44
|
42
|
|
|
45
|
|
-=== The Origin Repo
|
|
46
|
|
-The OpenShift team is developing tools that will optimize and extend Kubernetes to function as a next-generation https://www.youtube.com/watch?v=aZ40GobvA1c[Platform-as-a-Service] offering. This repo contains that instrumentation along with some script-based examples of the +openshift+ utility in action. Kubernetes is included as a set of dependencies for this code, meaning that _it is not necessary to download Kubernetes separately if you are only interested in Origin development_.
|
|
|
43
|
+=== The OpenShift Origin Repo
|
|
|
44
|
+This repo contains the OpenShift 3 https://www.youtube.com/watch?v=aZ40GobvA1c[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.
|
|
47
|
45
|
|
|
48
|
|
-*Hacking Origin:* +
|
|
|
46
|
+*Hacking OpenShift Origin:* +
|
|
49
|
47
|
To get started, https://help.github.com/articles/fork-a-repo[fork] the https://help.github.com/articles/fork-a-repo[origin repo] and then set up a local copy:
|
|
50
|
48
|
|
|
51
|
49
|
----
|
|
...
|
...
|
@@ -57,7 +52,7 @@ $ git remote rename origin upstream
|
|
57
|
57
|
$ git remote add origin git@github.com:<YOUR_GITHUB_USERNAME>/origin
|
|
58
|
58
|
----
|
|
59
|
59
|
|
|
60
|
|
-From here, you can follow the https://github.com/openshift/origin/#getting-started[Getting Started section] of the README for a brief tour of Origin v3 functionality, which includes single- and multi-container pod examples.
|
|
|
60
|
+From here, you can follow the https://github.com/openshift/origin/#getting-started[Getting Started section] of the README for a brief tour of OpenShift 3 functionality, which includes single- and multi-container pod examples.
|
|
61
|
61
|
|
|
62
|
62
|
Ready to play with some code? Hop down and read up on our link:#_the_roadmap[roadmap] for ideas on where you can contribute.
|
|
63
|
63
|
|
|
...
|
...
|
@@ -85,7 +80,7 @@ From there, head to the https://github.com/openshift/kubernetes#development[Deve
|
|
85
|
85
|
When you're ready to get your hands dirty, check out the roadmap info in the next section.
|
|
86
|
86
|
|
|
87
|
87
|
=== The Roadmap
|
|
88
|
|
-The OpenShift project roadmap lives https://trello.com/b/nlLwlKoz/openshift-origin-roadmap[on Trello]. Of particular interest to those who want to get involved with the OpenShift v3 architecture are the following topics:
|
|
|
88
|
+The OpenShift project roadmap lives https://trello.com/b/nlLwlKoz/openshift-origin-roadmap[on Trello]. Of particular interest to those who want to get involved with the OpenShift 3 architecture are the following topics:
|
|
89
|
89
|
|
|
90
|
90
|
* https://trello.com/c/uqNIamJi[Orchestration]
|
|
91
|
91
|
* https://trello.com/c/ja8bbQwy[Networking]
|