-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): Added documentation for cloud provisioning
Added cloud_keystore_installation resource doc Added cloud_provider data source doc Added cloud_keystore data source doc Added categories for the documentation Removed unnecessary files and metadata from docs Closes VC-32723
- Loading branch information
1 parent
1c96bdc
commit 2830d0e
Showing
10 changed files
with
132 additions
and
34 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
|
||
Certificate Issuance | ||
Cloud Provisioning | ||
Policy Management |
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,40 @@ | ||
--- | ||
subcategory: "Cloud Provisioning" | ||
layout: "venafi" | ||
page_title: "Venafi: venafi_cloud_keystore" | ||
description: |- | ||
Get information on a Venafi Control Plane (VCP) Cloud Keystore | ||
--- | ||
|
||
# Data source: venafi_cloud_keystore | ||
|
||
Use this data source to get the `ID` of a cloud keystore in Venafi Control Plane, referenced by its name and parent | ||
cloud provider ID. You can use `venafi_cloud_provider` data source to obtain the ID of the parent cloud provider. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
# Find a cloud keystore with a static cloud provider id | ||
data "venafi_cloud_keystore" "ck_example_by_id" { | ||
cloud_provider_id = "e48897d0-2762-11ef-8fab-79ac590dd358" | ||
name = "Cloud Keystore Example" | ||
} | ||
# Find a cloud keystore by using venafi_cloud_provider data source as input | ||
data "venafi_cloud_keystore" "ck_example" { | ||
cloud_provider_id = data.venafi_cloud_provider.cp_example.id | ||
name = "Cloud Keystore example" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
* `cloud_provider_id` - (Required, string) ID of the cloud provider whom the cloud keystore to look up belongs to. | ||
* `name` - (Required, string) Name of the cloud keystore to look up. | ||
|
||
## Attribute Reference | ||
|
||
This data source exports the following attributes in addition to the arguments above: | ||
|
||
* `machine_identities_count` - Number of machine identities provisioned to the cloud keystore. | ||
* `type` - The cloud keystore type. Either `ACM`, `AKV` or `GCM`. |
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,33 @@ | ||
--- | ||
subcategory: "Cloud Provisioning" | ||
layout: "venafi" | ||
page_title: "Venafi: venafi_cloud_provider" | ||
description: |- | ||
Get information on a Venafi Control Plane (VCP) Cloud Provider | ||
--- | ||
|
||
# Data Source: venafi_cloud_provider | ||
|
||
Use this data source to get the `ID` of a cloud provider in Venafi Control Plane, referenced by its name. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
# Find a cloud provider | ||
data "venafi_cloud_provider" "cp_example" { | ||
name = "Cloud Provider Example" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
* `name` - (Required, string) Name of the Cloud Provider to look up. | ||
|
||
## Attribute Reference | ||
|
||
This data source exports the following attributes in addition to the arguments above: | ||
|
||
* `keystores_count` - Number of Cloud Keystores configured with the Cloud Provider | ||
* `status` - The status of the Cloud Provider. Either `VALIDATED` or `NOT_VALIDATED`. | ||
* `status_details` - The details of the Cloud Provider status. If the status is `VALIDATED`, this value will be empty. | ||
* `type` - The Cloud Provider type. Either `AWS`, `AZURE` or `GCP` |
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
47 changes: 47 additions & 0 deletions
47
website/docs/r/venafi_cloud_keystore_installation.html.markdown
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,47 @@ | ||
--- | ||
subcategory: "Cloud Provisioning" | ||
layout: "venafi" | ||
page_title: "Venafi: venafi_cloud_keystore_installation" | ||
description: |- | ||
Provisions a Venafi managed certificate to an existing Cloud Keystore in Venafi Control Plane (VCP) | ||
--- | ||
|
||
# Resource: venafi_cloud_keystore_installation | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
# Provision a certificate to cloud keystore with static values | ||
resource "venafi_cloud_keystore_installation" "ck_installation_example_by_id" { | ||
cloud_keystore_id = "e48897d0-2762-11ef-198k-79ac590dd358" | ||
certificate_id = "1877af16-2762-11ef-8fab-cc123456ff7" | ||
cloud_certificate_name = "com-terraform-example-com" | ||
} | ||
# Provision a certificate to cloud keystore | ||
resource "venafi_cloud_keystore_installation" "ck_installation_example" { | ||
cloud_keystore_id = data.venafi_cloud_keystore.ck_example.id | ||
certificate_id = venafi_certificate.certificate_example.certificate_id | ||
cloud_certificate_name = venafi_certificate.certificate_example.common_name | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
* `cloud_keystore_id` - (Required, string) ID of the cloud keystore where the certificate will be provisioned. | ||
* `certificate_id` - (Required, string) ID of the certificate to be provisioned to the given `keystore_id`. | ||
* `cloud_certificate_name` - (Optional, string) Name for the provisioned certificate in the keystore. If the name already exists, the provisioning will replace the previous certificate with the one from `certificate_id`. Only valid for AKV and GCM keystores. | ||
* `arn` - (Optional, string) ARN of the AWS certificate. Use it to provision the VCP certificate to an existing ACM certificate, instead of a new one. Only valid for ACM keystores. | ||
|
||
## Attribute Reference | ||
|
||
* `cloud_certificate_id` - | ||
* `cloud_certificate_metadata` - | ||
|
||
## Import | ||
|
||
Using `terraform import`, import a Machine Identity from Venafi Control Plane using their ID. For example: | ||
|
||
```console | ||
terraform import venafi_cloud_keystore_installation.example 2155bd32-2234-22ac-7cfd-ff1198845aa2 | ||
``` |
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 was deleted.
Oops, something went wrong.