You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,17 @@
2
2
3
3
## About
4
4
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.
7
6
8
7
## Logs
9
8
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.
12
10
13
11
### Kubernetes System/Service Logs
14
12
15
13
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.
16
14
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:
18
16
- Kube Proxy
19
17
- Kube Flannel
20
18
- Kubelet
@@ -26,7 +24,7 @@ The following service logs are configured to collect out of the box:
26
24
27
25
### Linux System Logs
28
26
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:
30
28
- Syslog
31
29
- Secure logs
32
30
- Cron logs
@@ -44,7 +42,7 @@ The following are various Control Plane components in OKE/Kubernetes.
44
42
- Cloud Controller Manager
45
43
- etcd
46
44
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.
48
46
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).
49
47
50
48
### Application Pod/Container Logs
@@ -84,7 +82,7 @@ At present, for testing purposes follow the below mentioned steps to build an im
84
82
- Download all the files from [this dir](/logan/docker-images/v1.0/debian/) into a local machine having access to internet.
85
83
- Run the following command to build the docker image.
86
84
-*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.
88
86
-[How to push the image to Docker Hub](https://docs.docker.com/docker-hub/repos/#pushing-a-docker-container-image-to-docker-hub)
89
87
-[How to push the image to OCIR](https://www.oracle.com/webfolder/technetwork/tutorials/obe/oci/registry/index.html).
90
88
-[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
104
102
105
103
- 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.
106
104
- 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.
108
105
- 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.
109
106
- 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.
110
107
- 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
115
112
116
113
##### fluentd-daemonset.yaml
117
114
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.
119
116
- Inline comments are available in the file describing each of the fields/sections.
120
117
- Make sure to replace the fields with actual values before deploying.
121
118
- 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> tootag 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.
123
120
124
121
##### secrets.yaml (Optional)
125
122
126
123
- At present, InstancePrincipal and OCI Config File (UserPrincipal) based Auth/AuthZ are supported for Fluentd to talk to OCI Logging Analytics APIs.
127
124
- 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.
128
125
- 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.
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.
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.
0 commit comments