Skip to content

Commit 7927452

Browse files
Florian SandelFlorian Sandel
authored andcommitted
update readme
1 parent 759f645 commit 7927452

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,12 @@ certificates. The subsequent section delineates the pertinent arguments and thei
2828

2929
| Argument | Example Value | Description |
3030
|-------------------------------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
31-
| `--authenticator` | dns-stackit | Engages the STACKIT authenticator mechanism. This must be configured as dns-stackit. (Mandatory) |
32-
| `--dns-stackit-credentials` | ./credentials.ini | Denotes the directory path to the credentials file for STACKIT DNS. This document must encapsulate the dns_stackit_auth_token and dns_stackit_project_id variables. (Mandatory) |
33-
| `--dns-stackit-propagation-seconds` | 900 | Configures the delay prior to initiating the DNS record query. A 900-second interval (equivalent to 15 minutes) is recommended. (Default: 900) |
31+
| `--authenticator` | dns-stackit | Engages the STACKIT authenticator mechanism. This must be configured as dns-stackit. (Mandatory) |
32+
| `--dns-stackit-credentials` | ./credentials.ini | Denotes the directory path to the credentials file for STACKIT DNS. This document must encapsulate the dns_stackit_auth_token and dns_stackit_project_id variables. |
33+
| `--dns-stackit-propagation-seconds` | 900 | Configures the delay prior to initiating the DNS record query. A 900-second interval (equivalent to 15 minutes) is recommended. (Default: 900) |
34+
| `--dns-stackit-service-account` | ./service-acount.pem | Denotes the directory path to the STACKIT service account file.recommended. |
35+
| `--dns-stackit-project-id` | '8a4c68b1-586a-4534-aa0c-9f8c12334a76' | Sets the STACKIT project id if the service account authentication is used |
36+
Either the --dns-stackit-credentials flag or the --dns-stackit-service-account and --dns-stackit-project-id flags are mandatory.
3437

3538
### Example
3639

@@ -65,6 +68,11 @@ It's crucial to replace "your_token_here" and "your_project_id_here" placeholder
6568
authentication token and project ID. The token's associated service account necessitates project membership privileges
6669
for record set creation.
6770

71+
### Authentication via STACKIT service account
72+
73+
The service account allows the user to use a long lived authentication which generates short lived tokens. To setup a service account refer to the [service account documentation](https://docs.stackit.cloud/stackit/en/create-a-service-account-134415839.html).
74+
It's important to also set the --dns-stackit-project-id flag to the corresponding STACKIT project when using a service account.
75+
6876
## Test Procedures
6977

7078
- Unit Testing:

0 commit comments

Comments
 (0)