types

Documentation

Index

• Constants
• type AuthType
• type Backend
• type HTTPClient

Constants

const (
	// Environment Variable Constants
	EnvAvpType           = "AVP_TYPE"
	EnvAvpRoleID         = "AVP_ROLE_ID"
	EnvAvpSecretID       = "AVP_SECRET_ID"
	EnvAvpAuthType       = "AVP_AUTH_TYPE"
	EnvAvpGithubToken    = "AVP_GITHUB_TOKEN"
	EnvAvpK8sRole        = "AVP_K8S_ROLE"
	EnvAvpK8sMountPath   = "AVP_K8S_MOUNT_PATH"
	EnvAvpK8sTokenPath   = "AVP_K8S_TOKEN_PATH"
	EnvAvpIBMAPIKey      = "AVP_IBM_API_KEY"
	EnvAvpIBMInstanceURL = "AVP_IBM_INSTANCE_URL"
	EnvAvpKvVersion      = "AVP_KV_VERSION"
	EnvAvpPathPrefix     = "AVP_PATH_PREFIX"
	EnvAWSRegion         = "AWS_REGION"
	EnvVaultAddress      = "VAULT_ADDR"

	// Backend and Auth Constants
	VaultBackend             = "vault"
	IBMSecretsManagerbackend = "ibmsecretsmanager"
	AWSSecretsManagerbackend = "awssecretsmanager"
	GCPSecretManagerbackend  = "gcpsecretmanager"
	AzureKeyVaultbackend     = "azurekeyvault"
	K8sAuth                  = "k8s"
	ApproleAuth              = "approle"
	GithubAuth               = "github"
	TokenAuth                = "token"
	IAMAuth                  = "iam"
	AwsDefaultRegion         = "us-east-2"
	GCPCurrentSecretVersion  = "latest"
	IBMMaxRetries            = 3
	IBMRetryIntervalSeconds  = 20
	IBMMaxPerPage            = 200
	IBMIAMCredentialsType    = "iam_credentials"
	IBMImportedCertType      = "imported_cert"
	IBMPublicCertType        = "public_cert"

	// Supported annotations
	AVPPathAnnotation          = "avp.kubernetes.io/path"
	AVPIgnoreAnnotation        = "avp.kubernetes.io/ignore"
	AVPRemoveMissingAnnotation = "avp.kubernetes.io/remove-missing"
	AVPSecretVersionAnnotation = "avp.kubernetes.io/secret-version"
	VaultKVVersionAnnotation   = "avp.kubernetes.io/kv-version"
)

Types

type AuthType

type AuthType interface {
	Authenticate(*api.Client) error
}

AuthType is and interface for the supported authentication methods

type Backend

type Backend interface {
	Login() error

	// GetSecrets retrieves the secret at `path` with specified `version` based on configuation given in `annotations`
	GetSecrets(path string, version string, annotations map[string]string) (map[string]interface{}, error)

	// GetIndividualSecret retrieves the specific secret from `path` with specified `version` based on configuation given in `annotations`
	GetIndividualSecret(path, secret, version string, annotations map[string]string) (interface{}, error)
}

Backend is an interface for the types of Vaults that are supported

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient interface