Documentation refactor 3 (#181)

ahma · tarokkk · commit 1740dc22e9ff · 2019-10-12T08:46:56.000+02:00
Add documentation
diff --git a/README.md b/README.md
@@ -103,7 +103,7 @@ The detailed CRD documentation can be found [here](/docs/crds.md).
 
 ## Supported Plugins
 
-For complete list of supported plugins pleas checkl the [plugins index](/docs/plugins/index.md).
+For complete list of supported plugins please check the [plugins index](/docs/plugins/Readme.md).
 
 | Name                                                    |  Type  |                                Description               | Status  | Version                                                                                 |
 |---------------------------------------------------------|:------:|:--------------------------------------------------------:|---------|-----------------------------------------------------------------------------------------|
diff --git a/cmd/docs.go b/cmd/docs.go
@@ -154,7 +154,7 @@ func main() {
 	}
 
 	index := doc{
-		Name: "index",
+		Name: "Readme",
 	}
 	index.append("## Table of Contents\n\n")
 	for _, p := range pluginDirs {
diff --git a/docs/deploy/manifests/rbac.yaml b/docs/deploy/manifests/rbac.yaml
@@ -9,6 +9,26 @@ kind: ClusterRole
 metadata:
   name: logging-operator
 rules:
+  - apiGroups:
+      - monitoring.coreos.com
+    resources:
+      - alertmanagers
+      - prometheuses
+      - prometheuses/finalizers
+      - alertmanagers/finalizers
+      - servicemonitors
+      - podmonitors
+      - prometheusrules
+      - podmonitors
+    verbs:
+      - '*'
+  - apiGroups:
+      - apiextensions.k8s.io
+    resources:
+      - customresourcedefinitions
+    verbs:
+      - list
+      - watch
   - apiGroups:
       - logging.banzaicloud.io
     resources:
diff --git a/docs/example-es-nginx.md b/docs/example-es-nginx.md
@@ -4,6 +4,23 @@
 
 <p align="center"><img src="./img/nginx-elastic.png" width="900"></p>
 
+---
+## Contents
+- **Installation**
+  - ElasticSearch Operator
+    - [Deploy with Helm](#example-es-nginx.md#deploy-elasticsearch)
+  - **Logging Operator**
+    - [Deploy with Helm](#install-with-helm)
+    - [Deploy with Kuberenetes Manifests](./deploy/README.md#deploy-logging-operator-from-kubernetes-manifests)
+   - **Demo Application**  
+    - [Deploy with Helm](#nginx-app-and-logging-definition)
+    - [Deploy with Kuberenetes Manifests](#install-from-kubernetes-manifests)
+- **Validation**
+    - [Cerebro Dashboard](#forward-cerebro-dashboard)
+    - [Kibana Dashboard](#forward-kibana-dashboard)
+---
+
+
 ## Deploy ElasticSearch
 
 ### Add chart repository:
diff --git a/docs/example-kafka-nginx.md b/docs/example-kafka-nginx.md
@@ -4,6 +4,21 @@
 
 <p align="center"><img src="./img/nignx-kafka.png" width="900"></p>
 
+---
+## Contents
+- **Installation**
+  - Kafka 
+    - [Deploy with Helm](#deploy-kafka)
+  - **Logging Operator**
+    - [Deploy with Helm](#install-with-helm)
+    - [Deploy with Kuberenetes Manifests](./deploy/README.md#deploy-logging-operator-from-kubernetes-manifests)
+   - **Demo Application**  
+    - [Deploy with Helm](install-with-helm)
+    - [Deploy with Kuberenetes Manifests](#install-from-kubernetes-manifests)
+- **Validation**
+    - [Kafkacat](#test-your-deployment-with-kafkacat)
+---
+
 ## Deploy Kafka
 >In this demo we are using our kafka operator.
 > [Easy Way Installing with Helm](https://github.com/banzaicloud/kafka-operator#easy-way-installing-with-helm)
@@ -139,4 +154,4 @@ Run kafkacat
 kafkacat -C -b kafka-0.kafka-headless.kafka.svc.cluster.local:29092 -t topic
 ```
 
-[![asciicast](https://asciinema.org/a/273236.svg)](https://asciinema.org/a/273236)
+[![asciicast](https://asciinema.org/a/273236.svg)](https://asciinema.org/a/273236)
diff --git a/docs/example-loki-nginx.md b/docs/example-loki-nginx.md
@@ -4,6 +4,21 @@
 
 <p align="center"><img src="./img/nginx-loki.png" width="900"></p>
 
+---
+## Contents
+- **Installation**
+  - Loki
+    - [Deploy with Helm](#add-operator-chart-repository)
+  - **Logging Operator**
+    - [Deploy with Helm](#install-with-helm)
+    - [Deploy with Kuberenetes Manifests](./deploy/README.md#deploy-logging-operator-from-kubernetes-manifests)
+   - **Demo Application**  
+    - [Deploy with Helm](#nginx-app--logging-definition)
+    - [Deploy with Kuberenetes Manifests](#install-from-manifest)
+- **Validation**
+    - [Grafana Dashboard](#grafana-dashboard)
+---
+
 ### Add operator chart repository:
 ```bash
 helm repo add loki https://grafana.github.io/loki/charts
diff --git a/docs/example-s3.md b/docs/example-s3.md
@@ -1,5 +1,9 @@
+<p align="center"><img src="./img/s3_logo.png" width="340"></p>
+
 # Save all logs to S3
 
+<p align="center"><img src="./img/s3_flow.png" width="900"></p>
+
 Before you start [install logging-operator](/README.md#deploying-with-helm-chart)
 
 ### Create default logging
diff --git a/docs/img/monitor.png b/docs/img/monitor.png
diff --git a/docs/img/s3_flow.png b/docs/img/s3_flow.png
diff --git a/docs/img/s3_logo.png b/docs/img/s3_logo.png
diff --git a/docs/logging-operator-monitoring.md b/docs/logging-operator-monitoring.md
@@ -12,7 +12,9 @@
   - **Logging Operator**
     - [Deploy with Helm](#install-with-helm)
     - [Deploy with Kuberenetes Manifests](./deploy/README.md#deploy-logging-operator-from-kubernetes-manifests)
-  - **Demo Application**  
+  - **Minio**  
+    - [Deploy with Kuberenetes Manifests](#install-minio)
+   - **Demo Application**  
     - [Deploy with Helm](#deploy-demo-nginx-app--logging-definition-with-metrics)
     - [Deploy with Kuberenetes Manifests](#install-from-manifest)
 - **Validation**
@@ -37,7 +39,7 @@ helm install --namespace logging --name monitor stable/prometheus-operator \
     --set "grafana.dashboardProviders.dashboardproviders\\.yaml.providers[0].disableDeletion=false" \
     --set "grafana.dashboardProviders.dashboardproviders\\.yaml.providers[0].options.path=/var/lib/grafana/dashboards/default" \
     --set "grafana.dashboards.default.logging.gnetId=7752" \
-    --set "grafana.dashboards.default.logging.revision=2" \
+    --set "grafana.dashboards.default.logging.revision=3" \
     --set "grafana.dashboards.default.logging.datasource=Prometheus" \
     --set "prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=False"
 ```
@@ -70,6 +72,76 @@ helm install --namespace logging --name nginx-demo banzaicloud-stable/nginx-logg
 ---
 ## Install from manifest
 
+### Install Minio
+
+#### Create Minio Credential Secret
+```bash
+kubectl -n logging create secret generic logging-s3 --from-literal=accesskey='AKIAIOSFODNN7EXAMPLE' --from-literal=secretkey='wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
+```
+#### Deploy Minio
+```bash
+cat <<EOF | kubectl -n logging apply -f -
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+  name: minio-deployment
+  namespace: logging
+spec:
+  strategy:
+    type: Recreate
+  template:
+    metadata:
+      labels:
+        app: minio
+    spec:
+      containers:
+      - name: minio
+        image: minio/minio
+        args:
+        - server
+        - /storage
+        readinessProbe:
+          httpGet:
+            path: /minio/health/ready
+            port: 9000
+          initialDelaySeconds: 10
+          periodSeconds: 5
+        env:
+        - name: MINIO_REGION
+          value: 'test_region'
+        - name: MINIO_ACCESS_KEY
+          valueFrom:
+            secretKeyRef:
+              name: logging-s3
+              key: accesskey
+        - name: MINIO_SECRET_KEY
+          valueFrom:
+            secretKeyRef:
+              name: logging-s3
+              key: secretkey
+        ports:
+        - containerPort: 9000
+      volumes:
+        - name: logging-s3
+          secret:
+            secretName: logging-s3
+---
+kind: Service
+apiVersion: v1
+metadata:
+  name: nginx-demo-minio
+  namespace: logging
+spec:
+  selector:
+    app: minio
+  ports:
+  - protocol: TCP
+    port: 9000
+    targetPort: 9000
+
+EOF
+```
+
 #### Create `logging` resource
 ```bash
 cat <<EOF | kubectl -n logging apply -f -
@@ -79,20 +151,16 @@ metadata:
   name: default-logging-simple
 spec:
   fluentd:
-    metics:
+    metrics:
       serviceMonitor: true
   fluentbit:
-    metics:
+    metrics:
       serviceMonitor: true
   controlNamespace: logging
 EOF
 ```
 > Note: `ClusterOutput` and `ClusterFlow` resource will only be accepted in the `controlNamespace` 
 
-#### Create Minio Credential Secret
-```bash
-ANYAD
-```
 #### Create Minio output definition 
 ```bash
 cat <<EOF | kubectl -n logging apply -f -
@@ -165,7 +233,8 @@ spec:
   template:
     metadata:
       labels:
-        app: nginx
+        app.kubernetes.io/instance: nginx-demo
+        app.kubernetes.io/name: nginx-logging-demo 
     spec:
       containers:
       - name: nginx
diff --git a/docs/plugins/Readme.md b/docs/plugins/Readme.md
diff --git a/docs/plugins/outputs/elasticsearch.md b/docs/plugins/outputs/elasticsearch.md
@@ -1,6 +1,22 @@
 # Elasticsearch output plugin for Fluentd
 ## Overview
 More info at https://github.com/uken/fluent-plugin-elasticsearch
+>Example Deployment: [Save all logs to ElasticSearch](../../../docs/example-es.md)
+
+ #### Example output configurations
+ ```
+ spec:
+   elasticsearch:
+     host: elasticsearch-elasticsearch-cluster.default.svc.cluster.local
+     port: 9200
+     scheme: https
+     ssl_verify: false
+     ssl_version: TLSv1_2
+     buffer:
+       timekey: 1m
+       timekey_wait: 30s
+       timekey_use_utc: true
+ ```
 
 ## Configuration
 ### Elasticsearch
diff --git a/docs/plugins/outputs/kafka.md b/docs/plugins/outputs/kafka.md
@@ -1,6 +1,7 @@
 # Kafka output plugin for Fluentd
 ## Overview
   More info at https://github.com/fluent/fluent-plugin-kafka
+>Example Deployment: [Transport Nginx Access Logs into Kafka with Logging Operator](../../../docs/example-kafka-nginx.md)
 
  #### Example output configurations
  ```
diff --git a/docs/plugins/outputs/loki.md b/docs/plugins/outputs/loki.md
@@ -2,6 +2,18 @@
 ## Overview
 Fluentd output plugin to ship logs to a Loki server.
 More info at https://github.com/banzaicloud/fluent-plugin-kubernetes-loki
+>Example: [Store Nginx Access Logs in Grafana Loki with Logging Operator](../../../docs/example-loki-nginx.md)
+
+ #### Example output configurations
+ ```
+ spec:
+   loki:
+     url: http://loki:3100
+     buffer:
+       timekey: 1m
+       timekey_wait: 30s
+       timekey_use_utc: true
+ ```
 
 ## Configuration
 ### Output Config
diff --git a/docs/plugins/outputs/s3.md b/docs/plugins/outputs/s3.md
@@ -1,6 +1,30 @@
 # Amazon S3 plugin for Fluentd
 ## Overview
 **s3** output plugin buffers event logs in local file and upload it to S3 periodically. This plugin splits files exactly by using the time of event logs (not the time when the logs are received). For example, a log '2011-01-02 message B' is reached, and then another log '2011-01-03 message B' is reached in this order, the former one is stored in "20110102.gz" file, and latter one in "20110103.gz" file.
+>Example: [S3 Output Deployment](../../../docs/example-s3.md)
+
+ #### Example output configurations
+ ```
+ spec:
+  s3:
+    aws_key_id:
+      valueFrom:
+        secretKeyRef:
+          name: logging-s3
+          key: awsAccessKeyId
+    aws_sec_key:
+      valueFrom:
+        secretKeyRef:
+          name: logging-s3
+          key: awsSecretAccesKey
+    s3_bucket: logging-amazon-s3
+    s3_region: eu-central-1
+    path: logs/${tag}/%Y/%m/%d/
+    buffer:
+      timekey: 10m
+      timekey_wait: 30s
+      timekey_use_utc: true*/
+ ```
 
 ## Configuration
 ### Output Config
diff --git a/pkg/model/output/elasticsearch.go b/pkg/model/output/elasticsearch.go
@@ -21,6 +21,22 @@ import (
 
 // +docName:"Elasticsearch output plugin for Fluentd"
 //More info at https://github.com/uken/fluent-plugin-elasticsearch
+//>Example Deployment: [Save all logs to ElasticSearch](../../../docs/example-es.md)
+//
+// #### Example output configurations
+// ```
+// spec:
+//   elasticsearch:
+//     host: elasticsearch-elasticsearch-cluster.default.svc.cluster.local
+//     port: 9200
+//     scheme: https
+//     ssl_verify: false
+//     ssl_version: TLSv1_2
+//     buffer:
+//       timekey: 1m
+//       timekey_wait: 30s
+//       timekey_use_utc: true
+// ```
 type _docElasticsearch interface{}
 
 // +kubebuilder:object:generate=true
diff --git a/pkg/model/output/kafka.go b/pkg/model/output/kafka.go
@@ -21,6 +21,7 @@ import (
 
 // +docName:"Kafka output plugin for Fluentd"
 //  More info at https://github.com/fluent/fluent-plugin-kafka
+//>Example Deployment: [Transport Nginx Access Logs into Kafka with Logging Operator](../../../docs/example-kafka-nginx.md)
 //
 // #### Example output configurations
 // ```
diff --git a/pkg/model/output/loki.go b/pkg/model/output/loki.go
@@ -22,6 +22,18 @@ import (
 // +docName:"Loki output plugin "
 //Fluentd output plugin to ship logs to a Loki server.
 //More info at https://github.com/banzaicloud/fluent-plugin-kubernetes-loki
+//>Example: [Store Nginx Access Logs in Grafana Loki with Logging Operator](../../../docs/example-loki-nginx.md)
+//
+// #### Example output configurations
+// ```
+// spec:
+//   loki:
+//     url: http://loki:3100
+//     buffer:
+//       timekey: 1m
+//       timekey_wait: 30s
+//       timekey_use_utc: true
+// ```
 type _docLoki interface{}
 
 // +kubebuilder:object:generate=true
diff --git a/pkg/model/output/s3.go b/pkg/model/output/s3.go

Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,7 @@ func main() {`
`154`	`154`	`}`
`155`	`155`
`156`	`156`	`index := doc{`
`157`		`- Name: "index",`
	`157`	`+ Name: "Readme",`
`158`	`158`	`}`
`159`	`159`	`index.append("## Table of Contents\n\n")`
`160`	`160`	`for _, p := range pluginDirs {`