-
Notifications
You must be signed in to change notification settings - Fork 778
Add Akeyless Doc #4910
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
base: v1.16
Are you sure you want to change the base?
Add Akeyless Doc #4910
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This component PR needs to target the v1.17 docs branch, since it will be in the next V1.17 release. Please change the branch.
|
|
||
| ## Authentication Methods | ||
|
|
||
| We currently support the following authentication methods: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| We currently support the following authentication methods: | |
| Akeyless supports the following authentication methods: |
| curl http://localhost:3500/v1.0/secrets/akeyless/my-secret | ||
| ``` | ||
|
|
||
| This will return the secret value stored in Akeyless with the name `my-secret`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| This will return the secret value stored in Akeyless with the name `my-secret`. | |
| This returns the secret value stored in Akeyless with the name `my-secret`. |
| To get started with Akeyless: | ||
|
|
||
| 1. Sign up for an Akeyless account at [https://www.akeyless.io](https://www.akeyless.io) | ||
| 2. Create an Access ID and configure your preferred authentication method |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 2. Create an Access ID and configure your preferred authentication method | |
| 2. Create an Access ID and configure your preferred authentication method. |
| The above examples use secrets as plain strings. It is recommended to use a local secret store such as [Kubernetes secret store]({{% ref kubernetes-secret-store.md %}}) or a [local file]({{% ref file-secret-store.md %}}) to bootstrap secure key storage. | ||
| {{% /alert %}} | ||
|
|
||
| ## Spec metadata fields |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you move this section up after the proposed Component format section. See example here https://docs.dapr.io/reference/components-reference/supported-secret-stores/aws-secret-manager/
| ## Create the Akeyless component | ||
|
|
||
| To setup Akeyless secret store create a component of type `secretstores.akeyless`. See [this guide]({{% ref "setup-secret-store.md#apply-the-configuration" %}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{% ref component-secrets.md %}}) to retrieve and use the secret with Dapr components. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a "Component format" section that covers all the potential field for the component. Then follow this with the "Spec metadata fields". The Authentication Methods section can then follow after this as examples of using the component with different auth methods. See example here https://docs.dapr.io/reference/components-reference/supported-secret-stores/aws-secret-manager/
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Part of dapr/components-contrib#4036.
Issue reference