cluster

Documentation

Overview

Package cluster is the internal version of the API.

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type Cluster
  • func (in *Cluster) DeepCopy() *Cluster
  • func (in *Cluster) DeepCopyInto(out *Cluster)
  • func (in *Cluster) DeepCopyObject() runtime.Object
• type ClusterAccess
  • func (in *ClusterAccess) DeepCopy() *ClusterAccess
  • func (in *ClusterAccess) DeepCopyInto(out *ClusterAccess)
• type ClusterAccessCredential
  • func (in *ClusterAccessCredential) DeepCopy() *ClusterAccessCredential
  • func (in *ClusterAccessCredential) DeepCopyInto(out *ClusterAccessCredential)
• type ClusterList
  • func (in *ClusterList) DeepCopy() *ClusterList
  • func (in *ClusterList) DeepCopyInto(out *ClusterList)
  • func (in *ClusterList) DeepCopyObject() runtime.Object
• type ClusterProxyOptions
  • func (in *ClusterProxyOptions) DeepCopy() *ClusterProxyOptions
  • func (in *ClusterProxyOptions) DeepCopyInto(out *ClusterProxyOptions)
  • func (in *ClusterProxyOptions) DeepCopyObject() runtime.Object
• type ClusterSpec
  • func (in *ClusterSpec) DeepCopy() *ClusterSpec
  • func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
• type ClusterStatus
  • func (in *ClusterStatus) DeepCopy() *ClusterStatus
  • func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
• type CredentialType
• type X509
  • func (in *X509) DeepCopy() *X509
  • func (in *X509) DeepCopyInto(out *X509)

Constants

const GroupName = "cluster.karpor.io"

GroupName is the group name used in this package

Variables

var (
	// SchemeBuilder is the scheme builder with scheme init functions to run for
	// this API package.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a common registration function for mapping packaged scoped
	// group & version keys to a scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{
	Group:   GroupName,
	Version: runtime.APIVersionInternal,
}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

Types

type Cluster

type Cluster struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"` //nolint:tagliatelle

	Spec   ClusterSpec   `json:"spec"`
	Status ClusterStatus `json:"status,omitempty"`
}

Cluster is an extension type to access a cluster

func (*Cluster) DeepCopy

func (in *Cluster) DeepCopy() *Cluster

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

func (*Cluster) DeepCopyInto

func (in *Cluster) DeepCopyInto(out *Cluster)

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

func (*Cluster) DeepCopyObject

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

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

type ClusterAccess

type ClusterAccess struct {
	Endpoint string `json:"endpoint"`
	// +optional
	CABundle   []byte                   `json:"caBundle,omitempty"`
	Insecure   *bool                    `json:"insecure,omitempty"`
	Credential *ClusterAccessCredential `json:"credential,omitempty"`
}

func (*ClusterAccess) DeepCopy

func (in *ClusterAccess) DeepCopy() *ClusterAccess

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

func (*ClusterAccess) DeepCopyInto

func (in *ClusterAccess) DeepCopyInto(out *ClusterAccess)

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

type ClusterAccessCredential

type ClusterAccessCredential struct {
	Type CredentialType `json:"type"`
	// +optional
	ServiceAccountToken string `json:"serviceAccountToken,omitempty"`
	X509                *X509  `json:"x509,omitempty"`
}

func (*ClusterAccessCredential) DeepCopy

func (in *ClusterAccessCredential) DeepCopy() *ClusterAccessCredential

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

func (*ClusterAccessCredential) DeepCopyInto

func (in *ClusterAccessCredential) DeepCopyInto(out *ClusterAccessCredential)

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

type ClusterList

type ClusterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"` //nolint:tagliatelle

	Items []Cluster `json:"items"`
}

ClusterList is a list of Cluster objects.

func (*ClusterList) DeepCopy

func (in *ClusterList) DeepCopy() *ClusterList

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

func (*ClusterList) DeepCopyInto

func (in *ClusterList) DeepCopyInto(out *ClusterList)

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

func (*ClusterList) DeepCopyObject

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

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

type ClusterProxyOptions

type ClusterProxyOptions struct {
	metav1.TypeMeta `json:",inline"`

	// Path is the target api path of the proxy request.
	// e.g. "/healthz", "/api/v1"
	Path string `json:"path,omitempty"`
}

func (*ClusterProxyOptions) DeepCopy

func (in *ClusterProxyOptions) DeepCopy() *ClusterProxyOptions

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

func (*ClusterProxyOptions) DeepCopyInto

func (in *ClusterProxyOptions) DeepCopyInto(out *ClusterProxyOptions)

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

func (*ClusterProxyOptions) DeepCopyObject

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

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

type ClusterSpec

type ClusterSpec struct {
	Provider string        `json:"provider"`
	Access   ClusterAccess `json:"access"`
	// +optional
	Description string `json:"description,omitempty"`
	DisplayName string `json:"displayName,omitempty"`
	Finalized   *bool  `json:"finalized,omitempty"`
}

func (*ClusterSpec) DeepCopy

func (in *ClusterSpec) DeepCopy() *ClusterSpec

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

func (*ClusterSpec) DeepCopyInto

func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)

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

type ClusterStatus

type ClusterStatus struct {
	Healthy bool `json:"healthy,omitempty"`
}

func (*ClusterStatus) DeepCopy

func (in *ClusterStatus) DeepCopy() *ClusterStatus

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

func (*ClusterStatus) DeepCopyInto

func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)

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

type CredentialType

type CredentialType string

const (
	CredentialTypeServiceAccountToken CredentialType = "ServiceAccountToken"
	CredentialTypeX509Certificate     CredentialType = "X509Certificate"
)

type X509

type X509 struct {
	Certificate []byte `json:"certificate"`
	PrivateKey  []byte `json:"privateKey"`
}

func (*X509) DeepCopy

func (in *X509) DeepCopy() *X509

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

func (*X509) DeepCopyInto

func (in *X509) DeepCopyInto(out *X509)

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