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

[all] Simplify doc in 6.8 branch #858

Merged
merged 4 commits into from
Oct 21, 2020
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
19 changes: 10 additions & 9 deletions apm-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ 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 [6.8.12][] release
for released version.
**Warning**: This branch is used for development, please use the latest [6.x][] release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand All @@ -18,7 +17,7 @@ for released version.

- [Requirements](#requirements)
- [Installing](#installing)
- [Install released version using Helm repository](#install-released-version-using-helm-repository)
- [Install released version using Helm repository](#install-released-version-using-helm-repository)
- [Install development version using 6.8 branch and 6.8.13-SNAPSHOT versions](#install-development-version-using-68-branch-and-6813-snapshot-versions)
- [Upgrading](#upgrading)
- [Usage notes](#usage-notes)
Expand All @@ -45,22 +44,24 @@ See [supported configurations][] for more details.

This chart is tested with the latest 6.8.13-SNAPSHOT version.

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

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

* Install it:
- with Helm 2: `helm install --name apm-server --version 6.8.12 elastic/apm-server`
- with [Helm 3 (beta)][]: `helm install apm-server --version 6.8.12 elastic/apm-server`
- with Helm 2: `helm install --name apm-server --version <version> elastic/apm-server`
- with [Helm 3 (beta)][]: `helm install apm-server --version <version> elastic/apm-server`

### Install development version using 6.8 branch and 6.8.13-SNAPSHOT versions

* Clone the git repo: `git clone git@github.com:elastic/helm-charts.git`

* Checkout the branch : git checkout 6.8

* Install it:
- with Helm 2: `helm install --name apm-server ./helm-charts/apm-server`
- with [Helm 3 (beta)][]: `helm install apm-server ./helm-charts/apm-server`
- with Helm 2: `helm install --name apm-server --version 6.8.13-SNAPSHOT ./helm-charts/apm-server`
- with [Helm 3 (beta)][]: `helm install apm-server --version 6.8.13-SNAPSHOT ./helm-charts/apm-server`


## Upgrading
Expand Down Expand Up @@ -146,7 +147,7 @@ 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.


[6.x]: https://github.com/elastic/helm-charts/releases
[6.8.13-SNAPSHOT]: https://github.com/elastic/helm-charts/blob/6.8.13-SNAPSHOT/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
Expand Down
17 changes: 9 additions & 8 deletions elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ 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 (see [supported configurations][] for more details).

**Warning**: This branch is used for development, please use [6.8.12][] release
for released version.
**Warning**: This branch is used for development, please use the latest [6.x][] release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -56,6 +55,7 @@ default settings. All of these settings are configurable.

See [supported configurations][] for more details.


## Installing

This chart is tested with the latest 6.8.13-SNAPSHOT version.
Expand All @@ -66,17 +66,18 @@ This chart is tested with the latest 6.8.13-SNAPSHOT version.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name elasticsearch --version 6.8.12 elastic/elasticsearch`
- with [Helm 3 (beta)][]: `helm install elasticsearch --version 6.8.12 elastic/elasticsearch`
- with Helm 2: `helm install --name elasticsearch --version <version> elastic/elasticsearch`
- with [Helm 3 (beta)][]: `helm install elasticsearch --version <version> elastic/elasticsearch`

### Install development version using 6.8 branch and 6.8.13-SNAPSHOT versions

* Clone the git repo: `git clone git@github.com:elastic/helm-charts.git`

* Install it:
- with Helm 2: `helm install --name elasticsearch ./helm-charts/elasticsearch`
- with [Helm 3 (beta)][]: `helm install elasticsearch ./helm-charts/elasticsearch`
* Checkout the branch : git checkout 6.8

* Install it:
- with Helm 2: `helm install --name elasticsearch --version 6.8.13-SNAPSHOT ./helm-charts/elasticsearch`
- with [Helm 3 (beta)][]: `helm install elasticsearch --version 6.8.13-SNAPSHOT ./helm-charts/elasticsearch`

## Upgrading

Expand Down Expand Up @@ -392,7 +393,7 @@ lifecycle:
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[6.x]: https://github.com/elastic/helm-charts/releases
[#63]: https://github.com/elastic/helm-charts/issues/63
[6.8.13-SNAPSHOT]: https://github.com/elastic/helm-charts/blob/6.8.13-SNAPSHOT/elasticsearch/README.md
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
Expand Down
15 changes: 8 additions & 7 deletions filebeat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ 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 (see [supported configurations][] for more details).

**Warning**: This branch is used for development, please use [6.8.12][] release
for released version.
**Warning**: This branch is used for development, please use the latest [6.x][] release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -53,16 +52,18 @@ This chart is tested with the latest 6.8.13-SNAPSHOT version.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name filebeat --version 6.8.12 elastic/filebeat`
- with [Helm 3 (beta)][]: `helm install filebeat --version 6.8.12 elastic/filebeat`
- with Helm 2: `helm install --name filebeat --version <version> elastic/filebeat`
- with [Helm 3 (beta)][]: `helm install filebeat --version <version> elastic/filebeat`

### Install development version using 6.8 branch and 6.8.13-SNAPSHOT versions

* Clone the git repo: `git clone git@github.com:elastic/helm-charts.git`

* Checkout the branch : git checkout 6.8

* Install it:
- with Helm 2: `helm install --name filebeat ./helm-charts/filebeat`
- with [Helm 3 (beta)][]: `helm install filebeat ./helm-charts/filebeat`
- with Helm 2: `helm install --name filebeat --version 6.8.13-SNAPSHOT ./helm-charts/filebeat`
- with [Helm 3 (beta)][]: `helm install filebeat --version 6.8.13-SNAPSHOT ./helm-charts/filebeat`


## Upgrading
Expand Down Expand Up @@ -190,7 +191,7 @@ readinessProbe:
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[6.x]: https://github.com/elastic/helm-charts/releases
[6.8.13-SNAPSHOT]: https://github.com/elastic/helm-charts/blob/6.8.13-SNAPSHOT/filebeat/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
Expand Down
15 changes: 8 additions & 7 deletions kibana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ 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 (see [supported configurations][] for more details).

**Warning**: This branch is used for development, please use [6.8.12][] release
for released version.
**Warning**: This branch is used for development, please use the latest [6.x][] release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -54,16 +53,18 @@ This chart is tested with the latest 6.8.13-SNAPSHOT version.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name kibana --version 6.8.12 elastic/kibana`
- with [Helm 3 (beta)][]: `helm install kibana --version 6.8.12 elastic/kibana`
- with Helm 2: `helm install --name kibana --version <version> elastic/kibana`
- with [Helm 3 (beta)][]: `helm install kibana --version <version> elastic/kibana`

### Install development version using 6.8 branch and 6.8.13-SNAPSHOT versions

* Clone the git repo: `git clone git@github.com:elastic/helm-charts.git`

* Checkout the branch : git checkout 6.8

* Install it:
- with Helm 2: `helm install --name kibana ./helm-charts/kibana`
- with [Helm 3 (beta)][]: `helm install kibana ./helm-charts/kibana`
- with Helm 2: `helm install --name kibana --version 6.8.13-SNAPSHOT ./helm-charts/kibana`
- with [Helm 3 (beta)][]: `helm install kibana --version 6.8.13-SNAPSHOT ./helm-charts/kibana`


## Upgrading
Expand Down Expand Up @@ -207,7 +208,7 @@ lifecycle:
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[6.x]: https://github.com/elastic/helm-charts/releases
[6.8.13-SNAPSHOT]: https://github.com/elastic/helm-charts/blob/6.8.13-SNAPSHOT/kibana/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
Expand Down
16 changes: 8 additions & 8 deletions logstash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ 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 [6.8.12][] release
for released version.
**Warning**: This branch is used for development, please use the latest [6.x][] release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -40,7 +39,6 @@ for released version.

See [supported configurations][] for more details.


## Installing

This chart is tested with the latest 6.8.13-SNAPSHOT version.
Expand All @@ -51,16 +49,18 @@ This chart is tested with the latest 6.8.13-SNAPSHOT version.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name logstash --version 6.8.12 elastic/logstash`
- with [Helm 3 (beta)][]: `helm install logstash --version 6.8.12 elastic/logstash`
- with Helm 2: `helm install --name logstash --version <version> elastic/logstash`
- with [Helm 3 (beta)][]: `helm install logstash --version <version> elastic/logstash`

### Install development version using 6.8 branch and 6.8.13-SNAPSHOT versions

* Clone the git repo: `git clone git@github.com:elastic/helm-charts.git`

* Checkout the branch : git checkout 6.8

* Install it:
- with Helm 2: `helm install --name logstash ./helm-charts/logstash`
- with [Helm 3 (beta)][]: `helm install logstash ./helm-charts/logstash`
- with Helm 2: `helm install --name logstash --version 6.8.13-SNAPSHOT ./helm-charts/logstash`
- with [Helm 3 (beta)][]: `helm install logstash --version 6.8.13-SNAPSHOT ./helm-charts/logstash`


## Upgrading
Expand Down Expand Up @@ -190,7 +190,7 @@ against best practices of containers and immutable infrastructure.
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[6.x]: https://github.com/elastic/helm-charts/releases
[6.8.13-SNAPSHOT]: https://github.com/elastic/helm-charts/blob/6.8.13-SNAPSHOT/logstash/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
Expand Down
16 changes: 8 additions & 8 deletions metricbeat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ 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 (see [supported configurations][] for more details).

**Warning**: This branch is used for development, please use [6.8.12][] release
for released version.

**Warning**: This branch is used for development, please use the latest [6.x][] 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 Down Expand Up @@ -53,16 +51,18 @@ This chart is tested with the latest 6.8.13-SNAPSHOT version.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name apm-server --version 6.8.12 elastic/apm-server`
- with [Helm 3 (beta)][]: `helm install apm-server --version 6.8.12 elastic/apm-server`
- with Helm 2: `helm install --name metricbeat --version <version> elastic/metricbeat`
- with [Helm 3 (beta)][]: `helm install metricbeat --version <version> elastic/metricbeat`

### Install development version using 6.8 branch and 6.8.13-SNAPSHOT versions

* Clone the git repo: `git clone git@github.com:elastic/helm-charts.git`

* Checkout the branch : git checkout 6.8

* Install it:
- with Helm 2: `helm install --name apm-server ./helm-charts/apm-server`
- with [Helm 3 (beta)][]: `helm install apm-server ./helm-charts/apm-server`
- with Helm 2: `helm install --name metricbeat --version 6.8.13-SNAPSHOT ./helm-charts/metricbeat`
- with [Helm 3 (beta)][]: `helm install metricbeat --version 6.8.13-SNAPSHOT ./helm-charts/metricbeat`


## Upgrading
Expand Down Expand Up @@ -214,7 +214,7 @@ same node.
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[6.x]: https://github.com/elastic/helm-charts/releases
[#471]: https://github.com/elastic/helm-charts/pull/471
[6.8.13-SNAPSHOT]: https://github.com/elastic/helm-charts/blob/6.8.13-SNAPSHOT/metricbeat/README.md
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
Expand Down