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 for Vault.

func WithAWSRole

func WithAWSRole(awsRole string) ClientOpt

WithAWSRole sets the AWS role in the secret client for Vault.

func WithAddress

func WithAddress(address string) ClientOpt

WithAddress sets the address in the secret client for Vault.

func WithAuthMethod

func WithAuthMethod(authMethod string) ClientOpt

WithAuthMethod sets the authentication method in the secret client for Vault.

func WithPrefix

func WithPrefix(prefix string) ClientOpt

WithPrefix sets the prefix in the secret client for Vault.

func WithToken

func WithToken(token string) ClientOpt

WithToken sets the token in the secret client for Vault.

func WithTokenDuration

func WithTokenDuration(tokenDuration time.Duration) ClientOpt

WithTokenDuration sets the token duration in the secret client for Vault.

func WithVersion

func WithVersion(version string) ClientOpt

WithVersion sets the version in the secret client for Vault.