Skip to content

Commit 55c43f4

Browse files
committed
added k8s auth conf to readme
Signed-off-by: Kobbi Gal <[email protected]>
1 parent cd18d5d commit 55c43f4

File tree

2 files changed

+37
-7
lines changed

2 files changed

+37
-7
lines changed

secretstores/akeyless/README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ This component provides a Dapr secret store implementation for [Akeyless](https:
44

55
## Configuration
66

7+
- [API Key](https://docs.akeyless.io/docs/api-key)
8+
- [OAuth2.0/JWT](https://docs.akeyless.io/docs/oauth20jwt)
9+
- [AWS IAM](https://docs.akeyless.io/docs/aws-iam)
10+
- [Kubernetes](https://docs.akeyless.io/docs/kubernetes-auth)
11+
12+
### Authentication
13+
714
The Akeyless secret store component supports the following configuration options:
815

916
| Field | Required | Description | Example |
@@ -12,12 +19,13 @@ The Akeyless secret store component supports the following configuration options
1219
| `accessId` | Yes | The Akeyless authentication access ID. | `p-123456780wm` |
1320
| `jwt` | No | If using an OAuth2.0/JWT access ID, specify the JSON Web Token | `eyJ...` |
1421
| `accessKey` | No | If using an API Key access ID, specify the API key | `ABCD123...=` |
22+
| `k8sAuthConfigName` | No | If using the k8s auth method, specify the name of the k8s auth config. | `k8s-auth-config` |
23+
| `k8sGatewayUrl` | No | The gateway URL that where the k8s auth config is located. | `http://gw.akeyless.svc.cluster.local:8000` |
24+
| `k8sServiceAccountToken` | No | If using the k8s auth method, specify the service account token. If not specified,
25+
we will try to read it from the default service account token file. | `eyJ...` |
1526

1627
We currently support the following [Authentication Methods](https://docs.akeyless.io/docs/access-and-authentication-methods):
1728

18-
- [API Key](https://docs.akeyless.io/docs/api-key)
19-
- [OAuth2.0/JWT](https://docs.akeyless.io/docs/oauth20jwt)
20-
- [AWS IAM](https://docs.akeyless.io/docs/aws-iam)
2129

2230
## Example Configuration: API Key
2331

@@ -75,9 +83,30 @@ spec:
7583
value: "p-1234Abcdwm"
7684
```
7785
86+
## Example Configuration: Kubernetes
87+
88+
```yaml
89+
apiVersion: dapr.io/v1alpha1
90+
kind: Component
91+
metadata:
92+
name: akeyless
93+
spec:
94+
type: secretstores.akeyless
95+
version: v1
96+
metadata:
97+
- name: gatewayUrl
98+
value: "https://gw.akeyless.svc.cluster.local"
99+
- name: accessId
100+
value: "p-1234Abcdwm"
101+
- name: k8sAuthConfigName
102+
value: "us-east-1-prod-akeyless-k8s-conf"
103+
- name: k8sGatewayUrl
104+
value: https://gw.akeyless.svc.cluster.local
105+
```
106+
78107
## Usage
79108
80-
Once configured, you can retrieve secrets using the Dapr secrets API:
109+
Once configured, you can retrieve secrets using the Dapr secrets API/SDK:
81110
82111
```bash
83112
# Get a single secret
@@ -89,5 +118,6 @@ curl http://localhost:3500/v1.0/secrets/akeyless/bulk
89118

90119
## Features
91120

92-
- **GetSecret**: Retrieve an individual static secret by name.
93-
- **BulkGetSecret**: Retrieve an all static secrets.
121+
- Supports static, dynamic and rotated secrets.
122+
- **GetSecret**: Retrieve an individual value secret by path.
123+
- **BulkGetSecret**: Retrieve an all secrets from the root path.

secretstores/akeyless/metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ metadata:
4646
required: false
4747
description: |
4848
The gateway URL that where the k8s auth config is located.
49-
example: "https://gw.akeyless.svc.cluster.local"
49+
example: "http://gw.akeyless.svc.cluster.local:8000"
5050
type: string
5151
- name: k8sServiceAccountToken
5252
required: false

0 commit comments

Comments
 (0)