Skip to content

Commit

Permalink
Remove contributors, relocate maintainers and repush codeowners
Browse files Browse the repository at this point in the history
  • Loading branch information
nzlosh committed Sep 5, 2023
1 parent 3473d9a commit 066eccb
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 76 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

# This is base configuration. These owners could review the
# changes in all files in this repository.

* @cognifloyd
* @nzlosh

Expand Down
17 changes: 6 additions & 11 deletions README.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,6 @@ _{{ pack["pack.yaml"].description }}_

*Author:* {{ pack["pack.yaml"].author }} <{{ pack["pack.yaml"].email }}>

## Maintainers
Active pack maintainers with review & write repository access and expertise with vault:
* Jacob Floyd ([@cognifloyd](https://github.com/cognifloyd)) <cognifloyd@gmail.com> Copart
* Carlos ([@nzlosh](https://github.com/nzlosh))

### Contributors
{% for contributor in pack["pack.yaml"].contributors -%}
- {{ contributor }}
{% endfor %}

{% if pack and pack["config.schema.yaml"] -%}
## Configuration

Expand Down Expand Up @@ -40,7 +30,7 @@ The following options are required to be configured for the pack to work correct
{% if actions | length > 0 %}
The pack provides the following actions:

{% for key, value in actions.items() -%}
{% for key, value in (actions.items() | list | sort) -%}
### {{ value.name }}
_{{ value.description }}_
{% if "parameters" in value -%}
Expand Down Expand Up @@ -138,4 +128,9 @@ method that should be used.
- radius
- userpass

## Maintainers
Active pack maintainers with review & write repository access and expertise with vault:
* Jacob Floyd ([@cognifloyd](https://github.com/cognifloyd)) <cognifloyd@gmail.com> Copart
* Carlos ([@nzlosh](https://github.com/nzlosh))

<sub>Documentation generated using [pack2md](https://github.com/nzlosh/pack2md)</sub>
124 changes: 59 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,6 @@ _StackStorm pack integration with HashiCorp Vault_

*Author:* steve.neuharth <[email protected]>

## Maintainers
Active pack maintainers with review & write repository access and expertise with vault:
* Jacob Floyd ([@cognifloyd](https://github.com/cognifloyd)) <[email protected]> Copart
* Carlos ([@nzlosh](https://github.com/nzlosh))

### Contributors
- Andy Moore <[email protected]>
- Jacob Floyd <[email protected]>
- Carlos <[email protected]>


## Configuration

The following options are required to be configured for the pack to work correctly.
Expand All @@ -39,35 +28,6 @@ The following options are required to be configured for the pack to work correct

The pack provides the following actions:

### delete
_Delete value from Vault server_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `path` | string | True | default | _Path to delete from Vault_ |


### generate_secret
_Generate a secret and write it to vault._
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `mount_point` | string | False | default | _Vault moint point in the URL_ |
| `path` | string | True | default | _Path to the secrets_ |
| `key_name` | string | True | default | _Name of the key to write the secret._ |
| `update_tactic` | string | False | default | _The logic to use when writing secret to Vault. See readme for details._ |
| `string_set` | string | default | default | _Unavailable_ |
| `secret_length` | integer | default | default | _The number of characters to use in the secret._ |


### read
_Read value from Vault server_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `path` | string | True | default | _Key to read from Vault_ |


### create_token
_Create a new Token_
| Parameter | Type | Required | Secret | Description |
Expand All @@ -92,13 +52,33 @@ _Create a new Token_
| `mount_point` | string | False | default | _The 'path' the method/backend was mounted on._ |


### write
_Write a key/value to Vault_
### delete
_Delete value from Vault server_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `path` | string | True | default | _Path to the Vault secrets_ |
| `values` | string | True | default | _Keys and values to write in Vault ({"key":"value", "key2": "value2"}_ |
| `path` | string | True | default | _Path to delete from Vault_ |


### delete_policy
_Delete policy from Vault server_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `name` | string | True | default | _Policy to delete from Vault_ |


### generate_secret
_Generate a secret and write it to vault._
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `mount_point` | string | False | default | _Vault moint point in the URL_ |
| `path` | string | True | default | _Path to the secrets_ |
| `key_name` | string | True | default | _Name of the key to write the secret._ |
| `update_tactic` | string | False | default | _The logic to use when writing secret to Vault. See readme for details._ |
| `string_set` | string | default | default | _Unavailable_ |
| `secret_length` | integer | default | default | _The number of characters to use in the secret._ |


### get_policy
Expand All @@ -109,12 +89,26 @@ _Read policy from Vault server_
| `name` | string | True | default | _Policy to read from Vault_ |


### delete_policy
_Delete policy from Vault server_
### is_initialized
_Read initialization status from Vault server_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `name` | string | True | default | _Policy to delete from Vault_ |


### list_policies
_List Policies from Vault server_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |


### read
_Read value from Vault server_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `path` | string | True | default | _Key to read from Vault_ |


### read_kv
Expand All @@ -128,6 +122,15 @@ _Read a kv value from Vault server_
| `version` | string | True | default | _The version of the kv *data*_ |


### revoke_token
_Revoke a token and all its child tokens._
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `token` | string | True | default | _Token to revoke._ |
| `mount_point` | string | False | default | _The 'path' the method/backend was mounted on._ |


### set_policy
_Create a new Vault policy_
| Parameter | Type | Required | Secret | Description |
Expand All @@ -137,11 +140,13 @@ _Create a new Vault policy_
| `rules` | string | True | default | _Policy rules_ |


### list_policies
_List Policies from Vault server_
### write
_Write a key/value to Vault_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `path` | string | True | default | _Path to the Vault secrets_ |
| `values` | string | True | default | _Keys and values to write in Vault ({"key":"value", "key2": "value2"}_ |


### write_secret
Expand All @@ -157,22 +162,6 @@ _Write a secret to Vault._
| `update_tactic` | string | False | default | _The logic to use when writing secret to Vault. See readme for details._ |


### revoke_token
_Revoke a token and all its child tokens._
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |
| `token` | string | True | default | _Token to revoke._ |
| `mount_point` | string | False | default | _The 'path' the method/backend was mounted on._ |


### is_initialized
_Read initialization status from Vault server_
| Parameter | Type | Required | Secret | Description |
|---|---|---|---|---|
| `profile_name` | string | False | default | _The profile to use to run this action._ |





Expand Down Expand Up @@ -235,4 +224,9 @@ method that should be used.
- radius
- userpass

## Maintainers
Active pack maintainers with review & write repository access and expertise with vault:
* Jacob Floyd ([@cognifloyd](https://github.com/cognifloyd)) <[email protected]> Copart
* Carlos ([@nzlosh](https://github.com/nzlosh))

<sub>Documentation generated using [pack2md](https://github.com/nzlosh/pack2md)</sub>

0 comments on commit 066eccb

Please sign in to comment.