Skip to content

Commit e7ac3a5

Browse files
ahmatarokkk
authored andcommitted
Readme refactor
1 parent 8c46b58 commit e7ac3a5

File tree

4 files changed

+23
-30
lines changed

4 files changed

+23
-30
lines changed

README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ The detailed CRD documentation can be found [here](/docs/crds.md).
8686

8787
## Contents
8888
- Installation
89-
- [Deploy with Helm](#deploying-with-helm-chart)
89+
- [Deploy with Helm](./docs/deploy/README.md#deploy-logging-operator-with-helm)
90+
- [Deploy with Kuberenetes Manifests](./docs/deploy/README.md#deploy-logging-operator-from-kubernetes-manifests)
9091
- [Supported Plugins](#supported-plugins)
9192
- Examples
9293
- [S3 Output](./docs/example-s3.md)
@@ -98,23 +99,6 @@ The detailed CRD documentation can be found [here](/docs/crds.md).
9899
---
99100

100101

101-
## Deploying with helm chart
102-
The following steps set up an example configuration for sending nginx logs to S3.
103-
104-
105-
#### Add BanzaiCloud chart repository:
106-
```bash
107-
$ helm repo add banzaicloud-stable https://kubernetes-charts.banzaicloud.com
108-
$ helm repo update
109-
```
110-
111-
#### Install logging-operator chart
112-
```bash
113-
$ helm install banzaicloud-stable/logging-operator
114-
```
115-
116-
---
117-
118102
## Supported Plugins
119103

120104
For complete list of supported plugins pleas checkl the [plugins index](/docs/plugins/index.md).

docs/deploy/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
git clone [email protected]:banzaicloud/logging-operator.git
99
```
1010

11-
### Navigate to the nginx-data-www folder
11+
### Navigate to the `logging-operator` folder
1212
```bash
1313
cd logging-operator
1414
```
1515

16-
### Now, let’s create a Namespace called “logging” to work in:
16+
### Create a controlNamespace named “logging”:
1717
```bash
1818
kubectl create ns logging
1919
```
@@ -37,6 +37,7 @@ kubectl -n logging create -f ./config/crd/bases/logging.banzaicloud.io_outputs.y
3737
kubectl -n logging create -f ./docs/deploy/manifests/deployment.yaml
3838
```
3939

40+
---
4041

4142
<p align="center"><img src="../img/helm.svg" width="150"></p>
4243
<p align="center">

docs/example-es-nginx.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44

55
<p align="center"><img src="./img/nginx-elastic.png" width="900"></p>
66

7-
### Add operator chart repository:
7+
## Deploy ElasticSearch
8+
9+
### Add chart repository:
810
```bash
911
helm repo add es-operator https://raw.githubusercontent.com/upmc-enterprises/elasticsearch-operator/master/charts/
10-
helm repo add banzaicloud-stable https://kubernetes-charts.banzaicloud.com
1112
helm repo update
1213
```
1314

@@ -17,20 +18,21 @@ helm install --namespace logging --name elasticsearch-operator es-operator/elast
1718
helm install --namespace logging --name elasticsearch es-operator/elasticsearch --set kibana.enabled=True --set cerebro.enabled=True
1819
```
1920
> [Elasticsearch Operator Documentation](https://github.com/upmc-enterprises/elasticsearch-operator)
21+
## Deploy Logging-Operator with Demo Application
22+
23+
### Install with Helm
24+
25+
[Install Logging-operator with helm](./deploy/README.md#deploy-logging-operator-with-helm)
2026

21-
## Install with Helm
22-
### Logging Operator
23-
```bash
24-
helm install --name logging banzaicloud-stable/logging-operator
25-
```
26-
> You can install `logging` resource via [Helm chart](/charts/logging-operator-logging) with built-in TLS generation.
2727

28-
### Nginx App + Logging Definition
28+
#### Nginx App and Logging Definition
2929
```bash
3030
helm install --namespace logging --name nginx-demo banzaicloud-stable/nginx-logging-es-demo
3131
```
3232

33-
## Install from manifest
33+
---
34+
### Install from Kubernetes manifests
35+
[Install Logging-operator from manifests](./deploy/README.md#deploy-logging-operator-from-kubernetes-manifests)
3436

3537
#### Create `logging` resource
3638
```bash
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
apiVersion: logging.banzaicloud.io/v1beta1
2+
kind: Output
3+
metadata:
4+
name: null-output-sample
5+
spec:
6+
nullout: {}

0 commit comments

Comments
 (0)