types

Documentation

Index

• type CustomResourceDefinition
• type CustomResourceDefinitionDetail
• type CustomResourceDefinitionList
• type CustomResourceDefinitionNames
• type CustomResourceDefinitionVersion
• type CustomResourceObject
  • func (r *CustomResourceObject) UnmarshalJSON(data []byte) error
• type CustomResourceObjectDetail
• type CustomResourceObjectList
  • func (r *CustomResourceObjectList) UnmarshalJSON(data []byte) error

Types

type CustomResourceDefinition

type CustomResourceDefinition struct {
	ObjectMeta  api.ObjectMeta                `json:"objectMeta"`
	TypeMeta    api.TypeMeta                  `json:"typeMeta"`
	Version     string                        `json:"version,omitempty"`
	Group       string                        `json:"group"`
	Scope       apiextensions.ResourceScope   `json:"scope"`
	Names       CustomResourceDefinitionNames `json:"names"`
	Established apiextensions.ConditionStatus `json:"established"`
}

CustomResourceDefinition represents a custom resource definition.

type CustomResourceDefinitionDetail

type CustomResourceDefinitionDetail struct {
	CustomResourceDefinition `json:",inline"`

	Versions     []CustomResourceDefinitionVersion `json:"versions,omitempty"`
	Conditions   []common.Condition                `json:"conditions"`
	Objects      CustomResourceObjectList          `json:"objects"`
	Subresources []string                          `json:"subresources"`

	// List of non-critical errors, that occurred during resource retrieval.
	Errors []error `json:"errors"`
}

type CustomResourceDefinitionList

type CustomResourceDefinitionList struct {
	ListMeta api.ListMeta `json:"listMeta"`

	// Unordered list of custom resource definitions
	Items []CustomResourceDefinition `json:"items"`

	// List of non-critical errors, that occurred during resource retrieval.
	Errors []error `json:"errors"`
}

CustomResourceDefinitionList contains a list of Custom Resource Definitions in the cluster.

type CustomResourceDefinitionNames

type CustomResourceDefinitionNames struct {
	// plural is the plural name of the resource to serve.
	// The custom resources are served under `/apis/<group>/<version>/.../<plural>`.
	// Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
	// Must be all lowercase.
	Plural string `json:"plural"`
	// singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.
	// +optional
	Singular string `json:"singular,omitempty"`
	// shortNames are short names for the resource, exposed in API discovery documents,
	// and used by clients to support invocations like `kubectl get <shortname>`.
	// It must be all lowercase.
	// +optional
	ShortNames []string `json:"shortNames,omitempty"`
	// kind is the serialized kind of the resource. It is normally CamelCase and singular.
	// Custom resource instances will use this value as the `kind` attribute in API calls.
	Kind string `json:"kind"`
	// listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
	// +optional
	ListKind string `json:"listKind,omitempty"`
	// categories is a list of grouped resources this custom resource belongs to (e.g. 'all').
	// This is published in API discovery documents, and used by clients to support invocations like
	// `kubectl get all`.
	// +optional
	Categories []string `json:"categories,omitempty"`
}

type CustomResourceDefinitionVersion

type CustomResourceDefinitionVersion struct {
	Name    string `json:"name"`
	Served  bool   `json:"served"`
	Storage bool   `json:"storage"`
}

type CustomResourceObject

type CustomResourceObject struct {
	TypeMeta   api.TypeMeta   `json:"typeMeta"`
	ObjectMeta api.ObjectMeta `json:"objectMeta"`
}

CustomResourceObject represents a custom resource object.

func (*CustomResourceObject) UnmarshalJSON

func (r *CustomResourceObject) UnmarshalJSON(data []byte) error

type CustomResourceObjectDetail

type CustomResourceObjectDetail struct {
	CustomResourceObject `json:",inline"`

	// List of non-critical errors, that occurred during resource retrieval.
	Errors []error `json:"errors"`
}

type CustomResourceObjectList

type CustomResourceObjectList struct {
	TypeMeta metav1.TypeMeta `json:"typeMeta"`
	ListMeta api.ListMeta    `json:"listMeta"`

	// Unordered list of custom resource definitions
	Items []CustomResourceObject `json:"items"`

	// List of non-critical errors, that occurred during resource retrieval.
	Errors []error `json:"errors"`
}

CustomResourceObjectList represents crd objects in a namespace.

func (*CustomResourceObjectList) UnmarshalJSON

func (r *CustomResourceObjectList) UnmarshalJSON(data []byte) error