Skip to content

Commit 6ab6cd8

Browse files
committed
review fixes
1 parent 899d0c9 commit 6ab6cd8

File tree

1 file changed

+24
-61
lines changed
  • daprdocs/content/en/reference/components-reference/supported-secret-stores

1 file changed

+24
-61
lines changed

daprdocs/content/en/reference/components-reference/supported-secret-stores/akeyless.md

Lines changed: 24 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -13,82 +13,44 @@ To setup Akeyless secret store create a component of type `secretstores.akeyless
1313
## Component Format
1414

1515
```yaml
16-
# yaml-language-server: $schema=../../component-metadata-schema.json
17-
schemaVersion: v1
18-
type: secretstores
19-
name: akeyless
20-
version: v1
21-
status: beta
22-
title: "Akeyless Secret Store"
23-
urls:
24-
- title: Reference
25-
url: https://docs.dapr.io/reference/components-reference/supported-secret-stores/akeyless/
16+
apiVersion: dapr.io/v1alpha1
17+
kind: Component
2618
metadata:
19+
name: akeyless
20+
spec:
21+
type: secretstores.akeyless
22+
version: v1
23+
metadata:
2724
- name: gatewayUrl
28-
required: false
29-
description: |
30-
The URL to the Akeyless Gateway API. Default is https://api.akeyless.io.
31-
default: "https://api.akeyless.io"
32-
example: "https://your.akeyless.gw"
33-
type: string
25+
value: "http://gw.akeyless.svc.cluster.local/api/v2"
3426
- name: accessId
35-
required: true
36-
description: |
37-
The Akeyless Access ID. Currently supported authentication methods are: API keys (`access_key`, default), JWT (`jwt`) and AWS IAM (`aws_iam`).
38-
example: "p-123456780wm"
39-
type: string
40-
- name: jwt
41-
required: false
42-
description: |
43-
If using the JWT authentication method, specify it here.
44-
example: "eyJ..."
45-
type: string
46-
sensitive: true
27+
value: "p-abcdefg1234am"
4728
- name: accessKey
48-
required: false
49-
description: |
50-
If using the API key (access_key) authentication method, specify it here.
51-
example: "ABCD1233...="
52-
type: string
53-
sensitive: true
29+
value: "abcd/1234="
30+
- name: jwt
31+
value: "ZXlKa..."
5432
- name: k8sAuthConfigName
55-
required: false
56-
description: |
57-
If using the k8s auth method, specify the name of the k8s auth config.
58-
example: "k8s-auth-config"
59-
type: string
60-
- name: k8sGatewayUrl
61-
required: false
62-
description: |
63-
The gateway URL that where the k8s auth config is located.
64-
example: "http://gw.akeyless.svc.cluster.local:8000"
65-
type: string
33+
value: aks-cluster-1-auth-conf
6634
- name: k8sServiceAccountToken
67-
required: false
68-
description: |
69-
If using the k8s auth method, specify the service account token. If not specified,
70-
we will try to read it from the default service account token file.
71-
example: "eyJ..."
72-
type: string
73-
sensitive: true
35+
value: "Z1234ch/sasw1..."
7436
```
7537
7638
## Spec metadata fields
7739
7840
| Field | Required | Details | Example |
7941
|--------------------|:--------:|-------------------------------------------------------------------------|---------------------|
80-
| `gatewayUrl` | N | The Akeyless Gateway API URL. Defaults to https://api.akeyless.io. | `http://gw-release.akeyless.svc.cluster.local:8000/api/v2` |
81-
| `accessID` | Y | The Akeyless Access ID of the authentication method | `p-1234567890` |
42+
| `gatewayUrl` | N | The Akeyless Gateway API URL. Defaults to https://api.akeyless.io. | `http://gw.akeyless.svc.cluster.local:8000/api/v2` |
43+
| `accessID` | Y | The Akeyless Access ID of the authentication method | `p-1234567890am` |
8244
| `accessKey` | N | Fill in when using an API Key (`access_key`) authentication method. | `ABCD1233...=` |
83-
| `jwt` | N | Fill in a `base64`-encoded string of the JWT when using OAuth2.0/JWT (`jwt`) authentication method | `eyJ...` |
45+
| `jwt` | N | Fill in a `base64`-encoded string of the JWT when using OAuth2.0/JWT (`jwt`) authentication method | `base64 -i "eyJ..."` |
8446
| `k8sAuthConfigName` | N | Fill in when using Kubernetes Authentication (`k8s`) authentication method | `my-k8s-auth-conf` |
85-
| `k8sGatewayUrl` | N | Fill in when using Kubernetes Authentication (`k8s`) authentication method. If not filled in, will default to value set for `akeylessGWApiURL`. | `http://gw-release.akeyless.svc.cluster.local:8000/api/v2` |
86-
| `k8sServiceAccountToken` | N | Fill in a `base64`-encoded string of the JWT when using Kubernetes Authentication (`k8s`) authentication method. If not filled in, will read from k8s token in container filesystem | `ej...` |
47+
| `k8sGatewayUrl` | N | Fill in when using Kubernetes Authentication (`k8s`) authentication method. If not filled in, will default to value set for `akeylessGWApiURL`. | `http://gw.akeyless.svc.cluster.local:8000` |
48+
| `k8sServiceAccountToken` | N | Fill in a `base64`-encoded string of the JWT when using Kubernetes Authentication (`k8s`) authentication method. If not filled in, will read from k8s token in container filesystem | ``base64 -i "eyJ..."`` |
8749

8850

8951
## Authentication Methods
9052

91-
We currently support the following authentication methods:
53+
The following authentication methods are supported:
9254

9355
### [API Key](https://docs.akeyless.io/docs/api-key)
9456

@@ -142,7 +104,7 @@ spec:
142104
- name: accessId
143105
value: "p-123..."
144106
- name: jwt
145-
value: "eyJ..."
107+
value: "base64 encoded JWT"
146108
```
147109

148110
### [Kubernetes](https://docs.akeyless.io/docs/kubernetes-auth)
@@ -191,6 +153,7 @@ curl http://localhost:3500/v1.0/secrets/akeyless/bulk?metadata.secrets_type=stat
191153
curl http://localhost:3500/v1.0/secrets/akeyless/bulk?metadata.secrets_type=static,dynamic&metadata.path=/my/org
192154
```
193155

156+
### Language Tab: Golang
194157
Or using the Dapr SDK. The example below retrieves all static secrets from path `/path/to/department`:
195158

196159
```go
@@ -221,7 +184,7 @@ log.Println("Starting test application")
221184
```
222185

223186
{{% alert title="Failing Retrieval in Bulk" color="info" %}}
224-
When retrieving secrets using the bulk API, all successfully-retrieved secrets will be returned and failed ones will be logged in the component log.
187+
When retrieving secrets using the bulk API, all successfully-retrieved secrets are returned and failed ones are logged in the component log.
225188
{{% /alert %}}
226189

227190
## Setup Akeyless instance
@@ -236,7 +199,7 @@ To get started with Akeyless:
236199
For more detailed setup instructions, refer to the [Akeyless documentation](https://docs.akeyless.io/).
237200

238201
## Related links
239-
202+
- [Akeyless Sign Up](https://console.akeyless.io/registration)
240203
- [Secrets building block]({{% ref secrets %}})
241204
- [How-To: Retrieve a secret]({{% ref "howto-secrets.md" %}})
242205
- [How-To: Reference secrets in Dapr components]({{% ref component-secrets.md %}})

0 commit comments

Comments
 (0)