vault

Documentation

Overview

Package vault provides the ability for Vela to integrate with HashiCorp Vault as a secret backend.

Usage:

import "github.com/go-vela/server/secret/vault"

Index

• Constants
• func New(opts ...ClientOpt) (*client, error)
• type ClientOpt
  • func WithAWSRole(awsRole string) ClientOpt
  • func WithAddress(address string) ClientOpt
  • func WithAuthMethod(authMethod string) ClientOpt
  • func WithPrefix(prefix string) ClientOpt
  • func WithToken(token string) ClientOpt
  • func WithTokenDuration(tokenDuration time.Duration) ClientOpt
  • func WithVersion(version string) ClientOpt

Constants

const (
	PrefixVaultV1 = "secret"
	PrefixVaultV2 = "secret/data"
)

Functions

func New

func New(opts ...ClientOpt) (*client, error)

New returns a Secret implementation that integrates with a Vault secrets engine.

nolint: revive // ignore returning unexported client

Types

type ClientOpt

type ClientOpt func(*client) error

ClientOpt represents a configuration option to initialize the secret client.

func WithAWSRole

func WithAWSRole(awsRole string) ClientOpt

WithAWSRole sets the Vault AWS role in the secret client.

func WithAddress

func WithAddress(address string) ClientOpt

WithAddress sets the Vault address in the secret client.

func WithAuthMethod

func WithAuthMethod(authMethod string) ClientOpt

WithAuthMethod sets the Vault authentication method in the secret client.

func WithPrefix

func WithPrefix(prefix string) ClientOpt

WithPrefix sets the Vault prefix in the secret client.

func WithToken

func WithToken(token string) ClientOpt

WithToken sets the Vault token in the secret client.

func WithTokenDuration

func WithTokenDuration(tokenDuration time.Duration) ClientOpt

WithTokenDuration sets the Vault token duration in the secret client.

func WithVersion

func WithVersion(version string) ClientOpt

WithVersion sets the Vault version in the secret client.