Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'origin/7.10' into 710-readme-enhancements
Browse files Browse the repository at this point in the history
  • Loading branch information
jmlrt committed Nov 23, 2020
2 parents 36f0bf2 + 60b8922 commit dd6b64c
Show file tree
Hide file tree
Showing 78 changed files with 713 additions and 390 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,12 +261,12 @@ make goss
[elastic helm repository]: https://helm.elastic.co
[github forking model]: https://help.github.com/articles/fork-a-repo/
[goss]: https://github.com/aelsabbahy/goss/blob/master/docs/manual.md
[integration test example]: https://github.com/elastic/helm-charts/blob/7.x/elasticsearch/examples/default/test/goss.yaml
[integration test example]: https://github.com/elastic/helm-charts/blob/7.10.0/elasticsearch/examples/default/test/goss.yaml
[integration tests section]: #integration-tests
[pytest]: https://docs.pytest.org/en/latest/
[serverspec]: https://serverspec.org
[templating test example]: https://github.com/elastic/helm-charts/blob/7.x/elasticsearch/tests/elasticsearch_test.py
[templating test example]: https://github.com/elastic/helm-charts/blob/7.10.0/elasticsearch/tests/elasticsearch_test.py
[templating tests section]: #templating-tests
[release.md]: https://github.com/elastic/helm-charts/blob/master/helpers/release.md
[releases section]: #releases
[requirements.txt]: https://github.com/elastic/helm-charts/blob/7.x/requirements.txt
[requirements.txt]: https://github.com/elastic/helm-charts/blob/7.10.0/requirements.txt
74 changes: 38 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Elastic Stack Kubernetes Helm Charts

