Skip to content

Commit

Permalink
docs: add CLI reference
Browse files Browse the repository at this point in the history
  • Loading branch information
werne2j committed Aug 26, 2021
1 parent cd4288f commit a47fcae
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/cmd/avp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
This is a plugin to replace <wildcards\> with Vault secrets

```
argocd-vault-plugin [flags]
```

### Options
```
-h, --help help for version
```

### SEE ALSO

* [argocd-vault-plugin generate](generate.md) - Generate manifests from templates with Vault values
* [argocd-vault-plugin version](version.md) - Print version information
16 changes: 16 additions & 0 deletions docs/cmd/generate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Generate manifests from templates with Vault values

```
argocd-vault-plugin generate PATH [flags]
```

### Options
```
-c, --config-path string path to a file containing Vault configuration (YAML, JSON, envfile) to use
-h, --help help for generate
-s, --secret-name string name of a Kubernetes Secret containing Vault configuration data in the argocd namespace of your ArgoCD host (Only available when used in ArgoCD)
```

### SEE ALSO

* [argocd-vault-plugin](avp.md) - replace <wildcards\> with Vault secrets
14 changes: 14 additions & 0 deletions docs/cmd/version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Print argocd-vault-plugin version information

```
argocd-vault-plugin version [flags]
```

### Options
```
-h, --help help for version
```

### SEE ALSO

* [argocd-vault-plugin](avp.md) - replace <wildcards\> with Vault secrets
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ nav:
- Usage: usage.md
- Backends: backends.md
- Configuration: config.md
- CLI Reference:
- argocd-vault-plugin: cmd/avp.md
- argocd-vault-plugin generate: cmd/generate.md
- argocd-vault-plugin version: cmd/version.md
- Upgrading:
- v0.x to v1.x: 0x-1x.md
- Releases ⧉: https://github.com/IBM/argocd-vault-plugin/releases

0 comments on commit a47fcae

Please sign in to comment.