This project is currently unstable - breaking changes may still land in the future.
The Habitat operator is a Kubernetes controller designed to solve running and auto-managing Habitat Services on Kubernetes. It does this by making use of Custom Resource Definitions
.
To learn more about Habitat, please visit the Habitat website.
For a more detailed description of the Habitat type have a look here.
- Habitat
>= 0.52.0
- Kubernetes cluster with version
1.9.x
,1.10.x
or1.11.x
- Kubectl version
1.10.x
or1.11.x
Make sure you have golang compiler installed. Follow the installation instructions on download page to learn about GOPATH
. Then run following command:
go get -u github.com/habitat-sh/habitat-operator/cmd/habitat-operator
This will put the built binary in $GOPATH/bin
, make sure this is in your PATH
, so you can access the binary from anywhere.
Clone the code locally:
go get -u github.com/habitat-sh/habitat-operator/cmd/habitat-operator
cd ${GOPATH:-$HOME/go}/src/github.com/habitat-sh/habitat-operator
Then build it:
make build
This command will create a habitat-operator
binary in the source directory. Copy this file somewhere to your PATH
.
Start the Habitat operator by running:
habitat-operator --kubeconfig ~/.kube/config
First build the image:
make image
This will produce a habitat/habitat-operator
image, which can then be deployed to your cluster.
The name of the generated docker image can be changed with an IMAGE
variable, for example make image IMAGE=mycorp/my-habitat-operator
. If the habitat-operator
name is fine, then a REPO
variable can be used like make image REPO=mycorp
to generate the mycorp/habitat-operator
image. Use the TAG
variable to change the tag to something else (the default value is taken from git describe --tags --always
) and a HUB
variable to avoid using the default docker hub.
Habitat operator images are located here, they are tagged with the release version.
Make sure to give Habitat operator the correct permissions, so it's able to create and monitor certain resources. To do it, use the manifest files located under the examples directory:
kubectl create -f examples/rbac
For more information see the README file in RBAC example
To deploy the operator inside the Kubernetes cluster use the Deployment manifest file located under the examples directory:
kubectl create -f examples/habitat-operator-deployment.yml
To create an example service run:
kubectl create -f examples/standalone/habitat.yml
This will create a single-pod deployment of an nginx
Habitat service.
More examples are located in the example directory.
This project uses go dep >= v0.4.1
for dependency management.
If you add, remove or change an import, run:
dep ensure
To run unit tests locally, run:
make test
Clean up after the tests with:
make clean-test
Our current setup does not allow e2e tests to run locally. It is best run on a CI setup with Google Cloud.
If you change one of the types in pkg/apis/habitat/v1beta1/types.go
, run the code generation script with:
make codegen