v1alpha1

package
v0.10.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 13, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the xds.agent.enterprise.mesh.gloo.solo.io v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=xds.agent.enterprise.mesh.gloo.solo.io

NOTE: Boilerplate only. Ignore this file. Used to register the Go types with the Kubernetes internal scheme

Definitions for the Kubernetes types

Definitions for the Kubernetes types

Index

Constants

This section is empty.

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "xds.agent.enterprise.mesh.gloo.solo.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)
View Source 
var File_github_com_solo_io_gloo_mesh_api_xds_v1alpha1_xds_config_proto protoreflect.FileDescriptor

Functions

func AddToScheme 

func AddToScheme(s *runtime.Scheme) error

func NewXdsConfigClient 

func NewXdsConfigClient(client client.Client) *xdsConfigClient

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Clientset 

type Clientset interface {
	// clienset for the xds.agent.enterprise.mesh.gloo.solo.io/v1alpha1/v1alpha1 APIs
	XdsConfigs() XdsConfigClient
}

clienset for the xds.agent.enterprise.mesh.gloo.solo.io/v1alpha1 APIs

func NewClientset 

func NewClientset(client client.Client) Clientset

func NewClientsetFromConfig 

func NewClientsetFromConfig(cfg *rest.Config) (Clientset, error)

type MulticlusterClientset 

type MulticlusterClientset interface {
	// Cluster returns a Clientset for the given cluster
	Cluster(cluster string) (Clientset, error)
}

MulticlusterClientset for the xds.agent.enterprise.mesh.gloo.solo.io/v1alpha1 APIs

func NewMulticlusterClientset 

func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset

type MulticlusterXdsConfigClient 

type MulticlusterXdsConfigClient interface {
	// Cluster returns a XdsConfigClient for the given cluster
	Cluster(cluster string) (XdsConfigClient, error)
}

Provides XdsConfigClients for multiple clusters.

func NewMulticlusterXdsConfigClient 

func NewMulticlusterXdsConfigClient(client multicluster.Client) MulticlusterXdsConfigClient

type XdsConfig 

type XdsConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   XdsConfigSpec   `json:"spec,omitempty"`
	Status XdsConfigStatus `json:"status,omitempty"`
}

XdsConfig is the Schema for the xdsConfig API

func (*XdsConfig) DeepCopy 

func (in *XdsConfig) DeepCopy() *XdsConfig

func (*XdsConfig) DeepCopyInto 

func (in *XdsConfig) DeepCopyInto(out *XdsConfig)

func (*XdsConfig) DeepCopyObject 

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

func (XdsConfig) GVK 

func (XdsConfig) GVK() schema.GroupVersionKind

GVK returns the GroupVersionKind associated with the resource type.

type XdsConfigClient 

type XdsConfigClient interface {
	XdsConfigReader
	XdsConfigWriter
	XdsConfigStatusWriter
}

Client knows how to perform CRUD operations on XdsConfigs.

type XdsConfigList 

type XdsConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []XdsConfig `json:"items"`
}

XdsConfigList contains a list of XdsConfig

func (*XdsConfigList) DeepCopy 

func (in *XdsConfigList) DeepCopy() *XdsConfigList

func (*XdsConfigList) DeepCopyInto 

func (in *XdsConfigList) DeepCopyInto(out *XdsConfigList)

func (*XdsConfigList) DeepCopyObject 

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

type XdsConfigReader 

type XdsConfigReader interface {
	// Get retrieves a XdsConfig for the given object key
	GetXdsConfig(ctx context.Context, key client.ObjectKey) (*XdsConfig, error)

	// List retrieves list of XdsConfigs for a given namespace and list options.
	ListXdsConfig(ctx context.Context, opts ...client.ListOption) (*XdsConfigList, error)
}

Reader knows how to read and list XdsConfigs.

type XdsConfigSlice 

type XdsConfigSlice []*XdsConfig

XdsConfigSlice represents a slice of *XdsConfig

type XdsConfigSpec 

type XdsConfigSpec struct {

	//
	//The Workloads that will receive this XDS Configuration.
	Workloads []*v1.ObjectRef `protobuf:"bytes,1,rep,name=workloads,proto3" json:"workloads,omitempty"`
	// the xDS resources to serve to the nodes.
	// mapped by type URL.
	Types []*XdsConfigSpec_TypedResources `protobuf:"bytes,2,rep,name=types,proto3" json:"types,omitempty"`
	// contains filtered or unexported fields
}

XdsConfigs are used to issue XDS Configuration Resources to running Envoy instances. They are created by Gloo Mesh for processing by an agent running on managed clusters.

