Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Secrets manager documentation fixes #4530

Merged
merged 1 commit into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions website/docs/d/sm_arbitrary_secret.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.

* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.
* `payload` - (String) The arbitrary secret's data payload.
* Constraints: The maximum length is `100000` characters. The minimum length is `0` characters. The value must match regular expression `/(.*?)/`.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_arbitrary_secret_metadata.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `secret_group_id` - (String) A v4 UUID identifier, or `default` secret group.
* Constraints: The maximum length is `36` characters. The minimum length is `7` characters. The value must match regular expression `/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/`.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_iam_credentials_secret.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `next_rotation_date` - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `next_rotation_date` - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_imported_certificate.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `private_key` - (String) (Optional) The PEM-encoded private key to associate with the certificate.
* Constraints: The maximum length is `100000` characters. The minimum length is `50` characters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `private_key_included` - (Boolean) Indicates whether the certificate was imported with an associated private key.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_kv_secret.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `secret_group_id` - (String) A v4 UUID identifier, or `default` secret group.
* Constraints: The maximum length is `36` characters. The minimum length is `7` characters. The value must match regular expression `/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/`.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_kv_secret_metadata.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `secret_group_id` - (String) A v4 UUID identifier, or `default` secret group.
* Constraints: The maximum length is `36` characters. The minimum length is `7` characters. The value must match regular expression `/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/`.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_private_certificate.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `next_rotation_date` - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `next_rotation_date` - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_public_certificate.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Nested scheme for **issuance_info**:
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `private_key` - (String) (Optional) The PEM-encoded private key to associate with the certificate.
* Constraints: The maximum length is `100000` characters. The minimum length is `50` characters. The value must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Nested scheme for **issuance_info**:
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `rotation` - (List) Determines whether Secrets Manager rotates your secrets automatically.
Nested scheme for **rotation**:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_secrets.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Nested scheme for **secrets**:
* `locks_total` - (Integer) The number of locks of the secret.
* Constraints: The maximum value is `1000`. The minimum value is `0`.
* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.
* `next_rotation_date` - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
* `private_key_included` - (Boolean) Indicates whether the certificate was imported with an associated private key.
* `reuse_api_key` - (Boolean) Determines whether to use the same service ID and API key for future read operations on an`iam_credentials` secret. The value is always `true` for IAM credentials secrets managed by Terraform.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sm_username_password_secret.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `next_rotation_date` - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum value is `1000`. The minimum value is `0`.

* `name` - (String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters.

* `next_rotation_date` - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/sm_arbitrary_secret.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Review the argument reference that you can specify for your resource.
* `labels` - (Optional, List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
* Constraints: The list items must match regular expression `/(.*?)/`. The maximum length is `30` items. The minimum length is `0` items.
* `name` - (Required, String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`.
* `region` - (Optional, Forces new resource, String) The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
* `payload` - (Required, String) The arbitrary secret's data payload. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.
* Constraints: The maximum length is `100000` characters. The minimum length is `0` characters. The value must match regular expression `/(.*?)/`.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/sm_iam_credentials_secret.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ resource "ibm_sm_iam_credentials_secret" "sm_iam_credentials_secret" {
}
secret_group_id = "default"
service_id = "ServiceId-bb4ccc31-bd31-493a-bb58-52ec399800be"
ttl = "30m"
ttl = "1800"
}
```

Expand All @@ -48,7 +48,7 @@ Review the argument reference that you can specify for your resource.
* `labels` - (Optional, List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
* Constraints: The list items must match regular expression `/(.*?)/`. The maximum length is `30` items. The minimum length is `0` items.
* `name` - (Required, String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`.
* `reuse_api_key` - (Optional, Boolean) Determines whether to use the same service ID and API key for future read operations on an`iam_credentials` secret. Must be set to `true` for IAM credentials secrets managed by Terraform.
* `rotation` - (Optional, List) Determines whether Secrets Manager rotates your secrets automatically.
Nested scheme for **rotation**:
Expand All @@ -62,7 +62,7 @@ Nested scheme for **rotation**:
* Constraints: The maximum length is `36` characters. The minimum length is `7` characters. The value must match regular expression `/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/`.
* `service_id` - (Optional, Forces new resource, String) The service ID under which the API key (see the `api_key` field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the `access_groups` parameter.
* Constraints: The maximum length is `50` characters. The minimum length is `40` characters. The value must match regular expression `/^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/`.
* `ttl` - (Optional, String) The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value should be an integer that specifies the number of seconds. Minimum duration is 60 seconds. Maximum is 7776000 seconds (90 days).
* `ttl` - (Required, String) The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value should be an integer that specifies the number of seconds. Minimum duration is 60 seconds. Maximum is 7776000 seconds (90 days).
* Constraints: The maximum length is `7` characters. The minimum length is `2` characters.

## Attribute Reference
Expand Down
3 changes: 2 additions & 1 deletion website/docs/r/sm_imported_certificate.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ resource "ibm_sm_imported_certificate" "sm_imported_certificate" {
description = "Extended description for this secret."
labels = ["my-label"]
secret_group_id = "default"
certificate: "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----"
}
```

Expand All @@ -43,7 +44,7 @@ Review the argument reference that you can specify for your resource.
* `labels` - (Optional, List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
* Constraints: The list items must match regular expression `/(.*?)/`. The maximum length is `30` items. The minimum length is `0` items.
* `name` - (Required, String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`.
* `private_key` - (Computed, String) (Optional) The PEM-encoded private key to associate with the certificate.
* Constraints: The maximum length is `100000` characters. The minimum length is `50` characters. The value must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`.
* `secret_group_id` - (Optional, Forces new resource, String) A v4 UUID identifier, or `default` secret group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/sm_kv_secret.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Review the argument reference that you can specify for your resource.
* `labels` - (Optional, List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
* Constraints: The list items must match regular expression `/(.*?)/`. The maximum length is `30` items. The minimum length is `0` items.
* `name` - (Required, String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`.
* `secret_group_id` - (Optional, Forces new resource, String) A v4 UUID identifier, or `default` secret group.
* Constraints: The maximum length is `36` characters. The minimum length is `7` characters. The value must match regular expression `/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/`.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/sm_private_certificate.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ resource "ibm_sm_private_certificate" "sm_private_certificate"{
instance_id = "6ebc4224-e983-496a-8a54-f40a0bfa9175"
region = "us-south"
name = "secret-name"
certificate_template = "cert-template-1"
certificate_template = resource.ibm_sm_private_certificate_configuration_template.my_template.name
custom_metadata = {"key":"value"}
description = "Extended description for this secret."
common_name = "example.com"
Expand Down Expand Up @@ -50,7 +50,7 @@ Review the argument reference that you can specify for your resource.
* `labels` - (Optional, List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
* Constraints: The list items must match regular expression `/(.*?)/`. The maximum length is `30` items. The minimum length is `0` items.
* `name` - (Required, String) The human-readable name of your secret.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^\\w(([\\w-.]+)?\\w)?$/`.
* Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`.
* `rotation` - (Optional, List) Determines whether Secrets Manager rotates your secrets automatically.
Nested scheme for **rotation**:
* `auto_rotate` - (Optional, Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ resource "ibm_sm_private_certificate_configuration_template" "certificate_templa
region = "us-south"
name = "my_template"
certificate_authority = "my_intermediate_ca"
allowed_domains = ["example.com"]
}
```

Expand Down
Loading