Using Kubernetes Monitoring Helm chart

Deploy the agent software and Java Management Service plug-in on a Kubernetes cluster to monitor and manage your applications.

The following steps detail the process to configure and install the helm chart:
  1. Configure the Helm chart:
    The OCI Kubernetes Monitoring Helm chart includes templates that require user-provided values. The values.yaml file is located in the oci-onm directory that you created when you downloaded the Helm chart. Update the oci-onm/values.yaml file according to the instructions provided.
    Note

    The following file snippets are only portions of the actual file. Ensure that you modify only the fields marked as [Input Required].
    global:
      [...]
      kubernetesClusterID:
      # -- Provide a unique name for the cluster. This would help uniquely identifying the logs and metrics data at OCI Logging Analytics and OCI Monitoring respectively, when monitoring multiple clusters
      kubernetesClusterName: NameOfYourCluster # [INPUT REQUIRED] Enter a name for your cluster. This will be the host name for the managed instance in JMS Fleets.
    
    [...]
    
    oci-onm-logan:
     enabled: false # [INPUT REQUIRED] Add this line to disable logging analytics as JMS does not depend on it
     oci-onm-common:
        enabled: false
    [...] 
    
    oci-onm-mgmt-agent:
      [...]
      kubernetesCluster:
        name: "< .Values.global.kubernetesClusterName >"
      mgmtagent:
        # Provide the base64 encoded content of the Management Agent Install Key file (e.g. cat input.rsp | base64 -w 0)
        installKeyFileContent: "" # [INPUT REQUIRED] Enter the base64 value copied from step 2 between the quotes
        # Follow steps documented at https://github.com/oracle/docker-images/tree/main/OracleManagementAgent to build docker image.
        image:
          [...]
  2. From the parent directory of the oci-onm folder, run the following command to verify the Helm chart:
    helm template oci-onm/

    Ensure that no errors appear in the console output.

  3. Install the Helm chart in the default namespace:

    From the parent directory of the oci-onm folder, run the following command to install the Helm chart in the default namespace.

    helm install mgmtagent-monitoring oci-onm/ -n default
  4. Verify the installation:
    Verify that the StatefulSet for the Management Agent is ready and running by checking its status with the following command:
    kubectl get pods -n oci-onm