Go to file
dlorenc 081a1851dd Update .gitignore and integration test for new build locations. 2016-05-04 14:31:32 -07:00
Godeps added localkube and dependencies 2016-05-04 01:54:00 -07:00
cli added localkube and dependencies 2016-05-04 01:54:00 -07:00
cmd added localkube and dependencies 2016-05-04 01:54:00 -07:00
integration Update .gitignore and integration test for new build locations. 2016-05-04 14:31:32 -07:00
k2s added localkube and dependencies 2016-05-04 01:54:00 -07:00
localkube added localkube and dependencies 2016-05-04 01:54:00 -07:00
vendor added localkube and dependencies 2016-05-04 01:54:00 -07:00
.cobra.yaml Initial commit of CLI using cobra scaffolding. 2016-04-18 10:40:41 -07:00
.gitignore Update .gitignore and integration test for new build locations. 2016-05-04 14:31:32 -07:00
.travis.yml Fix files with missing copyright headers. 2016-05-02 12:02:16 -07:00
CONTRIBUTING.md Add CONTRIBUTING.md 2016-04-25 10:42:07 -07:00
LICENSE Update License file 2016-04-15 15:44:00 -07:00
README.md updated README for new minikube build path 2016-05-04 11:31:27 -07:00
build.sh added localkube and dependencies 2016-05-04 01:54:00 -07:00
godep.sh updated .gitignore and added comment explaining vendoring patch 2016-05-04 02:24:07 -07:00
test.sh Fix files with missing copyright headers. 2016-05-02 12:02:16 -07:00

README.md

Minikube

Run Kubernetes locally

Build Status

Background

Minikube is a tool that makes it easy to run Kubernetes locally. Minikube runs a single-node Kubernetes cluster inside a VM on your laptop for users looking to try out Kubernetes or develop with it day-to-day.

Design

Minikube uses libmachine for provisioning VMs, and localkube for running the cluster.

For more information about minikube, see the proposal.

Goals

  • Works across multiple OSes - OS X, Linux and Windows primarily.
  • Single command setup and teardown UX.
  • Unified UX across OSes
  • Minimal dependencies on third party software.
  • Minimal resource overhead.
  • Replace any other alternatives to local cluster deployment.

Non Goals

  • Simplifying kubernetes production deployment experience. Kube-deploy is attempting to tackle this problem.
  • Supporting all possible deployment configurations of Kubernetes like various types of storage, networking, etc.

Build Instructions

./build.sh

Run Instructions

Start the cluster with:

$ ./out/minikube start
Starting local Kubernetes cluster...
2016/04/19 11:41:26 Machine exists!
2016/04/19 11:41:27 Kubernetes is available at http://192.168.99.100:8080.
2016/04/19 11:41:27 Run this command to use the cluster: 
2016/04/19 11:41:27 kubectl config set-cluster minikube --insecure-skip-tls-verify=true --server=http://192.168.99.100:8080

Access the cluster by adding -s=http://192.168.x.x:8080 to every kubectl command, or run the commands below:

kubectl config set-cluster minikube --insecure-skip-tls-verify=true --server=http://192.168.99.100:8080
kubectl config set-context minikube --cluster=minikube
kubectl config use-context minikube

by running those commands, you may use kubectl normally

Development

See CONTRIBUTING.md for an overview of how to send pull requests.

Running Tests

Unit Tests

Unit tests are run on Travis before code is merged. To run as part of a development cycle:

./test.sh

Integration Tests

Integration tests are currently run manually. To run them, build the binary and run the tests:

./build.sh
go test ./integration --tags=integration