providers

Documentation

Overview

Package providers implements generic certificate provider related functionality

Index

• Variables
• func GetCertFromKubernetes(ns string, secretName string, kubeClient kubernetes.Interface) (certificate.Certificater, error)
• func GetCertificateFromSecret(ns string, secretName string, cert certificate.Certificater, ...) (certificate.Certificater, error)
• func ValidateCertManagerOptions(options CertManagerOptions) error
• func ValidateTresorOptions(options TresorOptions) error
• func ValidateVaultOptions(options VaultOptions) error
• type CertManagerOptions
• type Config
  • func NewCertificateProvider(kubeClient kubernetes.Interface, kubeConfig *rest.Config, ...) (certificate.Manager, debugger.CertificateManagerDebugger, *Config, error)
  • func NewCertificateProviderConfig(kubeClient kubernetes.Interface, kubeConfig *rest.Config, ...) *Config
  • func (c *Config) GetCertificateManager() (certificate.Manager, debugger.CertificateManagerDebugger, error)
  • func (c *Config) Validate() error
• type Kind
  • func (p Kind) String() string
• type TresorOptions
• type VaultOptions

Variables

var (
	// ValidCertificateProviders is the list of supported certificate providers
	ValidCertificateProviders = []Kind{TresorKind, VaultKind, CertManagerKind}
)

Functions

func GetCertFromKubernetes

func GetCertFromKubernetes(ns string, secretName string, kubeClient kubernetes.Interface) (certificate.Certificater, error)

GetCertFromKubernetes is a helper function that loads a certificate from a Kubernetes secret The function returns an error only if a secret is found with invalid data.

func GetCertificateFromSecret

func GetCertificateFromSecret(ns string, secretName string, cert certificate.Certificater, kubeClient kubernetes.Interface) (certificate.Certificater, error)

GetCertificateFromSecret is a helper function that ensures creation and synchronization of a certificate using Kubernetes Secrets backend and API atomicity.

func ValidateCertManagerOptions

func ValidateCertManagerOptions(options CertManagerOptions) error

ValidateCertManagerOptions validates the options for cert-manager.io certificate provider

func ValidateTresorOptions

func ValidateTresorOptions(options TresorOptions) error

ValidateTresorOptions validates the options for Tresor certificate provider

func ValidateVaultOptions

func ValidateVaultOptions(options VaultOptions) error

ValidateVaultOptions validates the options for Hashi Vault certificate provider

Types

type CertManagerOptions

type CertManagerOptions struct {
	IssuerName  string
	IssuerKind  string
	IssuerGroup string
}

CertManagerOptions is a type that specifies 'cert-manager.io' certificate provider options

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config is a type that stores config related to certificate providers and implements generic utility functions

func NewCertificateProvider

func NewCertificateProvider(kubeClient kubernetes.Interface, kubeConfig *rest.Config, cfg configurator.Configurator, providerKind Kind,
	providerNamespace string, caBundleSecretName string, tresorOptions TresorOptions, vaultOptions VaultOptions,
	certManagerOptions CertManagerOptions) (certificate.Manager, debugger.CertificateManagerDebugger, *Config, error)

NewCertificateProvider returns a new certificate provider and associated config

func NewCertificateProviderConfig

func NewCertificateProviderConfig(kubeClient kubernetes.Interface, kubeConfig *rest.Config, cfg configurator.Configurator, providerKind Kind,
	providerNamespace string, caBundleSecretName string, tresorOptions TresorOptions, vaultOptions VaultOptions,
	certManagerOptions CertManagerOptions) *Config

NewCertificateProviderConfig returns a new certificate provider config

func (*Config) GetCertificateManager

func (c *Config) GetCertificateManager() (certificate.Manager, debugger.CertificateManagerDebugger, error)

GetCertificateManager returns the certificate manager/provider instance

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the certificate provider config

type Kind

type Kind string

Kind specifies the certificate provider kind

const (
	// TresorKind represents Tresor, an internal package which leverages Kubernetes secrets and signs certs on the OSM pod
	TresorKind Kind = "tresor"

	// VaultKind represents Hashi Vault; OSM is pointed to an external Vault; signing of certs happens on Vault
	VaultKind Kind = "vault"

	// CertManagerKind represents cert-manager.io; certificates are requested using cert-manager
	CertManagerKind Kind = "cert-manager"
)

func (Kind) String

func (p Kind) String() string

String returns the Kind as a string

type TresorOptions

type TresorOptions struct {
}

TresorOptions is a type that specifies 'Tresor' certificate provider options

type VaultOptions

type VaultOptions struct {
	VaultProtocol string
	VaultHost     string
	VaultToken    string
	VaultRole     string
	VaultPort     int
}

VaultOptions is a type that specifies 'Hashicorp Vault' certificate provider options