diff --git a/README.md b/README.md index 0b0bdc410..fc5f617c7 100644 --- a/README.md +++ b/README.md @@ -27,49 +27,43 @@ Once installed, the Fluent Operator provides the following features: ## Table of contents + + - [Fluent Operator](#fluent-operator) - - [Table of contents](#table-of-contents) - - [Overview](#overview) - - [Fluent Bit](#fluent-bit) - - [Fluentd](#fluentd) - - [Get Started](#get-started) - - [Prerequisites](#prerequisites) - - [Install](#install) - - [Deploy Fluent Operator with YAML](#deploy-fluent-operator-with-yaml) - - [Deploy Fluent Operator with Helm](#deploy-fluent-operator-with-helm) - - [Quick Start](#quick-start) - - [Fluent Bit quick start](#fluent-bit-quick-start) - - [Fluentd quick start](#fluentd-quick-start) - - [Configure Custom Watch Namespaces](#configure-custom-watch-namespaces) - - [Fluent Bit: Collect Kubernetes logs](#fluent-bit-collect-kubernetes-logs) - - [Deploy the Kubernetes logging stack with YAML](#deploy-the-kubernetes-logging-stack-with-yaml) - - [Deploy the Kubernetes logging stack with Helm](#deploy-the-kubernetes-logging-stack-with-helm) - - [Collect auditd logs](#collect-auditd-logs) - - [Fluentd](#fluentd-1) - - [Collecting logs from Fluent Bit](#collecting-logs-from-fluent-bit) - - [Enable Fluent Bit forward plugin](#enable-fluent-bit-forward-plugin) - - [ClusterFluentdConfig: Fluentd cluster-wide configuration](#clusterfluentdconfig-fluentd-cluster-wide-configuration) - - [FluentdConfig: Fluentd namespaced-wide configuration](#fluentdconfig-fluentd-namespaced-wide-configuration) - - [Combining Fluentd cluster-wide and namespaced-wide configuration](#combining-fluentd-cluster-wide-and-namespaced-wide-configuration) - - [Combining Fluentd cluster-wide output and namespace-wide output for the multi-tenant scenario](#combining-fluentd-cluster-wide-output-and-namespace-wide-output-for-the-multi-tenant-scenario) - - [Outputing logs to Kafka or Elasticsearch](#outputing-logs-to-kafka-or-elasticsearch) - - [Using buffer for Fluentd output](#using-buffer-for-fluentd-output) - - [Collecting logs over HTTP](#collecting-logs-over-http) - - [Monitoring](#monitoring) - - [API Doc](#api-doc) - - [Fluent Bit](#fluent-bit-1) - - [Fluentd](#fluentd-2) - - [Best Practice](#best-practice) - - [Plugin Grouping](#plugin-grouping) - - [Path Convention](#path-convention) - - [Custom Parser](#custom-parser) - - [Roadmap](#roadmap) - - [Development](#development) - - [Requirements](#requirements) - - [Running](#running) - - [Contributing](#contributing) - - [Documentation](#documentation) - - [Manifests](#manifests) + - [Table of contents](#table-of-contents) + - [Overview](#overview) + - [Fluent Bit](#fluent-bit) + - [Fluentd](#fluentd) + - [Get Started](#get-started) + - [Prerequisites](#prerequisites) + - [Install](#install) + - [Deploy Fluent Operator with YAML](#deploy-fluent-operator-with-yaml) + - [Deploy Fluent Operator with Helm](#deploy-fluent-operator-with-helm) + - [Fluent Operator Walkthrough](#fluent-operator-walkthrough) + - [Fluent Bit: Collect Kubernetes logs](#fluent-bit-collect-kubernetes-logs) + - [Deploy the Kubernetes logging stack with YAML](#deploy-the-kubernetes-logging-stack-with-yaml) + - [Deploy the Kubernetes logging stack with Helm](#deploy-the-kubernetes-logging-stack-with-helm) + - [Collect auditd logs](#collect-auditd-logs) + - [Fluentd](#fluentd-1) + - [Monitoring](#monitoring) + - [API Doc](#api-doc) + - [Fluent Bit](#fluent-bit-1) + - [Fluentd](#fluentd-2) + - [Best Practice](#best-practice) + - [Plugin Grouping](#plugin-grouping) + - [Path Convention](#path-convention) + - [Custom Parser](#custom-parser) + - [Roadmap](#roadmap) + - [Development](#development) + - [Requirements](#requirements) + - [Running](#running) + - [Contributing](#contributing) + - [Documentation](#documentation) + - [Manifests](#manifests) + - [Community](#community) + - [About the community](#about-the-community) + - [Contact us](#contact-us) + - [Videos and blogs](#videos-and-blogs) ## Overview @@ -177,7 +171,7 @@ helm install fluent-operator --create-namespace -n fluent https://github.com/flu > Please replace < version > with a actual version like v1.0.0 ### Fluent Operator Walkthrough - + For more info on various use cases of Fluent Operator, you can refer to [Fluent-Operator-Walkthrough](https://github.com/kubesphere-sigs/fluent-operator-walkthrough). ### Fluent Bit: Collect Kubernetes logs