oci-logging-analytics-kubernetes-discovery 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 358cc8651c1361741c8232f14c77c4d40aec7a9981a491c5b0f835baada853c6
-  data.tar.gz: deb40680dae588f0c26580679c2c4ff35afd941dfb14447ea8ec09e2ddbd4985
+  metadata.gz: cbe8ec23d60bcc04c315d7961b841fd7f0ccd7ba3c2133e1fd7db537dcbc4e3c
+  data.tar.gz: a02f9f5241b9ab760b9f9c6cf6eb8a29f8667c3dbfd23ae0a761195e9eee69b2
 SHA512:
-  metadata.gz: a4cb5609901d156a1c1d792e60c352e30a1bcae3a777388dde13dbce966671982489263e954cc12ad2ce6e7061e7f066a04a8f8d9e7921c2bb0f4d7bafe9f1e8
-  data.tar.gz: 3e3f52a6ea9d8c7f2bf0e59b15aeb7525e8b0649b71bfb4bec6c1be31d2505a901b1e13260e4a51a9ded9112f5d3aae58a7fe39c9d001d042b9f825cc5004520
+  metadata.gz: d086d772a3f91bddd8f85d1627cbb825cb2373aff0e55cbef28a9d28dabded567170df1a778f176682812f693a6baf49067631f510eace5e2de5a44500b119f2
+  data.tar.gz: 1dcd772179a5c037c23924f685d23716f788cd78db2d254c64b77ccacd2528b87132ab726e95c109ddd33d6d7e3ce94c5ef825f7aa8f918ece96880d5a5fada6

data/.ruby-gemset

@@ -0,0 +1 @@
+logan-kubernetes-discovery

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.5

data/README.md

@@ -1,8 +1,8 @@
-# OCI Logging Analytics Kubernetes Discovery
+# OCI Log Analytics Kubernetes Discovery
 
 ## Overview
 
-A rubygem for discovering Kubernetes resources and send it to OCI Logging Analytics.
+A rubygem for discovering Kubernetes resources and send it to OCI Log Analytics.
 
 ## Installation
 
@@ -31,9 +31,9 @@ Usage: oci-loganalytics-kubernetes-discovery [options]
         --oci_la_namespace OCI_LA_NAMESPACE
                                      OCI Tenancy Namespace to which the collected log data is to be uploaded
         --oci_la_log_group_id OCI_LA_LOG_GROUP_ID
-                                     OCID of Logging Analytics Log Group to which the uploaded data is to be associated with
+                                     OCID of Log Analytics Log Group to which the uploaded data is to be associated with
         --oci_la_cluster_entity_id KUBERNETES_CLUSTER_ENTITY_ID
-                                     OCID of Logging Analytics Kubernetes Cluster entity
+                                     OCID of Log Analytics Kubernetes Cluster entity
         --kubernetes_cluster_name KUBERNETES_CLUSTER_NAME
                                      A unique name for each kubernetes cluster must be provided
         --kubernetes_cluster_namespace KUBERNETES_CLUSTER_NAMESPACE
@@ -42,7 +42,7 @@ Usage: oci-loganalytics-kubernetes-discovery [options]
                                      Kubernetes cluster resourcename prefix. Defaults to oci-onm
         --kubernetes_cluster_id KUBERNETES_CLUSTER_ID
                                      Unique identifier for Kubernetes cluster
-        --endpoint ENDPOINT          Logging Analytics Ingestion API endpoint to ingest your application logs
+        --endpoint ENDPOINT          Log Analytics Ingestion API endpoint to ingest your application logs
         --profile_name PROFILE_NAME  OCI Config Profile Name to be used from the configuration file
         --config_file_location CONFIG_FILE_LOCATION
                                      The location of the configuration file containing OCI authentication details
@@ -59,7 +59,7 @@ Usage: oci-loganalytics-kubernetes-discovery [options]
         --secret_dir SECRET_DIR      Path to Kubernetes service account token file to access Kubernetes API
         --discovery DISCOVERY_MODE   Discovery mode to be used: {infra|object}
         --chunk_limit CHUNK_SIZE     Max number of objects that can be fetched via K8s GET API call. Default: 1000
-        --skip_upload                Flag to skip uploading data to OCI Logging Analytics [ONLY FOR INTERNAL TESTING]
+        --skip_upload                Flag to skip uploading data to OCI Log Analytics [ONLY FOR INTERNAL TESTING]
         --collect_warning_events_only
                                      Flag to collect only warning event logs
         --log_format LOG_FORMAT      Log format to be used: {text|json}

