automatedrotationutil

Documentation

Index

• Variables
• func AddAutomatedRotationFields(m map[string]*framework.FieldSchema)
• type AutomatedRotationParams
  • func (p *AutomatedRotationParams) ParseAutomatedRotationFields(d *framework.FieldData) error
  • func (p *AutomatedRotationParams) PopulateAutomatedRotationData(m map[string]interface{})
  • func (p *AutomatedRotationParams) ShouldDeregisterRotationJob() bool
  • func (p *AutomatedRotationParams) ShouldRegisterRotationJob() bool

Variables

var (
	ErrRotationMutuallyExclusiveFields = errors.New("mutually exclusive fields rotation_schedule and rotation_period were both specified; only one of them can be provided")
	ErrRotationManagerUnsupported      = errors.New("rotation manager capabilities not supported in Vault community edition")
)

Functions

func AddAutomatedRotationFields

func AddAutomatedRotationFields(m map[string]*framework.FieldSchema)

AddAutomatedRotationFields adds plugin identity token fields to the given field schema map.

Types

type AutomatedRotationParams

type AutomatedRotationParams struct {
	// RotationSchedule is the CRON-style rotation schedule.
	RotationSchedule string `json:"rotation_schedule"`
	// RotationWindow specifies the amount of time in which the rotation is allowed to
	// occur starting from a given rotation_schedule.
	RotationWindow time.Duration `json:"rotation_window"`
	// RotationPeriod is an alternate choice for simple time-to-live based rotation timing.
	RotationPeriod time.Duration `json:"rotation_period"`

	// If set, will deregister all registered rotation jobs from the RotationManager for plugin.
	DisableAutomatedRotation bool `json:"disable_automated_rotation"`
}

AutomatedRotationParams contains a set of common parameters that plugins can use for setting automated credential rotation.

func (*AutomatedRotationParams) ParseAutomatedRotationFields

func (p *AutomatedRotationParams) ParseAutomatedRotationFields(d *framework.FieldData) error

ParseAutomatedRotationFields provides common field parsing to embedding structs.

func (*AutomatedRotationParams) PopulateAutomatedRotationData

func (p *AutomatedRotationParams) PopulateAutomatedRotationData(m map[string]interface{})

PopulateAutomatedRotationData adds PluginIdentityTokenParams info into the given map.

func (*AutomatedRotationParams) ShouldDeregisterRotationJob

func (p *AutomatedRotationParams) ShouldDeregisterRotationJob() bool

func (*AutomatedRotationParams) ShouldRegisterRotationJob

func (p *AutomatedRotationParams) ShouldRegisterRotationJob() bool