Customizing your mesh#

The Aspen Mesh installation requires a few customizations, all of which can be configured by creating an override Helm values file. This override values file will be used to install and/or upgrade to future verions of Aspen Mesh.

It is highly recommended to store your override values file in a source control repository like Git where your configuration resources are kept for your cluster.

Below is an example of an override values file which adds the following customizations:

  • Set the name of your cluster for reporting via Aspen Mesh dashboard.

  • Configure the authentication mode for users within your organization to access the Aspen Mesh dashboard. The default option is jwt which requires jwks and redirectUrl options to be set. You can configure the userAuth mode to insecure option none where any user can access the dashboard. Read this guide for various options available to access Aspen Mesh dashboard.

  • For manual provisioning of persistent volume claims (PVCs), you can add your existing PVC under the aspen-mesh-metrics-collector section.

    aspen-mesh-controlplane:
  # The name of the cluster where Aspen Mesh is being installed.
  clusterId: MyCluster

  userAuth:
    # type can be set to `jwt` or `none`. JWT authentication is highly recommended.
    type: jwt
    # If type is set to jwt, use the below parameters for configuration:
    jwt:
      # jwks (Required) - The URL for retrieving the Json Web Keys (JWKs) used for validating Json Web Tokens (JWTs).
      jwks: https://YOUR_DOMAIN/.well-known/jwks.json
      # redirectUrl (Required) - The URL that users should be redirected to if they're not logged in.
      redirectUrl: https://YOUR_DOMAIN/login
      # (Optional) - A comma delimited list of claims used for validating JWTs. Example "aud=aspenmesh.io,role=k8s.admin". Defaults to "aud=aspenmesh.io"
      #claims: aud=aspenmesh:io,role=k8s:admin

aspen-mesh-metrics-collector:
  server:
    # (Optional) For configurations where PVCs are manually allocated
    persistentVolume:
      # Add the name of the manually created PVC. (e.g. aspen-mesh-metrics-collector)
      existingClaim: 'YOUR_PVC_NAME'

Warning

The following values must be added to the override Helm values file if you are installing Aspen Mesh in CNI mode.

istio_cni:
  enabled: true

sidecarInjectorWebhook:
  injectedAnnotations:
    k8s.v1.cni.cncf.io/networks: istio-cni