Skip to content

Using KOF#

Most of the time, you'll access KOF's data through Grafana.

Access to Grafana#

To make Grafana available, start with these steps:

  1. Get the Grafana username and password: 

    kubectl get secret -n kof grafana-admin-credentials -o yaml | yq '{
  "user": .data.GF_SECURITY_ADMIN_USER | @base64d,
  "pass": .data.GF_SECURITY_ADMIN_PASSWORD | @base64d
}'

  2. Forward a port to the Grafana dashboard: 

    kubectl port-forward -n kof svc/grafana-vm-service 3000:3000

  3. Login to http://127.0.0.1:3000/dashboards with the username/password printed above.

  4. Open a dashboard and select any cluster:

collect-from-3-cluster-roles

grafana-demo

Single Sign-On#

Port forwarding, as described above, is a quick solution.

Single Single-On provides better experience. If you want to enable it, please apply this advanced guide: SSO for Grafana.

Cluster Overview#

From here you can get an overview of the cluster, including:

  • Health metrics
  • Resource utilization
  • Performance trends
  • Cost analysis

Logging Interface#

The logging interface will also be available, including:

  • Real-time log streaming
  • Full-text search
  • Log aggregation
  • Alert correlation

Cost Management#

Finally there are the cost management features, including:

  • Resource cost tracking
  • Usage analysis
  • Budget monitoring
  • Optimization recommendations

Access to Jaeger#

Jaeger UI of each regional cluster can be accessed by following these steps:

  1. Ensure you have the regional-kubeconfig file created on the verification step.

  2. If you've applied the Istio section:

    • Forward a port to the Jaeger UI: 

      KUBECONFIG=regional-kubeconfig kubectl port-forward \
  -n kof svc/kof-storage-jaeger-query 16686:16686

    • Open the link http://127.0.0.1:16686/search and explore the Jaeger UI.

  3. If you have not applied the Istio section:

    • Ensure you have the REGIONAL_DOMAIN variable set on the installation step.

    • Get the regional Jaeger username and password: 

      KUBECONFIG=regional-kubeconfig kubectl get secret \
  -n kof jaeger-credentials -o yaml | yq '{
  "user": .data.username | @base64d,
  "pass": .data.password | @base64d
}'

    • Get the the Jaeger UI URL, open it, and login with the username/password printed above: 

      echo https://jaeger.$REGIONAL_DOMAIN

Access to the KOF UI#

When the TargetAllocator is in use, the configuration of OpenTelemetryCollectors Prometheus receivers is distributed across the cluster.

The KOF UI collects metrics metadata from the same endpoints that are scraped by the Prometheus server:

graph TB
    KOF_UI[KOF UI] --> C1OTC11
    KOF_UI --> C1OTC1N
    KOF_UI --> C1OTC21
    KOF_UI --> C1OTC2N
    KOF_UI --> C2OTC11
    KOF_UI --> C2OTC1N
    KOF_UI --> C2OTC21
    KOF_UI --> C2OTC2N
    subgraph Cluster1
    subgraph C1Node1[Node 1]
        C1OTC11[OTel Collector]
        C1OTC1N[OTel Collector]
    end
    subgraph C1NodeN[Node N]
        C1OTC21[OTel Collector]
        C1OTC2N[OTel Collector]
    end

    C1OTC11 --PrometheusReceiver--> C1TA[TargetAllocator]
    C1OTC1N --PrometheusReceiver--> C1TA
    C1OTC21 --PrometheusReceiver--> C1TA
    C1OTC2N --PrometheusReceiver--> C1TA
    end
    subgraph Cluster2
    subgraph C2Node1[Node 1]
        C2OTC11[OTel Collector]
        C2OTC1N[OTel Collector]
    end
    subgraph C2NodeN[Node N]
        C2OTC21[OTel Collector]
        C2OTC2N[OTel Collector]
    end

    C2OTC11 --PrometheusReceiver--> C2TA[TargetAllocator]
    C2OTC1N --PrometheusReceiver--> C2TA
    C2OTC21 --PrometheusReceiver--> C2TA
    C2OTC2N --PrometheusReceiver--> C2TA
    end

You can access the KOF UI by following these steps:

  1. Forward a port to the KOF UI:

    kubectl port-forward -n kof deploy/kof-mothership-kof-operator 9090:9090

  2. Open the link http://127.0.0.1:9090

  3. Check the state of the endpoints:

kof-ui-demo