This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch docs-aws-sec-manager
in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit 27ac5851a84c7b29e42f7dab0745e0da1986d89d
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Wed Sep 28 12:12:55 2022 +0200
Added docs for AWS Secrets Manager Vault trait
---
addons/vault/aws/aws_secrets_manager.go | 1 -
docs/modules/ROOT/nav.adoc | 1 +
docs/modules/traits/pages/aws-secrets-manager.adoc | 57 ++++++++++++++++++++++
resources/traits.yaml | 32 ++++++++++++
4 files changed, 90 insertions(+), 1 deletion(-)
diff --git a/addons/vault/aws/aws_secrets_manager.go
b/addons/vault/aws/aws_secrets_manager.go
index 80f401e30..dfb2e22f1 100644
--- a/addons/vault/aws/aws_secrets_manager.go
+++ b/addons/vault/aws/aws_secrets_manager.go
@@ -36,7 +36,6 @@ import (
// -t aws-secrets-manager.enabled=true -t
aws-secrets-manager.access-key="aws-access-key" -t
aws-secrets-manager.secret-key="aws-secret-key" -t
aws-secrets-manager.region="aws-region"
//
// +camel-k:trait=aws-secrets-manager.
-
type Trait struct {
traitv1.Trait `property:",squash"`
// Enables automatic configuration of the trait.
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index 948a21364..04714ab33 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -52,6 +52,7 @@
// Start of autogenerated code - DO NOT EDIT! (trait-nav)
** xref:traits:3scale.adoc[3scale]
** xref:traits:affinity.adoc[Affinity]
+** xref:traits:aws-secrets-manager.adoc[Aws Secrets Manager]
** xref:traits:builder.adoc[Builder]
** xref:traits:camel.adoc[Camel]
** xref:traits:container.adoc[Container]
diff --git a/docs/modules/traits/pages/aws-secrets-manager.adoc
b/docs/modules/traits/pages/aws-secrets-manager.adoc
new file mode 100644
index 000000000..0b65c1d28
--- /dev/null
+++ b/docs/modules/traits/pages/aws-secrets-manager.adoc
@@ -0,0 +1,57 @@
+= Aws Secrets Manager Trait
+
+// Start of autogenerated code - DO NOT EDIT! (description)
+The Secrets Manager trait can be used to use secrets from AWS Secrets Manager
+
+The AWS Secrets Manager trait is disabled by default.
+
+A sample execution of this trait, would require
+the following trait options:
+-t aws-secrets-manager.enabled=true -t
aws-secrets-manager.access-key="aws-access-key" -t
aws-secrets-manager.secret-key="aws-secret-key" -t
aws-secrets-manager.region="aws-region"
+
+
+This trait is available in the following profiles: **Kubernetes, Knative,
OpenShift**.
+
+// End of autogenerated code - DO NOT EDIT! (description)
+// Start of autogenerated code - DO NOT EDIT! (configuration)
+== Configuration
+
+Trait properties can be specified when running any integration with the CLI:
+[source,console]
+----
+$ kamel run --trait aws-secrets-manager.[key]=[value] --trait
aws-secrets-manager.[key2]=[value2] integration.groovy
+----
+The following configuration options are available:
+
+[cols="2m,1m,5a"]
+|===
+|Property | Type | Description
+
+| aws-secrets-manager.enabled
+| bool
+| Can be used to enable or disable a trait. All traits share this common
property.
+
+| aws-secrets-manager.auto
+| bool
+| Enables automatic configuration of the trait.
+
+| aws-secrets-manager.access-key,omitempty
+| string
+| The AWS Access Key to use
+
+| aws-secrets-manager.secret-key,omitempty
+| string
+| The AWS Secret Key to use
+
+| aws-secrets-manager.region,omitempty
+| string
+| The AWS Region to use
+
+| aws-secrets-manager.use-default-credentials-provider,omitempty
+| bool
+| The adapter-specific policy to use when filling the cache (use: minimizing /
maximizing). Check
+the component documentation if unsure
+
+|===
+
+// End of autogenerated code - DO NOT EDIT! (configuration)
diff --git a/resources/traits.yaml b/resources/traits.yaml
index d7a3ecd3b..a03f5ee2b 100755
--- a/resources/traits.yaml
+++ b/resources/traits.yaml
@@ -65,6 +65,38 @@ traits:
description: Defines a set of pods (namely those matching the label
selector,
relative to the given namespace) that the integration pod(s) should not
be co-located
with.
+- name: aws-secrets-manager
+ platform: false
+ profiles:
+ - Kubernetes
+ - Knative
+ - OpenShift
+ description: 'The Secrets Manager trait can be used to use secrets from AWS
Secrets
+ Manager The AWS Secrets Manager trait is disabled by default. A sample
execution
+ of this trait, would require the following trait options: -t
aws-secrets-manager.enabled=true
+ -t aws-secrets-manager.access-key="aws-access-key" -t
aws-secrets-manager.secret-key="aws-secret-key"
+ -t aws-secrets-manager.region="aws-region"'
+ properties:
+ - name: enabled
+ type: bool
+ description: Can be used to enable or disable a trait. All traits share
this common
+ property.
+ - name: auto
+ type: bool
+ description: Enables automatic configuration of the trait.
+ - name: access-key,omitempty
+ type: string
+ description: The AWS Access Key to use
+ - name: secret-key,omitempty
+ type: string
+ description: The AWS Secret Key to use
+ - name: region,omitempty
+ type: string
+ description: The AWS Region to use
+ - name: use-default-credentials-provider,omitempty
+ type: bool
+ description: 'The adapter-specific policy to use when filling the cache
(use:
+ minimizing / maximizing). Check the component documentation if unsure'
- name: builder
platform: true
profiles:
