Skip to content

Commit 0b0988a

Browse files
committed
docs: add generated PAM operation use cases
1 parent fc8ebee commit 0b0988a

7 files changed

Lines changed: 1212 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- Add use-case documentation for bulk certificate store updates.
1515
- Add use-case documentation for migrating certificate store credentials from static values to a PAM provider.
1616
- Add generated per-store-type bulk create and update use-case guides.
17+
- Add generated PAM Operations use-case documentation for PAM type and provider creation.
1718

1819
# v1.9.1
1920

GNUmakefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,5 +86,7 @@ generate_toc:
8686
store-type-docs:
8787
GOWORK=off GOCACHE=/tmp/kfutil-gocache go run ./tools/storetypedocs
8888

89+
pam-operation-docs:
90+
GOWORK=off GOCACHE=/tmp/kfutil-gocache go run ./tools/pamdocs
8991

90-
.PHONY: build prerelease release install test fmt vendor version setversion store-type-docs
92+
.PHONY: build prerelease release install test fmt vendor version setversion store-type-docs pam-operation-docs
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!-- Generated by tools/pamdocs. -->
2+
# PAM Operations
3+
4+
Use cases for creating PAM provider types and PAM providers with `kfutil`.
5+
6+
These docs are generated from `cmd/pam_types.json`. Regenerate after PAM type metadata changes:
7+
8+
```bash
9+
make pam-operation-docs
10+
```
11+
12+
- [Create PAM Types](create-pam-types.md)
13+
- [Create PAM Providers](create-pam-providers.md)
14+
15+
## Embedded PAM Types
16+
17+
| PAM type | Provider configuration parameters | Certificate store instance parameters |
18+
| --- | --- | --- |
19+
| `1Password-CLI` | Vault, Token | Item, Field |
20+
| `Azure-KeyVault` | KeyVaultUri, AuthorityHost | SecretId |
21+
| `Azure-KeyVault-ServicePrincipal` | KeyVaultUri, AuthorityHost, TenantId, ClientId, ClientSecret | SecretId |
22+
| `BeyondTrust-PasswordSafe` | Host, APIKey, Username, ClientCertificate | SystemId, AccountId |
23+
| `CyberArk-CentralCredentialProvider` | AppId, Host, Site | Safe, Folder, Object |
24+
| `CyberArk-SdkCredentialProvider` | AppId | Safe, Folder, Object |
25+
| `Delinea-SecretServer` | Host, Username, Password, ClientId, ClientSecret, GrantType | SecretId, SecretFieldName |
26+
| `GCP-SecretManager` | projectId | secretId |
27+
| `Hashicorp-Vault` | Host, Token, Path | Secret, Key |
28+

0 commit comments

Comments
 (0)