v1

package
v1.1.0-beta4 Latest Latest
Warning

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

 Go to latest Published: May 4, 2021 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Overview

Package v1 contains API Schema definitions for the settings.mesh.gloo.solo.io v1 API group +k8s:deepcopy-gen=package,register +groupName=settings.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: "settings.mesh.gloo.solo.io", Version: "v1"}

	// 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_settings_v1_settings_proto protoreflect.FileDescriptor
View Source 
var SettingsGVK = schema.GroupVersionKind{
	Group:   "settings.mesh.gloo.solo.io",
	Version: "v1",
	Kind:    "Settings",
}

GroupVersionKind for Settings

Functions

func AddToScheme 

func AddToScheme(s *runtime.Scheme) error

func NewSettingsClient 

func NewSettingsClient(client client.Client) *settingsClient

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 settings.mesh.gloo.solo.io/v1/v1 APIs
	Settings() SettingsClient
}

clienset for the settings.mesh.gloo.solo.io/v1 APIs

func NewClientset 

func NewClientset(client client.Client) Clientset

func NewClientsetFromConfig 

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

type DiscoverySettings 

type DiscoverySettings struct {

	// Istio-specific discovery settings
	Istio *DiscoverySettings_Istio `protobuf:"bytes,1,opt,name=istio,proto3" json:"istio,omitempty"`
	// contains filtered or unexported fields
}

Settings for Gloo Mesh discovery.

func (*DiscoverySettings) Descriptor deprecated 

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

Deprecated: Use DiscoverySettings.ProtoReflect.Descriptor instead.

func (*DiscoverySettings) Equal 

func (m *DiscoverySettings) Equal(that interface{}) bool

Equal function

func (*DiscoverySettings) GetIstio 

func (x *DiscoverySettings) GetIstio() *DiscoverySettings_Istio

func (*DiscoverySettings) ProtoMessage 

func (*DiscoverySettings) ProtoMessage()

func (*DiscoverySettings) ProtoReflect 

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

func (*DiscoverySettings) Reset 

func (x *DiscoverySettings) Reset()

func (*DiscoverySettings) String 

func (x *DiscoverySettings) String() string

type DiscoverySettings_Istio 

type DiscoverySettings_Istio struct {

	// Configure discovery of ingress gateways per cluster. The key to the map is either a Gloo Mesh cluster name or
	// `*` denoting all clusters. If an entry is found for a given cluster, it will be used. Otherwise, the
	// wildcard entry will be used if it exists. Lastly, we will fall back to a set of default values.
	IngressGatewayDetectors map[string]*DiscoverySettings_Istio_IngressGatewayDetector `` /* 220-byte string literal not displayed */
	// contains filtered or unexported fields
}

Istio-specific discovery settings

func (*DiscoverySettings_Istio) Descriptor deprecated 

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

Deprecated: Use DiscoverySettings_Istio.ProtoReflect.Descriptor instead.

func (*DiscoverySettings_Istio) Equal 

func (m *DiscoverySettings_Istio) Equal(that interface{}) bool

Equal function

func (*DiscoverySettings_Istio) GetIngressGatewayDetectors 

func (x *DiscoverySettings_Istio) GetIngressGatewayDetectors() map[string]*DiscoverySettings_Istio_IngressGatewayDetector

func (*DiscoverySettings_Istio) ProtoMessage 

func (*DiscoverySettings_Istio) ProtoMessage()

func (*DiscoverySettings_Istio) ProtoReflect 

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

func (*DiscoverySettings_Istio) Reset 

func (x *DiscoverySettings_Istio) Reset()

func (*DiscoverySettings_Istio) String 

func (x *DiscoverySettings_Istio) String() string

type DiscoverySettings_Istio_IngressGatewayDetector 

type DiscoverySettings_Istio_IngressGatewayDetector struct {

	// Workload labels used to detect ingress gateways for an Istio deployment.
	// If not specified, will default to `{"istio": "ingressgateway"}`.
	GatewayWorkloadLabels map[string]string `` /* 214-byte string literal not displayed */
	// The name of the TLS port used to detect ingress gateways. Kubernetes services must have a port with this name
	// in order to be recognized as an ingress gateway. If not specified, will default to `tls`.
	GatewayTlsPortName string `protobuf:"bytes,2,opt,name=gateway_tls_port_name,json=gatewayTlsPortName,proto3" json:"gateway_tls_port_name,omitempty"`
	// contains filtered or unexported fields
}

