Documentation

Overview

    +k8s:deepcopy-gen=package,register +groupName=example.k8s.io

    package example contains an example API used to demonstrate how to create api groups. Moreover, this is used within tests.

    Index

    Constants

    View Source
    const GroupName = "example.apiserver.k8s.io"

      GroupName is the group name use in this package

      Variables

      View Source
      var (
      	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
      	AddToScheme   = SchemeBuilder.AddToScheme
      )
      View Source
      var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

        SchemeGroupVersion is group version used to register these objects

        Functions

        func DeepCopy_example_Pod

        func DeepCopy_example_Pod(in interface{}, out interface{}, c *conversion.Cloner) error

        func DeepCopy_example_PodCondition

        func DeepCopy_example_PodCondition(in interface{}, out interface{}, c *conversion.Cloner) error

        func DeepCopy_example_PodList

        func DeepCopy_example_PodList(in interface{}, out interface{}, c *conversion.Cloner) error

        func DeepCopy_example_PodSpec

        func DeepCopy_example_PodSpec(in interface{}, out interface{}, c *conversion.Cloner) error

        func DeepCopy_example_PodStatus

        func DeepCopy_example_PodStatus(in interface{}, out interface{}, c *conversion.Cloner) error

        func Kind

        func Kind(kind string) schema.GroupKind

          Kind takes an unqualified kind and returns a Group qualified GroupKind

          func RegisterDeepCopies

          func RegisterDeepCopies(scheme *runtime.Scheme) error

            RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

            func Resource

            func Resource(resource string) schema.GroupResource

              Resource takes an unqualified resource and returns a Group qualified GroupResource

              Types

              type ConditionStatus

              type ConditionStatus string

              type Pod

              type Pod struct {
              	metav1.TypeMeta
              	// +optional
              	metav1.ObjectMeta
              
              	// Spec defines the behavior of a pod.
              	// +optional
              	Spec PodSpec
              
              	// Status represents the current information about a pod. This data may not be up
              	// to date.
              	// +optional
              	Status PodStatus
              }

                Pod is a collection of containers, used as either input (create, update) or as output (list, get).

                type PodCondition

                type PodCondition struct {
                	Type   PodConditionType
                	Status ConditionStatus
                	// +optional
                	LastProbeTime metav1.Time
                	// +optional
                	LastTransitionTime metav1.Time
                	// +optional
                	Reason string
                	// +optional
                	Message string
                }

                type PodConditionType

                type PodConditionType string

                type PodList

                type PodList struct {
                	metav1.TypeMeta
                	// +optional
                	metav1.ListMeta
                
                	Items []Pod
                }

                  PodList is a list of Pods.

                  type PodPhase

                  type PodPhase string

                  type PodSpec

                  type PodSpec struct {
                  	// +optional
                  	RestartPolicy RestartPolicy
                  	// Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
                  	// Value must be non-negative integer. The value zero indicates delete immediately.
                  	// If this value is nil, the default grace period will be used instead.
                  	// The grace period is the duration in seconds after the processes running in the pod are sent
                  	// a termination signal and the time when the processes are forcibly halted with a kill signal.
                  	// Set this value longer than the expected cleanup time for your process.
                  	// +optional
                  	TerminationGracePeriodSeconds *int64
                  	// Optional duration in seconds relative to the StartTime that the pod may be active on a node
                  	// before the system actively tries to terminate the pod; value must be positive integer
                  	// +optional
                  	ActiveDeadlineSeconds *int64
                  	// NodeSelector is a selector which must be true for the pod to fit on a node
                  	// +optional
                  	NodeSelector map[string]string
                  
                  	// ServiceAccountName is the name of the ServiceAccount to use to run this pod
                  	// The pod will be allowed to use secrets referenced by the ServiceAccount
                  	ServiceAccountName string
                  
                  	// NodeName is a request to schedule this pod onto a specific node.  If it is non-empty,
                  	// the scheduler simply schedules this pod onto that node, assuming that it fits resource
                  	// requirements.
                  	// +optional
                  	NodeName string
                  	// Specifies the hostname of the Pod.
                  	// If not specified, the pod's hostname will be set to a system-defined value.
                  	// +optional
                  	Hostname string
                  	// If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".
                  	// If not specified, the pod will not have a domainname at all.
                  	// +optional
                  	Subdomain string
                  	// If specified, the pod will be dispatched by specified scheduler.
                  	// If not specified, the pod will be dispatched by default scheduler.
                  	// +optional
                  	SchedulerName string
                  }

                    PodSpec is a description of a pod

                    type PodStatus

                    type PodStatus struct {
                    	// +optional
                    	Phase PodPhase
                    	// +optional
                    	Conditions []PodCondition
                    	// A human readable message indicating details about why the pod is in this state.
                    	// +optional
                    	Message string
                    	// A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk'
                    	// +optional
                    	Reason string
                    
                    	// +optional
                    	HostIP string
                    	// +optional
                    	PodIP string
                    
                    	// Date and time at which the object was acknowledged by the Kubelet.
                    	// This is before the Kubelet pulled the container image(s) for the pod.
                    	// +optional
                    	StartTime *metav1.Time
                    }

                      PodStatus represents information about the status of a pod. Status may trail the actual state of a system.

                      type RestartPolicy

                      type RestartPolicy string

                      Directories

                      Path Synopsis
                      Package install installs the certificates API group, making it available as an option to all of the API encoding/decoding machinery.
                      Package install installs the certificates API group, making it available as an option to all of the API encoding/decoding machinery.
                      +groupName=example.apiserver.k8s.io Package v1 is a generated protocol buffer package.
                      +groupName=example.apiserver.k8s.io Package v1 is a generated protocol buffer package.