sensu-docs icon indicating copy to clipboard operation
sensu-docs copied to clipboard

Custom secrets types and backend API

Open hillaryfraley opened this issue 2 years ago • 1 comments

Description

[Issue created as a placeholder in April 2022; probably will need to revisit and update into separate issues, depending on how this feature develops]

Need to document new secrets/v2 API and update references for secrets and secrets providers.

Category

This is an issue with:

  • [ ] errata (error in doc content)
  • [x] new doc (requires a completely new doc)
  • [ ] update (add missing or refresh existing content)
  • [ ] improvement (improve docs content or format)

Corrections needed

  • Add a page in the enterprise APIs like https://docs.sensu.io/sensu-go/latest/api/enterprise/secrets/
  • ~Not sure what to do~ with https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets/, https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-providers/, and https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-management/
    • Think we need a v1 and v2 version of the secrets and secrets providers references
    • Add a section in https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-management/ to cover new secrets/providers

Additional context

Issues:

  • https://github.com/sensu/sensu-enterprise-go/issues/2172
  • https://github.com/sensu/sensu-enterprise-go/issues/2173
  • https://github.com/sensu/sensu-enterprise-go/issues/2293

PRs:

  • https://github.com/sensu/sensu-enterprise-go/pull/2177
  • https://github.com/sensu/sensu-enterprise-go/pull/2195
  • https://github.com/sensu/sensu-enterprise-go/pull/2211
  • https://github.com/sensu/sensu-enterprise-go/pull/2399

Proposal: https://docs.google.com/document/d/1KLatzCkCYRhm0DngKw4X-upbFewJTV6NDNPCTYYea78/edit#heading=h.1axp98vz7cn0

hillaryfraley avatar Apr 19 '22 16:04 hillaryfraley

@hillaryfraley as discussed in the staff meeting today, we're going to put this work on hold for the time being. I'll remove it from the 6.8.0 milestone for now. Please let me know if you have any questions. 😊

calebhailey avatar Aug 09 '22 20:08 calebhailey