Configure discovery of ingress gateways.

func (*DiscoverySettings_Istio_IngressGatewayDetector) Descriptor deprecated 

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

Deprecated: Use DiscoverySettings_Istio_IngressGatewayDetector.ProtoReflect.Descriptor instead.

func (*DiscoverySettings_Istio_IngressGatewayDetector) Equal 

func (m *DiscoverySettings_Istio_IngressGatewayDetector) Equal(that interface{}) bool

Equal function

func (*DiscoverySettings_Istio_IngressGatewayDetector) GetGatewayTlsPortName 

func (x *DiscoverySettings_Istio_IngressGatewayDetector) GetGatewayTlsPortName() string

func (*DiscoverySettings_Istio_IngressGatewayDetector) GetGatewayWorkloadLabels 

func (x *DiscoverySettings_Istio_IngressGatewayDetector) GetGatewayWorkloadLabels() map[string]string

func (*DiscoverySettings_Istio_IngressGatewayDetector) ProtoMessage 

func (*DiscoverySettings_Istio_IngressGatewayDetector) ProtoMessage()

func (*DiscoverySettings_Istio_IngressGatewayDetector) ProtoReflect 

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

func (*DiscoverySettings_Istio_IngressGatewayDetector) Reset 

func (x *DiscoverySettings_Istio_IngressGatewayDetector) Reset()

func (*DiscoverySettings_Istio_IngressGatewayDetector) String 

func (x *DiscoverySettings_Istio_IngressGatewayDetector) String() string

type GrpcServer 

