Cloud Discovery Configuration

This page describes the configuration options available for RunWhen Local (Self-Hosted Runner).

RunWhen Local's primary configuration is provided in a file called workspaceInfo.yaml. This file is used to specify:

Which resources to discover and index (currently supporting Kubernetes, Microsoft Azure, AWS, and Google Cloud Platform)
Which CodeCollection repositories to scan for applicable tasks, health checks, and other automation scripts
Additional customizations to apply when uploading to a RunWhen Platform workspace

The top-level structure of the workspace info file is:

CODE

# Information about the RunWhen workspace
workspaceName: my-workspace
# More workspace config
# Information about cloud platforms to scan to discover resources
cloudConfig:
  kubernetes:
    # Kubernetes config
  azure:
    # Azure config
  # Other platform configs
  
# Information about which code collections to scan for code bundles
codeCollections:
- "https://github.com/runwhen-contrib/rw-public-codecollection.git"
- # Another code collections to scan


# Custom information about specific code bundles
custom:
  prometheus_provider: gmp
  # More custom configuration

Basic Workspace Configuration Info

There are several settings that are used to configure information in the workspace that's generated to be uploaded to the RunWhen platform to. The available settings are:

Label	Description
workspaceName	The name of the workspace to generate
workspaceOwnerEmail	The email address of the owner of the workspace
defaultLocation	The location where the the workspace is hosted
defaultLOD	The default level of detail to user for cloud resources