-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
147 changed files
with
15,564 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.git/ | ||
.terraform/ | ||
bin/ | ||
test/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
annotations: | ||
artifacthub.io/images: | | ||
- name: consul | ||
image: hashicorp/consul:1.14.2 | ||
- name: consul-k8s-control-plane | ||
image: hashicorp/consul-k8s-control-plane:1.0.2 | ||
- name: consul-dataplane | ||
image: hashicorp/consul-dataplane:1.0.0 | ||
- name: envoy | ||
image: envoyproxy/envoy:v1.23.1 | ||
artifacthub.io/license: MPL-2.0 | ||
artifacthub.io/links: | | ||
- name: Documentation | ||
url: https://www.consul.io/docs/k8s | ||
- name: hashicorp/consul | ||
url: https://github.com/hashicorp/consul | ||
- name: hashicorp/consul-k8s | ||
url: https://github.com/hashicorp/consul-k8s | ||
artifacthub.io/prerelease: "false" | ||
artifacthub.io/signKey: | | ||
fingerprint: C874011F0AB405110D02105534365D9472D7468F | ||
url: https://keybase.io/hashicorp/pgp_keys.asc | ||
apiVersion: v2 | ||
appVersion: 1.14.2 | ||
description: Official HashiCorp Consul Chart | ||
home: https://www.consul.io | ||
icon: https://raw.githubusercontent.com/hashicorp/consul-k8s/main/assets/icon.png | ||
kubeVersion: '>=1.21.0-0' | ||
name: consul | ||
sources: | ||
- https://github.com/hashicorp/consul | ||
- https://github.com/hashicorp/consul-k8s | ||
version: 1.0.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# Consul on Kubernetes Helm Chart | ||
|
||
--- | ||
|
||
**We're looking for feedback on how folks are using Consul on Kubernetes. Please fill out our brief [survey](https://hashicorp.sjc1.qualtrics.com/jfe/form/SV_4MANbw1BUku7YhL)!** | ||
|
||
## Overview | ||
|
||
This is the Official HashiCorp Helm chart for installing and configuring Consul on Kubernetes. This chart supports multiple use cases of Consul on Kubernetes, depending on the values provided. | ||
|
||
For full documentation on this Helm chart along with all the ways you can use Consul with Kubernetes, please see the Consul and Kubernetes documentation. | ||
|
||
> :warning: **Please note**: We take Consul's security and our users' trust very seriously. If | ||
you believe you have found a security issue in Consul K8s, _please responsibly disclose_ | ||
by contacting us at [security@hashicorp.com](mailto:security@hashicorp.com). | ||
|
||
## Features | ||
|
||
* [**Consul Service Mesh**](https://www.consul.io/docs/k8s/connect): | ||
Run Consul Service Mesh on Kubernetes. This feature | ||
injects Envoy sidecars and registers your Pods with Consul. | ||
|
||
* [**Catalog Sync**](https://www.consul.io/docs/k8s/service-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. | ||
|
||
## Installation | ||
|
||
`consul-k8s` is distributed in multiple forms: | ||
|
||
* The recommended installation method is the official | ||
[Consul Helm chart](https://github.com/hashicorp/consul-k8s/tree/main/charts/consul). This will | ||
automatically configure the Consul and Kubernetes integration to run within | ||
an existing Kubernetes cluster. | ||
|
||
* A [Docker image `hashicorp/consul-k8s-control-plane`](https://hub.docker.com/r/hashicorp/consul-k8s-control-plane) is available. This can be used to manually run `consul-k8s-control-plane` within a scheduled environment. | ||
|
||
* Consul K8s CLI, distributed as `consul-k8s`, can be used to install and uninstall Consul Kubernetes. See the [Consul K8s CLI Reference](https://www.consul.io/docs/k8s/k8s-cli) for more details on usage. | ||
|
||
### Prerequisites | ||
|
||
The following pre-requisites must be met before installing Consul on Kubernetes. | ||
|
||
* **Kubernetes 1.22.x - 1.25.x** - This represents the earliest versions of Kubernetes tested. | ||
It is possible that this chart works with earlier versions, but it is | ||
untested. | ||
* Helm install | ||
* **Helm 3.6+** for Helm based installs. | ||
* Consul K8s CLI based install | ||
* `kubectl` configured to authenticate to a Kubernetes cluster with a valid `kubeconfig` file. | ||
* `brew`, `yum`, or `apt` package manager on your local machine | ||
|
||
### CLI | ||
|
||
The Consul K8s CLI is the easiest way to get up and running with Consul on Kubernetes. See [Install Consul on K8s CLI](https://developer.hashicorp.com/consul/docs/k8s/installation/install-cli#install-the-cli) for more details on installation, and refer to | ||
[Consul on Kubernetes CLI Reference](https://developer.hashicorp.com/consul/docs/k8s/k8s-cli) for more details on subcommands and a list of all available flags | ||
for each subcommand. | ||
|
||
|
||
1. Install the HashiCorp tap, which is a repository of all Homebrew packages for HashiCorp: | ||
|
||
``` bash | ||
brew tap hashicorp/tap | ||
``` | ||
|
||
2. Install the Consul K8s CLI with hashicorp/tap/consul formula. | ||
|
||
``` bash | ||
brew install hashicorp/tap/consul-k8s | ||
``` | ||
|
||
3. Issue the install subcommand to install Consul on Kubernetes: | ||
|
||
``` bash | ||
consul-k8s install | ||
``` | ||
|
||
### Helm | ||
|
||
The Helm chart is ideal for those who prefer to use Helm for automation for either the installation or upgrade of Consul on Kubernetes. The chart supports multiple use cases of Consul on Kubernetes, depending on the values provided. Detailed installation instructions for Consul on Kubernetes are found [here](https://www.consul.io/docs/k8s/installation/overview). | ||
|
||
1. Add the HashiCorp Helm repository: | ||
|
||
``` bash | ||
helm repo add hashicorp https://helm.releases.hashicorp.com | ||
``` | ||
|
||
2. Ensure you have access to the Consul Helm chart and you see the latest chart version listed. If you have previously added the | ||
HashiCorp Helm repository, run `helm repo update`. | ||
|
||
``` bash | ||
helm search repo hashicorp/consul | ||
``` | ||
|
||
3. Now you're ready to install Consul! To install Consul with the default configuration using Helm 3.2 run the following command below. | ||
This will create a `consul` Kubernetes namespace if not already present, and install Consul on the dedicated namespace. | ||
``` bash | ||
helm install consul hashicorp/consul --set global.name=consul --create-namespace -n consul | ||
Please see the many options supported in the `values.yaml` | ||
file. These are also fully documented directly on the | ||
[Consul website](https://www.consul.io/docs/platform/k8s/helm.html). | ||
## Tutorials | ||
You can find examples and complete tutorials on how to deploy Consul on | ||
Kubernetes using Helm on the [HashiCorp Learn website](https://learn.hashicorp.com/collections/consul/kubernetes). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
#!/usr/bin/env bash | ||
|
||
WD=$(dirname "$0") | ||
WD=$(cd "$WD"; pwd) | ||
|
||
set -eux | ||
|
||
TEMPLATES="${WD}/../templates" | ||
DASHBOARDS="${WD}/dashboards" | ||
TMP=$(mktemp -d) | ||
|
||
# create Prometheus template | ||
helm template prometheus prometheus \ | ||
--repo https://prometheus-community.github.io/helm-charts \ | ||
--namespace "replace-me-namespace" \ | ||
--version 13.2.1 \ | ||
-f "${WD}/values/prometheus.yaml" \ | ||
> "${TEMPLATES}/prometheus.yaml" | ||
|
||
# Find and replace `replace-me-namespace` with `{{ .Release.Namespace }}` in Prometheus template. | ||
sed -i'.orig' 's/replace-me-namespace/{{ .Release.Namespace }}/g' "${TEMPLATES}/prometheus.yaml" | ||
# Add a comment to the top of the template file mentioning that the file is auto-generated. | ||
sed -i'.orig' '1i\ | ||
# This file is auto-generated, see addons/gen.sh | ||
' "${TEMPLATES}/prometheus.yaml" | ||
# Add `{{- if .Values.prometheus.enabled }} to the top of the Prometheus template to ensure it is only templated when enabled. | ||
sed -i'.orig' '1i\ | ||
{{- if .Values.prometheus.enabled }} | ||
' "${TEMPLATES}/prometheus.yaml" | ||
# Add `{{- end }} to the bottom of the Prometheus template to ensure it is only templated when enabled (closes the `if` statement). | ||
sed -i'.orig' -e '$a\ | ||
{{- end }}' "${TEMPLATES}/prometheus.yaml" | ||
# Remove the `prometheus.yaml.orig` file that is created as a side-effect of the `sed` command on OS X. | ||
rm "${TEMPLATES}/prometheus.yaml.orig" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Disable non-essential components | ||
alertmanager: | ||
enabled: false | ||
pushgateway: | ||
enabled: false | ||
kubeStateMetrics: | ||
enabled: false | ||
nodeExporter: | ||
enabled: false | ||
server: | ||
podAnnotations: | ||
"consul.hashicorp.com/connect-inject": "false" | ||
persistentVolume: | ||
enabled: false | ||
readinessProbeInitialDelay: 0 | ||
# Speed up scraping a bit from the default | ||
global: | ||
scrape_interval: 15s |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
|
||
Thank you for installing HashiCorp Consul! | ||
|
||
Your release is named {{ .Release.Name }}. | ||
|
||
To learn more about the release, run: | ||
|
||
$ helm status {{ .Release.Name }} {{- if .Release.Namespace }} --namespace {{ .Release.Namespace }}{{ end }} | ||
$ helm get all {{ .Release.Name }} {{- if .Release.Namespace }} --namespace {{ .Release.Namespace }}{{ end }} | ||
|
||
Consul on Kubernetes Documentation: | ||
https://www.consul.io/docs/platform/k8s | ||
|
||
Consul on Kubernetes CLI Reference: | ||
https://www.consul.io/docs/k8s/k8s-cli | ||
|
||
{{- if (and .Values.global.acls.manageSystemACLs (gt (len .Values.server.extraConfig) 3)) }} | ||
Warning: Defining server extraConfig potentially disrupts the automatic ACL | ||
bootstrapping required settings. This may cause future issues if | ||
there are conflicts. | ||
{{- end }} |
Oops, something went wrong.