13.2. Clara Deploy SDK Configuration

clara uses the configuration stored in ~/.clara/ to install and uninstall the Clara Deploy SDK helm charts and communicate with the Clara Deploy SDK APIs. Custom configuration can be specified in place of the default configuration by using the --config flag.

13.2.1. Structure

~/.clara has the following structure:

# ~/.clara/
#     charts/
#         clara/                           <- The Clara helm chart
#         clara-renderer/                  <- The Render Server helm chart
#         dicom-adapter/                   <- The DICOM Adapter helm chart
#         results-service/                 <- The results service helm chart
#     clara-chart-config.yaml              <- Overrides used when installing the clara helm chart
#     clara-common-chart-config.yaml       <- Overrides common to all the helm charts
#     config.yaml                          <- CLI config

13.2.2. config.yaml

~/.clara/config.yaml is the root configuration file that manages all other configurations. clara uses this configuration to execute actions and commands. ~/.clara/config.yaml consists of the following fields:

# The version of the cli
version: "##.##.##"

# All helm configuration is specified under this propery
helm:

  # All helm chart configuration is specified under this property
  charts:

    # Specified configuration for the clara helm chart
    clara:
      # The Kubernetes namespace
      namespace: "default"

      # Overrides used during helm install
      overrides:
      - "~/.clara/clara-chart-config.yaml"

      # The path to the helm chart
      path: "~/.clara/charts/clara"

      # Helm release name
      releaseName: "clara"

    # Specifies configuration for the DICOM Adapter helm chart
    # used by the clara-dicom plugin
    dicomAdapter:
      namespace: "default"
      overrides:
      - "~/.clara/clara-common-chart-config.yaml"
      path: "~/.clara/charts/dicom-adapter"
      releaseName: "clara-dicom-adapter"

    # Specifies configuration for the Render Server helm chart
    # used by the clara-render plugin
    renderServer:
      namespace: "default"
      overrides:
      - "~/.clara/clara-common-chart-config.yaml"install.yaml"
      path: "~/.clara/charts/clara-renderer"
      releaseName: "clara-render-server"

    # Specifies configuration for the results service helm chart
    # used by the clara-results plugin
    resultsService:
      namespace: "default"
      overrides:
      - "~/.clara/clara-common-chart-config.yaml"install.yaml"
      path: "~/.clara/charts/results-service"
      releaseName: "clara-results-service"

    # Specifies configuration for the tiller helm chart.
    # This config is used to communicate with tiller.
    # This config is NOT used to manage the tiller installation.
    tiller:
      namespace: "kube-system"

We do not recommend changing these values. If you need to override this configuration, use the --config flag with any command. For example:

# Use custom configuration to start the Clara Deploy SDK
clara start --config <file>

Note: Using custom configuration may leave your system in a bad state.