v1

Documentation

Overview

Package v1 is the v1 version of the API. +groupName=secretless.io

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type Configuration
  • func (in *Configuration) DeepCopy() *Configuration
  • func (in *Configuration) DeepCopyInto(out *Configuration)
  • func (in *Configuration) DeepCopyObject() runtime.Object
• type ConfigurationList
  • func (in *ConfigurationList) DeepCopy() *ConfigurationList
  • func (in *ConfigurationList) DeepCopyInto(out *ConfigurationList)
  • func (in *ConfigurationList) DeepCopyObject() runtime.Object
• type ConfigurationSpec
  • func (in *ConfigurationSpec) DeepCopy() *ConfigurationSpec
  • func (in *ConfigurationSpec) DeepCopyInto(out *ConfigurationSpec)
  • func (in *ConfigurationSpec) DeepCopyObject() runtime.Object
• type ConfigurationStatus
  • func (in *ConfigurationStatus) DeepCopy() *ConfigurationStatus
  • func (in *ConfigurationStatus) DeepCopyInto(out *ConfigurationStatus)
• type Handler
  • func (in *Handler) DeepCopy() *Handler
  • func (in *Handler) DeepCopyInto(out *Handler)
  • func (in *Handler) DeepCopyObject() runtime.Object
• type Listener
  • func (in *Listener) DeepCopy() *Listener
  • func (in *Listener) DeepCopyInto(out *Listener)
  • func (in *Listener) DeepCopyObject() runtime.Object
• type Variable
  • func (in *Variable) DeepCopy() *Variable
  • func (in *Variable) DeepCopyInto(out *Variable)
  • func (in *Variable) DeepCopyObject() runtime.Object

Variables

var (
	// SchemeBuilder is a parent object that we copy fields from
	SchemeBuilder runtime.SchemeBuilder

	// AddToScheme indicates the function that will be used to add types
	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{

	Group: secretlessio.GroupName,

	Version: "v1",
}

SchemeGroupVersion indicates the combo of group name and version that we are defining these schemes for

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource returns a group resource of our specificed group/version combo with a specific resource ID

Types

type Configuration

type Configuration struct {
	meta_v1.TypeMeta   `json:",omitempty" yaml:",omitempty"`
	meta_v1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	Spec   ConfigurationSpec   `json:"spec"`
	Status ConfigurationStatus `json:"status"`
}

Configuration is the generic CRD API type wrapping our spec +genclient +genclient:noStatus +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Configuration) DeepCopy

func (in *Configuration) DeepCopy() *Configuration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Configuration.

func (*Configuration) DeepCopyInto

func (in *Configuration) DeepCopyInto(out *Configuration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Configuration) DeepCopyObject

func (in *Configuration) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ConfigurationList

type ConfigurationList struct {
	meta_v1.TypeMeta `json:",omitempty" yaml:",omitempty"`
	meta_v1.ListMeta `json:"metadata" yaml:"metadata,omitempty"`

	Items []Configuration `json:"items"`
}

ConfigurationList is an array container of our CRD resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ConfigurationList) DeepCopy

func (in *ConfigurationList) DeepCopy() *ConfigurationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigurationList.

func (*ConfigurationList) DeepCopyInto

func (in *ConfigurationList) DeepCopyInto(out *ConfigurationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConfigurationList) DeepCopyObject

func (in *ConfigurationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ConfigurationSpec

type ConfigurationSpec struct {
	meta_v1.TypeMeta   `json:",omitempty" yaml:",omitempty"`
	meta_v1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	Listeners []Listener `json:"listeners"`
	Handlers  []Handler  `json:"handlers"`
}

ConfigurationSpec is the main configuration structure for Secretless. It lists and configures the protocol listeners and handlers. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ConfigurationSpec) DeepCopy

func (in *ConfigurationSpec) DeepCopy() *ConfigurationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigurationSpec.

func (*ConfigurationSpec) DeepCopyInto

func (in *ConfigurationSpec) DeepCopyInto(out *ConfigurationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConfigurationSpec) DeepCopyObject

func (in *ConfigurationSpec) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ConfigurationStatus

type ConfigurationStatus struct {
	AvailableReplicas int32 `json:"availableReplicas"`
}

ConfigurationStatus is used to indicate what state the CRD is in

func (*ConfigurationStatus) DeepCopy

func (in *ConfigurationStatus) DeepCopy() *ConfigurationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigurationStatus.

func (*ConfigurationStatus) DeepCopyInto

func (in *ConfigurationStatus) DeepCopyInto(out *ConfigurationStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Handler

type Handler struct {
	meta_v1.TypeMeta   `json:",omitempty" yaml:",omitempty"`
	meta_v1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	Name         string     `json:"name,omitempty" yaml:",omitempty"`
	Type         string     `json:"type"`
	ListenerName string     `json:"listener" yaml:"listener"`
	Debug        bool       `json:"debug,omitempty" yaml:",omitempty"`
	Match        []string   `json:"match,omitempty" yaml:",omitempty"`
	Credentials  []Variable `json:"credentials,omitempty" yaml:",omitempty"`
}

Handler processes an inbound message and connects to a specified backend using Credentials which it fetches from a provider. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Handler) DeepCopy

func (in *Handler) DeepCopy() *Handler

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Handler.

func (*Handler) DeepCopyInto

func (in *Handler) DeepCopyInto(out *Handler)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Handler) DeepCopyObject

func (in *Handler) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type Listener

type Listener struct {
	meta_v1.TypeMeta   `json:",omitempty" yaml:",omitempty"`
	meta_v1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	Address     string   `json:"address,omitempty" yaml:",omitempty"`
	CACertFiles []string `yaml:"caCertFiles,omitempty" yaml:",omitempty"`
	Debug       bool     `json:"debug,omitempty" yaml:",omitempty"`
	Name        string   `json:"name"`
	Protocol    string   `json:"protocol"`
	Socket      string   `json:"socket,omitempty" yaml:",omitempty"`
}

Listener listens on a port on socket for inbound connections, which are handed off to Handlers. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Listener) DeepCopy

func (in *Listener) DeepCopy() *Listener

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Listener.

func (*Listener) DeepCopyInto

func (in *Listener) DeepCopyInto(out *Listener)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Listener) DeepCopyObject

func (in *Listener) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type Variable

type Variable struct {
	meta_v1.TypeMeta   `json:",omitempty" yaml:",omitempty"`
	meta_v1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	// Name is the name by which the variable will be used by the client.
	Name string `json:"name,omitempty" yaml:",omitempty"`
	// Provider is the provider name.
	Provider string `json:"provider"`
	// Value is the identifier of the secret that the Provider will load.
	ID string `json:"id"`
}

Variable is a named secret. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Variable) DeepCopy

func (in *Variable) DeepCopy() *Variable

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Variable.

func (*Variable) DeepCopyInto

func (in *Variable) DeepCopyInto(out *Variable)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Variable) DeepCopyObject

func (in *Variable) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.