data/bin/oci-loganalytics-kubernetes-discovery

@@ -29,8 +29,8 @@ optparse = OptionParser.new do |param|
 
   # Mandatory Fields
   param.on('--oci_la_namespace OCI_LA_NAMESPACE', 'OCI Tenancy Namespace to which the collected log data is to be uploaded') { |o| cluster_config[:oci_la_namespace] = o }
-  param.on('--oci_la_log_group_id OCI_LA_LOG_GROUP_ID', 'OCID of Logging Analytics Log Group to which the uploaded data is to be associated with') { |o| cluster_config[:oci_la_log_group_id] = o }
-  param.on('--oci_la_cluster_entity_id KUBERNETES_CLUSTER_ENTITY_ID', 'OCID of Logging Analytics Kubernetes Cluster entity') { |o| cluster_config[:oci_la_cluster_entity_id] = o }
+  param.on('--oci_la_log_group_id OCI_LA_LOG_GROUP_ID', 'OCID of Log Analytics Log Group to which the uploaded data is to be associated with') { |o| cluster_config[:oci_la_log_group_id] = o }
+  param.on('--oci_la_cluster_entity_id KUBERNETES_CLUSTER_ENTITY_ID', 'OCID of Log Analytics Kubernetes Cluster entity') { |o| cluster_config[:oci_la_cluster_entity_id] = o }
   param.on('--kubernetes_cluster_name KUBERNETES_CLUSTER_NAME', 'A unique name for each kubernetes cluster must be provided') { |o| cluster_config[:kubernetes_cluster_name] = o }
   param.on('--kubernetes_cluster_namespace KUBERNETES_CLUSTER_NAMESPACE', 'Kubernetes namespace in which the discovery job is configured') { |o| cluster_config[:kubernetes_cluster_namespace] = o }
   param.on('--kubernetes_resourcename_prefix PREFIX', 'Kubernetes cluster resourcename prefix. Defaults to oci-onm') { |o| cluster_config[:kubernetes_resourcename_prefix] = o }
@@ -44,8 +44,8 @@ optparse = OptionParser.new do |param|
   param.on('--profile_name PROFILE_NAME', 'OCI Config Profile Name to be used from the configuration file') { |o| auth_config[:profile_name] = o }
   param.on('--config_file_location CONFIG_FILE_LOCATION', 'The location of the configuration file containing OCI authentication details') { |o| auth_config[:config_file_location] = o }
 
-  # OCI Logging Analytics custom endpoints
-  param.on('--endpoint ENDPOINT', 'Logging Analytics Ingestion API endpoint to ingest your application logs') { |o| auth_config[:endpoint] = o }
+  # OCI Log Analytics custom endpoints
+  param.on('--endpoint ENDPOINT', 'Log Analytics Ingestion API endpoint to ingest your application logs') { |o| auth_config[:endpoint] = o }
 
   # Kubernetes Cluster
   # For AuthNAuth when the job is outside the cluster.
@@ -63,7 +63,7 @@ optparse = OptionParser.new do |param|
   # Discovery
   param.on('--discovery DISCOVERY_MODE', "[Deprecated] Discovery mode to be used: #{format_option_selections(DISCOVERY_OPTIONS)}") { |o| app_config[:mode] = o.downcase }
   param.on('--chunk_limit CHUNK_SIZE', Integer, "Max number of objects that can be fetched via K8s GET API call. Default: #{CHUNK_LIMIT_DEFAULT}") { |o| app_config[:chunk_limit] = o }
-  param.on('--skip_upload', 'Flag to skip uploading data to OCI Logging Analytics [ONLY FOR INTERNAL TESTING]') { |_o| app_config[:skip_upload] = true }
+  param.on('--skip_upload', 'Flag to skip uploading data to OCI Log Analytics [ONLY FOR INTERNAL TESTING]') { |_o| app_config[:skip_upload] = true }
   param.on('--collect_warning_events_only', 'Flag to collect only warning event logs') { |_o| app_config[:collect_warning_events_only] = true }
   param.on('--tenancy_ocid TENANCY_OCID', 'Tenancy OCID') { |o| app_config[:tenancy_ocid] = o }
 
@@ -115,6 +115,13 @@ begin
     end
   end
 
