Skip to content
This repository was archived by the owner on May 16, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 0 additions & 188 deletions BREAKING_CHANGES.md

This file was deleted.

52 changes: 42 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
# 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.8.svg)](https://devops-ci.elastic.co/job/elastic+helm-charts+7.8/)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Charts](#charts)
- [Supported Configurations](#supported-configurations)
- [Support Matrix](#support-matrix)
- [Kubernetes Versions](#kubernetes-versions)
- [Helm versions](#helm-versions)
- [ECK](#eck)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

This functionality is in beta and is subject to change. The design and code is
less mature than official GA features and is being provided as-is with no
warranties. Beta features are not subject to the support SLA of official GA
features.

## Charts

Expand All @@ -23,13 +32,34 @@ added below.
| [Logstash](./logstash/README.md) | https://www.elastic.co/guide/en/logstash/7.8/docker.html |
| [Metricbeat](./metricbeat/README.md) | https://www.elastic.co/guide/en/beats/metricbeat/7.8/running-on-docker.html |

## Kubernetes Versions
## Supported Configurations

Starting with 7.7.0 release, some charts are reaching GA.

Note that only the released charts coming from [Elastic Helm repo][] or
[GitHub releases][] are supported.

### Support Matrix

| | Elasticsearch | Kibana | Logstash | Filebeat | Metricbeat | APM Server |
|-----|---------------|--------|----------|----------|------------|------------|
| 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 |

### Kubernetes Versions

The charts are [currently tested][] against all GKE versions available. The
exact versions are defined under `KUBERNETES_VERSIONS` in
[helpers/matrix.yml][].

## Helm versions
### Helm versions

While we are checking backward compatibility, the charts are only tested with
Helm version mentioned in [helm-tester Dockerfile][] (currently 2.16.8).
Expand All @@ -43,9 +73,11 @@ Elastic recommended way to deploy Elasticsearch, Kibana and APM Server on
Kubernetes.


[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.8/
[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 3]: https://v3.helm.sh
[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.8/helpers/helm-tester/Dockerfile
[helpers/matrix.yml]: https://github.com/elastic/helm-charts/blob/7.8/helpers/matrix.yml
[operator pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
59 changes: 30 additions & 29 deletions apm-server/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
# APM Server Helm Chart

This Helm chart is a lightweight way to configure and run our official
[APM Server Docker image][].

**Warning**: This functionality is in alpha and is subject to change.
The design and code is less mature than official GA features and is being
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).

**Warning**: This branch is used for development, please use [7.7.1][] 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 -->


- [Requirements](#requirements)
- [Installing](#installing)
- [Using Helm repository](#using-helm-repository)
- [Using the 7.x branch](#using-the-7x-branch)
- [Install released version using Helm repository](#install-released-version-using-helm-repository)
- [Install development version using 7.8 branch and 7.8.0-SNAPSHOT versions](#install-development-version-using-78-branch-and-780-snapshot-versions)
- [Upgrading](#upgrading)
- [Usage notes](#usage-notes)
- [Configuration](#configuration)
Expand All @@ -20,45 +33,31 @@
<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->


This functionality is in alpha and is subject to change. The design and code is
less mature than official GA features and is being provided as-is with no
warranties. Alpha features are not subject to the support SLA of official GA
features.

This Helm chart is a lightweight way to configure and run our official
[APM Server Docker image][].


## Requirements

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

See [supported configurations][] for more details.


## Installing

This chart is tested with the latest 7.8.0-SNAPSHOT versions.

### Using Helm repository
### Install released version using Helm repository

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

* Install the latest 7.8 release:
`helm install --name apm-server elastic/apm-server --version=7.8.0`

### Using the 7.x branch
* Install the latest 7.7 release:
`helm install --name apm-server elastic/apm-server`

* Clone the git repo and checkout the right branch:
### Install development version using 7.8 branch and 7.8.0-SNAPSHOT versions

```shell
git clone git@github.com:elastic/helm-charts.git
cd helm-charts
git checkout -b 7.x origin/7.x
````
* Clone the git repo: `git clone git@github.com:elastic/helm-charts.git`

* Install the latest 7.8.0-SNAPSHOT:
`helm install --name apm-server ./helm-charts/apm-server`
* Install it: `helm install --name apm-server ./helm-charts/apm-server`


## Upgrading
Expand Down Expand Up @@ -144,19 +143,20 @@ Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/apm-server/README.md
[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.8/running-on-docker.html
[apm server oss docker image]: https://www.docker.elastic.co/#apm-server-7-8-0-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.8/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.8/apm-server/examples
[examples/oss]: https://github.com/elastic/helm-charts/tree/7.8/apm-server/examples/oss
[examples/security]: https://github.com/elastic/helm-charts/tree/7.8/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 @@ -172,6 +172,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.8/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.8/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.8.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.8/elasticsearch/examples/default/
[goss integration tests]: https://github.com/elastic/helm-charts/tree/7.8/apm-server/examples/default/test/goss.yaml
[default values]: https://github.com/elastic/helm-charts/tree/7.8/apm-server/values.yaml
Loading