Documentation
¶
Index ¶
- Variables
- type Metadata
- func (*Metadata) Descriptor() ([]byte, []int)
- func (this *Metadata) Equal(that interface{}) bool
- func (m *Metadata) GetAnnotations() map[string]string
- func (m *Metadata) GetCluster() string
- func (m *Metadata) GetGeneration() int64
- func (m *Metadata) GetLabels() map[string]string
- func (m *Metadata) GetName() string
- func (m *Metadata) GetNamespace() string
- func (m *Metadata) GetOwnerReferences() []*Metadata_OwnerReference
- func (m *Metadata) GetResourceVersion() string
- func (m *Metadata) Hash(hasher hash.Hash64) (uint64, error)
- func (m Metadata) Less(m2 Metadata) bool
- func (m Metadata) Match(ref ResourceRef) bool
- func (*Metadata) ProtoMessage()
- func (m Metadata) Ref() ResourceRef
- func (m *Metadata) Reset()
- func (m *Metadata) String() string
- func (m *Metadata) XXX_DiscardUnknown()
- func (m *Metadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Metadata) XXX_Merge(src proto.Message)
- func (m *Metadata) XXX_Size() int
- func (m *Metadata) XXX_Unmarshal(b []byte) error
- type Metadata_OwnerReference
- func (*Metadata_OwnerReference) Descriptor() ([]byte, []int)
- func (this *Metadata_OwnerReference) Equal(that interface{}) bool
- func (m *Metadata_OwnerReference) GetApiVersion() string
- func (m *Metadata_OwnerReference) GetBlockOwnerDeletion() *types.BoolValue
- func (m *Metadata_OwnerReference) GetController() *types.BoolValue
- func (m *Metadata_OwnerReference) GetKind() string
- func (m *Metadata_OwnerReference) GetName() string
- func (m *Metadata_OwnerReference) GetUid() string
- func (m *Metadata_OwnerReference) Hash(hasher hash.Hash64) (uint64, error)
- func (*Metadata_OwnerReference) ProtoMessage()
- func (m *Metadata_OwnerReference) Reset()
- func (m *Metadata_OwnerReference) String() string
- func (m *Metadata_OwnerReference) XXX_DiscardUnknown()
- func (m *Metadata_OwnerReference) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Metadata_OwnerReference) XXX_Merge(src proto.Message)
- func (m *Metadata_OwnerReference) XXX_Size() int
- func (m *Metadata_OwnerReference) XXX_Unmarshal(b []byte) error
- type Resource
- func (*Resource) Descriptor() ([]byte, []int)
- func (m *Resource) GetClusterScoped() bool
- func (m *Resource) GetPluralName() string
- func (m *Resource) GetShortName() string
- func (m *Resource) GetSkipDocsGen() bool
- func (m *Resource) GetSkipHashingAnnotations() bool
- func (m *Resource) Hash(hasher hash.Hash64) (uint64, error)
- func (*Resource) ProtoMessage()
- func (m *Resource) Reset()
- func (m *Resource) String() string
- func (m *Resource) XXX_DiscardUnknown()
- func (m *Resource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Resource) XXX_Merge(src proto.Message)
- func (m *Resource) XXX_Size() int
- func (m *Resource) XXX_Unmarshal(b []byte) error
- type ResourceRef
- func (*ResourceRef) Descriptor() ([]byte, []int)
- func (this *ResourceRef) Equal(that interface{}) bool
- func (m *ResourceRef) GetName() string
- func (m *ResourceRef) GetNamespace() string
- func (m *ResourceRef) Hash(hasher hash.Hash64) (uint64, error)
- func (r ResourceRef) Key() string
- func (*ResourceRef) ProtoMessage()
- func (m *ResourceRef) Reset()
- func (m *ResourceRef) String() string
- func (r ResourceRef) Strings() (string, string)
- func (m *ResourceRef) XXX_DiscardUnknown()
- func (m *ResourceRef) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ResourceRef) XXX_Merge(src proto.Message)
- func (m *ResourceRef) XXX_Size() int
- func (m *ResourceRef) XXX_Unmarshal(b []byte) error
- type Status
- func (s Status) DeepCopyInto(out *Status)
- func (*Status) Descriptor() ([]byte, []int)
- func (this *Status) Equal(that interface{}) bool
- func (s Status) Flatten() Status
- func (m *Status) GetDetails() *types.Struct
- func (m *Status) GetReason() string
- func (m *Status) GetReportedBy() string
- func (m *Status) GetState() Status_State
- func (m *Status) GetSubresourceStatuses() map[string]*Status
- func (m *Status) Hash(hasher hash.Hash64) (uint64, error)
- func (*Status) ProtoMessage()
- func (m *Status) Reset()
- func (m *Status) String() string
- func (m *Status) XXX_DiscardUnknown()
- func (m *Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Status) XXX_Merge(src proto.Message)
- func (m *Status) XXX_Size() int
- func (m *Status) XXX_Unmarshal(b []byte) error
- type Status_State
Constants ¶
This section is empty.
Variables ¶
View Source
var E_Resource = &proto.ExtensionDesc{ ExtendedType: (*descriptor.MessageOptions)(nil), ExtensionType: (*Resource)(nil), Field: 10000, Name: "core.solo.io.resource", Tag: "bytes,10000,opt,name=resource", Filename: "solo-kit.proto", }
View Source
var Status_State_name = map[int32]string{
0: "Pending",
1: "Accepted",
2: "Rejected",
3: "Warning",
}
View Source
var Status_State_value = map[string]int32{
"Pending": 0,
"Accepted": 1,
"Rejected": 2,
"Warning": 3,
}
Functions ¶
This section is empty.
Types ¶
type Metadata ¶
type Metadata struct {
//
//Name of the resource.
//
//Names must be unique and follow the following syntax rules:
//
//One or more lowercase rfc1035/rfc1123 labels separated by '.' with a maximum length of 253 characters.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Namespace is used for the namespacing of resources.
Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
// Cluster indicates the cluster this resource belongs to
// Cluster is only applicable in certain contexts, e.g. Kubernetes
// An empty string here refers to the local cluster
Cluster string `protobuf:"bytes,7,opt,name=cluster,proto3" json:"cluster,omitempty"`
// An opaque value that represents the internal version of this object that can
// be used by clients to determine when objects have changed.
ResourceVersion string `protobuf:"bytes,4,opt,name=resource_version,json=resourceVersion,proto3" json:"resource_version,omitempty" testdiff:"ignore"`
// Map of string keys and values that can be used to organize and categorize
// (scope and select) objects. Some resources contain `selectors` which
// can be linked with other resources by their labels
Labels map[string]string `` /* 153-byte string literal not displayed */
// Annotations is an unstructured key value map stored with a resource that may be
// set by external tools to store and retrieve arbitrary metadata.
Annotations map[string]string `` /* 163-byte string literal not displayed */
// A sequence number representing a specific generation of the desired state.
// Currently only populated for resources backed by Kubernetes
Generation int64 `protobuf:"varint,8,opt,name=generation,proto3" json:"generation,omitempty"`
//List of objects depended by this object.
// Currently only populated for resources backed by Kubernetes
OwnerReferences []*Metadata_OwnerReference `protobuf:"bytes,9,rep,name=owner_references,json=ownerReferences,proto3" json:"owner_references,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
* Metadata contains general properties of resources for purposes of versioning, annotating, and namespacing.
func (*Metadata) Descriptor ¶
func (*Metadata) GetAnnotations ¶
func (*Metadata) GetCluster ¶
func (*Metadata) GetGeneration ¶ added in v0.10.15
func (*Metadata) GetNamespace ¶
func (*Metadata) GetOwnerReferences ¶ added in v0.10.18
func (m *Metadata) GetOwnerReferences() []*Metadata_OwnerReference
func (*Metadata) GetResourceVersion ¶
func (Metadata) Match ¶
func (m Metadata) Match(ref ResourceRef) bool
func (*Metadata) ProtoMessage ¶
func (*Metadata) ProtoMessage()
func (Metadata) Ref ¶
func (m Metadata) Ref() ResourceRef
func (*Metadata) XXX_DiscardUnknown ¶
func (m *Metadata) XXX_DiscardUnknown()
func (*Metadata) XXX_Marshal ¶
func (*Metadata) XXX_Unmarshal ¶
type Metadata_OwnerReference ¶ added in v0.10.18
type Metadata_OwnerReference struct {
ApiVersion string `protobuf:"bytes,1,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
BlockOwnerDeletion *types.BoolValue `protobuf:"bytes,2,opt,name=block_owner_deletion,json=blockOwnerDeletion,proto3" json:"block_owner_deletion,omitempty"`
Controller *types.BoolValue `protobuf:"bytes,3,opt,name=controller,proto3" json:"controller,omitempty"`
Kind string `protobuf:"bytes,4,opt,name=kind,proto3" json:"kind,omitempty"`
Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`
Uid string `protobuf:"bytes,6,opt,name=uid,proto3" json:"uid,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
proto message representing kubernertes owner reference https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#ownerreference-v1-meta
func (*Metadata_OwnerReference) Descriptor ¶ added in v0.10.18
func (*Metadata_OwnerReference) Descriptor() ([]byte, []int)
func (*Metadata_OwnerReference) Equal ¶ added in v0.10.18
func (this *Metadata_OwnerReference) Equal(that interface{}) bool
func (*Metadata_OwnerReference) GetApiVersion ¶ added in v0.10.18
func (m *Metadata_OwnerReference) GetApiVersion() string
func (*Metadata_OwnerReference) GetBlockOwnerDeletion ¶ added in v0.10.18
func (m *Metadata_OwnerReference) GetBlockOwnerDeletion() *types.BoolValue
func (*Metadata_OwnerReference) GetController ¶ added in v0.10.18
func (m *Metadata_OwnerReference) GetController() *types.BoolValue
func (*Metadata_OwnerReference) GetKind ¶ added in v0.10.18
func (m *Metadata_OwnerReference) GetKind() string
func (*Metadata_OwnerReference) GetName ¶ added in v0.10.18
func (m *Metadata_OwnerReference) GetName() string
func (*Metadata_OwnerReference) GetUid ¶ added in v0.10.18
func (m *Metadata_OwnerReference) GetUid() string
func (*Metadata_OwnerReference) Hash ¶ added in v0.11.14
func (m *Metadata_OwnerReference) Hash(hasher hash.Hash64) (uint64, error)
Hash function
func (*Metadata_OwnerReference) ProtoMessage ¶ added in v0.10.18
func (*Metadata_OwnerReference) ProtoMessage()
func (*Metadata_OwnerReference) Reset ¶ added in v0.10.18
func (m *Metadata_OwnerReference) Reset()
func (*Metadata_OwnerReference) String ¶ added in v0.10.18
func (m *Metadata_OwnerReference) String() string
func (*Metadata_OwnerReference) XXX_DiscardUnknown ¶ added in v0.10.18
func (m *Metadata_OwnerReference) XXX_DiscardUnknown()
func (*Metadata_OwnerReference) XXX_Marshal ¶ added in v0.10.18
func (m *Metadata_OwnerReference) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Metadata_OwnerReference) XXX_Merge ¶ added in v0.10.18
func (m *Metadata_OwnerReference) XXX_Merge(src proto.Message)
func (*Metadata_OwnerReference) XXX_Size ¶ added in v0.10.18
func (m *Metadata_OwnerReference) XXX_Size() int
func (*Metadata_OwnerReference) XXX_Unmarshal ¶ added in v0.10.18
func (m *Metadata_OwnerReference) XXX_Unmarshal(b []byte) error
type Resource ¶
type Resource struct {
// becomes the kubernetes short name for the generated crd
ShortName string `protobuf:"bytes,1,opt,name=short_name,json=shortName,proto3" json:"short_name,omitempty"`
// becomes the kubernetes plural name for the generated crd
PluralName string `protobuf:"bytes,2,opt,name=plural_name,json=pluralName,proto3" json:"plural_name,omitempty"`
// the resource lives at the cluster level, namespace is ignored by the server
ClusterScoped bool `protobuf:"varint,3,opt,name=cluster_scoped,json=clusterScoped,proto3" json:"cluster_scoped,omitempty"`
// indicates whether documentation generation has to be skipped for the given resource, defaults to false
SkipDocsGen bool `protobuf:"varint,4,opt,name=skip_docs_gen,json=skipDocsGen,proto3" json:"skip_docs_gen,omitempty"`
// indicates whether annotations should be excluded from the resource's generated hash function.
// if set to true, changes in annotations will not cause a new snapshot to be emitted
SkipHashingAnnotations bool `` /* 130-byte string literal not displayed */
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (*Resource) Descriptor ¶
func (*Resource) GetClusterScoped ¶
func (*Resource) GetPluralName ¶
func (*Resource) GetShortName ¶
func (*Resource) GetSkipDocsGen ¶
func (*Resource) GetSkipHashingAnnotations ¶ added in v0.10.18
func (*Resource) ProtoMessage ¶
func (*Resource) ProtoMessage()
func (*Resource) XXX_DiscardUnknown ¶
func (m *Resource) XXX_DiscardUnknown()
func (*Resource) XXX_Marshal ¶
func (*Resource) XXX_Unmarshal ¶
type ResourceRef ¶
type ResourceRef struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
}
A way to reference resources across namespaces
func (*ResourceRef) Descriptor ¶
func (*ResourceRef) Descriptor() ([]byte, []int)
func (*ResourceRef) Equal ¶
func (this *ResourceRef) Equal(that interface{}) bool
func (*ResourceRef) GetName ¶
func (m *ResourceRef) GetName() string
func (*ResourceRef) GetNamespace ¶
func (m *ResourceRef) GetNamespace() string
func (*ResourceRef) Hash ¶ added in v0.11.14
func (m *ResourceRef) Hash(hasher hash.Hash64) (uint64, error)
Hash function
func (ResourceRef) Key ¶
func (r ResourceRef) Key() string
func (*ResourceRef) ProtoMessage ¶
func (*ResourceRef) ProtoMessage()
func (*ResourceRef) Reset ¶
func (m *ResourceRef) Reset()
func (*ResourceRef) String ¶
func (m *ResourceRef) String() string
func (ResourceRef) Strings ¶
func (r ResourceRef) Strings() (string, string)
func (*ResourceRef) XXX_DiscardUnknown ¶
func (m *ResourceRef) XXX_DiscardUnknown()
func (*ResourceRef) XXX_Marshal ¶
func (m *ResourceRef) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ResourceRef) XXX_Merge ¶
func (m *ResourceRef) XXX_Merge(src proto.Message)
func (*ResourceRef) XXX_Size ¶
func (m *ResourceRef) XXX_Size() int
func (*ResourceRef) XXX_Unmarshal ¶
func (m *ResourceRef) XXX_Unmarshal(b []byte) error
type Status ¶
type Status struct {
// State is the enum indicating the state of the resource
State Status_State `protobuf:"varint,1,opt,name=state,proto3,enum=core.solo.io.Status_State" json:"state,omitempty"`
// Reason is a description of the error for Rejected resources. If the resource is pending or accepted, this field will be empty
Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
// Reference to the reporter who wrote this status
ReportedBy string `protobuf:"bytes,3,opt,name=reported_by,json=reportedBy,proto3" json:"reported_by,omitempty"`
// Reference to statuses (by resource-ref string: "Kind.Namespace.Name") of subresources of the parent resource
SubresourceStatuses map[string]*Status `` /* 206-byte string literal not displayed */
// Opaque details about status results
Details *types.Struct `protobuf:"bytes,5,opt,name=details,proto3" json:"details,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
* Status indicates whether a resource has been (in)validated by a reporter in the system. Statuses are meant to be read-only by users
func (Status) DeepCopyInto ¶ added in v0.11.3
func (*Status) Descriptor ¶
func (*Status) GetDetails ¶ added in v0.10.15
func (*Status) GetReportedBy ¶
func (*Status) GetState ¶
func (m *Status) GetState() Status_State
func (*Status) GetSubresourceStatuses ¶
func (*Status) ProtoMessage ¶
func (*Status) ProtoMessage()
func (*Status) XXX_DiscardUnknown ¶
func (m *Status) XXX_DiscardUnknown()
func (*Status) XXX_Marshal ¶
func (*Status) XXX_Unmarshal ¶
type Status_State ¶
type Status_State int32
const ( // Pending status indicates the resource has not yet been validated Status_Pending Status_State = 0 // Accepted indicates the resource has been validated Status_Accepted Status_State = 1 // Rejected indicates an invalid configuration by the user // Rejected resources may be propagated to the xDS server depending on their severity Status_Rejected Status_State = 2 // Warning indicates a partially invalid configuration by the user // Resources with Warnings may be partially accepted by a controller, depending on the implementation Status_Warning Status_State = 3 )
func (Status_State) EnumDescriptor ¶
func (Status_State) EnumDescriptor() ([]byte, []int)
func (Status_State) String ¶
func (x Status_State) String() string
Click to show internal directories.
Click to hide internal directories.