+  # Valid oci_domain format check
+  unless auth_config[:oci_domain].nil?
+    unless auth_config[:oci_domain].match?(/^[a-z0-9-]+\.oci\.[a-z0-9.]+[a-z0-9]$/i)
+      raise OptionParser::InvalidOption, "--oci_domain '#{auth_config[:oci_domain]}' | " \
+            "expected format: <region>.oci.<domain> (e.g., us-ashburn-1.oci.oraclecloud.com)"
+    end
+  end
   # If threads are enabled, thread count and queue size should be provided as arguments.
   if app_config[:enable_threading] && app_config[:thread_count].nil?
     raise OptionParser::MissingArgument, '--thread_count'
@@ -164,10 +171,12 @@ cluster_config[:oci_la_cluster_entity_id] = cluster_config[:oci_la_cluster_entit
 cluster_config[:kubernetes_resourcename_prefix] = cluster_config[:kubernetes_resourcename_prefix] ||= 'oci-onm'
 
 # OCI Auth Type
-if !auth_config[:config_file_location].nil?
-  auth_config[:auth_type] = auth_config[:auth_type] ||=  Enum::AuthTypeEnum::CONFIG
-else
-  auth_config[:auth_type] = auth_config[:auth_type] ||=  Enum::AuthTypeEnum::INSTANCE_PRINCIPAL
+if auth_config[:auth_type].nil?
+  if !auth_config[:config_file_location].nil?
+    auth_config[:auth_type] = Enum::AuthTypeEnum::CONFIG
+  else
+    auth_config[:auth_type] = Enum::AuthTypeEnum::INSTANCE_PRINCIPAL
+  end
 end
 
 # OCI Domain
@@ -177,7 +186,7 @@ auth_config[:oci_domain] = auth_config[:oci_domain] ||= nil
 auth_config[:profile_name] = auth_config[:profile_name] ||= 'DEFAULT'
 auth_config[:config_file_location] = auth_config[:config_file_location] ||= nil
 
-# OCI Logging Analytics custom endpoints
+# OCI Log Analytics custom endpoints
 auth_config[:endpoint] = auth_config[:endpoint] ||= nil
 
 # Kubernetes cluster related

data/lib/enum/auth_type_enum.rb

@@ -5,6 +5,6 @@ module Enum
   module AuthTypeEnum
     CONFIG = 'config'.freeze
     INSTANCE_PRINCIPAL = 'instance_principal'.freeze
-    # OKE_WORKLOAD_IDENTITY = 'oke_workload_identity'.freeze
+    OKE_WORKLOAD_IDENTITY = 'oke_workload_identity'.freeze
   end
 end

data/lib/oci_loganalytics_resources_discovery.rb

@@ -123,7 +123,7 @@ module OciLogAnalyticsResourcesDiscovery
 
     # Send collected data
     if @app_config_hash[:skip_upload]
-      logger.warn('--skip_upload Flag is set: Skipping payload upload to OCI logging analytics.')
+      logger.warn('--skip_upload Flag is set: Skipping payload upload to OCI Log Analytics.')
     else
       upload_failure = false
 

data/lib/util/oci_clients.rb

@@ -14,7 +14,7 @@ module Util
     module_function
 
     attr_accessor :oci_clients, :ce_client, :id_client, :lb_client, :la_client, :rs_client,
-                  :vcn_client, :oci_config, :instance_principals_signer, :la_endpoint,
+                  :vcn_client, :oci_config, :instance_principals_signer, :workload_identity_signer , :la_endpoint,
                   :auth_type, :auth_config_object, :oci_domain, :oci_retry_config, :oci_region
 
     # This must be the first method called before any other method
@@ -56,8 +56,38 @@ module Util
             )
           end
           @oci_region = @instance_principals_signer.region
-        # elsif @auth_type == Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
-        #   @workload_identity_signer = OCI::Auth::Signers::oke_workload_resource_principal_signer
+        elsif @auth_type == Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
+          @oci_config = OCI::Config.new
+          @workload_identity_signer = OCI::Auth::Signers.oke_workload_resource_principal_signer
+          if !@oci_domain.nil?
+            region_match = @oci_domain.match(/^([a-z0-9-]+)\.oci\./i)
+            if region_match
+                @oci_region = region_match[1]
+                logger.info("Extracted region from domain: #{@oci_region}")
+            else
+                raise StandardError, "Invalid oci_domain format: '#{@oci_domain}'. " \
+                          "Expected: <region>.oci.<domain> (e.g., us-ashburn-1.oci.oraclecloud.com)"
+            end
+          else
+            begin
+                tmp_signer = OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner.new
+                if tmp_signer.region
+                    @oci_region = tmp_signer.region
+                    logger.info("extracted region from IMDS: #{@oci_region}")
+                else
+                    raise StandardError, "IMDS returned nil region. " \
+                                  "Provide --oci_domain parameter (e.g., us-ashburn-1.oci.oraclecloud.com)."
+                end
+            rescue StandardError => e
+                raise
+            rescue => e
+                raise StandardError, "Unable to determine region. " \
+                          "IMDS not available: #{e.message}. " \
+                          "Provide --oci_domain parameter (e.g., us-ashburn-1.oci.oraclecloud.com)."
+            end
+          end
+          @oci_config.region = @oci_region
+
         elsif @auth_type == Enum::AuthTypeEnum::CONFIG
           @oci_config = OCI::ConfigFileLoader.load_config(config_file_location: auth_config_hash[:config_file_location],
           profile_name: auth_config_hash[:profile_name])
