16.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. By default clara uses the platformapiserver running on the machine where clara cli is installed. clara can also point to a remote target using --host flag.

16.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
#         clara-monitor-server/              <- The Monitor Server helm chart
#         clara-console/                          <- The Management Console helm chart
#     clara-chart-config.yaml                <- Overrides used when installing the clara helm chart
#     dicom-adapter-chart-config.yaml        <- Overrides used when installing the dicom adapter helm chart
#     clara-monitor-server-chart-config.yaml <- Overrides used when installing the monitor server helm chart
#     clara-renderer-chart-config.yaml       <- Overrides used when installing the renderer helm chart
#     clara-console-chart-config.yaml        <- Overrides used when installing the management console helm chart
#     config.yaml                            <- CLI config

16.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 Management Console helm chart
    # used by the clara-console plugin
    console:
      namespace: default
      overrides: ~/.clara/clara-console-chart-config.yaml
      path: ~/.clara/charts/clara-console
      releasename: clara-console

    # Specifies configuration for the DICOM Adapter helm chart
    # used by the clara-dicom plugin
    dicomadapter:
      namespace: default
      overrides: /home/clara/.clara/dicom-adapter-chart-config.yaml
      path: /home/clara/.clara/charts/dicom-adapter
      releasename: clara-dicom-adapter

    # Specifies configuration for the Monitor Server helm chart
    # used by the clara-monitor plugin
    monitorserver:
      namespace: default
      overrides: /home/clara/.clara/clara-monitor-server-chart-config.yaml
      path: /home/clara/.clara/charts/clara-monitor-server
      releasename: clara-monitor-server

    # Specifies configuration for the Render Server helm chart
    # used by the clara-render plugin
    renderserver:
      namespace: default
      overrides: /home/clara/.clara/clara-renderer-chart-config.yaml
      path: /home/clara/.clara/charts/clara-renderer
      releasename: clara-render-server

    # 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 platform start --config <file>

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

16.2.3. Pointing to a remote host

# Get the list of pipelines on remote host
clara list pipelines --host REMOTE_IP:PORT

REMOTE_IP is the IP of the remote machine where platform api server is running. PORT is the nodeport on which the platform api server is exposed.