Skip to content

Commit 56ba554

Browse files
committed
docs: Improve key flag description
1 parent 5d65e33 commit 56ba554

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

.web-docs/components/builder/oci/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,9 @@ or configured for the default OCI CLI authenticaton profile.
136136
if present. This cannot be used along with the `use_instance_principals` key.
137137

138138
- `key` (string) - The contents of the OCI API signing key. Overrides value provided by the `key_file`.
139-
This cannot be used along with the `use_instance_principals` key.
139+
This cannot be used along with the `use_instance_principals` key. The `key` is meant to be used with dynamic secret fetching,
140+
for example, [`aws_secretsmanager` function](https://developer.hashicorp.com/packer/docs/templates/hcl_templates/functions/contextual/aws_secretsmanager),
141+
storing secrets in a versioning system should be avoided.
140142

141143
- `key_file` (string) - Full path and filename of the OCI API signing key. Overrides value provided
142144
by the [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm)

docs/builders/oci.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,9 @@ or configured for the default OCI CLI authenticaton profile.
143143
if present. This cannot be used along with the `use_instance_principals` key.
144144

145145
- `key` (string) - The contents of the OCI API signing key. Overrides value provided by the `key_file`.
146-
This cannot be used along with the `use_instance_principals` key.
146+
This cannot be used along with the `use_instance_principals` key. Also, the `key` is meant to be used with dynamic secret fetching,
147+
for example, [`aws_secretsmanager` function](https://developer.hashicorp.com/packer/docs/templates/hcl_templates/functions/contextual/aws_secretsmanager),
148+
storing secrets in a versioning system should be avoided.
147149

148150
- `key_file` (string) - Full path and filename of the OCI API signing key. Overrides value provided
149151
by the [OCI config file](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm)

0 commit comments

Comments
 (0)