Skip to content

Commit

Permalink
Doc Updates (#686)
Browse files Browse the repository at this point in the history
* Initial commit.  Docs refactoring.

  * Document configurable parameters and respective defaults.
  * Refactor Helm install, adding Helm3.

* some tweaks and fixes.

* some tweaks and fixes.

* some tweaks and fixes.

* Fixes from some feedback

* Final updates to Helm Install

* use sections better

* fix typo

* fix typo

* add note on upgrading from pre 1.x

* formatting

* update non-helm insatllation

* fix typos

* fix typos

* Update docs for existing prometheues operator install

* more tweaks, add troubleshooting section

* add pointer to merge where relevant

* add pre-req and TOC

* Update standalone prometheus

* Remove legacy Helm3 doc

* SideBySide install as well as consistent validaton step

* make other methods more clear

* Add missing props

* For remoteWrite, refer to values.yaml

* Update deploy/docs/Installation_with_Helm.md

Co-authored-by: Vijit Singhal <56007827+vsinghal13@users.noreply.github.com>

* fix issue from conflict merge

* delete old helm3 doc and update root README.

* Update Installation_with_Helm.md

* Update SideBySidePrometheus.md

* Update existingPrometheusDoc.md

* Update standAlonePrometheus.md

* Helm3 has fixed the namespace issue so update steps.  Also port in missed content in the different installs for parity.  Update non-helm install with improvements.

* Fix formatting

* Incorporate some feedback

* Update deploy/docs/Non_Helm_Installation.md

* Update deploy/docs/Non_Helm_Installation.md

* Update deploy/docs/Non_Helm_Installation.md

* Update deploy/docs/Non_Helm_Installation.md

* Add reference to proxy based installation.

* Last tweaks

Co-authored-by: Vijit Singhal <56007827+vsinghal13@users.noreply.github.com>
Co-authored-by: David Duke <drduke1@gmail.com>
Co-authored-by: Marcin Stozek <58700054+perk-sumo@users.noreply.github.com>
  • Loading branch information
4 people authored Jul 30, 2020
1 parent 4f15ddb commit 142aa6d
Show file tree
Hide file tree
Showing 10 changed files with 900 additions and 417 deletions.
2 changes: 0 additions & 2 deletions deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ K8s with AKS | 1.15<br/>1.16<br/>1.17
Helm | 2.14.13 (Linux)
kubectl | 1.15.0

NOTE: Helm 3 compatibility is in the early stages and is not fully tested or supported. Please refer to this [guide](docs/Helm3.md) for more information on Helm 3. We recommend you thoroughly test the use of Helm 3 in your pre-production environments before use.

The following matrix displays the tested package versions for our Helm chart.

Sumo Logic Helm Chart | Prometheus Operator | Fluent Bit | Falco | Metrics Server
Expand Down
4 changes: 1 addition & 3 deletions deploy/docs/Additional_Fluentd_Plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ To add additional Fluentd plugins, you can modify `values.yaml` or create a new
__Note__: If your plugin requires additional system libraries, it cannot be installed this way.

```yaml
# ...
fluentd:
# ...
additionalPlugins:
- fluent-plugin-route
- fluent-plugin-aws-elasticsearch-service
Expand All @@ -23,7 +21,7 @@ __Note__: You will want to update `<RELEASE>` to the [docker tag](https://hub.do
FROM sumologic/kubernetes-fluentd:<RELEASE>
USER root
# Here goes your changes
# Add the plugins you wish to install below.
RUN gem install fluent-plugin-route
RUN gem install fluent-plugin-aws-elasticsearch-service
Expand Down
85 changes: 0 additions & 85 deletions deploy/docs/Helm3.md

This file was deleted.

Loading

0 comments on commit 142aa6d

Please sign in to comment.