@@ -132,6 +162,11 @@ module Util
                 config: @oci_config, endpoint: endpoint,
                 signer: @instance_principals_signer,
                 retry_config: retry_config)
+        when Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
+          client = OCI::ContainerEngine::ContainerEngineClient.new(
+                config: @oci_config, endpoint: endpoint,
+                signer: @workload_identity_signer,
+                retry_config: retry_config)
         else
           logger.warn("Unknown auth_type '#{@auth_type}' provided for container engine client.")
         end
@@ -159,6 +194,8 @@ module Util
           client = OCI::Identity::IdentityClient.new(config: @oci_config, endpoint: endpoint, retry_config: retry_config)
         when Enum::AuthTypeEnum::INSTANCE_PRINCIPAL
           client = OCI::Identity::IdentityClient.new(config: @oci_config, endpoint: endpoint, signer: @instance_principals_signer, retry_config: retry_config)
+        when Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
+          client = OCI::Identity::IdentityClient.new(config: @oci_config, endpoint: endpoint, signer: @workload_identity_signer, retry_config: retry_config)
         else
           logger.warn("Unknown auth_type '#{@auth_type}' provided for identity client.")
         end
@@ -186,6 +223,8 @@ module Util
           client = OCI::LoadBalancer::LoadBalancerClient.new(config: @oci_config, endpoint: endpoint, retry_config: retry_config)
         when Enum::AuthTypeEnum::INSTANCE_PRINCIPAL
           client = OCI::LoadBalancer::LoadBalancerClient.new(config: @oci_config, endpoint: endpoint, signer: @instance_principals_signer, retry_config: retry_config)
+        when Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
+          client = OCI::LoadBalancer::LoadBalancerClient.new(config: @oci_config, endpoint: endpoint, signer: @workload_identity_signer, retry_config: retry_config)
         else
           logger.warn("Unknown auth_type '#{@auth_type}' provided for load balancer client.")
         end
@@ -221,6 +260,11 @@ module Util
                                                              endpoint: endpoint,
                                                              signer: @instance_principals_signer,
                                                              retry_config: retry_config)
+        when Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
+          client = OCI::LogAnalytics::LogAnalyticsClient.new(config: @oci_config,
+                                                             endpoint: endpoint,
+                                                             signer: @workload_identity_signer,
+                                                             retry_config: retry_config)
         else
           logger.warn("Unknown auth_type while creating log analytics client: #{@auth_type}")
           raise StandardError, 'Unknown auth_type for log analytics client.'
@@ -252,6 +296,8 @@ module Util
           client = OCI::ResourceSearch::ResourceSearchClient.new(config: @oci_config, endpoint: endpoint, retry_config: retry_config)
         when Enum::AuthTypeEnum::INSTANCE_PRINCIPAL
           client = OCI::ResourceSearch::ResourceSearchClient.new(config: @oci_config, endpoint: endpoint, signer: @instance_principals_signer, retry_config: retry_config)
+        when Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
+          client = OCI::ResourceSearch::ResourceSearchClient.new(config: @oci_config, endpoint: endpoint, signer: @workload_identity_signer, retry_config: retry_config)
         else
           logger.warn("Unknown auth_type '#{@auth_type}' provided for resource search client.")
         end
@@ -284,6 +330,8 @@ module Util
           client = OCI::Core::VirtualNetworkClient.new(config: @oci_config, endpoint: endpoint, retry_config: retry_config)
         when Enum::AuthTypeEnum::INSTANCE_PRINCIPAL
           client = OCI::Core::VirtualNetworkClient.new(config: @oci_config, endpoint: endpoint, signer: @instance_principals_signer, retry_config: retry_config)
+        when Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
+          client = OCI::Core::VirtualNetworkClient.new(config: @oci_config, endpoint: endpoint, signer: @workload_identity_signer, retry_config: retry_config)
         else
           logger.warn("Unknown auth_type '#{@auth_type}' provided for virtual network client.")
         end
