Overview

Habitat centers application configuration, management, and behavior around the application itself, not the infrastructure that the app runs on. This allows Habitat to be deployed and run on various infrastructure environments, such as bare metal, VM, containers, and PaaS.

The Habitat documentation is broken out into the following sections:

Getting Started

  • Get Habitat: Download the hab command-line interface tool (CLI) for Mac, Linux, and Windows to get started using Habitat.
  • Tutorials: Location for our getting started and advanced tutorials. Currently, only the getting started tutorial is available. You should start here if you are new to Habitat.
  • Concepts: Describes the major components of Habitat and how they work.

Using Habitat

  • Create packages: Learn how to create a plan, what all of the plan settings are, how to configure a package, and how to build packages.
  • Run packages: Learn how to run a package natively as well as through an external runtime format, such as a Docker or rkt container.
  • Share packages: Describes how to upload, share, and run Habitat packages from the public depot.
  • Continuous deployment: Explains the how Habitat supports continuous deployment and the implementation details of deploying Habitat packages through Chef Automate.
  • Container orchestration: Describes how to use Habitat with container orchestration technologies such as EC2 Container Service, Mesos, and Kubernetes.
  • Habitat internals: Provides deeper explanations on topics such as how the supervisor works, how leader election happens, etc.

Reference

  • CLI reference: Usage and basic help documentation for all hab CLI commands and subcommands.
  • Plan syntax: All settings, variables, callbacks, functions, and other configuration options that can be used when creating your plan.
  • Environment variables: All environment variables that you can modify when using the hab CLI.
  • Package contents: Dependency, build, and configuration files that are included in a Habitat package.

Contribute

  • Help build Habitat: Additional functionality and that we would love the community to help us define and implement.

Where to begin

Whether you're new to Habitat or have a little bit of experience under your belt, you've come to the right place.

Are you new to Habitat?

If you're just getting started and want a quick introduction, then we recommend you review the following items in the order listed.

Try Habitat demo

Complete a short
10-minute interactive demo

Go to tutorials

Get your first
hands-on experience

Review concepts

Start learning the
fundamentals of Habitat

Already know your way around?

If you already have experience with Habitat and simply want to download the source code and get cookin', then these links should provide everything you need.

Download Habitat

Get Habitat and install it on your workstation

Contribute to Habitat

Habitat is open source;
let's build together

Sign in to Web App

Manage your information and
browse official packages