logstash/docsk8s/index.asciidoc
Rob Bavey 1f8ee249bb
Logstash Getting started with Kubernetes Guide (#14655)
This PR presents a getting started guide to working with Logstash in Kubernetes, and comes in three parts:

- A walkthrough of a sample scenario, setting up a Kubernetes cluster with 
  - Elasticsearch
  - Kibana
  - Filebeat to read Kubernetes API server logs and sent to Elasticsearch via Logstash
  - Logstash
  - Metricbeat to monitor Logstash
and walks through the setup of these files
- An annotated guide to these files
- Explanations of how Logstash configuration and settings files map to the Kubernetes environment


Relates #14576
Closes #14576 

Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
2022-11-16 16:06:56 -05:00

70 lines
2.3 KiB
Text

[[logstash-and-kubernetes]]
= Logstash and Kubernetes Reference
include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[]
include::{docs-root}/shared/attributes.asciidoc[]
[[introduction]]
== Introduction
WARNING: This documentation is still in development and may be changed or removed in a future release.
This guide helps you to run and work with {ls} in a Kubernetes environment.
Are you trying out {ls} for the first time? We recommend beginning with our guide {logstash-ref}/getting-started-with-logstash.html[Getting Started with Logstash].
If you're already familiar with Logstash, then it's time to try it out in Kubernetes. The <<ls-k8s-quick-start,Getting started with Logstash and Kubernetes>> demo guides you through the steps of configuring Logstash inside a running Kubernetes cluster.
// Logstash and Kubernetes Quick start
include::quick-start/ls-k8s-quick-start.asciidoc[]
// List of sample configuration files and what they're used for
include::quick-start/sample-configuration-files.asciidoc[]
// Logstash and Kubernetes Quick start
include::quick-start/ls-k8s-configuration-files.asciidoc[]
// Setting up
include::setting-up/ls-k8s-setting-up.asciidoc[]
// Persistent storage requirements
include::setting-up/ls-k8s-persistent-storage.asciidoc[]
// Designing your installation based on plugin usage
include::setting-up/ls-k8s-design-for-plugins.asciidoc[]
// Sizing Logstash instances
include::setting-up/ls-k8s-sizing.asciidoc[]
// Secure your environment
include::setting-up/ls-k8s-secure.asciidoc[]
// Administering
include::administering/ls-k8s-administering.asciidoc[]
// Stack Monitoring
include::administering/ls-k8s-stack-monitoring.asciidoc[]
// Stack Monitoring external
include::administering/ls-k8s-stack-monitoring-external.asciidoc[]
// Stack Monitoring Elastic Cloud
include::administering/ls-k8s-stack-monitoring-cloud.asciidoc[]
// Upgrade Logstash
include::administering/ls-k8s-upgrade.asciidoc[]
// Logstash logging
include::administering/ls-k8s-logging.asciidoc[]
// Recipes
include::ls-k8s-recipes.asciidoc[]
// Troubleshooting
include::troubleshooting/ls-k8s-troubleshooting.asciidoc[]
// Common problems
include::troubleshooting/ls-k8s-common-problems.asciidoc[]
// Troubleshooting methods
include::troubleshooting/ls-k8s-troubleshooting-methods.asciidoc[]