kubernetes 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +228 -0
  3. metadata +45 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a0ddd0473607bd2d2156094bac09c6fe20e45c13
4
+ data.tar.gz: e099266b4c4ab18e148958c6deed8d48bb30fe9b
5
+ SHA512:
6
+ metadata.gz: 2ebc86e727d3aaa8e261aaaf4d3e4c59b4116e221e3ec9fd05072589d8e8224d8303ca050df864f249e6b885fcafc028e98373ac49dda4142bcadcb32162935a
7
+ data.tar.gz: 478322427cf293073197f582e44f0b12dbb44ef2fcc6891ce4005cc42d65ca9a8864d59dfa05a21b2ad0ea38eb305428ec0c08d8ff655267ca3f76f9fb04034f
data/README.md ADDED
@@ -0,0 +1,228 @@
1
+ # Kubernetes
2
+ Kubernetes is an open source implementation of container cluster management.
3
+
4
+ [Kubernetes Design Document](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/DESIGN.md) - [Kubernetes @ Google I/O 2014](http://youtu.be/tsk0pWf4ipw)
5
+
6
+ [![GoDoc](https://godoc.org/github.com/GoogleCloudPlatform/kubernetes?status.png)](https://godoc.org/github.com/GoogleCloudPlatform/kubernetes)
7
+ [![Travis](https://travis-ci.org/GoogleCloudPlatform/kubernetes.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/kubernetes)
8
+
9
+
10
+ ## Kubernetes can run anywhere!
11
+ However, initial development was done on GCE and so our instructions and scripts are built around that. If you make it work on other infrastructure please let us know and contribute instructions/code.
12
+
13
+ ## Kubernetes is in pre-production beta!
14
+ While the concepts and architecture in Kubernetes represent years of experience designing and building large scale cluster manager at Google, the Kubernetes project is still under heavy development. Expect bugs, design and API changes as we bring it to a stable, production product over the coming year.
15
+
16
+ ### Contents
17
+ * Getting Started Guides
18
+ * [Google Compute Engine](docs/getting-started-guides/gce.md)
19
+ * [Vagrant](docs/getting-started-guides/vagrant.md)
20
+ * [Locally](docs/getting-started-guides/locally.md)
21
+ * [CoreOS](docs/getting-started-guides/coreos.md)
22
+ * Fedora (w/ [Ansible](docs/getting-started-guides/fedora/fedora_ansible_config.md) or [manual](docs/getting-started-guides/fedora/fedora_manual_config.md))
23
+ * [vSphere](docs/getting-started-guides/vsphere.md)
24
+ * [Microsoft Azure](docs/getting-started-guides/azure.md)
25
+ * [Rackspace](docs/getting-started-guides/rackspace.md)
26
+ * [Circle CI](https://circleci.com/docs/docker#google-compute-engine-and-kubernetes)
27
+ * [Digital Ocean](https://github.com/bketelsen/coreos-kubernetes-digitalocean)
28
+ * [OpenStack](https://developer.rackspace.com/blog/running-coreos-and-kubernetes/)
29
+ * [kubecfg command line tool](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/cli.md)
30
+ * [Kubernetes API Documentation](http://cdn.rawgit.com/GoogleCloudPlatform/kubernetes/31a0daae3627c91bc96e1f02a6344cd76e294791/api/kubernetes.html)
31
+ * [Kubernetes Client Libraries](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/client-libraries.md)
32
+ * [Discussion and Community Support](#community-discussion-and-support)
33
+ * [Hacking on Kubernetes](#development)
34
+ * [Hacking on Kubernetes Salt configuration](docs/salt.md)
35
+
36
+ ## Where to go next?
37
+
38
+ Check out examples of Kubernetes in action, and community projects in the larger ecosystem:
39
+
40
+ * [Detailed example application](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/examples/guestbook/README.md)
41
+ * [Example of dynamic updates](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/examples/update-demo/README.md)
42
+ * [Cluster monitoring with heapster and cAdvisor](https://github.com/GoogleCloudPlatform/heapster)
43
+ * [Community projects](https://github.com/GoogleCloudPlatform/kubernetes/wiki/Kubernetes-Community)
44
+
45
+ Or fork and start hacking!
46
+
47
+ ## Community, discussion and support
48
+
49
+ If you have questions or want to start contributing please reach out. We don't bite!
50
+
51
+ The Kubernetes team is hanging out on IRC on the [#google-containers room on freenode.net](http://webchat.freenode.net/?channels=google-containers). We also have the [google-containers Google Groups mailing list](https://groups.google.com/forum/#!forum/google-containers).
52
+
53
+ If you are a company and are looking for a more formal engagement with Google around Kubernetes and containers at Google as a whole, please fill out [this form](https://docs.google.com/a/google.com/forms/d/1_RfwC8LZU4CKe4vKq32x5xpEJI5QZ-j0ShGmZVv9cm4/viewform). and we'll be in touch.
54
+
55
+ ## Development
56
+
57
+ ### Go development environment
58
+
59
+ Kubernetes is written in [Go](http://golang.org) programming language. If you haven't set up Go development environment, please follow [this instruction](http://golang.org/doc/code.html) to install go tool and set up GOPATH. Ensure your version of Go is at least 1.3.
60
+
61
+ ### Put kubernetes into GOPATH
62
+
63
+ We highly recommend to put kubernetes' code into your GOPATH. For example, the following commands will download kubernetes' code under the current user's GOPATH (Assuming there's only one directory in GOPATH.):
64
+
65
+ ```
66
+ $ echo $GOPATH
67
+ /home/user/goproj
68
+ $ mkdir -p $GOPATH/src/github.com/GoogleCloudPlatform/
69
+ $ cd $GOPATH/src/github.com/GoogleCloudPlatform/
70
+ $ git clone git@github.com:GoogleCloudPlatform/kubernetes.git
71
+ ```
72
+
73
+ The commands above will not work if there are more than one directory in ``$GOPATH``.
74
+
75
+ (Obviously, clone your own fork of Kubernetes if you plan to do development.)
76
+
77
+ ### godep and dependency management
78
+
79
+ Kubernetes uses [godep](https://github.com/tools/godep) to manage dependencies. It is not strictly required for building Kubernetes but it is required when managing dependencies under the Godeps/ tree, and is required by a number of the build and test scripts. Please make sure that ``godep`` is installed and in your ``$PATH``.
80
+
81
+ #### Installing godep
82
+ There are many ways to build and host go binaries. Here is an easy way to get utilities like ```godep``` installed:
83
+
84
+ 1. Ensure that [mercurial](http://mercurial.selenic.com/wiki/Download) is installed on your system. (some of godep's dependencies use the mercurial
85
+ source control system). Use ```apt-get install mercurial``` or ```yum install mercurial``` on Linux, or [brew.sh](http://brew.sh) on OS X, or download
86
+ directly from mercurial.
87
+ 2. Create a new GOPATH for your tools and install godep:
88
+ ```
89
+ export GOPATH=$HOME/go-tools
90
+ mkdir -p $GOPATH
91
+ go get github.com/tools/godep
92
+ ```
93
+
94
+ 3. Add $GOPATH/bin to your path. Typically you'd add this to your ~/.profile:
95
+ ```
96
+ export GOPATH=$HOME/go-tools
97
+ export PATH=$PATH:$GOPATH/bin
98
+ ```
99
+
100
+ #### Using godep
101
+ Here is a quick summary of `godep`. `godep` helps manage third party dependencies by copying known versions into Godep/_workspace. You can use `godep` in three ways:
102
+
103
+ 1. Use `godep` to call your `go` commands. For example: `godep go test ./...`
104
+ 2. Use `godep` to modify your `$GOPATH` so that other tools know where to find the dependencies. Specifically: `export GOPATH=$GOPATH:$(godep path)`
105
+ 3. Use `godep` to copy the saved versions of packages into your `$GOPATH`. This is done with `godep restore`.
106
+
107
+ We recommend using options #1 or #2.
108
+
109
+ ### Hooks
110
+
111
+ Before committing any changes, please link/copy these hooks into your .git
112
+ directory. This will keep you from accidentally committing non-gofmt'd go code.
113
+
114
+ **NOTE:** The `../..` part seems odd but is correct, since the newly created
115
+ links will be 2 levels down the tree.
116
+
117
+ ```
118
+ cd kubernetes
119
+ ln -s ../../hooks/prepare-commit-msg .git/hooks/prepare-commit-msg
120
+ ln -s ../../hooks/commit-msg .git/hooks/commit-msg
121
+ ```
122
+
123
+ ### Unit tests
124
+
125
+ ```
126
+ cd kubernetes
127
+ hack/test-go.sh
128
+ ```
129
+
130
+ Alternatively, you could also run:
131
+
132
+ ```
133
+ cd kubernetes
134
+ godep go test ./...
135
+ ```
136
+
137
+ If you only want to run unit tests in one package, you could run ``godep go test`` under the package directory. For example, the following commands will run all unit tests in package kubelet:
138
+
139
+ ```
140
+ $ cd kubernetes # step into kubernetes' directory.
141
+ $ cd pkg/kubelet
142
+ $ godep go test
143
+ # some output from unit tests
144
+ PASS
145
+ ok github.com/GoogleCloudPlatform/kubernetes/pkg/kubelet 0.317s
146
+ ```
147
+
148
+ ### Coverage
149
+ ```
150
+ cd kubernetes
151
+ godep go tool cover -html=target/c.out
152
+ ```
153
+
154
+ ### Integration tests
155
+
156
+ You need an etcd somewhere in your PATH. To install etcd, run:
157
+
158
+ ```
159
+ cd kubernetes
160
+ hack/install-etcd.sh
161
+ sudo ln -s $(pwd)/third_party/etcd/bin/etcd /usr/bin/etcd
162
+ ```
163
+
164
+ ```
165
+ cd kubernetes
166
+ hack/test-integration.sh
167
+ ```
168
+
169
+ ### End-to-End tests
170
+
171
+ You can run an end-to-end test which will bring up a master and two minions, perform some tests, and then tear everything down. Make sure you have followed the getting started steps for your chosen cloud platform (which might involve changing the `KUBERNETES_PROVIDER` environment variable to something other than "gce".
172
+ ```
173
+ cd kubernetes
174
+ hack/e2e-test.sh
175
+ ```
176
+
177
+ Pressing control-C should result in an orderly shutdown but if something goes wrong and you still have some VMs running you can force a cleanup with the magical incantation:
178
+ ```
179
+ hack/e2e-test.sh 1 1 1
180
+ ```
181
+
182
+ ### Testing out flaky tests
183
+ [Instructions here](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/flaky-tests.md)
184
+
185
+ ### Add/Update dependencies
186
+
187
+ Kubernetes uses [godep](https://github.com/tools/godep) to manage dependencies. To add or update a package, please follow the instructions on [godep's document](https://github.com/tools/godep).
188
+
189
+ To add a new package ``foo/bar``:
190
+
191
+ - Download foo/bar into the first directory in GOPATH: ``go get foo/bar``.
192
+ - Change code in kubernetes to use ``foo/bar``.
193
+ - Run ``godep save ./...`` under kubernetes' root directory.
194
+
195
+ To update a package ``foo/bar``:
196
+
197
+ - Update the package with ``go get -u foo/bar``.
198
+ - Change code in kubernetes accordingly if necessary.
199
+ - Run ``godep update foo/bar``.
200
+
201
+ ### Keeping your development fork in sync
202
+
203
+ One time after cloning your forked repo:
204
+
205
+ ```
206
+ git remote add upstream https://github.com/GoogleCloudPlatform/kubernetes.git
207
+ ```
208
+
209
+ Then each time you want to sync to upstream:
210
+
211
+ ```
212
+ git fetch upstream
213
+ git rebase upstream/master
214
+ ```
215
+
216
+ ### Regenerating the API documentation
217
+
218
+ ```
219
+ cd kubernetes/api
220
+ sudo docker build -t kubernetes/raml2html .
221
+ sudo docker run --name="docgen" kubernetes/raml2html
222
+ sudo docker cp docgen:/data/kubernetes.html .
223
+ ```
224
+
225
+ View the API documentation using htmlpreview (works on your fork, too):
226
+ ```
227
+ http://htmlpreview.github.io/?https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/kubernetes.html
228
+ ```
metadata ADDED
@@ -0,0 +1,45 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kubernetes
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Riccardo Carlesso
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2010-09-21 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: Currently a placeholder. In the future, a Gem to get up to speed with
14
+ Kubernetes
15
+ email: palladiusbonton@gmail.com
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files: []
19
+ files:
20
+ - README.md
21
+ homepage: http://rubygems.org/gems/kubernetes
22
+ licenses:
23
+ - Apache License
24
+ metadata: {}
25
+ post_install_message:
26
+ rdoc_options: []
27
+ require_paths:
28
+ - lib
29
+ required_ruby_version: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ! '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ required_rubygems_version: !ruby/object:Gem::Requirement
35
+ requirements:
36
+ - - ! '>='
37
+ - !ruby/object:Gem::Version
38
+ version: '0'
39
+ requirements: []
40
+ rubyforge_project:
41
+ rubygems_version: 2.3.0
42
+ signing_key:
43
+ specification_version: 4
44
+ summary: Kubernetes Gemfile
45
+ test_files: []