[![Build Status](https://img.shields.io/jenkins/s/https/devops-ci.elastic.co/job/elastic+helm-charts+7.x.svg)](https://devops-ci.elastic.co/job/elastic+helm-charts+7.x/)
[![Build Status](https://img.shields.io/jenkins/s/https/devops-ci.elastic.co/job/elastic+helm-charts+7.10.svg)](https://devops-ci.elastic.co/job/elastic+helm-charts+7.10/)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -35,14 +35,14 @@ The `master` version of these charts are intended to support the latest pre-rele
versions of our products, and therefore may or may not work with current released
versions.

| Chart | Docker documentation | Latest 7 Version | Latest 6 Version |
|--------------------------------------------|---------------------------------------------------------------------------------|----------------------------|-----------------------------|
| [APM-Server](./apm-server/README.md) | https://www.elastic.co/guide/en/apm/server/current/running-on-docker.html | [`7.9.3`][apm-7] | [`6.8.13`][apm-6] |
| [Elasticsearch](./elasticsearch/README.md) | https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html | [`7.9.3`][elasticsearch-7] | [`6.8.13`][elasticsearch-6] |
| [Filebeat](./filebeat/README.md) | https://www.elastic.co/guide/en/beats/filebeat/current/running-on-docker.html | [`7.9.3`][filebeat-7] | [`6.8.13`][filebeat-6] |
| [Kibana](./kibana/README.md) | https://www.elastic.co/guide/en/kibana/current/docker.html | [`7.9.3`][kibana-7] | [`6.8.13`][kibana-6] |
| [Logstash](./logstash/README.md) | https://www.elastic.co/guide/en/logstash/current/docker.html | [`7.9.3`][logstash-7] | [`6.8.13`][logstash-6] |
| [Metricbeat](./metricbeat/README.md) | https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-docker.html | [`7.9.3`][metricbeat-7] | [`6.8.13`][metricbeat-6] |
| Chart | Docker documentation | Latest 7 Version | Latest 6 Version |
|--------------------------------------------|---------------------------------------------------------------------------------|-----------------------------|-----------------------------|
| [APM-Server](./apm-server/README.md) | https://www.elastic.co/guide/en/apm/server/current/running-on-docker.html | [`7.10.0`][apm-7] | [`6.8.13`][apm-6] |
| [Elasticsearch](./elasticsearch/README.md) | https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html | [`7.10.0`][elasticsearch-7] | [`6.8.13`][elasticsearch-6] |
| [Filebeat](./filebeat/README.md) | https://www.elastic.co/guide/en/beats/filebeat/current/running-on-docker.html | [`7.10.0`][filebeat-7] | [`6.8.13`][filebeat-6] |
| [Kibana](./kibana/README.md) | https://www.elastic.co/guide/en/kibana/current/docker.html | [`7.10.0`][kibana-7] | [`6.8.13`][kibana-6] |
| [Logstash](./logstash/README.md) | https://www.elastic.co/guide/en/logstash/current/docker.html | [`7.10.0`][logstash-7] | [`6.8.13`][logstash-6] |
| [Metricbeat](./metricbeat/README.md) | https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-docker.html | [`7.10.0`][metricbeat-7] | [`6.8.13`][metricbeat-6] |

## Supported Configurations

Expand All @@ -53,18 +53,20 @@ Note that only the released charts coming from [Elastic Helm repo][] or

### Support Matrix

| | Elasticsearch | Kibana | Logstash | Filebeat | Metricbeat | APM Server |
|-----|---------------|--------|----------|----------|------------|------------|
| 6.8 | Beta | Beta | Beta | Beta | Beta | Alpha |
| 7.0 | Alpha | Alpha | / | / | / | / |
| 7.1 | Beta | Beta | / | Beta | / | / |
| 7.2 | Beta | Beta | / | Beta | Beta | / |
| 7.3 | Beta | Beta | / | Beta | Beta | / |
| 7.4 | Beta | Beta | / | Beta | Beta | / |
| 7.5 | Beta | Beta | Beta | Beta | Beta | Alpha |
| 7.6 | Beta | Beta | Beta | Beta | Beta | Alpha |
| 7.7 | GA | GA | Beta | GA | GA | Beta |
| 7.x | GA | GA | Beta | GA | GA | Beta |
| | Elasticsearch | Kibana | Logstash | Filebeat | Metricbeat | APM Server |
|------|---------------|--------|----------|----------|------------|------------|
| 6.8 | Beta | Beta | Beta | Beta | Beta | Alpha |
| 7.0 | Alpha | Alpha | / | / | / | / |
| 7.1 | Beta | Beta | / | Beta | / | / |
| 7.2 | Beta | Beta | / | Beta | Beta | / |
| 7.3 | Beta | Beta | / | Beta | Beta | / |
| 7.4 | Beta | Beta | / | Beta | Beta | / |
| 7.5 | Beta | Beta | Beta | Beta | Beta | Alpha |
| 7.6 | Beta | Beta | Beta | Beta | Beta | Alpha |
| 7.7 | GA | GA | Beta | GA | GA | Beta |
| 7.8 | GA | GA | Beta | GA | GA | Beta |
| 7.9 | GA | GA | Beta | GA | GA | Beta |
| 7.10 | GA | GA | Beta | GA | GA | Beta |

### Kubernetes Versions

Expand All @@ -87,26 +89,26 @@ Kubernetes. There is a dedicated Helm chart for ECK which can be found
[in ECK repo][eck-chart] ([documentation][eck-chart-doc]).


[currently tested]: https://devops-ci.elastic.co/job/elastic+helm-charts+7.x/
[currently tested]: https://devops-ci.elastic.co/job/elastic+helm-charts+7.10/
[eck-chart]: https://github.com/elastic/cloud-on-k8s/tree/master/deploy
[eck-chart-doc]: https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-install-helm.html
[elastic cloud on kubernetes]: https://github.com/elastic/cloud-on-k8s
[elastic helm repo]: https://helm.elastic.co
[github releases]: https://github.com/elastic/helm-charts/releases
[helm-tester Dockerfile]: https://github.com/elastic/helm-charts/blob/7.x/helpers/helm-tester/Dockerfile
[helpers/matrix.yml]: https://github.com/elastic/helm-charts/blob/7.x/helpers/matrix.yml
[helm-tester Dockerfile]: https://github.com/elastic/helm-charts/blob/7.10/helpers/helm-tester/Dockerfile
[helpers/matrix.yml]: https://github.com/elastic/helm-charts/blob/7.10/helpers/matrix.yml
[operator pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
[elasticsearch-771]: https://github.com/elastic/helm-charts/tree/7.7.1/elasticsearch/

[apm-7]: https://github.com/elastic/helm-charts/tree/7.8.1/apm-server/README.md
[apm-6]: https://github.com/elastic/helm-charts/tree/6.8.10/apm-server/README.md
[elasticsearch-7]: https://github.com/elastic/helm-charts/tree/7.8.1/elasticsearch/README.md
[elasticsearch-6]: https://github.com/elastic/helm-charts/tree/6.8.10/elasticsearch/README.md
[filebeat-7]: https://github.com/elastic/helm-charts/tree/7.8.1/filebeat/README.md
[filebeat-6]: https://github.com/elastic/helm-charts/tree/6.8.10/filebeat/README.md
[kibana-7]: https://github.com/elastic/helm-charts/tree/7.8.1/kibana/README.md
[kibana-6]: https://github.com/elastic/helm-charts/tree/6.8.10/kibana/README.md
[logstash-7]: https://github.com/elastic/helm-charts/tree/7.8.1/logstash/README.md
[logstash-6]: https://github.com/elastic/helm-charts/tree/6.8.10/logstash/README.md
[metricbeat-7]: https://github.com/elastic/helm-charts/tree/7.8.1/metricbeat/README.md
[metricbeat-6]: https://github.com/elastic/helm-charts/tree/6.8.10/metricbeat/README.md
[apm-7]: https://github.com/elastic/helm-charts/tree/7.10.0/apm-server/README.md
[apm-6]: https://github.com/elastic/helm-charts/tree/6.8.13/apm-server/README.md
[elasticsearch-7]: https://github.com/elastic/helm-charts/tree/7.10.0/elasticsearch/README.md
[elasticsearch-6]: https://github.com/elastic/helm-charts/tree/6.8.13/elasticsearch/README.md
[filebeat-7]: https://github.com/elastic/helm-charts/tree/7.10.0/filebeat/README.md
[filebeat-6]: https://github.com/elastic/helm-charts/tree/6.8.13/filebeat/README.md
[kibana-7]: https://github.com/elastic/helm-charts/tree/7.10.0/kibana/README.md
[kibana-6]: https://github.com/elastic/helm-charts/tree/6.8.13/kibana/README.md
[logstash-7]: https://github.com/elastic/helm-charts/tree/7.10.0/logstash/README.md
[logstash-6]: https://github.com/elastic/helm-charts/tree/6.8.13/logstash/README.md
[metricbeat-7]: https://github.com/elastic/helm-charts/tree/7.10.0/metricbeat/README.md
[metricbeat-6]: https://github.com/elastic/helm-charts/tree/6.8.13/metricbeat/README.md
22 changes: 11 additions & 11 deletions apm-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ provided as-is with no warranties. Alpha features are not subject to the support
SLA of official GA features (see [supported configurations][] for more details).

<!-- development warning placeholder -->
**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.
**Warning**: This branch is used for development, please use the latest [7.10][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand All @@ -34,8 +34,8 @@ SLA of official GA features (see [supported configurations][] for more details).

## Requirements

* Kubernetes >= 1.9
* [Helm][] >= 2.8.0
* Kubernetes >= 1.14
* [Helm][] >= 2.17.0

See [supported configurations][] for more details.

Expand Down Expand Up @@ -147,20 +147,20 @@ An example of APM Server deployment using OSS version can be found in
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.

[7.x]: https://github.com/elastic/helm-charts/releases
[7.10]: https://github.com/elastic/helm-charts/releases
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
[CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md
[CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md
[affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
[annotations]: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
[apm server docker image]: https://www.elastic.co/guide/en/apm/server/7.9/running-on-docker.html
[apm server docker image]: https://www.elastic.co/guide/en/apm/server/7.10/running-on-docker.html
[apm server oss docker image]: https://www.docker.elastic.co/r/apm/apm-server-oss
[default elasticsearch helm chart]: https://github.com/elastic/helm-charts/tree/7.x/elasticsearch/README.md#default
[default elasticsearch helm chart]: https://github.com/elastic/helm-charts/tree/7.10/elasticsearch/README.md#default
[environment variables]: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#using-environment-variables-inside-of-your-config
[environment from variables]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#configure-all-key-value-pairs-in-a-configmap-as-container-environment-variables
[examples]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/examples
[examples/oss]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/examples/oss
[examples/security]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/examples/security
[examples]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/examples
[examples/oss]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/examples/oss
[examples/security]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/examples/security
[helm]: https://helm.sh
[horizontal pod autoscaler]: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
[imagePullPolicy]: https://kubernetes.io/docs/concepts/containers/images/#updating-images
Expand All @@ -176,7 +176,7 @@ about our development and testing process.
[resources]: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
[service]: https://kubernetes.io/docs/concepts/services-networking/service/
[serviceAccount]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
[supported configurations]: https://github.com/elastic/helm-charts/tree/7.x/README.md#supported-configurations
[supported configurations]: https://github.com/elastic/helm-charts/tree/7.10/README.md#supported-configurations
[tolerations]: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
[updateStrategy]: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#updating-a-deployment
[values.yaml]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/values.yaml
[values.yaml]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/values.yaml
6 changes: 3 additions & 3 deletions apm-server/examples/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ This example deploy APM Server 7.10.0-SNAPSHOT using [default values][].
You can also run [goss integration tests][] using `make test`


[elasticsearch helm chart]: https://github.com/elastic/helm-charts/tree/7.x/elasticsearch/examples/default/
[goss integration tests]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/examples/default/test/goss.yaml
[default values]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/values.yaml
[elasticsearch helm chart]: https://github.com/elastic/helm-charts/tree/7.10/elasticsearch/examples/default/
[goss integration tests]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/examples/default/test/goss.yaml
[default values]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/values.yaml
4 changes: 2 additions & 2 deletions apm-server/examples/oss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ You can also run [goss integration tests][] using `make test`


[apm server oss]: https://www.elastic.co/downloads/apm-oss
[elasticsearch helm chart]: https://github.com/elastic/helm-charts/tree/7.x/elasticsearch/examples/oss/
[goss integration tests]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/examples/oss/test/goss.yaml
[elasticsearch helm chart]: https://github.com/elastic/helm-charts/tree/7.10/elasticsearch/examples/oss/
[goss integration tests]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/examples/oss/test/goss.yaml
6 changes: 3 additions & 3 deletions apm-server/examples/security/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ Elasticsearch (see [values][]).
You can also run [goss integration tests][] using `make test`


[elasticsearch helm chart]: https://github.com/elastic/helm-charts/tree/7.x/elasticsearch/examples/security/
[goss integration tests]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/examples/security/test/goss.yaml
[values]: https://github.com/elastic/helm-charts/tree/7.x/apm-server/examples/security/values.yaml
[elasticsearch helm chart]: https://github.com/elastic/helm-charts/tree/7.10/elasticsearch/examples/security/
[goss integration tests]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/examples/security/test/goss.yaml
[values]: https://github.com/elastic/helm-charts/tree/7.10/apm-server/examples/security/values.yaml
15 changes: 15 additions & 0 deletions apm-server/examples/upgrade/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
default: test

include ../../../helpers/examples.mk

CHART := apm-server
RELEASE := helm-apm-server-upgrade
FROM := 7.6.0 # 7.6.0 is the first release for apm-server

install:
../../../helpers/upgrade.sh --chart $(CHART) --release $(RELEASE) --from $(FROM)

test: install goss

purge:
helm del $(RELEASE)
21 changes: 21 additions & 0 deletions apm-server/examples/upgrade/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Upgrade

This example will deploy APM Server chart using an old chart version,
then upgrade it.


## Usage

* Add the Elastic Helm charts repo: `helm repo add elastic https://helm.elastic.co`

* Deploy [Elasticsearch Helm chart][]: `helm install elasticsearch elastic/elasticsearch`

* Deploy and upgrade APM Server chart with the default values: `make install`


## Testing

You can also run [goss integration tests][] using `make test`.


[goss integration tests]: https://github.com/elastic/helm-charts/tree/master/apm-server/examples/upgrade/test/goss.yaml
6 changes: 6 additions & 0 deletions apm-server/examples/upgrade/test/goss.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
http:
http://localhost:8200?pretty:
status: 200
timeout: 2000
body:
- "7.10.0"
12 changes: 12 additions & 0 deletions apm-server/examples/upgrade/values.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
apmConfig:
apm-server.yml: |
apm-server:
host: "0.0.0.0:8200"
queue: {}
output.file:
enabled: false
output.elasticsearch:
hosts: ["http://upgrade-master:9200"]
17 changes: 0 additions & 17 deletions apm-server/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,6 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
{{- end -}}
{{- end -}}

{{/*
Return the appropriate apiVersion for ingress.
*/}}
{{- define "apm.ingress.apiVersion" -}}
{{- if semverCompare "<1.14-0" .Capabilities.KubeVersion.Version -}}
{{- print "extensions/v1beta1" -}}
{{- else -}}
{{- print "networking.k8s.io/v1beta1" -}}
{{- end -}}
{{- end -}}
{{- define "apm.autoscaling.apiVersion" -}}
{{- if semverCompare "<1.12-0" .Capabilities.KubeVersion.Version -}}
{{- print "autoscaling/v2beta1" -}}
{{- else -}}
{{- print "autoscaling/v2beta2" -}}
{{- end -}}
{{- end -}}
{{/*
Use the fullname if the serviceAccount value is not set
*/}}
Expand Down
2 changes: 1 addition & 1 deletion apm-server/templates/hpa.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{- if .Values.autoscaling.enabled }}
apiVersion: {{ template "apm.autoscaling.apiVersion" . }}
apiVersion: autoscaling/v2beta2
kind: HorizontalPodAutoscaler
metadata:
name: {{ template "apm.fullname" . }}
Expand Down
2 changes: 1 addition & 1 deletion apm-server/templates/ingress.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{{- $fullName := include "apm.fullname" . -}}
{{- $servicePort := .Values.service.port -}}
{{- $ingressPath := .Values.ingress.path -}}
apiVersion: {{ template "apm.ingress.apiVersion" . }}
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
name: {{ template "apm.fullname" . }}
Expand Down
Loading

0 comments on commit dd6b64c

Please sign in to comment.