open-vault/website/content/api-docs/secret
Alexander Scheel f0a127487b
Add ability to cancel PKI tidy operations, pause between tidying certs (#16958)
* Allow tidy operations to be cancelled

When tidy operations take a long time to execute (and especially when
executing them automatically), having the ability to cancel them becomes
useful to reduce strain on Vault clusters (and let them be rescheduled
at a later time).

To this end, we add the /tidy-cancel write endpoint.

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add missing auto-tidy synopsis / description

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add a pause duration between tidying certificates

By setting pause_duration, operators can have a little control over the
resource utilization of a tidy operation. While the list of certificates
remain in memory throughout the entire operation, a pause is added
between processing certificates and the revocation lock is released.
This allows other operations to occur during this gap and potentially
allows the tidy operation to consume less resources per unit of time
(due to the sleep -- though obviously consumes the same resources over
the time of the operation).

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add tests for cancellation, pause

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add API docs on pause_duration, /tidy-cancel

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add changelog entry

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add lock releasing around tidy pause

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Reset cancel guard, return errors

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2022-08-31 11:36:12 -07:00
..
databases docs: add multi-host connection string info to postgres secrets API docs (#16780) 2022-08-18 14:38:30 -05:00
identity VAULT-6818 Docs for entity merge functionality (#16593) 2022-08-10 09:10:10 -04:00
key-management Fix missing quote in docs (#14277) 2022-02-25 09:02:08 -08:00
kv VAULT-6091 Document Duration Format String (#15920) 2022-06-13 08:51:07 -04:00
ad.mdx VAULT-6091 Document Duration Format String (#15920) 2022-06-13 08:51:07 -04:00
alicloud.mdx feat(website): migrates nav data format and updates docs pages (#11242) 2021-04-06 13:49:04 -04:00
aws.mdx Docs: API AWS Secrets Formatting (#16797) 2022-08-25 15:11:56 -07:00
azure.mdx update azure docs (#16819) 2022-08-29 14:55:37 -05:00
cassandra.mdx Add note about X.509 SHA-1 deprecation to relevant plugins (#15672) 2022-06-01 12:41:11 -07:00
consul.mdx docs: fix consul secrets feature version (#16304) 2022-07-18 13:03:45 -05:00
cubbyhole.mdx Replace docs references to PUT with POST (#14270) 2022-02-25 06:52:24 -08:00
gcp.mdx VAULT-6091 Document Duration Format String (#15920) 2022-06-13 08:51:07 -04:00
gcpkms.mdx feat(website): migrates nav data format and updates docs pages (#11242) 2021-04-06 13:49:04 -04:00
index.mdx feat(website): migrates nav data format and updates docs pages (#11242) 2021-04-06 13:49:04 -04:00
kmip.mdx Add new KMIP backend operation parameters to API documentation. (#16107) 2022-06-22 13:28:03 -04:00
kubernetes.mdx [Kubernetes Secret Engine]: Role namespace configuration possible via LabelSelector (#16240) 2022-07-19 13:11:45 -05:00
mongodbatlas.mdx secrets/mongodbatlas: adds missing organization_id to API docs (#15624) 2022-05-26 08:08:29 -07:00
nomad.mdx Change all occurrence of 'backend' to 'secrets engine' (#16859) 2022-08-23 19:58:54 -07:00
openldap.mdx VAULT-6091 Document Duration Format String (#15920) 2022-06-13 08:51:07 -04:00
pki.mdx Add ability to cancel PKI tidy operations, pause between tidying certs (#16958) 2022-08-31 11:36:12 -07:00
rabbitmq.mdx RabbitMQ - Add username customization (#11899) 2021-06-22 14:50:46 -05:00
ssh.mdx Mention allowed_users and allowed_domains are comma separated lists (#16877) 2022-08-24 16:17:20 -07:00
terraform.mdx VAULT-6091 Document Duration Format String (#15920) 2022-06-13 08:51:07 -04:00
totp.mdx Rename master key -> root key in docs (#14542) 2022-03-16 22:01:38 -07:00
transform.mdx Transform tokenization key auto-rotate docs (#16410) 2022-07-21 15:48:58 -05:00
transit.mdx Allow configuring the possible salt lengths for RSA PSS signatures (#16549) 2022-08-31 12:27:03 -04:00