@@ -317,6 +365,11 @@ module Util
                                                                    endpoint: endpoint,
                                                                    signer: @instance_principals_signer,
                                                                    retry_config: retry_config)
+        when Enum::AuthTypeEnum::OKE_WORKLOAD_IDENTITY
+          client = OCI::ResourceManager::ResourceManagerClient.new(config: @oci_config,
+                                                                   endpoint: endpoint,
+                                                                   signer: @workload_identity_signer,
+                                                                   retry_config: retry_config)
         else
           logger.warn("Unknown auth_type '#{auth_object[:auth_type]}' provided for resource manager client.")
         end
@@ -338,7 +391,7 @@ module Util
         oci_config: @oci_config,
         la_endpoint: @la_endpoint,
         instance_principals_signer: @instance_principals_signer,
-        # workload_identity_signer: @workload_identity_signer,
+        workload_identity_signer: @workload_identity_signer,
         auth_type: @auth_type,
         oci_domain: @oci_domain
       }.compact

data/lib/util/service_logs.rb

@@ -20,6 +20,7 @@ module Util
 
     # Prefix of resource manager stack (to be created via API)
     RESOURCE_MANAGER_STACK_PREFIX = 'oci-kubernetes-monitoring-service-logs'.freeze
+    STACK_TF_VERSION_STRING = '1.5.x'.freeze
 
     def invoke_resource_manager_stack(infra_objects_payload, app_config_hash,
           oci_la_log_group_id, onm_compartment_id, oci_region, oci_domain)
@@ -397,7 +398,7 @@ module Util
           client.create_stack(
             OCI::ResourceManager::Models::CreateStackDetails.new(
               compartment_id: compartment_id,
-              terraform_version: '1.2.x',
+              terraform_version: STACK_TF_VERSION_STRING,
               display_name: stack_unique_identifier,
               description: stack_unique_identifier,
               config_source:
@@ -521,6 +522,7 @@ module Util
         response = client.update_stack(stack_ocid,
                                        OCI::ResourceManager::Models::UpdateStackDetails.new(
                                           variables: rms_input_variables,
+                                          terraform_version: STACK_TF_VERSION_STRING,
                                           config_source: OCI::ResourceManager::Models::UpdateZipUploadConfigSourceDetails.new(zip_file_base64_encoded: rms_template_base64_encoded)
                                         )
                                       )

data/lib/version.rb

@@ -2,5 +2,5 @@
 ## The Universal Permissive License (UPL), Version 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 module Discovery
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/oci-logging-analytics-kubernetes-discovery.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Oracle', 'OCI Observability: Logging Analytics']
   spec.email         = ['oci_la_plugins_grp@oracle.com']
 
-  spec.summary       = 'A rubygem for discovering Kubernetes resources and send it to OCI Logging Analytics.'
-  spec.description   = 'A rubygem for discovering Kubernetes resources and send it to OCI Logging Analytics.'
+  spec.summary       = 'A rubygem for discovering Kubernetes resources and send it to OCI Log Analytics.'
+  spec.description   = 'A rubygem for discovering Kubernetes resources and send it to OCI Log Analytics.'
   spec.homepage      = 'https://rubygems.org/gems/oci-logging-analytics-kubernetes-discovery'
   spec.license       = 'UPL-1.0'
 

data/ocibuild.conf

@@ -1,7 +1,7 @@
 runnerTag: latest
 name: logan-kubernetes-discovery
 team: LOGAN
-description: Build config to build Logging Analytics Kubernetes Discovery gem.
+description: Build config to build Log Analytics Kubernetes Discovery gem.
 phoneBookId: logan
 version: ${BLD_NUMBER}
 authCompartmentOcid: ocid1.tenancy.oc1..aaaaaaaauj75yrhg54zor44qlc3chockspqc6e5c7nxlxjlcnunxo2hbs6ca

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oci-logging-analytics-kubernetes-discovery
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Oracle
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-28 00:00:00.000000000 Z
+date: 2026-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -261,7 +261,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: A rubygem for discovering Kubernetes resources and send it to OCI Logging
+description: A rubygem for discovering Kubernetes resources and send it to OCI Log
   Analytics.
 email:
 - oci_la_plugins_grp@oracle.com
@@ -271,6 +271,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -335,6 +337,5 @@ requirements: []
 rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
-summary: A rubygem for discovering Kubernetes resources and send it to OCI Logging
-  Analytics.
+summary: A rubygem for discovering Kubernetes resources and send it to OCI Log Analytics.
 test_files: []