Skip to main content
Version: Next

Cluster Monitoring

Codesphere provides two monitoring options for your private cloud installation: cluster-level monitoring for individual cluster oversight, and aggregated monitoring across multiple clusters for enterprise-wide visibility. Choose the option that best fits your operational needs.

Cluster-Level Monitoring (Grafana)​

As part of the regular Codesphere installation, a Grafana instance with predefined dashboards is automatically deployed into the cluster. The login credentials are automatically generated. The Grafana UI can be reached via port-forwarding to localhost.

Steps to access the Grafana instance:

  1. Retrieve credentials:
    1. Username: admin
    2. Password: kubectl get secret grafana -n monitoring -o jsonpath={.data.admin-password} | base64 -d
  2. Access Grafana in your local browser:
    1. Start port-forward with kubectl port-forward deployment/grafana 3000:3000 -n monitoring
    2. On your local browser visit localhost:3000
    3. Login with the credentials from the previous step.
  3. Hint: if you only have kubectl access via e.g. a jumphost, you can use ssh port-forwarding to continue to your local machine: ssh -L 3000:localhost:3000 user@jumphost

Aggregated Multi-Cluster Monitoring​

For organizations managing multiple Codesphere clusters, aggregated monitoring provides centralized visibility across all installations. This option enables Prometheus remote write functionality to send metrics to a central monitoring system managed by Codesphere SRE.

Enabling Aggregated Monitoring​

To enable aggregated monitoring, configure the following settings in your installation values file as described in the installation guide:

monitoring:
  prometheus:
    # optional, enable if external monitoring by Codesphere SRE is agreed
    remoteWrite:
      enabled: false
      clusterName: my-cluster-name

Configuration Parameters​

  • enabled: Set to true to activate remote write functionality
  • clusterName: A unique identifier for this cluster in the aggregated monitoring system. Choose a descriptive name that clearly identifies the cluster (e.g., production-us-east, staging-eu-west)
note

Aggregated monitoring requires prior agreement with Codesphere SRE. Contact your Codesphere representative to set up the central monitoring infrastructure before enabling this feature.