|
| 1 | +# {{ pack["pack.yaml"].name | capitalize }} Integration Pack |
| 2 | +_{{ pack["pack.yaml"].description }}_ |
| 3 | + |
| 4 | +*Author:* {{ pack["pack.yaml"].author }} <{{ pack["pack.yaml"].email }}> |
| 5 | + |
| 6 | +{% if pack and pack["config.schema.yaml"] -%} |
| 7 | +## Configuration |
| 8 | + |
| 9 | +The following options are required to be configured for the pack to work correctly. |
| 10 | + |
| 11 | +| Option | Type | Required | Secret | Description | |
| 12 | +|---|---|---|---|---| |
| 13 | +{% for key, value in pack["config.schema.yaml"].items() -%} |
| 14 | +| `{{ key }}` | {{ value.type }} | {{ value.required }} | {{ value.secret | default("default") }} | _{{ value.description | default("Unavailable") }}_ | |
| 15 | +{% if "array" == value.type -%} |
| 16 | +{% if "object" == value.get("items").type -%} |
| 17 | +{% for ik, iv in value.get("items").properties.items() -%} |
| 18 | +| - `{{ ik }}` | {{ iv.type }} | {{ iv.required }} | {{ iv.secret | default("default") }} | _{{ iv.description | default("Unavailable") }}_ | |
| 19 | +{% endfor -%} |
| 20 | +{% else -%} |
| 21 | +| | {{ value.get("items").type }} | | | list of items | |
| 22 | +{% endif -%} |
| 23 | +{% endif -%} |
| 24 | +{% endfor -%} |
| 25 | + |
| 26 | +{% endif %} |
| 27 | + |
| 28 | +## Actions |
| 29 | + |
| 30 | +{% if actions | length > 0 %} |
| 31 | +The pack provides the following actions: |
| 32 | + |
| 33 | +{% for key, value in (actions.items() | list | sort) -%} |
| 34 | +### {{ value.name }} |
| 35 | +_{{ value.description }}_ |
| 36 | +{% if "parameters" in value -%} |
| 37 | +| Parameter | Type | Required | Secret | Description | |
| 38 | +|---|---|---|---|---| |
| 39 | +{% for p_key, p_value in value.parameters.items() -%} |
| 40 | +{% if "array" == p_value.type -%} |
| 41 | +{% if p_value.get("items").type == "object" -%} |
| 42 | +{% for a_k, a_v in p_value.get("items").properties.items() -%} |
| 43 | +| - `{{ a_k }}` | {{ a_v.type | default("n/a") }} | {{ a_v.required | default("default") }} | {{ a_v.secret | default("default") }} | _{{ a_v.description | default("Unavailable") }}_ | |
| 44 | +{% endfor %} |
| 45 | +{% else -%} |
| 46 | +| Items are of type | {{ p_value.items.type }} |||| |
| 47 | +{% endif -%} |
| 48 | +{% endif -%} |
| 49 | +| `{{ p_key }}` | {{ p_value.type | default("n/a") }} | {{ p_value.required | default("default") }} | {{ p_value.secret | default("default") }} | _{{ p_value.description | default("Unavailable") }}_ | |
| 50 | +{% endfor -%} |
| 51 | +{% endif %} |
| 52 | + |
| 53 | +{% endfor %} |
| 54 | +{% else %} |
| 55 | +There are no actions available for this pack. |
| 56 | +{% endif %} |
| 57 | + |
| 58 | +### generate secret |
| 59 | + |
| 60 | +This action is written to pre-populate keys with a random secret. |
| 61 | + |
| 62 | +The following string sets are available |
| 63 | + |
| 64 | + - ascii_letters |
| 65 | + ```abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ``` |
| 66 | + - ascii_lowercase |
| 67 | + ```abcdefghijklmnopqrstuvwxyz``` |
| 68 | + - ascii_uppercase |
| 69 | + ```ABCDEFGHIJKLMNOPQRSTUVWXYZ``` |
| 70 | + - digits |
| 71 | + ```0123456789``` |
| 72 | + - punctuation |
| 73 | + ```!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~``` |
| 74 | + - printable |
| 75 | + ```0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c``` |
| 76 | + - alphanumeric |
| 77 | + ```abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``` |
| 78 | + |
| 79 | +### Update tactic |
| 80 | + |
| 81 | +The update tactic controls how the action will update existing secrets. It's intended to ensure idempotence on multiple runs of the secret generation action. The currently supported tactics are: |
| 82 | + - `overwrite`: Overwrite an existing secret. |
| 83 | + - `refrain`: Do not overwrite an existing secret. |
| 84 | + |
| 85 | +## Sensors |
| 86 | +{% if sensors | length > 0 %} |
| 87 | +The following sensors and triggers are provided: |
| 88 | +{% for key, value in sensors.items() %} |
| 89 | +### Class {{ value.class_name }} |
| 90 | +_{{ value.description }}_ |
| 91 | + |
| 92 | +{% for trigger in value.trigger_types -%} |
| 93 | +| Trigger Name | Description | |
| 94 | +|---|---| |
| 95 | +| `{{ trigger.name }}` | _{{ trigger.description | default("Unavailable") }}_ | |
| 96 | +{% endfor %} |
| 97 | + |
| 98 | + |
| 99 | +{% endfor %} |
| 100 | +{% else %} |
| 101 | +There are no sensors available for this pack. |
| 102 | +{% endif %} |
| 103 | + |
| 104 | +## Authentication methods |
| 105 | + |
| 106 | +Authentication methods are defined per profile and are mutally exclusive. Only configure the |
| 107 | +method that should be used. |
| 108 | + |
| 109 | +### Supported |
| 110 | + - approle |
| 111 | + - token |
| 112 | + |
| 113 | +### Unsupported |
| 114 | + - app-id |
| 115 | + - ali-cloud |
| 116 | + - aws-iam # aka aws |
| 117 | + - aws-ec2 |
| 118 | + - azure |
| 119 | + - cert # aka tls |
| 120 | + - gcp |
| 121 | + - github |
| 122 | + - jwt |
| 123 | + - kubernetes |
| 124 | + - ldap |
| 125 | + - mfa |
| 126 | + - oidc |
| 127 | + - okta |
| 128 | + - radius |
| 129 | + - userpass |
| 130 | + |
| 131 | +## Maintainers |
| 132 | +Active pack maintainers with review & write repository access and expertise with vault: |
| 133 | +* Jacob Floyd ([@cognifloyd](https://github.com/cognifloyd)) <cognifloyd@gmail.com> Copart |
| 134 | +* Carlos ([@nzlosh](https://github.com/nzlosh)) |
| 135 | + |
| 136 | +<sub>Documentation generated using [pack2md](https://github.com/nzlosh/pack2md)</sub> |
0 commit comments