v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the sentinel v1alpha1 API group +kubebuilder:object:generate=true +groupName=sentinel.sentinelguard.io

Index

• Variables
• type Dashboard
  • func (in *Dashboard) DeepCopy() *Dashboard
  • func (in *Dashboard) DeepCopyInto(out *Dashboard)
  • func (in *Dashboard) DeepCopyObject() runtime.Object
  • func (s *Dashboard) String() string
• type DashboardCondition
• type DashboardConditionType
• type DashboardList
  • func (in *DashboardList) DeepCopy() *DashboardList
  • func (in *DashboardList) DeepCopyInto(out *DashboardList)
  • func (in *DashboardList) DeepCopyObject() runtime.Object
• type DashboardSpec
  • func (in *DashboardSpec) DeepCopy() *DashboardSpec
  • func (in *DashboardSpec) DeepCopyInto(out *DashboardSpec)
• type DashboardStatus
  • func (in *DashboardStatus) DeepCopy() *DashboardStatus
  • func (in *DashboardStatus) DeepCopyInto(out *DashboardStatus)
• type Phase

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "sentinel.sentinelguard.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type Dashboard

type Dashboard struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DashboardSpec   `json:"spec,omitempty"`
	Status DashboardStatus `json:"status,omitempty"`
}

Dashboard is the Schema for the dashboards API

func (*Dashboard) DeepCopy

func (in *Dashboard) DeepCopy() *Dashboard

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

func (*Dashboard) DeepCopyInto

func (in *Dashboard) DeepCopyInto(out *Dashboard)

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

func (*Dashboard) DeepCopyObject

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

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

func (*Dashboard) String

func (s *Dashboard) String() string

type DashboardCondition

type DashboardCondition struct {
	// type of condition in CamelCase or in foo.example.com/CamelCase.
	// ---
	// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
	// useful (see .node.status.conditions), the ability to deconflict is important.
	// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
	// +optional
	Type string `json:"type" protobuf:"bytes,1,opt,name=type"`
	// status of the condition, one of True, False, Unknown.
	// +optional
	Status metav1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status"`
	// observedGeneration represents the .metadata.generation that the condition was set based upon.
	// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
	// with respect to the current state of the instance.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,3,opt,name=observedGeneration"`
	// lastTransitionTime is the last time the condition transitioned from one status to another.
	// This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime" protobuf:"bytes,4,opt,name=lastTransitionTime"`
	// reason contains a programmatic identifier indicating the reason for the condition's last transition.
	// Producers of specific condition types may define expected values and meanings for this field,
	// and whether the values are considered a guaranteed API.
	// The value should be a CamelCase string.
	// This field may not be empty.
	// +optional
	Reason string `json:"reason" protobuf:"bytes,5,opt,name=reason"`
	// message is a human readable message indicating details about the transition.
	// This may be an empty string.
	// +optional
	Message string `json:"message" protobuf:"bytes,6,opt,name=message"`
}

type DashboardConditionType

type DashboardConditionType string

const (
	AppliedConditionType DashboardConditionType = "Applied"
	ReadyConditionType   DashboardConditionType = "Ready"
)

type DashboardList

type DashboardList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Dashboard `json:"items"`
}

DashboardList contains a list of Dashboard

func (*DashboardList) DeepCopy

func (in *DashboardList) DeepCopy() *DashboardList

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

func (*DashboardList) DeepCopyInto

func (in *DashboardList) DeepCopyInto(out *DashboardList)

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

func (*DashboardList) DeepCopyObject

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

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

type DashboardSpec

type DashboardSpec struct {

	// Number of desired pods. This is a pointer to distinguish between explicit
	// zero and not specified. Defaults to 1.
	// +optional
	Replicas *int32 `json:"replicas,omitempty"`

	// Container image name.
	// More info: https://kubernetes.io/docs/concepts/containers/images
	// This field is optional to allow higher level config management to default or override
	// container images in workload controllers like Deployments and StatefulSets.
	// +optional
	Image string `json:"image,omitempty"`

	// type determines how the Service is exposed. Defaults to ClusterIP. Valid
	// options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
	// "ClusterIP" allocates a cluster-internal IP address for load-balancing
	// to endpoints. Endpoints are determined by the selector or if that is not
	// specified, by manual construction of an Endpoints object or
	// EndpointSlice objects. If clusterIP is "None", no virtual IP is
	// allocated and the endpoints are published as a set of endpoints rather
	// than a virtual IP.
	// "NodePort" builds on ClusterIP and allocates a port on every node which
	// routes to the same endpoints as the clusterIP.
	// "LoadBalancer" builds on NodePort and creates an external load-balancer
	// (if supported in the current cloud) which routes to the same endpoints
	// as the clusterIP.
	// "ExternalName" aliases this service to the specified externalName.
	// Several other fields do not apply to ExternalName services.
	// More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
	// +optional
	Type corev1.ServiceType `json:"type,omitempty"`

	// The list of ports that are exposed by this service.
	// More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
	// +patchMergeKey=port
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=port
	// +listMapKey=protocol
	Ports []corev1.ServicePort `json:"ports,omitempty"`

	// List of environment variables to set in the container.
	// Cannot be updated.
	// +optional
	Env []corev1.EnvVar `json:"env,omitempty"`

	// Compute Resources required by this container.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty" protobuf:"bytes,8,opt,name=resources"`
}

DashboardSpec defines the desired state of Dashboard

func (*DashboardSpec) DeepCopy

func (in *DashboardSpec) DeepCopy() *DashboardSpec

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

func (*DashboardSpec) DeepCopyInto

func (in *DashboardSpec) DeepCopyInto(out *DashboardSpec)

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

type DashboardStatus

type DashboardStatus struct {

	// +optional
	Phase Phase `json:"phase,omitempty"`

	Conditions []DashboardCondition `json:"conditions,omitempty"`
}

DashboardStatus defines the observed state of Dashboard

func (*DashboardStatus) DeepCopy

func (in *DashboardStatus) DeepCopy() *DashboardStatus

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

func (*DashboardStatus) DeepCopyInto

func (in *DashboardStatus) DeepCopyInto(out *DashboardStatus)

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

type Phase

type Phase string

const (
	PhaseWaiting  Phase = "Waiting"
	PhaseRunning  Phase = "Running"
	PhaseDeleting Phase = "Deleting"
	PhaseNotReady Phase = "NotReady"
)