Configure the dashboard storage

This document contains instructions to configure the storage size for dashboards using the ObservabilityPipeline custom resource. The instructions override the default values for the project namespace.

The Observability pipeline of Google Distributed Cloud (GDC) air-gapped appliance manages the deployment and configuration of Observability stack components. The ObservabilityPipeline custom resource lets you reach the API of the Observability pipeline and configure the Observability service for your deployments. This custom resource includes customized settings for dashboards used in system monitoring.

Before you begin

To get the permissions you need to configure or view the storage size for dashboards, ask your Security Admin to grant you one of the following roles in the infra-obs namespace:

• Observability Pipeline Creator: creates ObservabilityPipeline custom resources. Request the Observability Pipeline IO Creator (observabilitypipeline-io-creator) cluster role.
• Observability Pipeline Editor: edits or modifies ObservabilityPipeline custom resources. Request the Observability Pipeline IO Editor (observabilitypipeline-io-editor) cluster role.
• Observability Pipeline Viewer: views ObservabilityPipeline custom resources. Request the Observability Pipeline IO Viewer (observabilitypipeline-io-viewer) cluster role.

Before configuring the storage size for dashboards, work through the following steps:

1. Set the path of the kubeconfig file as an environment variable:

   export KUBECONFIG=KUBECONFIG_FILE
   

   Replace KUBECONFIG_FILE with the path of the kubeconfig file for the admin cluster.

2. Deploy the ObservabilityPipeline custom resource with the name observability-config into the project namespace.

3. View the current configuration of your Observability deployment:

   • For Infrastructure Operator (IO)

   kubectl --kubeconfig=${KUBECONFIG} get observabilitypipeline -n infra-obs observability-config -o yaml
   

   • For Platform administrator (PA)

   kubectl --kubeconfig=${KUBECONFIG} get observabilitypipeline -n platform-obs observability-config -o yaml
   

Update the storage size for dashboards

Work through the following steps to configure the storage size for dashboards in the project:

• For Infrastructure Operator (IO)

1. Open your ObservabilityPipeline custom resource in a command-line editor:

   kubectl --kubeconfig=${KUBECONFIG} -n infra-obs edit observabilitypipeline/observability-config
   

2. Update the storageSize value nested in the monitoring field:

     # Configure observability pipeline
   apiVersion: observability.gdc.goog/v1
   kind: ObservabilityPipeline
   metadata:
     namespace: infra-obs
     name: observability-config
   spec:
     ...
     monitoring:
       grafana:
         storageSize: 1Gi # Configure the new storage size for dashboards in the project.
       ...
   

3. Save the change and exit your command-line editor.

   • For Platform administrator (PA)

4. Open your ObservabilityPipeline custom resource in a command-line editor:

   kubectl --kubeconfig=${KUBECONFIG} -n platform-obs edit observabilitypipeline/observability-config
   

5. Update the storageSize value nested in the monitoring field:

     # Configure observability pipeline
   apiVersion: observability.gdc.goog/v1
   kind: ObservabilityPipeline
   metadata:
     namespace: platform-obs
     name: observability-config
   spec:
     ...
     monitoring:
       grafana:
         storageSize: 1Gi # Configure the new storage size for dashboards in the project.
       ...
   

6. Save the change and exit your command-line editor.

Sample configuration

The following YAML file shows a sample configuration of the ObservabilityPipeline custom resource:

  # Configure observability pipeline
apiVersion: observability.gdc.goog/v1
kind: ObservabilityPipeline
metadata:
  # Don't change the namespace or name.
  namespace: platform-obs
  name: observability-config
spec:
  ...
  monitoring:
    grafana:
      storageSize: 1Gi
    ...