Skip to content

Commit

Permalink
v0.0.27: Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
evanverneyfink committed Aug 15, 2023
1 parent 57ca755 commit 59ee1aa
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ provider "mcma" {
### Optional

- `aws4_auth` (Block Set) (see [below for nested schema](#nestedblock--aws4_auth))
- `mcma_api_key_auth` (Block Set) (see [below for nested schema](#nestedblock--mcma_api_key_auth))
- `service_registry_auth_type` (String) The auth type to use for the services endpoint of the MCMA Service Registry

<a id="nestedblock--aws4_auth"></a>
Expand All @@ -59,3 +60,11 @@ Optional:
- `profile` (String) The AWS profile to use for authentication
- `region` (String) The AWS region to use for authentication
- `secret_key` (String) The AWS secret key to use for authentication. Requires that access_key also be specified


<a id="nestedblock--mcma_api_key_auth"></a>
### Nested Schema for `mcma_api_key_auth`

Required:

- `api_key` (String) The MCMA API key (header = 'x-mcma-api-key') to use for authentication
8 changes: 8 additions & 0 deletions examples/provider/provider.tf
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,12 @@ provider "mcma" {
access_key = "accesskey"
secret_key = "secretkey"
}
}

# MCMA API Key auth
provider "mcma" {
service_registry_url = "https://service-registry-example.mcma.io/api/"
mcma_api_key_auth {
api_key = "abcd1234efgh5678"
}
}

0 comments on commit 59ee1aa

Please sign in to comment.