Browse code

further doc corrections/clarifications based on exercising *-ex; update .gitignore for .project; incorporate Ben's suggestions and Clayton's clarifications; general minor cleanup; fix typo

gabemontero authored on 2015/07/01 05:55:45
Showing 3 changed files
... ...
@@ -15,3 +15,4 @@
15 15
 origin.iml
16 16
 *.pyc
17 17
 .tag*
18
+.project
... ...
@@ -64,9 +64,45 @@ export PATH=$PATH:$GOPATH/bin
64 64
         $ git clone git://github.com/<forkid>/origin  # Replace <forkid> with the your github id
65 65
         $ cd origin
66 66
         $ git remote add upstream git://github.com/openshift/origin
67
-        
68 67
 
69
-5.  From here, you can follow https://github.com/openshift/origin/#start-developing[Start Developing] from the README.
68
+5.  From here, you can generate the OpenShift binaries by running:
69
+
70
+        $ make clean run
71
+
72
+6.  Next, assuming you have installed Docker 1.3.2 or higher, and that you have not changed the kubernetes/openshift service subnet configuration from the default value of 172.30.0.0/16, you need to instruct the Docker daemon to trust any Docker registry on the 172.30.0.0/16 subnet.  If you are running Docker as a service via `systemd`, add the `--insecure-registry 172.30.0.0/16` argument to the options value in `/etc/sysconfig/docker` and restart the Docker daemon.  Otherwise, add "--insecure-registry 172.30.0.0/16" to the Docker daemon invocation, eg:
73
+
74
+        $ docker -d --insecure-registry 172.30.0.0/16
75
+
76
+7.  Then, the OpenShift firewalld rules are also a work in progress. For now it is easiest to disable firewalld altogether:
77
+
78
+        $ sudo systemctl stop firewalld
79
+
80
+8.  Firewalld will start again on your next reboot, but you can manually restart it with this command when you are done running OpenShift:
81
+
82
+        $ sudo systemctl start firewalld
83
+
84
+9.  Now change into the directory with the OpenShift binaries, and start the OpenShift server:
85
+
86
+        $ cd _output/local/go/bin
87
+        $ sudo ./openshift start
88
+
89
+10.  Launch another terminal, change into the same directory you started OpenShift, and deploy the private docker registry within OpenShift with the following commands (note, the --credentials option allows secure communication between the internal OpenShift Docker registry and the OpenShift server, and the --config option provides your identity (in this case, cluster-admin) to the OpenShift server):
90
+
91
+        $ sudo chmod +r openshift.local.config/master/openshift-registry.kubeconfig
92
+        $ sudo chmod +r openshift.local.config/master/admin.kubeconfig
93
+        $ oadm registry --create --credentials=openshift.local.config/master/openshift-registry.kubeconfig --config=openshift.local.config/master/admin.kubeconfig
94
+
95
+11.  If it is not there already, add the current directory to the $PATH, so you can leverage the OpenShift commands elsewhere.
96
+
97
+12.  You are now ready to edit the OpenShift source, rebuild / restart OpenShift, and test your changes.
98
+
99
+13.  NOTE:  to properly stop OpenShift and clean up so you can restart OpenShift, execute:
100
+
101
+        $ sudo killall openshift
102
+        $ docker ps | awk 'index($NF,"k8s_")==1 { print $1 }' | xargs -l -r docker stop
103
+        $ mount | grep "openshift.local.volumes" | awk '{ print $3}' | xargs -l -r sudo umount
104
+        $ cd <to the dir you ran openshift start> ; sudo rm -rf openshift.local.*
105
+
70 106
 
71 107
 === Develop on virtual machine using Vagrant
72 108
 
... ...
@@ -57,6 +57,11 @@ The most recent container in that list should be the one that ran your build.  T
57 57
         
58 58
 Hopefully the logs will provide some indication of what it failed (e.g. failure to find the source repository, an actual build issue, failure to push the resulting image to the docker registry, etc).
59 59
 
60
+One issue seen somewhat often is not being able to resolve any hostname (for example github.com) from within running containers.  If this shows up in your build logs, restart docker and then resubmit a build:
61
+
62
+    $ sudo systemctl restart docker
63
+    $ oc start-build <your build identifier>
64
+
60 65
 Docker Registry
61 66
 ---------------
62 67