The agent will serve the specified XDS configuration resources on its grpc-xds port (default 9977) to the Envoy instances (nodes) defined in the XDSConfigSpec.

This feature is currently only available in Gloo Mesh Enterprise.

func (*XdsConfigSpec) DeepCopyInto 

func (in *XdsConfigSpec) DeepCopyInto(out *XdsConfigSpec)

DeepCopyInto for the XdsConfig.Spec

func (*XdsConfigSpec) Descriptor deprecated 

func (*XdsConfigSpec) Descriptor() ([]byte, []int)

Deprecated: Use XdsConfigSpec.ProtoReflect.Descriptor instead.

func (*XdsConfigSpec) GetTypes 

func (x *XdsConfigSpec) GetTypes() []*XdsConfigSpec_TypedResources

func (*XdsConfigSpec) GetWorkloads 

func (x *XdsConfigSpec) GetWorkloads() []*v1.ObjectRef

func (*XdsConfigSpec) MarshalJSON 

func (this *XdsConfigSpec) MarshalJSON() ([]byte, error)

MarshalJSON is a custom marshaler for XdsConfigSpec

func (*XdsConfigSpec) ProtoMessage 

func (*XdsConfigSpec) ProtoMessage()

func (*XdsConfigSpec) ProtoReflect 

func (x *XdsConfigSpec) ProtoReflect() protoreflect.Message

func (*XdsConfigSpec) Reset 

func (x *XdsConfigSpec) Reset()

func (*XdsConfigSpec) String 

func (x *XdsConfigSpec) String() string

func (*XdsConfigSpec) UnmarshalJSON 

func (this *XdsConfigSpec) UnmarshalJSON(b []byte) error

UnmarshalJSON is a custom unmarshaler for XdsConfigSpec

type XdsConfigSpec_Resource 

type XdsConfigSpec_Resource struct {

	// name of the resource, as referenced by xDS
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// stored as compressed, base-64 encoded raw bytes.
	CompressedData []byte `protobuf:"bytes,2,opt,name=compressed_data,json=compressedData,proto3" json:"compressed_data,omitempty"`
	// contains filtered or unexported fields
}

a single named resource

func (*XdsConfigSpec_Resource) Descriptor deprecated 

func (*XdsConfigSpec_Resource) Descriptor() ([]byte, []int)

Deprecated: Use XdsConfigSpec_Resource.ProtoReflect.Descriptor instead.

func (*XdsConfigSpec_Resource) GetCompressedData 

func (x *XdsConfigSpec_Resource) GetCompressedData() []byte

func (*XdsConfigSpec_Resource) GetName 

func (x *XdsConfigSpec_Resource) GetName() string

func (*XdsConfigSpec_Resource) ProtoMessage 

func (*XdsConfigSpec_Resource) ProtoMessage()

func (*XdsConfigSpec_Resource) ProtoReflect 

func (x *XdsConfigSpec_Resource) ProtoReflect() protoreflect.Message

func (*XdsConfigSpec_Resource) Reset 

func (x *XdsConfigSpec_Resource) Reset()

func (*XdsConfigSpec_Resource) String 

func (x *XdsConfigSpec_Resource) String() string

type XdsConfigSpec_TypedResources 

