Documentation

Overview

    Package v1alpha1 is a generated protocol buffer package.

    It is generated from these files:

    k8s.io/kubernetes/vendor/k8s.io/api/auditregistration/v1alpha1/generated.proto
    

    It has these top-level messages:

    AuditSink
    AuditSinkList
    AuditSinkSpec
    Policy
    ServiceReference
    Webhook
    WebhookClientConfig
    WebhookThrottleConfig
    

    Index

    Constants

    View Source
    const (
    	// The stage for events generated after the audit handler receives the request, but before it
    	// is delegated down the handler chain.
    	StageRequestReceived = "RequestReceived"
    	// The stage for events generated after the response headers are sent, but before the response body
    	// is sent. This stage is only generated for long-running requests (e.g. watch).
    	StageResponseStarted = "ResponseStarted"
    	// The stage for events generated after the response body has been completed, and no more bytes
    	// will be sent.
    	StageResponseComplete = "ResponseComplete"
    	// The stage for events generated when a panic occurred.
    	StagePanic = "Panic"
    )

      Valid audit stages.

      View Source
      const GroupName = "auditregistration.k8s.io"

        GroupName is the group name use in this package

        Variables

        View Source
        var (
        	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
        	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
        )
        View Source
        var (
        	SchemeBuilder runtime.SchemeBuilder
        
        	AddToScheme = localSchemeBuilder.AddToScheme
        )
        View Source
        var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

          SchemeGroupVersion is group version used to register these objects

          Functions

          func Resource

          func Resource(resource string) schema.GroupResource

            Resource takes an unqualified resource and returns a Group qualified GroupResource

            Types

            type AuditSink

            type AuditSink struct {
            	metav1.TypeMeta `json:",inline"`
            	// +optional
            	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
            
            	// Spec defines the audit configuration spec
            	Spec AuditSinkSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
            }

              AuditSink represents a cluster level audit sink

              func (*AuditSink) DeepCopy

              func (in *AuditSink) DeepCopy() *AuditSink

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

                func (*AuditSink) DeepCopyInto

                func (in *AuditSink) DeepCopyInto(out *AuditSink)

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

                  func (*AuditSink) DeepCopyObject

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

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

                    func (*AuditSink) Descriptor

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

                    func (*AuditSink) Marshal

                    func (m *AuditSink) Marshal() (dAtA []byte, err error)

                    func (*AuditSink) MarshalTo

                    func (m *AuditSink) MarshalTo(dAtA []byte) (int, error)

                    func (*AuditSink) ProtoMessage

                    func (*AuditSink) ProtoMessage()

                    func (*AuditSink) Reset

                    func (m *AuditSink) Reset()

                    func (*AuditSink) Size

                    func (m *AuditSink) Size() (n int)

                    func (*AuditSink) String

                    func (this *AuditSink) String() string

                    func (AuditSink) SwaggerDoc

                    func (AuditSink) SwaggerDoc() map[string]string

                    func (*AuditSink) Unmarshal

                    func (m *AuditSink) Unmarshal(dAtA []byte) error

                    type AuditSinkList

                    type AuditSinkList struct {
                    	metav1.TypeMeta `json:",inline"`
                    	// +optional
                    	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                    
                    	// List of audit configurations.
                    	Items []AuditSink `json:"items" protobuf:"bytes,2,rep,name=items"`
                    }

                      AuditSinkList is a list of AuditSink items.

                      func (*AuditSinkList) DeepCopy

                      func (in *AuditSinkList) DeepCopy() *AuditSinkList

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

                        func (*AuditSinkList) DeepCopyInto

                        func (in *AuditSinkList) DeepCopyInto(out *AuditSinkList)

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

                          func (*AuditSinkList) DeepCopyObject

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

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

                            func (*AuditSinkList) Descriptor

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

                            func (*AuditSinkList) Marshal

                            func (m *AuditSinkList) Marshal() (dAtA []byte, err error)

                            func (*AuditSinkList) MarshalTo

                            func (m *AuditSinkList) MarshalTo(dAtA []byte) (int, error)

                            func (*AuditSinkList) ProtoMessage

                            func (*AuditSinkList) ProtoMessage()

                            func (*AuditSinkList) Reset

                            func (m *AuditSinkList) Reset()

                            func (*AuditSinkList) Size

                            func (m *AuditSinkList) Size() (n int)

                            func (*AuditSinkList) String

                            func (this *AuditSinkList) String() string

                            func (AuditSinkList) SwaggerDoc

                            func (AuditSinkList) SwaggerDoc() map[string]string

                            func (*AuditSinkList) Unmarshal

                            func (m *AuditSinkList) Unmarshal(dAtA []byte) error

                            type AuditSinkSpec

                            type AuditSinkSpec struct {
                            	// Policy defines the policy for selecting which events should be sent to the webhook
                            	// required
                            	Policy Policy `json:"policy" protobuf:"bytes,1,opt,name=policy"`
                            
                            	// Webhook to send events
                            	// required
                            	Webhook Webhook `json:"webhook" protobuf:"bytes,2,opt,name=webhook"`
                            }

                              AuditSinkSpec holds the spec for the audit sink

                              func (*AuditSinkSpec) DeepCopy

                              func (in *AuditSinkSpec) DeepCopy() *AuditSinkSpec

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

                                func (*AuditSinkSpec) DeepCopyInto

                                func (in *AuditSinkSpec) DeepCopyInto(out *AuditSinkSpec)

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

                                  func (*AuditSinkSpec) Descriptor

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

                                  func (*AuditSinkSpec) Marshal

                                  func (m *AuditSinkSpec) Marshal() (dAtA []byte, err error)

                                  func (*AuditSinkSpec) MarshalTo

                                  func (m *AuditSinkSpec) MarshalTo(dAtA []byte) (int, error)

                                  func (*AuditSinkSpec) ProtoMessage

                                  func (*AuditSinkSpec) ProtoMessage()

                                  func (*AuditSinkSpec) Reset

                                  func (m *AuditSinkSpec) Reset()

                                  func (*AuditSinkSpec) Size

                                  func (m *AuditSinkSpec) Size() (n int)

                                  func (*AuditSinkSpec) String

                                  func (this *AuditSinkSpec) String() string

                                  func (AuditSinkSpec) SwaggerDoc

                                  func (AuditSinkSpec) SwaggerDoc() map[string]string

                                  func (*AuditSinkSpec) Unmarshal

                                  func (m *AuditSinkSpec) Unmarshal(dAtA []byte) error

                                  type Level

                                  type Level string

                                    Level defines the amount of information logged during auditing

                                    const (
                                    	// LevelNone disables auditing
                                    	LevelNone Level = "None"
                                    	// LevelMetadata provides the basic level of auditing.
                                    	LevelMetadata Level = "Metadata"
                                    	// LevelRequest provides Metadata level of auditing, and additionally
                                    	// logs the request object (does not apply for non-resource requests).
                                    	LevelRequest Level = "Request"
                                    	// LevelRequestResponse provides Request level of auditing, and additionally
                                    	// logs the response object (does not apply for non-resource requests and watches).
                                    	LevelRequestResponse Level = "RequestResponse"
                                    )

                                      Valid audit levels

                                      type Policy

                                      type Policy struct {
                                      	// The Level that all requests are recorded at.
                                      	// available options: None, Metadata, Request, RequestResponse
                                      	// required
                                      	Level Level `json:"level" protobuf:"bytes,1,opt,name=level"`
                                      
                                      	// Stages is a list of stages for which events are created.
                                      	// +optional
                                      	Stages []Stage `json:"stages" protobuf:"bytes,2,opt,name=stages"`
                                      }

                                        Policy defines the configuration of how audit events are logged

                                        func (*Policy) DeepCopy

                                        func (in *Policy) DeepCopy() *Policy

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

                                          func (*Policy) DeepCopyInto

                                          func (in *Policy) DeepCopyInto(out *Policy)

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

                                            func (*Policy) Descriptor

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

                                            func (*Policy) Marshal

                                            func (m *Policy) Marshal() (dAtA []byte, err error)

                                            func (*Policy) MarshalTo

                                            func (m *Policy) MarshalTo(dAtA []byte) (int, error)

                                            func (*Policy) ProtoMessage

                                            func (*Policy) ProtoMessage()

                                            func (*Policy) Reset

                                            func (m *Policy) Reset()

                                            func (*Policy) Size

                                            func (m *Policy) Size() (n int)

                                            func (*Policy) String

                                            func (this *Policy) String() string

                                            func (Policy) SwaggerDoc

                                            func (Policy) SwaggerDoc() map[string]string

                                            func (*Policy) Unmarshal

                                            func (m *Policy) Unmarshal(dAtA []byte) error

                                            type ServiceReference

                                            type ServiceReference struct {
                                            	// `namespace` is the namespace of the service.
                                            	// Required
                                            	Namespace string `json:"namespace" protobuf:"bytes,1,opt,name=namespace"`
                                            
                                            	// `name` is the name of the service.
                                            	// Required
                                            	Name string `json:"name" protobuf:"bytes,2,opt,name=name"`
                                            
                                            	// `path` is an optional URL path which will be sent in any request to
                                            	// this service.
                                            	// +optional
                                            	Path *string `json:"path,omitempty" protobuf:"bytes,3,opt,name=path"`
                                            }

                                              ServiceReference holds a reference to Service.legacy.k8s.io

                                              func (*ServiceReference) DeepCopy

                                              func (in *ServiceReference) DeepCopy() *ServiceReference

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

                                                func (*ServiceReference) DeepCopyInto

                                                func (in *ServiceReference) DeepCopyInto(out *ServiceReference)

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

                                                  func (*ServiceReference) Descriptor

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

                                                  func (*ServiceReference) Marshal

                                                  func (m *ServiceReference) Marshal() (dAtA []byte, err error)

                                                  func (*ServiceReference) MarshalTo

                                                  func (m *ServiceReference) MarshalTo(dAtA []byte) (int, error)

                                                  func (*ServiceReference) ProtoMessage

                                                  func (*ServiceReference) ProtoMessage()

                                                  func (*ServiceReference) Reset

                                                  func (m *ServiceReference) Reset()

                                                  func (*ServiceReference) Size

                                                  func (m *ServiceReference) Size() (n int)

                                                  func (*ServiceReference) String

                                                  func (this *ServiceReference) String() string

                                                  func (ServiceReference) SwaggerDoc

                                                  func (ServiceReference) SwaggerDoc() map[string]string

                                                  func (*ServiceReference) Unmarshal

                                                  func (m *ServiceReference) Unmarshal(dAtA []byte) error

                                                  type Stage

                                                  type Stage string

                                                    Stage defines the stages in request handling during which audit events may be generated.

                                                    type Webhook

                                                    type Webhook struct {
                                                    	// Throttle holds the options for throttling the webhook
                                                    	// +optional
                                                    	Throttle *WebhookThrottleConfig `json:"throttle,omitempty" protobuf:"bytes,1,opt,name=throttle"`
                                                    
                                                    	// ClientConfig holds the connection parameters for the webhook
                                                    	// required
                                                    	ClientConfig WebhookClientConfig `json:"clientConfig" protobuf:"bytes,2,opt,name=clientConfig"`
                                                    }

                                                      Webhook holds the configuration of the webhook

                                                      func (*Webhook) DeepCopy

                                                      func (in *Webhook) DeepCopy() *Webhook

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

                                                        func (*Webhook) DeepCopyInto

                                                        func (in *Webhook) DeepCopyInto(out *Webhook)

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

                                                          func (*Webhook) Descriptor

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

                                                          func (*Webhook) Marshal

                                                          func (m *Webhook) Marshal() (dAtA []byte, err error)

                                                          func (*Webhook) MarshalTo

                                                          func (m *Webhook) MarshalTo(dAtA []byte) (int, error)

                                                          func (*Webhook) ProtoMessage

                                                          func (*Webhook) ProtoMessage()

                                                          func (*Webhook) Reset

                                                          func (m *Webhook) Reset()

                                                          func (*Webhook) Size

                                                          func (m *Webhook) Size() (n int)

                                                          func (*Webhook) String

                                                          func (this *Webhook) String() string

                                                          func (Webhook) SwaggerDoc

                                                          func (Webhook) SwaggerDoc() map[string]string

                                                          func (*Webhook) Unmarshal

                                                          func (m *Webhook) Unmarshal(dAtA []byte) error

                                                          type WebhookClientConfig

                                                          type WebhookClientConfig struct {
                                                          	// `url` gives the location of the webhook, in standard URL form
                                                          	// (`scheme://host:port/path`). Exactly one of `url` or `service`
                                                          	// must be specified.
                                                          	//
                                                          	// The `host` should not refer to a service running in the cluster; use
                                                          	// the `service` field instead. The host might be resolved via external
                                                          	// DNS in some apiservers (e.g., `kube-apiserver` cannot resolve
                                                          	// in-cluster DNS as that would be a layering violation). `host` may
                                                          	// also be an IP address.
                                                          	//
                                                          	// Please note that using `localhost` or `127.0.0.1` as a `host` is
                                                          	// risky unless you take great care to run this webhook on all hosts
                                                          	// which run an apiserver which might need to make calls to this
                                                          	// webhook. Such installs are likely to be non-portable, i.e., not easy
                                                          	// to turn up in a new cluster.
                                                          	//
                                                          	// The scheme must be "https"; the URL must begin with "https://".
                                                          	//
                                                          	// A path is optional, and if present may be any string permissible in
                                                          	// a URL. You may use the path to pass an arbitrary string to the
                                                          	// webhook, for example, a cluster identifier.
                                                          	//
                                                          	// Attempting to use a user or basic auth e.g. "user:password@" is not
                                                          	// allowed. Fragments ("#...") and query parameters ("?...") are not
                                                          	// allowed, either.
                                                          	//
                                                          	// +optional
                                                          	URL *string `json:"url,omitempty" protobuf:"bytes,1,opt,name=url"`
                                                          
                                                          	// `service` is a reference to the service for this webhook. Either
                                                          	// `service` or `url` must be specified.
                                                          	//
                                                          	// If the webhook is running within the cluster, then you should use `service`.
                                                          	//
                                                          	// Port 443 will be used if it is open, otherwise it is an error.
                                                          	//
                                                          	// +optional
                                                          	Service *ServiceReference `json:"service,omitempty" protobuf:"bytes,2,opt,name=service"`
                                                          
                                                          	// `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.
                                                          	// If unspecified, system trust roots on the apiserver are used.
                                                          	// +optional
                                                          	CABundle []byte `json:"caBundle,omitempty" protobuf:"bytes,3,opt,name=caBundle"`
                                                          }

                                                            WebhookClientConfig contains the information to make a connection with the webhook

                                                            func (*WebhookClientConfig) DeepCopy

                                                            func (in *WebhookClientConfig) DeepCopy() *WebhookClientConfig

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

                                                              func (*WebhookClientConfig) DeepCopyInto

                                                              func (in *WebhookClientConfig) DeepCopyInto(out *WebhookClientConfig)

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

                                                                func (*WebhookClientConfig) Descriptor

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

                                                                func (*WebhookClientConfig) Marshal

                                                                func (m *WebhookClientConfig) Marshal() (dAtA []byte, err error)

                                                                func (*WebhookClientConfig) MarshalTo

                                                                func (m *WebhookClientConfig) MarshalTo(dAtA []byte) (int, error)

                                                                func (*WebhookClientConfig) ProtoMessage

                                                                func (*WebhookClientConfig) ProtoMessage()

                                                                func (*WebhookClientConfig) Reset

                                                                func (m *WebhookClientConfig) Reset()

                                                                func (*WebhookClientConfig) Size

                                                                func (m *WebhookClientConfig) Size() (n int)

                                                                func (*WebhookClientConfig) String

                                                                func (this *WebhookClientConfig) String() string

                                                                func (WebhookClientConfig) SwaggerDoc

                                                                func (WebhookClientConfig) SwaggerDoc() map[string]string

                                                                func (*WebhookClientConfig) Unmarshal

                                                                func (m *WebhookClientConfig) Unmarshal(dAtA []byte) error

                                                                type WebhookThrottleConfig

                                                                type WebhookThrottleConfig struct {
                                                                	// ThrottleQPS maximum number of batches per second
                                                                	// default 10 QPS
                                                                	// +optional
                                                                	QPS *int64 `json:"qps,omitempty" protobuf:"bytes,1,opt,name=qps"`
                                                                
                                                                	// ThrottleBurst is the maximum number of events sent at the same moment
                                                                	// default 15 QPS
                                                                	// +optional
                                                                	Burst *int64 `json:"burst,omitempty" protobuf:"bytes,2,opt,name=burst"`
                                                                }

                                                                  WebhookThrottleConfig holds the configuration for throttling events

                                                                  func (*WebhookThrottleConfig) DeepCopy

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

                                                                    func (*WebhookThrottleConfig) DeepCopyInto

                                                                    func (in *WebhookThrottleConfig) DeepCopyInto(out *WebhookThrottleConfig)

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

                                                                      func (*WebhookThrottleConfig) Descriptor

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

                                                                      func (*WebhookThrottleConfig) Marshal

                                                                      func (m *WebhookThrottleConfig) Marshal() (dAtA []byte, err error)

                                                                      func (*WebhookThrottleConfig) MarshalTo

                                                                      func (m *WebhookThrottleConfig) MarshalTo(dAtA []byte) (int, error)

                                                                      func (*WebhookThrottleConfig) ProtoMessage

                                                                      func (*WebhookThrottleConfig) ProtoMessage()

                                                                      func (*WebhookThrottleConfig) Reset

                                                                      func (m *WebhookThrottleConfig) Reset()

                                                                      func (*WebhookThrottleConfig) Size

                                                                      func (m *WebhookThrottleConfig) Size() (n int)

                                                                      func (*WebhookThrottleConfig) String

                                                                      func (this *WebhookThrottleConfig) String() string

                                                                      func (WebhookThrottleConfig) SwaggerDoc

                                                                      func (WebhookThrottleConfig) SwaggerDoc() map[string]string

                                                                      func (*WebhookThrottleConfig) Unmarshal

                                                                      func (m *WebhookThrottleConfig) Unmarshal(dAtA []byte) error