v1

package
v1.1.2 Latest Latest
Warning

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

Go to latest
Published: Sep 29, 2021 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Overview

Package v1 contains API Schema definitions for the observability.enterprise.mesh.gloo.solo.io v1 API group +k8s:deepcopy-gen=package,register +groupName=observability.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: "observability.enterprise.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 AccessLogRecordGVK = schema.GroupVersionKind{
	Group:   "observability.enterprise.mesh.gloo.solo.io",
	Version: "v1",
	Kind:    "AccessLogRecord",
}

GroupVersionKind for AccessLogRecord

View Source
var File_github_com_solo_io_gloo_mesh_api_enterprise_observability_v1_access_logging_proto protoreflect.FileDescriptor

Functions

func AddToScheme

func AddToScheme(s *runtime.Scheme) error

func NewAccessLogRecordClient

func NewAccessLogRecordClient(client client.Client) *accessLogRecordClient

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type AccessLogRecord

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

	Spec   AccessLogRecordSpec   `json:"spec,omitempty"`
	Status AccessLogRecordStatus `json:"status,omitempty"`
}

AccessLogRecord is the Schema for the accessLogRecord API

func (*AccessLogRecord) DeepCopy

func (in *AccessLogRecord) DeepCopy() *AccessLogRecord

func (*AccessLogRecord) DeepCopyInto

func (in *AccessLogRecord) DeepCopyInto(out *AccessLogRecord)

func (*AccessLogRecord) DeepCopyObject

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

func (AccessLogRecord) GVK

GVK returns the GroupVersionKind associated with the resource type.

type AccessLogRecordClient

Client knows how to perform CRUD operations on AccessLogRecords.

type AccessLogRecordList

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

AccessLogRecordList contains a list of AccessLogRecord

func (*AccessLogRecordList) DeepCopy

func (in *AccessLogRecordList) DeepCopy() *AccessLogRecordList

func (*AccessLogRecordList) DeepCopyInto

func (in *AccessLogRecordList) DeepCopyInto(out *AccessLogRecordList)

func (*AccessLogRecordList) DeepCopyObject

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

type AccessLogRecordReader

