This is unreleased documentation for SUSE® Virtualization v1.8 (Dev).

SUSE Observability Agent (Experimental)

suse-observability-agent is an experimental add-on. It is not included in the ISO, but you can download it from the experimental-addons repository. For more information about experimental features, see Feature Labels.

The suse-observability-agent add-on installs the SUSE® Observability Agent on the SUSE Virtualization cluster. This agent enables the cluster to connect to SUSE® Observability, which provides comprehensive monitoring, advanced analytics, and seamless integration capabilities.

Installing the add-on

  1. Obtain access data from SUSE® Observability.

    1. Log in to the SUSE® Observability UI.

    2. Add a new instance and assign a unique name.

    3. Click CREATE NEW SERVICE TOKEN.

      New SUSE Observability instance

    4. Follow the instructions and save the generated token.

      You must locate the keyword Generic Kubernetes.

  2. Deploy the SUSE® Observability Agent and Cluster Agent.

    1. Add the SUSE® Observability Helm repository to the local Helm client.

      helm repo add suse-observability https://charts.rancher.com/server-charts/prime/suse-observability
helm repo update

    2. Deploy the SUSE® Observability Kubernetes Node, Cluster Agent, and Checks Agent to the suse-observability namespace.

      helm upgrade --install \
--namespace suse-observability \
--create-namespace \
--set-string 'stackstate.apiKey'=$SERVICE_TOKEN \
--set-string 'stackstate.cluster.name'='harvester1' \
--set-string 'stackstate.url'='http://192.168.122.141:8090/receiver/stsAgent' \
suse-observability-agent suse-observability/suse-observability-agent

  3. Deploy the suse-observability-agent add-on to a running SUSE Virtualization cluster.

    kubectl apply -f https://raw.githubusercontent.com/harvester/experimental-addons/main/suse-observability-agent/suse-observability-agent.yaml

Enabling the add-on

  1. On the SUSE Virtualization UI, go to Advanced → Add-ons.

  2. Select suse-observability-agent (Experimental), and then select ⋮ → Edit YAML.

    Alternatively, run kubectl edit addons.harvesterhci -n suse-observability suse-observability-agent.

  3. Configure the following settings:

    • apiKey: Service token generated by SUSE® Observability.

    • cluster.name: Name used to identify the cluster (value of set-string 'stackstate.cluster.name').

    • url: Endpoint for the receiver (value of set-string 'stackstate.url').

      Example:

        valuesContent: |
    stackstate:
      apiKey: svctok-OxZrVBdB5g7UUESBNW1ozx5u7NrqaaBx
      cluster:
        name: harvester1
      url: http://192.168.122.233:8090/receiver/stsAgentreceiver/stsAgent'
      suse-observability-agent add-on YAML

      All specified values must match the values in SUSE® Observability.

  4. On the Add-ons screen, select suse-observability-agent, and then select ⋮ → Enable.

    suse-observability-agent add-on deployed

    When the add-on is enabled, the following pods are deployed to the suse-observability namespace in SUSE Virtualization.

    $ kubectl get pods -n suse-observability
NAME                                                      READY   STATUS      RESTARTS   AGE
helm-install-suse-observability-agent-tbk8w               0/1     Completed   0          7s
suse-observability-agent-checks-agent-5f5f5dc5b4-jgr6w    0/1     Running     0          5s
suse-observability-agent-cluster-agent-5f865f5f84-6q648   1/1     Running     0          5s
suse-observability-agent-logs-agent-rd6ks                 1/1     Running     0          5s
suse-observability-agent-node-agent-c5ldd                 1/2     Running     0          5s
suse-observability-agent-rbac-agent-7888cc47c9-pgj22      1/1     Running     0          5s

    In addition, the SUSE Virtualization instance is registered on the SUSE® Observability UI.