type GrpcServer struct {

	// TCP address of the gRPC Server (including port).
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// If true communicate over HTTP rather than HTTPS.
	Insecure bool `protobuf:"varint,2,opt,name=insecure,proto3" json:"insecure,omitempty"`
	// If true Gloo Mesh will automatically attempt to reconnect to the server after encountering network failures.
	ReconnectOnNetworkFailures bool `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

Options for connecting to an external gRPC server.

func (*GrpcServer) Descriptor deprecated 

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

Deprecated: Use GrpcServer.ProtoReflect.Descriptor instead.

func (*GrpcServer) Equal 

func (m *GrpcServer) Equal(that interface{}) bool

Equal function

func (*GrpcServer) GetAddress 

func (x *GrpcServer) GetAddress() string

func (*GrpcServer) GetInsecure 

func (x *GrpcServer) GetInsecure() bool

func (*GrpcServer) GetReconnectOnNetworkFailures 

func (x *GrpcServer) GetReconnectOnNetworkFailures() bool

func (*GrpcServer) ProtoMessage 

func (*GrpcServer) ProtoMessage()

func (*GrpcServer) ProtoReflect 

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

func (*GrpcServer) Reset 

func (x *GrpcServer) Reset()

func (*GrpcServer) String 

func (x *GrpcServer) String() string

type MulticlusterClientset 

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

MulticlusterClientset for the settings.mesh.gloo.solo.io/v1 APIs

func NewMulticlusterClientset 

func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset

type MulticlusterSettingsClient 

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

Provides SettingsClients for multiple clusters.

func NewMulticlusterSettingsClient 

func NewMulticlusterSettingsClient(client multicluster.Client) MulticlusterSettingsClient

type RelaySettings 

type RelaySettings struct {

	// Enable the use of Relay for cluster management.
	// If relay is enabled, make sure to follow the [relay cluster registration guide]({{< versioned_link_path fromRoot="/guides/setup/register_cluster#relay" >}})
	// for registering your clusters.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Connection info for the Relay Server. Gloo Mesh will fetch discovery resources from this server
	// and push translated outputs to this server.
	// Note: currently this field has no effect as the relay server runs in-process of the networking Pod.
	Server *GrpcServer `protobuf:"bytes,2,opt,name=server,proto3" json:"server,omitempty"`
	// contains filtered or unexported fields
}

RelaySettings contains options for configuring Gloo Mesh to use Relay for cluster management. Relay provides a way for connecting Gloo Mesh to remote Kubernetes Clusters without the need to share credentials and access to remote Kube API Servers from the management cluster (the Gloo Mesh controllers).

Relay instead uses a streaming gRPC API to pass discovery data from remote clusters to the management cluster, and push configuration from the management cluster to the remote clusters.

Architecturally, it includes a Relay-agent which is installed to remote Kube clusters at registration time, which then connects directly to the Relay Server in the management cluster. to push its discovery data and pull its mesh configuration.

To configure Gloo Mesh to use Relay, make sure to read the [relay installation guide]({{< versioned_link_path fromRoot="/guides/setup/install_gloo_mesh" >}}) and [relay cluster registration guide]({{< versioned_link_path fromRoot="/guides/setup/register_cluster" >}}).

func (*RelaySettings) Descriptor deprecated 

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

Deprecated: Use RelaySettings.ProtoReflect.Descriptor instead.

func (*RelaySettings) Equal 

func (m *RelaySettings) Equal(that interface{}) bool

Equal function

func (*RelaySettings) GetEnabled 

func (x *RelaySettings) GetEnabled() bool

func (*RelaySettings) GetServer 

func (x *RelaySettings) GetServer() *GrpcServer

func (*RelaySettings) ProtoMessage 

func (*RelaySettings) ProtoMessage()

func (*RelaySettings) ProtoReflect 

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

func (*RelaySettings) Reset 

func (x *RelaySettings) Reset()

func (*RelaySettings) String 

func (x *RelaySettings) String() string

type Settings 

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

	Spec   SettingsSpec   `json:"spec,omitempty"`
	Status SettingsStatus `json:"status,omitempty"`
}

Settings is the Schema for the settings API

func (*Settings) DeepCopy 

func (in *Settings) DeepCopy() *Settings

func (*Settings) DeepCopyInto 

func (in *Settings) DeepCopyInto(out *Settings)

func (*Settings) DeepCopyObject 

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

func (Settings) GVK 

func (Settings) GVK() schema.GroupVersionKind

GVK returns the GroupVersionKind associated with the resource type.

type SettingsClient 

type SettingsClient interface {
	SettingsReader
	SettingsWriter
	SettingsStatusWriter
}

Client knows how to perform CRUD operations on Settingss.

type SettingsList 

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

SettingsList contains a list of Settings

func (*SettingsList) DeepCopy 

func (in *SettingsList) DeepCopy() *SettingsList

func (*SettingsList) DeepCopyInto 

func (in *SettingsList) DeepCopyInto(out *SettingsList)

func (*SettingsList) DeepCopyObject 

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

type SettingsReader 

type SettingsReader interface {
	// Get retrieves a Settings for the given object key
	GetSettings(ctx context.Context, key client.ObjectKey) (*Settings, error)

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

Reader knows how to read and list Settingss.

type SettingsSlice 

type SettingsSlice []*Settings

SettingsSlice represents a slice of *Settings

type SettingsSpec 

type SettingsSpec struct {

	// Configure default mTLS settings for Destinations.
	Mtls *v1.TrafficPolicySpec_Policy_MTLS `protobuf:"bytes,1,opt,name=mtls,proto3" json:"mtls,omitempty"`
	// Configure Gloo Mesh networking to communicate with one or more external gRPC NetworkingExtensions servers.
	// Updates will be applied by the servers in the order they are listed (servers towards the end of the list take precedence).
	// Note: Extension Servers have full write access to the output objects written by Gloo Mesh.
	NetworkingExtensionServers []*GrpcServer `` /* 141-byte string literal not displayed */
	// Settings for Gloo Mesh discovery.
	Discovery *DiscoverySettings `protobuf:"bytes,3,opt,name=discovery,proto3" json:"discovery,omitempty"`
	// Enable and configure use of Relay mode to communicate with remote clusters. This is an enterprise-only feature.
	Relay *RelaySettings `protobuf:"bytes,4,opt,name=relay,proto3" json:"relay,omitempty"`
	// contains filtered or unexported fields
}

Configure system-wide settings and defaults. Settings specified in networking policies take precedence over those specified here.

func (*SettingsSpec) DeepCopyInto 

func (in *SettingsSpec) DeepCopyInto(out *SettingsSpec)

DeepCopyInto for the Settings.Spec

func (*SettingsSpec) Descriptor deprecated 

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

Deprecated: Use SettingsSpec.ProtoReflect.Descriptor instead.

func (*SettingsSpec) Equal 

func (m *SettingsSpec) Equal(that interface{}) bool

Equal function

func (*SettingsSpec) GetDiscovery 

func (x *SettingsSpec) GetDiscovery() *DiscoverySettings

func (*SettingsSpec) GetMtls 

func (x *SettingsSpec) GetMtls() *v1.TrafficPolicySpec_Policy_MTLS

func (*SettingsSpec) GetNetworkingExtensionServers 

func (x *SettingsSpec) GetNetworkingExtensionServers() []*GrpcServer

func (*SettingsSpec) GetRelay 

func (x *SettingsSpec) GetRelay() *RelaySettings

func (*SettingsSpec) MarshalJSON 

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

MarshalJSON is a custom marshaler for SettingsSpec

func (*SettingsSpec) ProtoMessage 

func (*SettingsSpec) ProtoMessage()

func (*SettingsSpec) ProtoReflect 

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

func (*SettingsSpec) Reset 

func (x *SettingsSpec) Reset()

func (*SettingsSpec) String 

func (x *SettingsSpec) String() string

func (*SettingsSpec) UnmarshalJSON 

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

UnmarshalJSON is a custom unmarshaler for SettingsSpec

type SettingsStatus 

type SettingsStatus struct {

	// The most recent generation observed in the the Settings metadata.
	// If the `observedGeneration` does not match `metadata.generation`, Gloo Mesh has not processed the most
	// recent version of this resource.
	ObservedGeneration int64 `protobuf:"varint,1,opt,name=observed_generation,json=observedGeneration,proto3" json:"observed_generation,omitempty"`
	// The state of the overall resource.
	// It will only show accepted if no processing errors encountered.
	State v11.ApprovalState `protobuf:"varint,2,opt,name=state,proto3,enum=common.mesh.gloo.solo.io.ApprovalState" json:"state,omitempty"`
	// Any errors encountered while processing Settings object.
	Errors []string `protobuf:"bytes,3,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

func (*SettingsStatus) DeepCopyInto 

func (in *SettingsStatus) DeepCopyInto(out *SettingsStatus)

DeepCopyInto for the Settings.Status

func (*SettingsStatus) Descriptor deprecated 

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

Deprecated: Use SettingsStatus.ProtoReflect.Descriptor instead.

func (*SettingsStatus) Equal 

func (m *SettingsStatus) Equal(that interface{}) bool

Equal function

func (*SettingsStatus) GetErrors 

func (x *SettingsStatus) GetErrors() []string

func (*SettingsStatus) GetObservedGeneration 

func (x *SettingsStatus) GetObservedGeneration() int64

func (*SettingsStatus) GetState 

func (x *SettingsStatus) GetState() v11.ApprovalState

func (*SettingsStatus) MarshalJSON 

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

MarshalJSON is a custom marshaler for SettingsStatus

func (*SettingsStatus) ProtoMessage 

func (*SettingsStatus) ProtoMessage()

func (*SettingsStatus) ProtoReflect 

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

func (*SettingsStatus) Reset 

func (x *SettingsStatus) Reset()

func (*SettingsStatus) String 

func (x *SettingsStatus) String() string

func (*SettingsStatus) UnmarshalJSON 

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

UnmarshalJSON is a custom unmarshaler for SettingsStatus

type SettingsStatusWriter 

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

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

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

type SettingsTransitionFunction 

type SettingsTransitionFunction func(existing, desired *Settings) error

SettingsTransitionFunction instructs the SettingsWriter how to transition between an existing Settings object and a desired on an Upsert

type SettingsWriter 

type SettingsWriter interface {
	// Create saves the Settings object.
	CreateSettings(ctx context.Context, obj *Settings, opts ...client.CreateOption) error

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

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

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

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

	// Create or Update the Settings object.
	UpsertSettings(ctx context.Context, obj *Settings, transitionFuncs ...SettingsTransitionFunction) error
}

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

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_v1 is a generated GoMock package.
 Package mock_v1 is a generated GoMock package.
mocks
Package mock_v1sets is a generated GoMock package.
 Package mock_v1sets 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.