V3.1.0

.gitignore

@@ -1,65 +1,69 @@
-# Copyright (c) 2023, Oracle and/or its affiliates.
-# Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
-
-.DS_Store
-
-####
-##  Ignore PEM files
-####
-
-**.pem
-
-####
-##  gitignore for terraform artifacts
-####
-
-# Local .terraform directories
-**/.terraform/*
-
-## Terraform Locck files
-*.terraform.lock.hcl
-
-# .tfstate filesdas
-*.tfstate
-*.tfstate.*
-
-# Crash log files
-crash.log
-crash.*.log
-
-# Exclude all .tfvars files, which are likely to contain sensitive data, such as
-# password, private keys, and other secrets. These should not be part of version
-# control as they are data points which are potentially sensitive and subject
-# to change depending on the environment.
-*.tfvars
-*.tfvars.json
-
-# Include sample tfvars
-!terraform-sample.tfvars
-
-# Ignore override files as they are usually used to override resources locally and so
-# are not checked in
-override.tf
-override.tf.json
-*_override.tf
-*_override.tf.json
-
-# Include override files you do wish to add to version control using negated pattern
-# !example_override.tf
-
-# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
-# example: *tfplan*
-
-# Ignore CLI configuration files
-.terraformrc
-terraform.rc
-
-# Ignore util dir
-logan/util/*
-
-# helm-chart
-charts/oci-onm/Chart.lock
-charts/oci-onm/charts/
-
-# zip artifacts
-releases/
+# Copyright (c) 2023, Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+.DS_Store
+
+####
+##  Ignore PEM files
+####
+
+**.pem
+
+####
+##  gitignore for terraform artifacts
+####
+
+# Local .terraform directories
+**/.terraform/*
+
+## Terraform Locck files
+*.terraform.lock.hcl
+
+# .tfstate filesdas
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+crash.*.log
+
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
+
+# Include sample tfvars
+!terraform-sample.tfvars
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
+
+# Ignore util dir
+logan/util/*
+
+# helm-chart
+charts/oci-onm/Chart.lock
+charts/oci-onm/charts/
+charts/.tests/
+
+# zip artifacts
+releases/
+
+# VSCode
+.vscode/

README.md

@@ -18,7 +18,7 @@ It does extensive enrichment of logs, metrics and object information to enable c
 ![Kubernetes Cluster Summary Dashboard](logan/images/kubernetes-cluster-summary-dashboard.png)
 
 <details>
-  <summary>Expand for more dasshboard screenshots</summary>
+  <summary>Expand for more dashboard screenshots</summary>
 
 ![Kubernetes Nodes Dashboard](logan/images/kubernetes-nodes-dashboard.png)
 
@@ -67,9 +67,9 @@ It does extensive enrichment of logs, metrics and object information to enable c
       ```
   </details>
 
-### Installation instructions 
+### Installation instructions
 
-#### Multiple methods of installation are avialble, with following differences:
+#### Multiple methods of installation are available, with following differences
 
 | Deployment Method | Supported Environments | Collection Automation | Dashboards | Customzations |
 | ----| :----:| :----:| :---: | ---|
@@ -114,7 +114,7 @@ It does extensive enrichment of logs, metrics and object information to enable c
         # Provide the base64 encoded content of the Management Agent Install Key file
         installKeyFileContent: 
     ```
-* **Refer to the oci-onm chart and sub-charts values.yaml for customising or modifying any other configuration.** It is recommended to not modify the values.yaml provided with the charts, instead use override_values.yaml to achieve the same.    
+* **Refer to the values.yaml file in oci-onm chart and sub-charts for customising or modifying any other configuration.** It is recommended to not modify the values.yaml provided with the charts, instead use override_values.yaml to achieve the same.    
 
 ##### 3.a Install helm release
 

charts/logan/README.md

@@ -15,7 +15,7 @@ Charts for sending Kubernetes platform logs, compute logs, and Kubernetes Object
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | authtype | string | `"InstancePrincipal"` | Allowed values: InstancePrincipal, config |
-| extraEnv | list | `[]` | Logging Analytics OCID for OKE Cluster ociLAEntityID: Logging Analytics additional metadata. Use this to tag all the collected logs with one or more key:value pairs. Key must be a valid field in Logging Analytics metadata: "Client Host Region": "PCT" "Environment": "Production" "Third key": "Third Value" @param extra environment variables. Example   name: ENV_VARIABLE_NAME   value: ENV_VARIABLE_VALUE |
+| extraEnv | list | `[]` | Use this to tag all the collected logs with one or more key:value pairs. Key must be a valid field in Logging Analytics metadata: "Client Host Region": "PCT" "Environment": "Production" "Third key": "Third Value" @param extra environment variables. Example   name: ENV_VARIABLE_NAME   value: ENV_VARIABLE_VALUE |
 | extraVolumeMounts | list | `[]` | @param extraVolumeMounts Mount extra volume(s). Example:   - name: tmpDir     mountPath: /tmp |
 | extraVolumes | list | `[]` | @param extraVolumes Extra volumes. Example:   - name: tmpDir     hostPath:         path: /tmp log |
 | fluentd.baseDir | string | `"/var/log"` | Base directory on the node (with read write permission) for storing fluentd plugins related data. |

charts/logan/templates/logs-configmap.yaml

@@ -100,11 +100,6 @@ data:
        {{- end }}
        oci_la_log_path "${record['tailed_path']}"
        oci_la_log_source_name "{{ $logDefinition.ociLALogSourceName | required (printf "fluentd.kubernetesSystem.logs.%s.ociLALogSourceName is required" $name) }}"
-       {{- if $logDefinition.ociLAEntityID }}
-       oci_la_entity_id "{{ $logDefinition.ociLAEntityID }}"
-       {{- else }}
-       oci_la_entity_id "{{ $.Values.fluentd.kubernetesSystem.ociLAEntityID | default $.Values.ociLAEntityID }}"
-       {{- end }}
        {{- if $logDefinition.ociLALogSet }}
        oci_la_log_set "{{ $logDefinition.ociLALogSet }}"
        {{- else }}
@@ -205,11 +200,6 @@ data:
        {{- end }}
        oci_la_log_path "${record['tailed_path']}"
        oci_la_log_source_name "{{ $logDefinition.ociLALogSourceName | required (printf "fluentd.linuxSystem.logs.%s.ociLALogSourceName is required" $name) }}"
-       {{- if $logDefinition.ociLAEntityID }}
-       oci_la_entity_id "{{ $logDefinition.ociLAEntityID }}"
-       {{- else }}
-       oci_la_entity_id "{{ $.Values.fluentd.linuxSystem.ociLAEntityID | default $.Values.ociLAEntityID }}"
-       {{- end }}
        {{- if $logDefinition.ociLALogSet }}
        oci_la_log_set "{{ $logDefinition.ociLALogSet }}"
        {{- else }}
@@ -294,11 +284,6 @@ data:
        {{- end }}
        oci_la_log_path "${record['tailed_path']}"
        oci_la_log_source_name "{{ required "fluentd.linuxSystem.logs.kubeletlog.ociLALogSourceName is required" $.Values.fluentd.linuxSystem.logs.kubeletlog.ociLALogSourceName }}"
-       {{- if $.Values.fluentd.linuxSystem.logs.kubeletlog.ociLAEntityID }}
-       oci_la_entity_id "{{ $.Values.fluentd.linuxSystem.logs.kubeletlog.ociLAEntityID }}"
-       {{- else }}
-       oci_la_entity_id "{{ $.Values.fluentd.linuxSystem.ociLAEntityID | default $.Values.ociLAEntityID }}"
-       {{- end }}
        {{- if $.Values.fluentd.linuxSystem.logs.kubeletlog.ociLALogSet }}
        oci_la_log_set "{{ $.Values.fluentd.linuxSystem.logs.kubeletlog.ociLALogSet }}"
        {{- else }}
@@ -329,11 +314,6 @@ data:
        {{- end }}
        oci_la_log_path "${record['tailed_path']}"
        oci_la_log_source_name "{{ required "fluentd.linuxSystem.logs.syslog.ociLALogSourceName is required" $.Values.fluentd.linuxSystem.logs.syslog.ociLALogSourceName }}"
-       {{- if $.Values.fluentd.linuxSystem.logs.syslog.ociLAEntityID }}
-       oci_la_entity_id "{{ $.Values.fluentd.linuxSystem.logs.syslog.ociLAEntityID }}"
-       {{- else }}
-       oci_la_entity_id "{{ $.Values.fluentd.linuxSystem.ociLAEntityID | default $.Values.ociLAEntityID }}"
-       {{- end }}
        {{- if $.Values.fluentd.linuxSystem.logs.syslog.ociLALogSet }}
        oci_la_log_set "{{ $.Values.fluentd.linuxSystem.logs.syslog.ociLALogSet }}"
        {{- else }}
@@ -408,7 +388,6 @@ data:
        {{- end }}
        oci_la_log_path "${record['tailed_path']}"
        oci_la_log_source_name "{{ $logDefinition.ociLALogSourceName | required (printf "fluentd.customLogs.%s.ociLALogSourceName is required" $name) }}"
-       oci_la_entity_id "{{ $logDefinition.ociLAEntityID | default $.Values.ociLAEntityID }}"
        oci_la_log_set "{{ $logDefinition.ociLALogSet | default $.Values.ociLALogSet }}"
        {{- if and (ne "false" ($logDefinition.isContainerLog | toString)) (eq $runtime "docker") }}
        message "${record['log']}"
@@ -515,7 +494,6 @@ data:
        oci_la_log_group_id ${record.dig("kubernetes", "annotations", "oracle.com/oci_la_log_group_id") ? record.dig("kubernetes", "annotations", "oracle.com/oci_la_log_group_id") : "{{ $.Values.fluentd.genericContainerLogs.ociLALogGroupID | default $.Values.ociLALogGroupID }}"}
        oci_la_log_path "${record['tailed_path']}"
        oci_la_log_source_name ${record.dig("kubernetes", "annotations", "oracle.com/oci_la_log_source_name") ? record.dig("kubernetes", "annotations", "oracle.com/oci_la_log_source_name") : "{{ $.Values.fluentd.genericContainerLogs.ociLALogSourceName | default "Kubernetes Container Generic Logs" }}"}
-       oci_la_entity_id ${record.dig("kubernetes", "annotations", "oracle.com/oci_la_entity_id") ? record.dig("kubernetes", "annotations", "oracle.com/oci_la_entity_id") : "{{ $.Values.fluentd.genericContainerLogs.ociLAEntityID | default $.Values.ociLAEntityID }}"}
        oci_la_log_set ${record.dig("kubernetes", "annotations", "oracle.com/oci_la_log_set") ? record.dig("kubernetes", "annotations", "oracle.com/oci_la_log_set") : "{{ $.Values.fluentd.genericContainerLogs.ociLALogSet | default $.Values.ociLALogSet }}"}
        {{- if eq $runtime "docker" }}
        message "${record['log']}"

charts/logan/templates/objects-configmap.yaml

@@ -100,7 +100,6 @@ data:
         oci_la_metadata ${{"{{"}}"Kubernetes Cluster Name":"{{ $kubernetesClusterName }}", "Kubernetes Cluster ID": "{{ $kubernetesClusterId }}" {{- range $k, $v := .Values.metadata }},{{ $k | quote }}: {{ $v | quote -}} {{- end }}{{"}}"}}
         {{- end }}
         oci_la_log_group_id "{{ .Values.fluentd.kubernetesObjects.ociLALogGroupID | default .Values.ociLALogGroupID }}"
-        oci_la_entity_id "{{ .Values.fluentd.kubernetesObjects.ociLAEntityID | default .Values.ociLAEntityID }}"
         oci_la_log_set "{{ .Values.fluentd.kubernetesObjects.ociLALogSet | default .Values.ociLALogSet }}"
         oci_la_log_path ${tag}
         oci_la_log_source_name "Kubernetes Object Logs"

charts/logan/values.yaml

@@ -67,8 +67,9 @@ kubernetesClusterID:
 # e.g. production-cluster
 kubernetesClusterName:
 
-# -- Logging Analytics OCID for OKE Cluster
-#ociLAEntityID:
+# -- Kubernetes Cluster Entity OCID.
+# e.g. ocid1.loganalyticsentity.oc1.phx.amaaaaaabulluiqabqeq4delvhdlmd7aqcjrdla57n2szsxyz7pfdvnhwuua
+ociLAClusterEntityID:
 
 # Logging Analytics additional metadata. Use this to tag all the collected logs with one or more key:value pairs.
 # Key must be a valid field in Logging Analytics
@@ -231,7 +232,6 @@ fluentd:
          #"Client Host Region": "America"
          #"Environment": "Production"
          #"Third Key": "Third Value"
-      #ociLAEntityID:
       #encoding:
       # Worker number in case of multi process workers enabled. If not set when multi process workers enabled, then it defaults to 0.
       #worker:
@@ -249,7 +249,6 @@ fluentd:
                #"Client Host Region": "America"
                #"Environment": "Production"
                #"Third Key": "Third Value"
-            #ociLAEntityID:
             #ociLALogGroupID:
             #encoding:
             # Worker number in case of multi process workers enabled. If not set when multi process workers enabled, then it defaults to 0.
@@ -311,7 +310,6 @@ fluentd:
          #"Client Host Region": "America"
          #"Environment": "Production"
          #"Third Key": "Third Value"
-      #ociLAEntityID:
       #encoding:
       # Worker number in case of multi process workers enabled. If not set when multi process workers enabled, then it defaults to 0.
       #worker:
@@ -417,7 +415,6 @@ fluentd:
             #"Client Host Region": "America"
             #"Environment": "Production"
             #"Third Key": "Third Value"
-         #ociLAEntityID:
          #encoding:
          # Worker number in case of multi process workers enabled. If not set when multi process workers enabled, then it defaults to 0.
          #worker:
@@ -445,7 +442,6 @@ fluentd:
          #"Client Host Region": "America"
          #"Environment": "Production"
          #"Third Key": "Third Value"
-      #ociLAEntityID:
       #ociLALogGroupID:
       objectsList:
          nodes:

terraform/modules/helm/helm.tf

@@ -6,8 +6,13 @@ data "oci_containerengine_clusters" "oke_clusters_list" {
 }
 
 locals {
+  helm_repo_url   = "https://oracle-quickstart.github.io/oci-kubernetes-monitoring"
+  helm_repo_chart = "oci-onm"
+
   oke_clusters_list = data.oci_containerengine_clusters.oke_clusters_list.clusters
-  oke_cluster_name  = [for c in local.oke_clusters_list : c.name if c.id == var.oke_cluster_ocid][0]
+  oke_cluster_name = var.oke_cluster_name == "NoInput" ? [for c in local.oke_clusters_list :
+  c.name if c.id == var.oke_cluster_ocid][0] : var.oke_cluster_name
+  oke_cluster_entity_ocid = var.oke_cluster_entity_ocid == "NoInput" ? null : var.oke_cluster_entity_ocid
 
   helm_inputs = {
     # global
@@ -32,12 +37,13 @@ locals {
     "createServiceAccount" = false
     "serviceAccount"       = var.livelab_service_account
   }
-
 }
 
+# Create helm release
 resource "helm_release" "oci-kubernetes-monitoring" {
   name              = "oci-kubernetes-monitoring"
-  chart             = var.helm_abs_path
+  repository        = var.use_local_helm_chart ? null : local.helm_repo_url
+  chart             = var.use_local_helm_chart ? var.helm_abs_path : local.helm_repo_chart
   wait              = true
   dependency_update = true
   atomic            = true
@@ -52,6 +58,14 @@ resource "helm_release" "oci-kubernetes-monitoring" {
     }
   }
 
+  dynamic "set" {
+    for_each = var.oke_cluster_entity_ocid == "NoInput" ? [] : ["run_once"]
+    content {
+      name  = "oci-onm-logan.ociLAClusterEntityID"
+      value = var.oke_cluster_entity_ocid
+    }
+  }
+
   dynamic "set" {
     for_each = var.deploy_mushop_config ? local.mushop_helm_inputs : {}
     content {
@@ -60,12 +74,14 @@ resource "helm_release" "oci-kubernetes-monitoring" {
     }
   }
 
-  count = var.generate_helm_template ? 0 : 1
+  count = var.install_helm ? 1 : 0
 }
 
+# Create helm template
 data "helm_template" "oci-kubernetes-monitoring" {
   name              = "oci-kubernetes-monitoring"
-  chart             = var.helm_abs_path
+  repository        = var.use_local_helm_chart ? null : local.helm_repo_url
+  chart             = var.use_local_helm_chart ? var.helm_abs_path : local.helm_repo_chart
   dependency_update = true
 
   values = var.deploy_mushop_config ? ["${file("${path.module}/mushop_values.yaml")}"] : null
@@ -78,6 +94,14 @@ data "helm_template" "oci-kubernetes-monitoring" {
     }
   }
 
+  dynamic "set" {
+    for_each = var.oke_cluster_entity_ocid == "NoInput" ? [] : ["run_once"]
+    content {
+      name  = "oci-onm-logan.ociLAClusterEntityID"
+      value = var.oke_cluster_entity_ocid
+    }
+  }
+
   dynamic "set" {
     for_each = var.deploy_mushop_config ? local.mushop_helm_inputs : {}
     content {
@@ -87,11 +111,4 @@ data "helm_template" "oci-kubernetes-monitoring" {
   }
 
   count = var.generate_helm_template ? 1 : 0
-}
-
-# Helm release artifacts for local testing and validation. Not used by helm resource.
-resource "local_file" "helm_release" {
-  content  = tostring(data.helm_template.oci-kubernetes-monitoring[0].manifest)
-  filename = "${path.module}/local/helmrelease.yaml"
-  count    = var.generate_helm_template ? 1 : 0
 }