-
Notifications
You must be signed in to change notification settings - Fork 273
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: fix missing reference for container provider
- Loading branch information
Showing
5 changed files
with
80 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
title: "`container` Provider" | ||
tocTitle: "`container`" | ||
--- | ||
|
||
# `container` Provider | ||
|
||
## Description | ||
|
||
Provides the [container](https://docs.garden.io/reference/module-types/container) module type. | ||
_Note that this provider is currently automatically included, and you do not need to configure it in your project configuration._ | ||
|
||
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](../../using-garden/configuration-overview.md). | ||
|
||
The reference is divided into two sections. The [first section](#complete-yaml-schema) contains the complete YAML schema, and the [second section](#configuration-keys) describes each schema key. | ||
|
||
## Complete YAML Schema | ||
|
||
The values in the schema below are the default values. | ||
|
||
```yaml | ||
providers: | ||
- # The name of the provider plugin to use. | ||
name: | ||
|
||
# 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](#providers) > name | ||
|
||
The name of the provider plugin to use. | ||
|
||
| Type | Required | | ||
| -------- | -------- | | ||
| `string` | Yes | | ||
|
||
Example: | ||
|
||
```yaml | ||
providers: | ||
- name: "local-kubernetes" | ||
``` | ||
|
||
### `providers[].environments[]` | ||
|
||
[providers](#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: | ||
|
||
```yaml | ||
providers: | ||
- environments: | ||
- dev | ||
- stage | ||
``` | ||
|