Skip to content

Commit

Permalink
Update documentation for v2.0.0
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Baillie <[email protected]>
  • Loading branch information
martinbaillie committed Oct 12, 2022
1 parent 8d0472f commit 072ee83
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.org
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[https://github.com/martinbaillie/vault-plugin-secrets-github/actions][https://github.com/martinbaillie/vault-plugin-secrets-github/actions/workflows/build.yml/badge.svg]]
[[https://github.com/martinbaillie/vault-plugin-secrets-github/actions][https://github.com/martinbaillie/vault-plugin-secrets-github/actions/workflows/test.yml/badge.svg]]
[[https://codecov.io/gh/martinbaillie/vault-plugin-secrets-github][https://codecov.io/gh/martinbaillie/vault-plugin-secrets-github/branch/master/graph/badge.svg]]
[[https://godoc.org/github.com/martinbaillie/vault-plugin-secrets-github][https://godoc.org/github.com/martinbaillie/vault-plugin-secrets-github?status.svg]]
[[https://goreportcard.com/report/github.com/martinbaillie/vault-plugin-secrets-github][https://goreportcard.com/badge/github.com/martinbaillie/vault-plugin-secrets-github?status.svg]]
Expand Down Expand Up @@ -333,15 +333,24 @@ Instruct the plugin to create an installation access token against the configure

*** Parameters
#+begin_quote
NOTE: All parameters are optional. Omitting them results in a token that has
access to all of the repositories and permissions that the GitHub App has.
NOTE: Only one of =installation_id= or =org_name= is required. If only =org_name= is
provided, an additional lookup against the GitHub instance is performed _per
token creation_ to discover the =installation_id=. If both are provided,
=installation_id= takes precedence to avoid the additional round trip. Also note
that no caching is performed so for high traffic use cases, favour
=installation_id=.

All other parameters are optional. Omitting them results in a token that has
access to all of the repositories and permissions that the GitHub App
installation has.

When crafting Vault policy, hyper security sensitive organisations may wish to
favour =repository_ids= (GitHub repository IDs are immutable) instead of
=repositories= (GitHub repository names are mutable).
#+end_quote

- =installation_id= (int64) — the ID of the app installation.
- =org_name= (string) — the organisation name.
- =repositories= ([]string) — a list of the names of the repositories within the
organisation that the installation token can access.
- =repository_ids= ([]int64) — a list of the IDs of the repositories that the
Expand Down Expand Up @@ -427,15 +436,24 @@ Instruct the plugin to create a specific permission set.

*** Parameters
#+begin_quote
NOTE: All parameters are optional. Omitting them results in a token that has
access to all of the repositories and permissions that the GitHub App has.
NOTE: Only one of =installation_id= or =org_name= is required. If only =org_name= is
provided, an additional lookup against the GitHub instance is performed _per
token creation_ to discover the =installation_id=. If both are provided,
=installation_id= takes precedence to avoid the additional round trip. Also note
that no caching is performed so for high traffic use cases, favour
=installation_id=.

All other parameters are optional. Omitting them results in a token that has
access to all of the repositories and permissions that the GitHub App
installation has.

When crafting Vault policy, hyper security sensitive organisations may wish to
favour =repository_ids= (GitHub repository IDs are immutable) instead of
=repositories= (GitHub repository names are mutable).
#+end_quote

- =installation_id= (int64) — the ID of the app installation.
- =org_name= (string) — the organisation name.
- =repositories= ([]string) — a list of the names of the repositories within the
organisation that the installation token can access.
- =repository_ids= ([]int64) — a list of the IDs of the repositories that the
Expand Down

0 comments on commit 072ee83

Please sign in to comment.