v1alpha1

package
v0.2.1 Latest Latest
Warning

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

 Go to latest Published: Oct 10, 2018 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v1alpha1 represents the v1alpha1 version of the Cluster Bundle API.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClusterBundle 

type ClusterBundle struct {
	// Required. Kubernetes API Version for the Bundle.
	// Must be gke.io/k8s-cluster-bundle/v1alpha1.
	ApiVersion string `protobuf:"bytes,1,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// Required. The Kubernetes `kind` for this object. Must be 'ClusterBundle'.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// Required. Kubernetes ObjectMeta proto. The Metadata.name field must be
	// filled out for each Bundle.
	Metadata *ObjectMeta `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Required. Version-string for this bundle. The version should be a SemVer
	// string (see https://semver.org/) of the form X.Y.Z (Major.Minor.Patch).
	// Generally speaking, a major-version (changes should indicate breaking
	// changes, minor-versions should indicate backwards compatible features, and
	// patch changes should indicate backwords compatible. If there are any
	// changes to the bundle, then the version string must be incremented.
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// Spec for the ClusterBundle, which specifies the intended Kubernetes cluster
	// configuration.
	Spec                 *ClusterBundleSpec `protobuf:"bytes,5,opt,name=spec,proto3" json:"spec,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

The ClusterBundle is a packaging format for Kubernetes Components.

func (*ClusterBundle) Descriptor 

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

func (*ClusterBundle) GetApiVersion 

func (m *ClusterBundle) GetApiVersion() string

func (*ClusterBundle) GetKind 

func (m *ClusterBundle) GetKind() string

func (*ClusterBundle) GetMetadata 

func (m *ClusterBundle) GetMetadata() *ObjectMeta

func (*ClusterBundle) GetSpec 

func (m *ClusterBundle) GetSpec() *ClusterBundleSpec

func (*ClusterBundle) GetVersion 

func (m *ClusterBundle) GetVersion() string

func (*ClusterBundle) ProtoMessage 

func (*ClusterBundle) ProtoMessage()

func (*ClusterBundle) Reset 

func (m *ClusterBundle) Reset()

func (*ClusterBundle) String 

func (m *ClusterBundle) String() string

func (*ClusterBundle) XXX_DiscardUnknown 

func (m *ClusterBundle) XXX_DiscardUnknown()

func (*ClusterBundle) XXX_Marshal 

func (m *ClusterBundle) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClusterBundle) XXX_Merge 

func (m *ClusterBundle) XXX_Merge(src proto.Message)

func (*ClusterBundle) XXX_Size 

func (m *ClusterBundle) XXX_Size() int

func (*ClusterBundle) XXX_Unmarshal 

func (m *ClusterBundle) XXX_Unmarshal(b []byte) error

type ClusterBundleSpec 

type ClusterBundleSpec struct {
	// Configuration for the nodes.
	NodeConfigs []*NodeConfig `protobuf:"bytes,1,rep,name=node_configs,json=nodeConfigs,proto3" json:"node_configs,omitempty"`
	// Configuration for the nodes, specified as external files. The process of
	// inlining reads node config files into node configs, and so after
	// inlining, this list will be empty.
	NodeConfigFiles []*File `protobuf:"bytes,2,rep,name=node_config_files,json=nodeConfigFiles,proto3" json:"node_config_files,omitempty"`
	// Kubernetes objects grouped into cluster components and versioned together.
	// These could be applications or they could be some sort of supporting
	// object collection.
	Components []*ClusterComponent `protobuf:"bytes,3,rep,name=components,proto3" json:"components,omitempty"`
	// Cluster components that are specified externally as Files. The process of inlining
	// for a bundle reads component files into components, and so after
	// inlining, this list will be empty.
	ComponentFiles       []*File  `protobuf:"bytes,4,rep,name=component_files,json=componentFiles,proto3" json:"component_files,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A spec object that wraps the Cluster Bundle.

func (*ClusterBundleSpec) Descriptor 

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

func (*ClusterBundleSpec) GetComponentFiles 

func (m *ClusterBundleSpec) GetComponentFiles() []*File

func (*ClusterBundleSpec) GetComponents 

func (m *ClusterBundleSpec) GetComponents() []*ClusterComponent

func (*ClusterBundleSpec) GetNodeConfigFiles 

func (m *ClusterBundleSpec) GetNodeConfigFiles() []*File

func (*ClusterBundleSpec) GetNodeConfigs 

func (m *ClusterBundleSpec) GetNodeConfigs() []*NodeConfig

func (*ClusterBundleSpec) ProtoMessage 

func (*ClusterBundleSpec) ProtoMessage()

func (*ClusterBundleSpec) Reset 

func (m *ClusterBundleSpec) Reset()

func (*ClusterBundleSpec) String 

func (m *ClusterBundleSpec) String() string

func (*ClusterBundleSpec) XXX_DiscardUnknown 

func (m *ClusterBundleSpec) XXX_DiscardUnknown()

func (*ClusterBundleSpec) XXX_Marshal 

func (m *ClusterBundleSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClusterBundleSpec) XXX_Merge 

func (m *ClusterBundleSpec) XXX_Merge(src proto.Message)

func (*ClusterBundleSpec) XXX_Size 

func (m *ClusterBundleSpec) XXX_Size() int

func (*ClusterBundleSpec) XXX_Unmarshal 

func (m *ClusterBundleSpec) XXX_Unmarshal(b []byte) error

type ClusterComponent 

type ClusterComponent struct {
	// Required. Kubernetes API Version for the ClusterComponent type.
	// Must always be 'gke.io/k8s-cluster-bundle/v1alpha1'
	ApiVersion string `protobuf:"bytes,1,opt,name=apiVersion,proto3" json:"apiVersion,omitempty"`
	// Required. The Kubernetes `kind` for this object. Must be
	// 'ClusterComponent'.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// Kubernetes Metadata for the component. The Metadata.name field must be
	// filled out and each component in a bundle must have a unique name. For
	// example you might have a 'kube-apiserver' component or perhaps even a
	// 'kubernetes' component, depending on the granulatarity of the Bundle
	// components.
	Metadata *ObjectMeta `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Required. Version-string for this component. The version should be a SemVer
	// 2 string (see https://semver.org/) of the form X.Y.Z (Major.Minor.Patch).
	// A major-version changes should indicate breaking changes, minor-versions
	// should indicate backwards compatible features, and patch changes should
	// indicate backwords compatible. If there are any changes to the component,
	// then the version string must be incremented.
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// Optional. A version-string representing the version of the API this
	// component offers to other components (for the purposes of requirement
	// satisfaction). If no API is offered to other components, then this field
	// may be blank, but then other components may not depend on this component.
	ComponentApiVersion string `protobuf:"bytes,5,opt,name=componentApiVersion,proto3" json:"componentApiVersion,omitempty"`
	// A list of components that must be packaged in a bundle in with this
	// component.
	Requirements []*MinRequirement `protobuf:"bytes,6,rep,name=requirements,proto3" json:"requirements,omitempty"`
	// Structured Kubenetes objects that run as part of this app, whether on the
	// master, on the nodes, or in some other fashio.  These Kubernetes objects
	// are inlined and must be YAML/JSON
	// compatible. Each must have `apiVersion`, `kind`, and `metadata`
	ClusterObjects []*_struct.Struct `protobuf:"bytes,7,rep,name=cluster_objects,json=clusterObjects,proto3" json:"cluster_objects,omitempty"`
	// Cluster objects that are specified via a File-URL. The process of inlining
	// the a component turns cluster object files into cluster objects.
	// During the inline process, if the file is YAML-formatted and contains multiple
	// objects, the objects will be split into separate inline objects. In other
	// words, one cluster object file may result in multiple cluster objects.
	ClusterObjectFiles   []*File  `protobuf:"bytes,8,rep,name=cluster_object_files,json=clusterObjectFiles,proto3" json:"cluster_object_files,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Kubernetes objects grouped into cluster components and versioned together. These could be applications or they could be some sort of supporting object collection.

func (*ClusterComponent) Descriptor 

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

func (*ClusterComponent) GetApiVersion 

func (m *ClusterComponent) GetApiVersion() string

func (*ClusterComponent) GetClusterObjectFiles 

func (m *ClusterComponent) GetClusterObjectFiles() []*File

func (*ClusterComponent) GetClusterObjects 

func (m *ClusterComponent) GetClusterObjects() []*_struct.Struct

func (*ClusterComponent) GetComponentApiVersion 

func (m *ClusterComponent) GetComponentApiVersion() string

func (*ClusterComponent) GetKind 

func (m *ClusterComponent) GetKind() string

func (*ClusterComponent) GetMetadata 

func (m *ClusterComponent) GetMetadata() *ObjectMeta

func (*ClusterComponent) GetRequirements 

func (m *ClusterComponent) GetRequirements() []*MinRequirement

func (*ClusterComponent) GetVersion 

func (m *ClusterComponent) GetVersion() string

func (*ClusterComponent) ProtoMessage 

func (*ClusterComponent) ProtoMessage()

func (*ClusterComponent) Reset 

func (m *ClusterComponent) Reset()

func (*ClusterComponent) String 

func (m *ClusterComponent) String() string

func (*ClusterComponent) XXX_DiscardUnknown 

func (m *ClusterComponent) XXX_DiscardUnknown()

func (*ClusterComponent) XXX_Marshal 

func (m *ClusterComponent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClusterComponent) XXX_Merge 

func (m *ClusterComponent) XXX_Merge(src proto.Message)

func (*ClusterComponent) XXX_Size 

func (m *ClusterComponent) XXX_Size() int

func (*ClusterComponent) XXX_Unmarshal 

func (m *ClusterComponent) XXX_Unmarshal(b []byte) error

type EnvVar 

type EnvVar struct {
	// Name of this environment variable. E.g., FOO_VAR. The name of the
	// environment variable should be unique within a node bootstrap
	// configuration.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The value to set for this environment variable.
	Value                string   `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

An environment variable specified for node startup.

func (*EnvVar) Descriptor 

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

func (*EnvVar) GetName 

func (m *EnvVar) GetName() string

func (*EnvVar) GetValue 

func (m *EnvVar) GetValue() string

func (*EnvVar) ProtoMessage 

func (*EnvVar) ProtoMessage()

func (*EnvVar) Reset 

func (m *EnvVar) Reset()

func (*EnvVar) String 

func (m *EnvVar) String() string

func (*EnvVar) XXX_DiscardUnknown 

func (m *EnvVar) XXX_DiscardUnknown()

func (*EnvVar) XXX_Marshal 

func (m *EnvVar) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EnvVar) XXX_Merge 

func (m *EnvVar) XXX_Merge(src proto.Message)

func (*EnvVar) XXX_Size 

func (m *EnvVar) XXX_Size() int

func (*EnvVar) XXX_Unmarshal 

func (m *EnvVar) XXX_Unmarshal(b []byte) error

type File 

type File struct {
	// Url to find this file.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// Optional Sha256 hash of the binary to ensure we are pulling the correct
	// binary/file.
	Hash                 string   `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

File represents some sort of file that's specified external to the bundle, which could be on either a local or remote file system.

func (*File) Descriptor 

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

func (*File) GetHash 

func (m *File) GetHash() string

func (*File) GetUrl 

func (m *File) GetUrl() string

func (*File) ProtoMessage 

func (*File) ProtoMessage()

func (*File) Reset 

func (m *File) Reset()

func (*File) String 

func (m *File) String() string

func (*File) XXX_DiscardUnknown 

func (m *File) XXX_DiscardUnknown()

func (*File) XXX_Marshal 

func (m *File) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*File) XXX_Merge 

func (m *File) XXX_Merge(src proto.Message)

func (*File) XXX_Size 

func (m *File) XXX_Size() int

func (*File) XXX_Unmarshal 

func (m *File) XXX_Unmarshal(b []byte) error

type MinRequirement 

type MinRequirement struct {
	// Name of a component. The component name specified here must match exactly a
	// component name in the `metadata.name` field of another component.
	Component string `protobuf:"bytes,1,opt,name=component,proto3" json:"component,omitempty"`
	// The sem-ver apiVersion of the component. The API Version is only a minimum
	// requirement. The assumption any newer component with only backwards
	// compatable changes is acceptable.
	ComponentApiVersion  string   `protobuf:"bytes,2,opt,name=componentApiVersion,proto3" json:"componentApiVersion,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

MinRequirement represents a component that this component must be packaged with in a ClusterBundle (or must be satisfied in some other fashion). This is roughly based on Semantic Import Versioning in the Go Language: https://research.swtch.com/vgo-import.

func (*MinRequirement) Descriptor 

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

func (*MinRequirement) GetComponent 

func (m *MinRequirement) GetComponent() string

func (*MinRequirement) GetComponentApiVersion 

func (m *MinRequirement) GetComponentApiVersion() string

func (*MinRequirement) ProtoMessage 

func (*MinRequirement) ProtoMessage()

func (*MinRequirement) Reset 

func (m *MinRequirement) Reset()

func (*MinRequirement) String 

func (m *MinRequirement) String() string

func (*MinRequirement) XXX_DiscardUnknown 

func (m *MinRequirement) XXX_DiscardUnknown()

func (*MinRequirement) XXX_Marshal 

func (m *MinRequirement) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MinRequirement) XXX_Merge 

func (m *MinRequirement) XXX_Merge(src proto.Message)

func (*MinRequirement) XXX_Size 

func (m *MinRequirement) XXX_Size() int

func (*MinRequirement) XXX_Unmarshal 

func (m *MinRequirement) XXX_Unmarshal(b []byte) error

type NodeConfig 

type NodeConfig struct {
	// Required. Kubernetes API Version for the NodeConfig type.
	// Should be 'gke.io/k8s-cluster-bundle/v1alpha1'
	ApiVersion string `protobuf:"bytes,1,opt,name=apiVersion,proto3" json:"apiVersion,omitempty"`
	// Required. The Kubernetes `kind` for this object. Must always be
	// 'NodeConfig'.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// Kubernetes Metadata for the node config. The Metadata.name field must be
	// filled out and each node config in a bundle must have a unique name. For
	// example you might have a 'master-node-config' component or perhaps even a
	// 'gpu-config' config.
	Metadata *ObjectMeta `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Required. Version-string for this node config. The version should be a
	// SemVer 2 string (see https://semver.org/) of the form X.Y.Z
	// (Major.Minor.Patch). A major-version changes should indicate breaking
	// changes, minor-versions should indicate backwards compatible features, and
	// patch changes should indicate backwords compatible. If there are any
	// changes to the component, then the version string must be incremented.
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// Initialization file to run on VM startup. The contents of this init file
	// will depend a great deal on the specific environment and operation system.
	//
	// Types that are valid to be assigned to InitData:
	//	*NodeConfig_InitFile
	//	*NodeConfig_ExternalInitFile
	InitData isNodeConfig_InitData `protobuf_oneof:"init_data"`
	// Envirnoment variables to set before startup to configure the init script.
	EnvVars []*EnvVar `protobuf:"bytes,7,rep,name=env_vars,json=envVars,proto3" json:"env_vars,omitempty"`
	// The OS image to use for VM creation.
	OsImage              *File    `protobuf:"bytes,8,opt,name=os_image,json=osImage,proto3" json:"os_image,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Configuration for node images.

func (*NodeConfig) Descriptor 

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

func (*NodeConfig) GetApiVersion 

func (m *NodeConfig) GetApiVersion() string

func (*NodeConfig) GetEnvVars 

func (m *NodeConfig) GetEnvVars() []*EnvVar

func (*NodeConfig) GetExternalInitFile 

func (m *NodeConfig) GetExternalInitFile() *File

func (*NodeConfig) GetInitData 

func (m *NodeConfig) GetInitData() isNodeConfig_InitData

func (*NodeConfig) GetInitFile 

func (m *NodeConfig) GetInitFile() string

func (*NodeConfig) GetKind 

func (m *NodeConfig) GetKind() string

func (*NodeConfig) GetMetadata 

func (m *NodeConfig) GetMetadata() *ObjectMeta

func (*NodeConfig) GetOsImage 

func (m *NodeConfig) GetOsImage() *File

func (*NodeConfig) GetVersion 

func (m *NodeConfig) GetVersion() string

func (*NodeConfig) ProtoMessage 

func (*NodeConfig) ProtoMessage()

func (*NodeConfig) Reset 

func (m *NodeConfig) Reset()

func (*NodeConfig) String 

func (m *NodeConfig) String() string

func (*NodeConfig) XXX_DiscardUnknown 

func (m *NodeConfig) XXX_DiscardUnknown()

func (*NodeConfig) XXX_Marshal 

func (m *NodeConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NodeConfig) XXX_Merge 

func (m *NodeConfig) XXX_Merge(src proto.Message)

func (*NodeConfig) XXX_OneofFuncs 

func (*NodeConfig) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

func (*NodeConfig) XXX_Size 

func (m *NodeConfig) XXX_Size() int

func (*NodeConfig) XXX_Unmarshal 

func (m *NodeConfig) XXX_Unmarshal(b []byte) error

type NodeConfig_ExternalInitFile 

type NodeConfig_ExternalInitFile struct {
	ExternalInitFile *File `protobuf:"bytes,6,opt,name=external_init_file,json=externalInitFile,proto3,oneof"`
}

type NodeConfig_InitFile 

type NodeConfig_InitFile struct {
	InitFile string `protobuf:"bytes,5,opt,name=init_file,json=initFile,proto3,oneof"`
}

type ObjectMeta 

type ObjectMeta struct {
	// Name must be unique within a namespace. Is required when creating resources, although
	// some resources may allow a client to request the generation of an appropriate name
	// automatically. Name is primarily intended for creation idempotence and configuration
	// definition.
	// Cannot be updated.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
	// +optional
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// GenerateName is an optional prefix, used by the server, to generate a unique
	// name ONLY IF the Name field has not been provided.
	// If this field is used, the name returned to the client will be different
	// than the name passed. This value will also be combined with a unique suffix.
	// The provided value has the same validation rules as the Name field,
	// and may be truncated by the length of the suffix required to make the value
	// unique on the server.
	//
	// If this field is specified and the generated name exists, the server will
	// NOT return a 409 - instead, it will either return 201 Created or 500 with Reason
	// ServerTimeout indicating a unique name could not be found in the time allotted, and the client
	// should retry (optionally after the time indicated in the Retry-After header).
	//
	// Applied only if Name is not specified.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
	// +optional
	GenerateName string `protobuf:"bytes,2,opt,name=generate_name,json=generateName,proto3" json:"generate_name,omitempty"`
	// Namespace defines the space within each name must be unique. An empty namespace is
	// equivalent to the "default" namespace, but "default" is the canonical representation.
	// Not all objects are required to be scoped to a namespace - the value of this field for
	// those objects will be empty.
	//
	// Must be a DNS_LABEL.
	// Cannot be updated.
	// More info: http://kubernetes.io/docs/user-guide/namespaces
	// +optional
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// SelfLink is a URL representing this object.
	// Populated by the system.
	// Read-only.
	// +optional
	SelfLink string `protobuf:"bytes,4,opt,name=self_link,json=selfLink,proto3" json:"self_link,omitempty"`
	// UID is the unique in time and space value for this object. It is typically generated by
	// the server on successful creation of a resource and is not allowed to change on PUT
	// operations.
	//
	// Populated by the system.
	// Read-only.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#uids
	// +optional
	Uid string `protobuf:"bytes,5,opt,name=uid,proto3" json:"uid,omitempty"`
	// An opaque value that represents the internal version of this object that can
	// be used by clients to determine when objects have changed. May be used for optimistic
	// concurrency, change detection, and the watch operation on a resource or set of resources.
	// Clients must treat these values as opaque and passed unmodified back to the server.
	// They may only be valid for a particular resource or set of resources.
	//
	// Populated by the system.
	// Read-only.
	// Value must be treated as opaque by clients and .
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
	// +optional
	ResourceVersion string `protobuf:"bytes,6,opt,name=resource_version,json=resourceVersion,proto3" json:"resource_version,omitempty"`
	// A sequence number representing a specific generation of the desired state.
	// Populated by the system. Read-only.
	// +optional
	Generation int64 `protobuf:"varint,7,opt,name=generation,proto3" json:"generation,omitempty"`
	// CreationTimestamp is a timestamp representing the server time when this object was
	// created. It is not guaranteed to be set in happens-before order across separate operations.
	// Clients may not set this value. It is represented in RFC3339 form and is in UTC.
	//
	// Populated by the system.
	// Read-only.
	// Null for lists.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	CreationTimestamp *Time `protobuf:"bytes,8,opt,name=creation_timestamp,json=creationTimestamp,proto3" json:"creation_timestamp,omitempty"`
	// DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
	// field is set by the server when a graceful deletion is requested by the user, and is not
	// directly settable by a client. The resource is expected to be deleted (no longer visible
	// from resource lists, and not reachable by name) after the time in this field, once the
	// finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
	// Once the deletionTimestamp is set, this value may not be unset or be set further into the
	// future, although it may be shortened or the resource may be deleted prior to this time.
	// For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
	// by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
	// the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
	// remove the pod from the API. In the presence of network partitions, this object may still
	// exist after this timestamp, until an administrator or automated process can determine the
	// resource is fully terminated.
	// If not set, graceful deletion of the object has not been requested.
	//
	// Populated by the system when a graceful deletion is requested.
	// Read-only.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	DeletionTimestamp *Time `protobuf:"bytes,9,opt,name=deletion_timestamp,json=deletionTimestamp,proto3" json:"deletion_timestamp,omitempty"`
	// Number of seconds allowed for this object to gracefully terminate before
	// it will be removed from the system. Only set when deletionTimestamp is also set.
	// May only be shortened.
	// Read-only.
	// +optional
	DeletionGracePeriodSeconds int64 `` /* 145-byte string literal not displayed */
	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects. May match selectors of replication controllers
	// and services.
	// More info: http://kubernetes.io/docs/user-guide/labels
	// +optional
	Labels map[string]string `` /* 154-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. They are not
	// queryable and should be preserved when modifying objects.
	// More info: http://kubernetes.io/docs/user-guide/annotations
	// +optional
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// List of objects depended by this object. If ALL objects in the list have
	// been deleted, this object will be garbage collected. If this object is managed by a controller,
	// then an entry in this list will point to this controller, with the controller field set to true.
	// There cannot be more than one managing controller.
	// +optional
	// +patchMergeKey=uid
	// +patchStrategy=merge
	OwnerReferences []*OwnerReference `protobuf:"bytes,13,rep,name=owner_references,json=ownerReferences,proto3" json:"owner_references,omitempty"`
	// Must be empty before the object is deleted from the registry. Each entry
	// is an identifier for the responsible component that will remove the entry
	// from the list. If the deletionTimestamp of the object is non-nil, entries
	// in this list can only be removed.
	// +optional
	// +patchStrategy=merge
	Finalizers []string `protobuf:"bytes,14,rep,name=finalizers,proto3" json:"finalizers,omitempty"`
	// The name of the cluster which the object belongs to.
	// This is used to distinguish resources with same name and namespace in different clusters.
	// This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
	// +optional
	ClusterName          string   `protobuf:"bytes,15,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

func (*ObjectMeta) Descriptor 

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

func (*ObjectMeta) GetAnnotations 

func (m *ObjectMeta) GetAnnotations() map[string]string

func (*ObjectMeta) GetClusterName 

func (m *ObjectMeta) GetClusterName() string

func (*ObjectMeta) GetCreationTimestamp 

func (m *ObjectMeta) GetCreationTimestamp() *Time

func (*ObjectMeta) GetDeletionGracePeriodSeconds 

func (m *ObjectMeta) GetDeletionGracePeriodSeconds() int64

func (*ObjectMeta) GetDeletionTimestamp 

func (m *ObjectMeta) GetDeletionTimestamp() *Time

func (*ObjectMeta) GetFinalizers 

func (m *ObjectMeta) GetFinalizers() []string

func (*ObjectMeta) GetGenerateName 

func (m *ObjectMeta) GetGenerateName() string

func (*ObjectMeta) GetGeneration 

func (m *ObjectMeta) GetGeneration() int64

func (*ObjectMeta) GetLabels 

func (m *ObjectMeta) GetLabels() map[string]string

func (*ObjectMeta) GetName 

func (m *ObjectMeta) GetName() string

func (*ObjectMeta) GetNamespace 

func (m *ObjectMeta) GetNamespace() string

func (*ObjectMeta) GetOwnerReferences 

func (m *ObjectMeta) GetOwnerReferences() []*OwnerReference

func (*ObjectMeta) GetResourceVersion 

func (m *ObjectMeta) GetResourceVersion() string
func (m *ObjectMeta) GetSelfLink() string

func (*ObjectMeta) GetUid 

func (m *ObjectMeta) GetUid() string

func (*ObjectMeta) ProtoMessage 

func (*ObjectMeta) ProtoMessage()

func (*ObjectMeta) Reset 

func (m *ObjectMeta) Reset()

func (*ObjectMeta) String 

func (m *ObjectMeta) String() string

func (*ObjectMeta) XXX_DiscardUnknown 

func (m *ObjectMeta) XXX_DiscardUnknown()

func (*ObjectMeta) XXX_Marshal 

func (m *ObjectMeta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ObjectMeta) XXX_Merge 

func (m *ObjectMeta) XXX_Merge(src proto.Message)

func (*ObjectMeta) XXX_Size 

func (m *ObjectMeta) XXX_Size() int

func (*ObjectMeta) XXX_Unmarshal 

func (m *ObjectMeta) XXX_Unmarshal(b []byte) error

type OwnerReference 

type OwnerReference struct {
	// API version of the referent.
	ApiVersion string `protobuf:"bytes,5,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// Kind of the referent.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
	// Name of the referent.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// UID of the referent.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#uids
	Uid string `protobuf:"bytes,4,opt,name=uid,proto3" json:"uid,omitempty"`
	// If true, this reference points to the managing controller.
	// +optional
	Controller bool `protobuf:"varint,6,opt,name=controller,proto3" json:"controller,omitempty"`
	// If true, AND if the owner has the "foregroundDeletion" finalizer, then
	// the owner cannot be deleted from the key-value store until this
	// reference is removed.
	// Defaults to false.
	// To set this field, a user needs "delete" permission of the owner,
	// otherwise 422 (Unprocessable Entity) will be returned.
	// +optional
	BlockOwnerDeletion   bool     `protobuf:"varint,7,opt,name=block_owner_deletion,json=blockOwnerDeletion,proto3" json:"block_owner_deletion,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

func (*OwnerReference) Descriptor 

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

func (*OwnerReference) GetApiVersion 

func (m *OwnerReference) GetApiVersion() string

func (*OwnerReference) GetBlockOwnerDeletion 

func (m *OwnerReference) GetBlockOwnerDeletion() bool

func (*OwnerReference) GetController 

func (m *OwnerReference) GetController() bool

func (*OwnerReference) GetKind 

func (m *OwnerReference) GetKind() string

func (*OwnerReference) GetName 

func (m *OwnerReference) GetName() string

func (*OwnerReference) GetUid 

func (m *OwnerReference) GetUid() string

func (*OwnerReference) ProtoMessage 

func (*OwnerReference) ProtoMessage()

func (*OwnerReference) Reset 

func (m *OwnerReference) Reset()

func (*OwnerReference) String 

func (m *OwnerReference) String() string

func (*OwnerReference) XXX_DiscardUnknown 

func (m *OwnerReference) XXX_DiscardUnknown()

func (*OwnerReference) XXX_Marshal 

func (m *OwnerReference) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OwnerReference) XXX_Merge 

func (m *OwnerReference) XXX_Merge(src proto.Message)

func (*OwnerReference) XXX_Size 

func (m *OwnerReference) XXX_Size() int

func (*OwnerReference) XXX_Unmarshal 

func (m *OwnerReference) XXX_Unmarshal(b []byte) error

type Time 

type Time struct {
	// Represents seconds of UTC time since Unix epoch
	// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
	// 9999-12-31T23:59:59Z inclusive.
	Seconds int64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`
	// Non-negative fractions of a second at nanosecond resolution. Negative
	// second values with fractions must still have non-negative nanos values
	// that count forward in time. Must be from 0 to 999,999,999
	// inclusive. This field may be limited in precision depending on context.
	Nanos                int32    `protobuf:"varint,2,opt,name=nanos,proto3" json:"nanos,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

func (*Time) Descriptor 

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

func (*Time) GetNanos 

func (m *Time) GetNanos() int32

func (*Time) GetSeconds 

func (m *Time) GetSeconds() int64

func (*Time) ProtoMessage 

func (*Time) ProtoMessage()

func (*Time) Reset 

func (m *Time) Reset()

func (*Time) String 

func (m *Time) String() string

func (*Time) XXX_DiscardUnknown 

func (m *Time) XXX_DiscardUnknown()

func (*Time) XXX_Marshal 

func (m *Time) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Time) XXX_Merge 

func (m *Time) XXX_Merge(src proto.Message)

func (*Time) XXX_Size 

func (m *Time) XXX_Size() int

func (*Time) XXX_Unmarshal 

func (m *Time) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

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.