Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 2.28 KB

octant.md

File metadata and controls

95 lines (63 loc) · 2.28 KB
title tocTitle
`octant` Provider
`octant`

octant Provider

Description

DEPRECATED: This plugin will be removed in a future version.

Adds Octant to the Garden dashboard, as well as a garden tools octant command.

Below is the full schema reference for the provider configuration. For an introduction to configuring a Garden project with providers, please look at our configuration guide.

The reference is divided into two sections. The first section contains the complete YAML schema, and the second section describes each schema key.

Complete YAML Schema

The values in the schema below are the default values.

providers:
  - # The name of the provider plugin to use.
    name:

    # List other providers that should be resolved before this one.
    dependencies: []

    # If specified, this provider will only be used in the listed environments. Note that an empty array effectively
    # disables the provider. To use a provider in all environments, omit this field.
    environments:

Configuration Keys

providers[]

Type Default Required
array[object] [] No

providers[].name

providers > name

The name of the provider plugin to use.

Type Required
string Yes

Example:

providers:
  - name: "local-kubernetes"

providers[].dependencies[]

providers > dependencies

List other providers that should be resolved before this one.

Type Default Required
array[string] [] No

Example:

providers:
  - dependencies:
      - exec

providers[].environments[]

providers > environments

If specified, this provider will only be used in the listed environments. Note that an empty array effectively disables the provider. To use a provider in all environments, omit this field.

Type Required
array[string] No

Example:

providers:
  - environments:
      - dev
      - stage