Configure the add-ons

About configuring the Aspen Mesh add-ons

To configure the Aspen Mesh add-ons, you add particular fields to your Aspen Mesh override values file and then install (or upgrade) the Aspen Mesh add-ons. Learn how to install the Aspen Mesh add-ons.

Configure the Aspen Mesh control plane

Use the following fields to configure the Aspen Mesh control plane:

aspen-mesh-controlplane:
  enabled: true
  # The name of the cluster where Aspen Mesh is being installed (for reporting
  # via the dashboard)
  clusterId: <clusterName>

  userAuth:
    # type - The authentication mode for users within your organization to
    # access the dashboard. type can be set to "jwt", "oauthOpenshift", or
    # "none" (so any user can access the dashboard; this is not recommended).
    type: jwt
    # If type is set to "jwt", use these fields for configuration:
    jwt:
      # jwks (required) - The URL for retrieving the JSON Web Keys (JWKs) used
      #  for validating JSON Web Tokens (JWTs)
      jwks: https://<yourDomain>/.well-known/jwks.json
      # redirectUrl (required) - The URL that users should be redirected to if
      # they're not logged in
      redirectUrl: https://<yourDomain>/login
      # claims (optional) - A comma-delimited list of claims used for
      # validating JWTs
      # Example "aud=aspenmesh.io,role=k8s.admin". Default: "aud=aspenmesh.io"
      claims: aud=aspenmesh:io,role=k8s:admin

Configure Metrics Collector

Use the following fields to configure Metrics Collector:

aspen-mesh-metrics-collector:
  enabled: true
  server:
    # (Optional) For configurations where PVCs are manually allocated
    persistentVolume:
      # Add the name of the manually created PVC (for example,
      # aspen-mesh-metrics-collector).
      existingClaim: '<yourPvcName>'

Configure event and alert storage

Use the following fields to configure event and alert storage:

aspen-mesh-event-storage:
  enabled: true
  persistence:
    # size - The size of the persistent volume storage for the
    # aspen-mesh-event-storage stateful-set object (Cassandra database)
    # Default: 10Gi
    size: 10Gi
  config:
    # cluster_size - The number of pods in the aspen-mesh-event-storage
    # stateful-set object (Cassandra database)
    # Default: 3
    cluster_size: 3
    # max_heap_size - The recommended max heap size is 1/2 of system memory
    # Default: 2048M
    max_heap_size: 2048M
    # heap_new_size - The recommended heap new size is 1/4 of max heap size
    # Default value: 512M
    heap_new_size: 512M

Note

Approximately 100,000 events and alerts in an eight-day retention period can be stored using the default values.