type AccessLogRecordReader interface {
	// Get retrieves a AccessLogRecord for the given object key
	GetAccessLogRecord(ctx context.Context, key client.ObjectKey) (*AccessLogRecord, error)

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

Reader knows how to read and list AccessLogRecords.

type AccessLogRecordSlice

type AccessLogRecordSlice []*AccessLogRecord

AccessLogRecordSlice represents a slice of *AccessLogRecord

type AccessLogRecordSpec

type AccessLogRecordSpec struct {

	// Select the workloads to be configured to emit access logs.
	// Leave empty to apply to all workloads managed by Gloo Mesh.
	WorkloadSelectors []*v1.WorkloadSelector `protobuf:"bytes,1,rep,name=workload_selectors,json=workloadSelectors,proto3" json:"workload_selectors,omitempty"`
	// Configure criteria for determining which access logs will be recorded.
	// The list is disjunctive, a request will be recorded if it matches any filter.
	// Leave empty to emit all access logs.
	Filters []*AccessLogRecordSpec_Filter `protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"`
	// Specify request headers to include in access logs.
	IncludedRequestHeaders []string `` /* 129-byte string literal not displayed */
	// Specify response headers to include in access logs.
	IncludedResponseHeaders []string `` /* 132-byte string literal not displayed */
	// Specify response trailers to include in access logs.
	IncludedResponseTrailers []string `` /* 135-byte string literal not displayed */
	// Specify filter state objects to include in access logs
	IncludedFilterStateObjects []string `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a record of access logs sourced from a set of workloads and optionally filtered based on request criteria.

func (*AccessLogRecordSpec) DeepCopyInto

func (in *AccessLogRecordSpec) DeepCopyInto(out *AccessLogRecordSpec)

DeepCopyInto for the AccessLogRecord.Spec

func (*AccessLogRecordSpec) Descriptor deprecated

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

Deprecated: Use AccessLogRecordSpec.ProtoReflect.Descriptor instead.

func (*AccessLogRecordSpec) GetFilters

func (*AccessLogRecordSpec) GetIncludedFilterStateObjects

func (x *AccessLogRecordSpec) GetIncludedFilterStateObjects() []string

func (*AccessLogRecordSpec) GetIncludedRequestHeaders

func (x *AccessLogRecordSpec) GetIncludedRequestHeaders() []string

func (*AccessLogRecordSpec) GetIncludedResponseHeaders

func (x *AccessLogRecordSpec) GetIncludedResponseHeaders() []string

func (*AccessLogRecordSpec) GetIncludedResponseTrailers

func (x *AccessLogRecordSpec) GetIncludedResponseTrailers() []string

func (*AccessLogRecordSpec) GetWorkloadSelectors

func (x *AccessLogRecordSpec) GetWorkloadSelectors() []*v1.WorkloadSelector

func (*AccessLogRecordSpec) MarshalJSON

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

MarshalJSON is a custom marshaler for AccessLogRecordSpec

func (*AccessLogRecordSpec) ProtoMessage

func (*AccessLogRecordSpec) ProtoMessage()

func (*AccessLogRecordSpec) ProtoReflect

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

func (*AccessLogRecordSpec) Reset

func (x *AccessLogRecordSpec) Reset()

func (*AccessLogRecordSpec) String

func (x *AccessLogRecordSpec) String() string

func (*AccessLogRecordSpec) UnmarshalJSON

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

UnmarshalJSON is a custom unmarshaler for AccessLogRecordSpec

type AccessLogRecordSpec_Filter

type AccessLogRecordSpec_Filter struct {

	// Criteria type.
	//
	// Types that are assignable to Type:
	//	*AccessLogRecordSpec_Filter_StatusCodeMatcher
	//	*AccessLogRecordSpec_Filter_HeaderMatcher
	Type isAccessLogRecordSpec_Filter_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

Specify criteria for recording access logs. A request must match all specified criteria to be recorded.

func (*AccessLogRecordSpec_Filter) Descriptor deprecated

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

Deprecated: Use AccessLogRecordSpec_Filter.ProtoReflect.Descriptor instead.

func (*AccessLogRecordSpec_Filter) GetHeaderMatcher

func (x *AccessLogRecordSpec_Filter) GetHeaderMatcher() *v12.HeaderMatcher

func (*AccessLogRecordSpec_Filter) GetStatusCodeMatcher

func (x *AccessLogRecordSpec_Filter) GetStatusCodeMatcher() *v12.StatusCodeMatcher

func (*AccessLogRecordSpec_Filter) GetType

func (m *AccessLogRecordSpec_Filter) GetType() isAccessLogRecordSpec_Filter_Type

func (*AccessLogRecordSpec_Filter) ProtoMessage

func (*AccessLogRecordSpec_Filter) ProtoMessage()

func (*AccessLogRecordSpec_Filter) ProtoReflect

func (*AccessLogRecordSpec_Filter) Reset

func (x *AccessLogRecordSpec_Filter) Reset()

func (*AccessLogRecordSpec_Filter) String

func (x *AccessLogRecordSpec_Filter) String() string

type AccessLogRecordSpec_Filter_HeaderMatcher

type AccessLogRecordSpec_Filter_HeaderMatcher struct {
	// Matches against a request or response header. Omit to match any headers.
	HeaderMatcher *v12.HeaderMatcher `protobuf:"bytes,2,opt,name=header_matcher,json=headerMatcher,proto3,oneof"`
}

type AccessLogRecordSpec_Filter_StatusCodeMatcher

type AccessLogRecordSpec_Filter_StatusCodeMatcher struct {
	// Matches against a response status code. Omit to match any status code.
	StatusCodeMatcher *v12.StatusCodeMatcher `protobuf:"bytes,1,opt,name=status_code_matcher,json=statusCodeMatcher,proto3,oneof"`
}

type AccessLogRecordStatus

type AccessLogRecordStatus struct {

	// The most recent generation observed in the the AccessLogRecord 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, will only show accepted if it has been successfully
	// applied to all target workloads.
	State v1.ApprovalState `protobuf:"varint,2,opt,name=state,proto3,enum=common.mesh.gloo.solo.io.ApprovalState" json:"state,omitempty"`
	// Any errors encountered during processing. Also reported to any Workloads that this object applies to.
	Errors []string `protobuf:"bytes,3,rep,name=errors,proto3" json:"errors,omitempty"`
	// references to workloads that this AccessLogRecord applies to
	Workloads []*v11.ObjectRef `protobuf:"bytes,4,rep,name=workloads,proto3" json:"workloads,omitempty"`
	// contains filtered or unexported fields
}

func (*AccessLogRecordStatus) DeepCopyInto

func (in *AccessLogRecordStatus) DeepCopyInto(out *AccessLogRecordStatus)

DeepCopyInto for the AccessLogRecord.Status

func (*AccessLogRecordStatus) Descriptor deprecated

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

Deprecated: Use AccessLogRecordStatus.ProtoReflect.Descriptor instead.

func (*AccessLogRecordStatus) GetErrors

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

func (*AccessLogRecordStatus) GetObservedGeneration

func (x *AccessLogRecordStatus) GetObservedGeneration() int64

func (*AccessLogRecordStatus) GetState

func (x *AccessLogRecordStatus) GetState() v1.ApprovalState

func (*AccessLogRecordStatus) GetWorkloads

func (x *AccessLogRecordStatus) GetWorkloads() []*v11.ObjectRef

func (*AccessLogRecordStatus) MarshalJSON

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

MarshalJSON is a custom marshaler for AccessLogRecordStatus

func (*AccessLogRecordStatus) ProtoMessage

func (*AccessLogRecordStatus) ProtoMessage()

func (*AccessLogRecordStatus) ProtoReflect

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

func (*AccessLogRecordStatus) Reset

func (x *AccessLogRecordStatus) Reset()

func (*AccessLogRecordStatus) String

func (x *AccessLogRecordStatus) String() string

func (*AccessLogRecordStatus) UnmarshalJSON

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

UnmarshalJSON is a custom unmarshaler for AccessLogRecordStatus

type AccessLogRecordStatusWriter

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

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

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

type AccessLogRecordTransitionFunction

type AccessLogRecordTransitionFunction func(existing, desired *AccessLogRecord) error

AccessLogRecordTransitionFunction instructs the AccessLogRecordWriter how to transition between an existing AccessLogRecord object and a desired on an Upsert

type AccessLogRecordWriter

type AccessLogRecordWriter interface {
	// Create saves the AccessLogRecord object.
	CreateAccessLogRecord(ctx context.Context, obj *AccessLogRecord, opts ...client.CreateOption) error

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

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

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

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

	// Create or Update the AccessLogRecord object.
	UpsertAccessLogRecord(ctx context.Context, obj *AccessLogRecord, transitionFuncs ...AccessLogRecordTransitionFunction) error
}

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

type Clientset

type Clientset interface {
	// clienset for the observability.enterprise.mesh.gloo.solo.io/v1/v1 APIs
	AccessLogRecords() AccessLogRecordClient
}

clienset for the observability.enterprise.mesh.gloo.solo.io/v1 APIs

func NewClientset

func NewClientset(client client.Client) Clientset

func NewClientsetFromConfig

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

type MulticlusterAccessLogRecordClient

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

Provides AccessLogRecordClients for multiple clusters.

func NewMulticlusterAccessLogRecordClient

func NewMulticlusterAccessLogRecordClient(client multicluster.Client) MulticlusterAccessLogRecordClient

type MulticlusterClientset

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

MulticlusterClientset for the observability.enterprise.mesh.gloo.solo.io/v1 APIs

func NewMulticlusterClientset

func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset

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