v1

Documentation

Overview

+k8s:deepcopy-gen=package +k8s:openapi-gen=true Package v1alpha1 is the v1alpha1 version of the API. +groupName=kubernetes-client.io

Index

• type Data
  • func (d Data) SecretLocation(backend string) string
• type ExternalSecret
  • func (s *ExternalSecret) KeyAndNames() []string
  • func (s *ExternalSecret) KeyAndProperty(name string) (string, string, error)
  • func (s *ExternalSecret) Keys() []string
• type ExternalSecretList
• type ExternalSecretSpec
• type ExternalSecretStatus
• type Template

Types

type Data

type Data struct {
	// Name name of the secret data entry
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// Key the key in the underlying secret storage (e.g. the key in vault)
	Key string `json:"key,omitempty" yaml:"key,omitempty"`

	// Property the property in the underlying secret storage (e.g.  in vault)
	Property string `json:"property,omitempty" yaml:"property,omitempty"`

	// Version the version of the property to use. e.g. 'latest'
	Version string `json:"version,omitempty" yaml:"version,omitempty"`
}

Data the data properties

func (Data) SecretLocation

func (d Data) SecretLocation(backend string) string

SecretLocation is the string representation of this unique property

type ExternalSecret

type ExternalSecret struct {
	metav1.TypeMeta `json:",inline" yaml:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata" yaml:"metadata"`

	// Spec holds the desired state of the ExternalSecret from the client
	// +optional
	Spec ExternalSecretSpec `json:"spec" yaml:"spec"`

	// Status holds the current status
	// +optional
	Status *ExternalSecretStatus `json:"status,omitempty" yaml:"status,omitempty"`
}

ExternalSecret represents a collection of mappings of Secrets to destinations in the underlying secret store (e.g. Vault keys)

+k8s:openapi-gen=true

func (*ExternalSecret) KeyAndNames

func (s *ExternalSecret) KeyAndNames() []string

KeyAndNames returns the data key and names for the secret

func (*ExternalSecret) KeyAndProperty

func (s *ExternalSecret) KeyAndProperty(name string) (string, string, error)

KeyAndProperty returns the secret key and property for a given secret data entry defined by name

func (*ExternalSecret) Keys

func (s *ExternalSecret) Keys() []string

Keys returns the keys for the secret

type ExternalSecretList

type ExternalSecretList struct {
	metav1.TypeMeta `json:",inline" yaml:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`
	Items           []ExternalSecret `json:"items" yaml:"items"`
}

ExternalSecretList contains a list of ExternalSecret

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

type ExternalSecretSpec

type ExternalSecretSpec struct {
	BackendType     string `json:"backendType,omitempty" yaml:"backendType,omitempty"`
	VaultMountPoint string `json:"vaultMountPoint,omitempty" yaml:"vaultMountPoint,omitempty"`
	VaultRole       string `json:"vaultRole,omitempty" yaml:"vaultRole,omitempty"`
	ProjectID       string `json:"projectId,omitempty" yaml:"projectId,omitempty"`
	KeyVaultName    string `json:"keyVaultName,omitempty" yaml:"keyVaultName,omitempty"`
	Region          string `json:"region,omitempty" yaml:"region,omitempty"`
	RoleArn         string `json:"roleArn,omitempty" yaml:"roleArn,omitempty"`
	// Data the data for each entry in the Secret
	Data []Data `json:"data,omitempty" yaml:"data,omitempty"`

	// Template
	Template Template `json:"template,omitempty" yaml:"template,omitempty"`
}

ExternalSecretSpec defines the desired state of ExternalSecret.

type ExternalSecretStatus

type ExternalSecretStatus struct {
	LastSync           metav1.Time `json:"lastSync,omitempty" yaml:"lastSync,omitempty"`
	ObservedGeneration int         `json:"observedGeneration,omitempty" yaml:"observedGeneration,omitempty"`
	Status             string      `json:"status,omitempty" yaml:"status,omitempty"`
}

ExternalSecretStatus defines the current status of the ExternalSecret.

type Template

type Template struct {
	// Type the type of the secret
	Type string `json:"type,omitempty" yaml:"type,omitempty"`

	// Metadata the metadata such as labels or annotations
	Metadata metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`
}

Template the template data