Skip to content

Commit 7cdf6b0

Browse files
Santhosh Kumar VudaSanthosh Kumar Vuda
authored andcommitted
README fixes
1 parent cccc190 commit 7cdf6b0

File tree

2 files changed

+11
-14
lines changed

2 files changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,17 @@
22

33
## About
44

5-
This provides an end-to-end monitoring solution for Oracle Container Engine for Kubernetes (OKE) and other forms of Kubernetes Clusters,
6-
using Logging Analytics, Monitoring other Oracle Cloud Infrastructure (OCI) Services.
5+
This provides an end-to-end monitoring solution for Oracle Container Engine for Kubernetes (OKE) and other forms of Kubernetes Clusters using Logging Analytics, Monitoring and other Oracle Cloud Infrastructure (OCI) Services.
76

87
## Logs
98

10-
This solutions offers collection of various logs of a Kubernetes cluster, out of the box into OCI Logging Analytics and offer rich analytics on top of it.
11-
Users may choose to customise the log collection by modifying the out of the box configuration that it provides.
9+
This solutions offers collection of various logs of a Kubernetes cluster into OCI Logging Analytics and offer rich analytics on top of the collected logs. Users may choose to customise the log collection by modifying the out of the box configuration that it provides.
1210

1311
### Kubernetes System/Service Logs
1412

1513
OKE or Kubernetes comes up with some built-in services where each one has different responsibilities and they run on one or more nodes in the cluster either as Deployments or DaemonSets.
1614

17-
The following service logs are configured to collect out of the box:
15+
The following service logs are configured to be collected out of the box:
1816
- Kube Proxy
1917
- Kube Flannel
2018
- Kubelet
@@ -26,7 +24,7 @@ The following service logs are configured to collect out of the box:
2624

2725
### Linux System Logs
2826

29-
The following Linux system logs are configured to collect out of the box:
27+
The following Linux system logs are configured to be collected out of the box:
3028
- Syslog
3129
- Secure logs
3230
- Cron logs
@@ -44,7 +42,7 @@ The following are various Control Plane components in OKE/Kubernetes.
4442
- Cloud Controller Manager
4543
- etcd
4644

47-
At present, control plane logs are not covered as part of out of the box collection, as these logs are not exposed to customers OKE.
45+
At present, control plane logs are not covered as part of out of the box collection, as these logs are not exposed to OKE customers.
4846
The out of the box collection for these logs will be available soon for generic Kubernetes clusters and for OKE (when OKE make it available for end users).
4947

5048
### Application Pod/Container Logs
@@ -84,7 +82,7 @@ At present, for testing purposes follow the below mentioned steps to build an im
8482
- Download all the files from [this dir](/logan/docker-images/v1.0/debian/) into a local machine having access to internet.
8583
- Run the following command to build the docker image.
8684
- *docker build -t fluentd_oci_la -f Dockerfile .*
87-
- The docker image built from above step, can be either pushed to Docker Hub or OCI Container Registry (OCIR) or to a Local Docker Registry depending on the requirements.
85+
- The docker image built from the above step, can either be pushed to Docker Hub or OCI Container Registry (OCIR) or to a Local Docker Registry depending on the requirements.
8886
- [How to push the image to Docker Hub](https://docs.docker.com/docker-hub/repos/#pushing-a-docker-container-image-to-docker-hub)
8987
- [How to push the image to OCIR](https://www.oracle.com/webfolder/technetwork/tutorials/obe/oci/registry/index.html).
9088
- [How to push the image to Local Registry](https://docs.docker.com/registry/deploying/).
@@ -104,7 +102,6 @@ These yaml files needs to be applied using kubectl to create the necessary resou
104102

105103
- This file contains the necessary out of the box fluentd configuration to collect Kubernetes System/Service Logs, Linux System Logs and Application Pod/Container Logs.
106104
- Some log locations may differ for Kubernetes clusters other than OKE, EKS and may need modifications accordingly.
107-
A comprehensive out of the box covering typical kubernetes clusters will be available soon.
108105
- Use configmap-docker.yaml for Kubernetes clusters based off Docker runtime (e.g., OKE < 1.20) and configmap-cri.yaml for Kubernetes clusters based off CRI-O.
109106
- Inline comments are available in the file for each of the source/filter/match blocks for easy reference for making any changes to the configuration.
110107
- Refer [this](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/) to learn about each of the Logging Analytics Fluentd Output plugin configuration parameters.
@@ -115,18 +112,18 @@ A comprehensive out of the box covering typical kubernetes clusters will be avai
115112

116113
##### fluentd-daemonset.yaml
117114

118-
- This file has all the necessary resources to deploy to run the Fluentd docker image as Daemonset.
115+
- This file has all the necessary resources required to deploy and run the Fluentd docker image as Daemonset.
119116
- Inline comments are available in the file describing each of the fields/sections.
120117
- Make sure to replace the fields with actual values before deploying.
121118
- At minimum, <IMAGE_URL>, <OCI_LOGGING_ANALYTICS_LOG_GROUP_ID>, <OCI_TENANCY_NAMESPACE> needs to be updated.
122-
- It is recommended to update, <KUBERNETES_CLUSTER_OCID>,<KUBERNETES_CLUSTER_NAME> too tag all the logs with corresponding Kubernetes cluster at Logging Analytics.
119+
- It is recommended to update <KUBERNETES_CLUSTER_OCID>,<KUBERNETES_CLUSTER_NAME> too, to tag all the logs processed with corresponding Kubernetes cluster at Logging Analytics.
123120

124121
##### secrets.yaml (Optional)
125122

126123
- At present, InstancePrincipal and OCI Config File (UserPrincipal) based Auth/AuthZ are supported for Fluentd to talk to OCI Logging Analytics APIs.
127124
- We recommend to use InstancePrincipal based AuthZ for OKE and all clusters which are running on OCI VMs and that is the default auth type configured.
128125
- Applying this file is not required when using InstancePrincipal based auth type.
129-
- You need to modify this file to fill out the values under config section with appropriate values.
126+
- When config file based Authz is used, modify this file to fill out the values under config section with appropriate values.
130127

131128
##### Commands Reference
132129

@@ -146,7 +143,7 @@ clusterrolebinding.rbac.authorization.k8s.io/oci-la-fluentd-logs-clusterrolebind
146143
daemonset.apps/oci-la-fluentd-daemonset created
147144
```
148145

149-
You may use the following command to restart DaemonSet upon any applying any modifications to configmap or secrets to reflect the changes into the Fluentd.
146+
Use the following command to restart DaemonSet after applying any modifications to configmap or secrets to reflect the changes into the Fluentd.
150147

151148
```
152149
kubectl rollout restart daemonset oci-la-fluentd-daemonset -n=kubectl
@@ -185,7 +182,7 @@ clusterrolebinding.rbac.authorization.k8s.io/oci-la-fluentd-objects-clusterroleb
185182
deployment.apps/oci-la-fluentd-deployment created
186183
```
187184

188-
You may use the following command to restart DaemonSet upon any applying any modifications to configmap or secrets to reflect the changes into the Fluentd.
185+
Use the following command to restart Deployment after applying any modifications to configmap or secrets to reflect the changes into the Fluentd.
189186

190187
```
191188
kubectl rollout restart deployment oci-la-fluentd-deployment -n=kubectl

0 commit comments

Comments
 (0)