-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #289 from volterraedge/13Dec24Release
13 dec 2024 release
- Loading branch information
Showing
1,421 changed files
with
1,045,549 additions
and
275,951 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
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,162 @@ | ||
--- | ||
|
||
page_title: "Volterra: api_crawler" | ||
|
||
description: "The api_crawler allows CRUD of Api Crawler resource on Volterra SaaS" | ||
----------------------------------------------------------------------------------- | ||
|
||
Resource volterra_api_crawler | ||
============================= | ||
|
||
The Api Crawler allows CRUD of Api Crawler resource on Volterra SaaS | ||
|
||
~> **Note:** Please refer to [Api Crawler API docs](https://docs.cloud.f5.com/docs-v2/api/api-crawler) to learn more | ||
|
||
Example Usage | ||
------------- | ||
|
||
```hcl | ||
resource "volterra_api_crawler" "example" { | ||
name = "acmecorp-web" | ||
namespace = "staging" | ||
domains { | ||
domain = "domain" | ||
simple_login { | ||
password { | ||
blindfold_secret_info_internal { | ||
decryption_provider = "value" | ||
location = "string:///U2VjcmV0SW5mb3JtYXRpb24=" | ||
store_provider = "value" | ||
} | ||
secret_encoding_type = "secret_encoding_type" | ||
// One of the arguments from this list "blindfold_secret_info clear_secret_info vault_secret_info wingman_secret_info" must be set | ||
blindfold_secret_info { | ||
decryption_provider = "value" | ||
location = "string:///U2VjcmV0SW5mb3JtYXRpb24=" | ||
store_provider = "value" | ||
} | ||
} | ||
user = "user" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
Argument Reference | ||
------------------ | ||
|
||
### Metadata Argument Reference | ||
|
||
`annotations` - (Optional) queryable and should be preserved when modifying objects. (`String`). | ||
|
||
`description` - (Optional) Human readable description for the object (`String`). | ||
|
||
`disable` - (Optional) A value of true will administratively disable the object (`Bool`). | ||
|
||
`labels` - (Optional) by selector expression (`String`). | ||
|
||
`name` - (Required) The value of name has to follow DNS-1035 format. (`String`). | ||
|
||
`namespace` - (Optional) Must be a DNS_LABEL format. For a namespace object itself, namespace value will be "" (`String`). | ||
|
||
### Spec Argument Reference | ||
|
||
`domains` - (Required) API Crawler Configuration. See [Domains ](#domains) below for details. | ||
|
||
### Domains | ||
|
||
API Crawler Configuration. | ||
|
||
`domain` - (Required) Select the domain to execute API Crawling with given credentials. (`String`). | ||
|
||
`simple_login` - (Required) Username and Password to assign credentials for the selected domain to crawl. See [Domains Simple Login ](#domains-simple-login) below for details. | ||
|
||
### Domains Simple Login | ||
|
||
Username and Password to assign credentials for the selected domain to crawl. | ||
|
||
`password` - (Required) x-displayName: "Password". See [Simple Login Password ](#simple-login-password) below for details. | ||
|
||
`user` - (Required) x-displayName: "User" (`String`). | ||
|
||
### Password Blindfold Secret Info Internal | ||
|
||
Blindfold Secret Internal is used for the putting re-encrypted blindfold secret. | ||
|
||
`decryption_provider` - (Optional) Name of the Secret Management Access object that contains information about the backend Secret Management service. (`String`). | ||
|
||
`location` - (Required) Or it could be a path if the store provider is an http/https location (`String`). | ||
|
||
`store_provider` - (Optional) This field needs to be provided only if the url scheme is not string:/// (`String`). | ||
|
||
### Secret Info Oneof Blindfold Secret Info | ||
|
||
Blindfold Secret is used for the secrets managed by F5XC Secret Management Service. | ||
|
||
`decryption_provider` - (Optional) Name of the Secret Management Access object that contains information about the backend Secret Management service. (`String`). | ||
|
||
`location` - (Required) Or it could be a path if the store provider is an http/https location (`String`). | ||
|
||
`store_provider` - (Optional) This field needs to be provided only if the url scheme is not string:/// (`String`). | ||
|
||
### Secret Info Oneof Clear Secret Info | ||
|
||
Clear Secret is used for the secrets that are not encrypted. | ||
|
||
`provider` - (Optional) This field needs to be provided only if the url scheme is not string:/// (`String`). | ||
|
||
`url` - (Required) When asked for this secret, caller will get Secret bytes after Base64 decoding. (`String`). | ||
|
||
### Secret Info Oneof Vault Secret Info | ||
|
||
Vault Secret is used for the secrets managed by Hashicorp Vault. | ||
|
||
`key` - (Optional) If not provided entire secret will be returned. (`String`). | ||
|
||
`location` - (Required) Path to secret in Vault. (`String`). | ||
|
||
`provider` - (Required) Name of the Secret Management Access object that contains information about the backend Vault. (`String`). | ||
|
||
`secret_encoding` - (Optional) This field defines the encoding type of the secret BEFORE the secret is put into Hashicorp Vault. (`String`). | ||
|
||
`version` - (Optional) If not provided latest version will be returned. (`Int`). | ||
|
||
### Secret Info Oneof Wingman Secret Info | ||
|
||
Secret is given as bootstrap secret in F5XC Security Sidecar. | ||
|
||
`name` - (Required) Name of the secret. (`String`). | ||
|
||
### Simple Login Password | ||
|
||
x-displayName: "Password". | ||
|
||
`blindfold_secret_info_internal` - (Optional) Blindfold Secret Internal is used for the putting re-encrypted blindfold secret. See [Password Blindfold Secret Info Internal ](#password-blindfold-secret-info-internal) below for details.(Deprecated) | ||
|
||
`secret_encoding_type` - (Optional) e.g. if a secret is base64 encoded and then put into vault. (`String`).(Deprecated) | ||
|
||
###### One of the arguments from this list "blindfold_secret_info, clear_secret_info, vault_secret_info, wingman_secret_info" must be set | ||
|
||
`blindfold_secret_info` - (Optional) Blindfold Secret is used for the secrets managed by F5XC Secret Management Service. See [Secret Info Oneof Blindfold Secret Info ](#secret-info-oneof-blindfold-secret-info) below for details. | ||
|
||
`clear_secret_info` - (Optional) Clear Secret is used for the secrets that are not encrypted. See [Secret Info Oneof Clear Secret Info ](#secret-info-oneof-clear-secret-info) below for details. | ||
|
||
`vault_secret_info` - (Optional) Vault Secret is used for the secrets managed by Hashicorp Vault. See [Secret Info Oneof Vault Secret Info ](#secret-info-oneof-vault-secret-info) below for details.(Deprecated) | ||
|
||
`wingman_secret_info` - (Optional) Secret is given as bootstrap secret in F5XC Security Sidecar. See [Secret Info Oneof Wingman Secret Info ](#secret-info-oneof-wingman-secret-info) below for details.(Deprecated) | ||
|
||
Attribute Reference | ||
------------------- | ||
|
||
- `id` - This is the id of the configured api_crawler. |
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,58 @@ | ||
--- | ||
|
||
page_title: "Volterra: api_discovery" | ||
|
||
description: "The api_discovery allows CRUD of Api Discovery resource on Volterra SaaS" | ||
--------------------------------------------------------------------------------------- | ||
|
||
Resource volterra_api_discovery | ||
=============================== | ||
|
||
The Api Discovery allows CRUD of Api Discovery resource on Volterra SaaS | ||
|
||
~> **Note:** Please refer to [Api Discovery API docs](https://docs.cloud.f5.com/docs-v2/api/api-discovery) to learn more | ||
|
||
Example Usage | ||
------------- | ||
|
||
```hcl | ||
resource "volterra_api_discovery" "example" { | ||
name = "acmecorp-web" | ||
namespace = "staging" | ||
} | ||
``` | ||
|
||
Argument Reference | ||
------------------ | ||
|
||
### Metadata Argument Reference | ||
|
||
`annotations` - (Optional) queryable and should be preserved when modifying objects. (`String`). | ||
|
||
`description` - (Optional) Human readable description for the object (`String`). | ||
|
||
`disable` - (Optional) A value of true will administratively disable the object (`Bool`). | ||
|
||
`labels` - (Optional) by selector expression (`String`). | ||
|
||
`name` - (Required) The value of name has to follow DNS-1035 format. (`String`). | ||
|
||
`namespace` - (Optional) Must be a DNS_LABEL format. For a namespace object itself, namespace value will be "" (`String`). | ||
|
||
### Spec Argument Reference | ||
|
||
`custom_auth_types` - (Optional) Select your custom authentication types to be detected in the API discovery. See [Custom Auth Types ](#custom-auth-types) below for details. | ||
|
||
### Custom Auth Types | ||
|
||
Select your custom authentication types to be detected in the API discovery. | ||
|
||
`parameter_name` - (Required) The authentication parameter name. (`String`). | ||
|
||
`parameter_type` - (Required) x-displayName: "Parameter Type" (`String`). | ||
|
||
Attribute Reference | ||
------------------- | ||
|
||
- `id` - This is the id of the configured api_discovery. |
Oops, something went wrong.