type XdsConfigSpec_TypedResources struct {

	// the type URL of the resources in the given set
	TypeUrl string `protobuf:"bytes,1,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// stored as compressed, base-64 encoded raw bytes.
	Resources []*XdsConfigSpec_Resource `protobuf:"bytes,2,rep,name=resources,proto3" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

a set of resources of a single type (typeURL)

func (*XdsConfigSpec_TypedResources) Descriptor deprecated 

func (*XdsConfigSpec_TypedResources) Descriptor() ([]byte, []int)

Deprecated: Use XdsConfigSpec_TypedResources.ProtoReflect.Descriptor instead.

func (*XdsConfigSpec_TypedResources) GetResources 

func (x *XdsConfigSpec_TypedResources) GetResources() []*XdsConfigSpec_Resource

func (*XdsConfigSpec_TypedResources) GetTypeUrl 

func (x *XdsConfigSpec_TypedResources) GetTypeUrl() string

func (*XdsConfigSpec_TypedResources) ProtoMessage 

func (*XdsConfigSpec_TypedResources) ProtoMessage()

func (*XdsConfigSpec_TypedResources) ProtoReflect 

func (x *XdsConfigSpec_TypedResources) ProtoReflect() protoreflect.Message

func (*XdsConfigSpec_TypedResources) Reset 

func (x *XdsConfigSpec_TypedResources) Reset()

func (*XdsConfigSpec_TypedResources) String 

func (x *XdsConfigSpec_TypedResources) String() string

type XdsConfigStatus 

type XdsConfigStatus struct {

	// The most recent generation observed in the the XdsConfig metadata.
	// If the observedGeneration does not match generation, the XDS Agent has not processed the most
	// recent version of this XdsConfig.
	ObservedGeneration int64 `protobuf:"varint,1,opt,name=observed_generation,json=observedGeneration,proto3" json:"observed_generation,omitempty"`
	// Any error observed which prevented the CertificateRequest from being processed.
	// If the error is empty, the request has been processed successfully.
	Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

The XdsConfig status is written by the CertificateRequesting agent.

func (*XdsConfigStatus) DeepCopyInto 

func (in *XdsConfigStatus) DeepCopyInto(out *XdsConfigStatus)

DeepCopyInto for the XdsConfig.Status

func (*XdsConfigStatus) Descriptor deprecated 

func (*XdsConfigStatus) Descriptor() ([]byte, []int)

Deprecated: Use XdsConfigStatus.ProtoReflect.Descriptor instead.

func (*XdsConfigStatus) GetError 

func (x *XdsConfigStatus) GetError() string

func (*XdsConfigStatus) GetObservedGeneration 

func (x *XdsConfigStatus) GetObservedGeneration() int64

func (*XdsConfigStatus) MarshalJSON 

func (this *XdsConfigStatus) MarshalJSON() ([]byte, error)

MarshalJSON is a custom marshaler for XdsConfigStatus

func (*XdsConfigStatus) ProtoMessage 

func (*XdsConfigStatus) ProtoMessage()

func (*XdsConfigStatus) ProtoReflect 

func (x *XdsConfigStatus) ProtoReflect() protoreflect.Message

func (*XdsConfigStatus) Reset 

func (x *XdsConfigStatus) Reset()

func (*XdsConfigStatus) String 

func (x *XdsConfigStatus) String() string

func (*XdsConfigStatus) UnmarshalJSON 

func (this *XdsConfigStatus) UnmarshalJSON(b []byte) error

UnmarshalJSON is a custom unmarshaler for XdsConfigStatus

type XdsConfigStatusWriter 

type XdsConfigStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given XdsConfig object.
	UpdateXdsConfigStatus(ctx context.Context, obj *XdsConfig, opts ...client.UpdateOption) error

	// Patch patches the given XdsConfig object's subresource.
	PatchXdsConfigStatus(ctx context.Context, obj *XdsConfig, patch client.Patch, opts ...client.PatchOption) error
}

StatusWriter knows how to update status subresource of a XdsConfig object.

type XdsConfigTransitionFunction 

type XdsConfigTransitionFunction func(existing, desired *XdsConfig) error

XdsConfigTransitionFunction instructs the XdsConfigWriter how to transition between an existing XdsConfig object and a desired on an Upsert

type XdsConfigWriter 

type XdsConfigWriter interface {
	// Create saves the XdsConfig object.
	CreateXdsConfig(ctx context.Context, obj *XdsConfig, opts ...client.CreateOption) error

	// Delete deletes the XdsConfig object.
	DeleteXdsConfig(ctx context.Context, key client.ObjectKey, opts ...client.DeleteOption) error

	// Update updates the given XdsConfig object.
	UpdateXdsConfig(ctx context.Context, obj *XdsConfig, opts ...client.UpdateOption) error

	// Patch patches the given XdsConfig object.
	PatchXdsConfig(ctx context.Context, obj *XdsConfig, patch client.Patch, opts ...client.PatchOption) error

	// DeleteAllOf deletes all XdsConfig objects matching the given options.
	DeleteAllOfXdsConfig(ctx context.Context, opts ...client.DeleteAllOfOption) error

	// Create or Update the XdsConfig object.
	UpsertXdsConfig(ctx context.Context, obj *XdsConfig, transitionFuncs ...XdsConfigTransitionFunction) error
}

Writer knows how to create, delete, and update XdsConfigs.

Source Files

View all Source files

Directories

Path Synopsis
Definitions for the Kubernetes Controllers Definitions for the multicluster Kubernetes Controllers Definitions for the Kubernetes Controllers
 Definitions for the Kubernetes Controllers Definitions for the multicluster Kubernetes Controllers Definitions for the Kubernetes Controllers
mocks
Package mock_controller is a generated GoMock package.
 Package mock_controller is a generated GoMock package.
Package mock_v1alpha1 is a generated GoMock package.
 Package mock_v1alpha1 is a generated GoMock package.
mocks
Package mock_v1alpha1sets is a generated GoMock package.
 Package mock_v1alpha1sets is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.