The Kubernetes Package Manager
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Matt Butcher e8aa841651
docs(README): update README in light of merger
9 years ago
cmd ref(repo): update import path 9 years ago
docs fix(*): update import paths for helm repo naming 9 years ago
examples Restore #290 9 years ago
expansion Add flake8 test and fix pep8 style in expansion scripts 9 years ago
hack fix(*): update import paths for helm repo naming 9 years ago
pkg ref(client): separate deployments from client file 9 years ago
rootfs fix(*): verify $DOCKER_PROJECT is set if using gcr 9 years ago
scripts ref(devtools): rename start.sh to start-local.sh 9 years ago
.gitignore feat(testcov): add a test coverage helper script 9 years ago
CONTRIBUTING.md doc(CONTRIBUTING): modify the procedural aspects 9 years ago
LICENSE Initial commit for DeploymentManager on k8s. 9 years ago
MAINTAINERS.md doc(CONTRIBUTING): modify the procedural aspects 9 years ago
Makefile fix(manager): refactor REST API to make it modular 9 years ago
README.md docs(README): update README in light of merger 9 years ago
circle.yml fix(*): update import paths for helm repo naming 9 years ago
get-install.sh fixing shell variable references 9 years ago
glide.lock fix(manager): add API test for healthz. 9 years ago
glide.yaml fix(*): update import paths for helm repo naming 9 years ago

README.md

Helm

Circle CI Go Report Card

Helm makes it easy to create, describe, update and delete Kubernetes resources using declarative configuration. A configuration is just a YAML file that configures Kubernetes resources or supplies parameters to templates.

Helm Manager runs server side, in your Kubernetes cluster, so it can tell you what templates you've instantiated there, what resources they created, and even how the resources are organized. So, for example, you can ask questions like:

  • What Redis instances are running in this cluster?
  • What Redis master and slave services are part of this Redis instance?
  • What pods are part of this Redis slave?

Please hang out with us in the Slack chat room.

Installing Helm

Note: if you're exploring or using the project, you'll probably want to pull (the latest release)[https://github.com/kubernetes/helm/releases/latest], since there may be undiscovered or unresolved issues at HEAD.

From a Linux or Mac OS X client:

$ git clone https://github.com/kubernetes/deployment-manager.git
$ cd deployment-manager
$ make build
$ bin/helm dm install

That's it. You can now use kubectl to see DM running in your cluster:

kubectl get pod,rc,service --namespace=dm

If you see expandybird-service, manager-service, resourcifier-service, and expandybird-rc, manager-rc and resourcifier-rc with pods that are READY, then DM is up and running!

Using Helm

Run a Kubernetes proxy to allow the dm client to connect to the cluster:

kubectl proxy --port=8001 --namespace=dm &

Uninstalling Helm from Kubernetes

You can uninstall Deployment Manager using the same configuration:

helm dm uninstall

Design of Deployment Manager

There is a more detailed design document available.

Status of the Project

This project is still under active development, so you might run into issues. If you do, please don't be shy about letting us know, or better yet, contribute a fix or feature.

Contributing

Your contributions are welcome.

We use the same workflow, License and Contributor License Agreement as the main Kubernetes repository.

Relationship to Google Cloud Platform

DM uses many of the same concepts and languages as Google Cloud Deployment Manager, but creates resources in Kubernetes clusters, not in Google Cloud Platform projects.