Skip to content

Conversation

@kgal-akl
Copy link

@kgal-akl kgal-akl commented Oct 4, 2025

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within tabpane
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have tabpane

In addition, please fill out the following to help reviewers understand this pull request:

Description

Part of dapr/components-contrib#4036.

Issue reference

@kgal-akl kgal-akl requested review from a team as code owners October 4, 2025 05:08
@kgal-akl kgal-akl marked this pull request as draft October 4, 2025 05:08
@kgal-akl kgal-akl marked this pull request as ready for review October 4, 2025 05:11
Copy link
Member

@msfussell msfussell left a 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Member

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.

Copy link
Member

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants