README
¶
Consul + Kubernetes (consul-k8s)
The consul-k8s binary includes first-class integrations between Consul and
Kubernetes. The project encapsulates multiple use cases such as syncing
services, injecting Connect sidecars, and more.
The Kubernetes integrations with Consul are
documented directly on the Consul website.
This README will present a basic overview of each use case, but for full
documentation please reference the Consul website.
This project is versioned separately from Consul. Supported Consul versions for each feature will be noted below. By versioning this project separately, we can iterate on Kubernetes integrations more quickly and release new versions without forcing Consul users to do a full Consul upgrade.
Features
-
Consul Service Mesh (Connect): Run Consul Service Mesh (aka Consul Connect) on Kubernetes. This feature injects Envoy sidecars and registers your Pods with Consul. (Requires Consul 1.3+)
-
Catalog Sync: Sync Consul services into first-class Kubernetes services and vice versa. This enables Kubernetes to easily access external services and for non-Kubernetes nodes to easily discover and access Kubernetes services. (Requires Consul 1.1+)
Installation
consul-k8s is distributed in multiple forms:
-
The recommended installation method is the official Consul Helm chart. This will automatically configure the Consul and Kubernetes integration to run within an existing Kubernetes cluster.
-
A Docker image
hashicorp/consul-k8sis available. This can be used to manually runconsul-k8swithin a scheduled environment. -
Raw binaries are available in the HashiCorp releases directory. These can be used to run
consul-k8sdirectly or build custom packages.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
acceptance
module
|
|
|
api
|
|
|
common
Package common holds code that isn't tied to a particular CRD version or type.
|
Package common holds code that isn't tied to a particular CRD version or type. |
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the consul.hashicorp.com v1alpha1 API group +kubebuilder:object:generate=true +groupName=consul.hashicorp.com
|
Package v1alpha1 contains API Schema definitions for the consul.hashicorp.com v1alpha1 API group +kubebuilder:object:generate=true +groupName=consul.hashicorp.com |
|
catalog
|
|
|
charts
module
|
|
|
cli
module
|
|
|
control-plane
module
|
|
|
cni
Module
|
|
|
hack
|
|
|
crds-to-consul-helm
Script to move generated CRD yaml into consul-helm and modify it to match the expected consul-helm format.
|
Script to move generated CRD yaml into consul-helm and modify it to match the expected consul-helm format. |
|
lint-api-new-client
Parses golang code looking for github.com/hashicorp/consul/api.NewClient() being used in non-test code.
|
Parses golang code looking for github.com/hashicorp/consul/api.NewClient() being used in non-test code. |
|
copy-crds-to-chart
Module
|
|
|
helm-reference-gen
Module
|
|
|
helper
|
|
|
controller
Package controller contains a reusable abstraction for efficiently watching for changes in resources in a Kubernetes cluster.
|
Package controller contains a reusable abstraction for efficiently watching for changes in resources in a Kubernetes cluster. |
|
Package namespaces handles interaction with Consul namespaces needed across commands.
|
Package namespaces handles interaction with Consul namespaces needed across commands. |
|
common
Package common holds code needed by multiple commands.
|
Package common holds code needed by multiple commands. |
|
flags
Package flags holds common flags that are shared between our commands.
|
Package flags holds common flags that are shared between our commands. |