Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the nauticus.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=nauticus.io
Index ¶
- Constants
- Variables
- type AdditionalRoleBinding
- type AdditionalRoleBindingsSpec
- type Annotations
- type ConditionMessage
- type ConditionReason
- type ConditionType
- type LimitRangesSpec
- type NetworkPolicies
- type ServiceAccountSpec
- type ServiceAccountsSpec
- type Space
- type SpaceList
- type SpaceSpec
- type SpaceStatus
- type SpaceTemplate
- type SpaceTemplateList
- type SpaceTemplateReference
- type SpaceTemplateSpec
- type SpaceTemplateStatus
Constants ¶
const (
IgnoreUnderlyingDeletionAnnotation = "nauticus.io/ignore-underlying-deletion"
)
Variables ¶
var ( // GroupVersion is group version used to register these objects. GroupVersion = schema.GroupVersion{Group: "nauticus.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 )
var SpaceKind = reflect.TypeOf(Space{}).Name()
Functions ¶
This section is empty.
Types ¶
type AdditionalRoleBinding ¶
type AdditionalRoleBinding struct { RoleRef v1.RoleRef `json:"roleRef,omitempty"` Subjects []v1.Subject `json:"subjects,omitempty"` }
func (*AdditionalRoleBinding) DeepCopy ¶
func (in *AdditionalRoleBinding) DeepCopy() *AdditionalRoleBinding
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdditionalRoleBinding.
func (*AdditionalRoleBinding) DeepCopyInto ¶
func (in *AdditionalRoleBinding) DeepCopyInto(out *AdditionalRoleBinding)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AdditionalRoleBindingsSpec ¶
type AdditionalRoleBindingsSpec []AdditionalRoleBinding
func (AdditionalRoleBindingsSpec) DeepCopy ¶
func (in AdditionalRoleBindingsSpec) DeepCopy() AdditionalRoleBindingsSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdditionalRoleBindingsSpec.
func (AdditionalRoleBindingsSpec) DeepCopyInto ¶
func (in AdditionalRoleBindingsSpec) DeepCopyInto(out *AdditionalRoleBindingsSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Annotations ¶
func (Annotations) DeepCopy ¶
func (in Annotations) DeepCopy() Annotations
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Annotations.
func (Annotations) DeepCopyInto ¶
func (in Annotations) DeepCopyInto(out *Annotations)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConditionMessage ¶ added in v0.1.1
type ConditionMessage string
type ConditionReason ¶ added in v0.1.1
type ConditionReason string
type ConditionType ¶ added in v0.1.1
type ConditionType string
type LimitRangesSpec ¶
type LimitRangesSpec struct {
Items []corev1.LimitRangeSpec `json:"items,omitempty"`
}
func (*LimitRangesSpec) DeepCopy ¶
func (in *LimitRangesSpec) DeepCopy() *LimitRangesSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LimitRangesSpec.
func (*LimitRangesSpec) DeepCopyInto ¶
func (in *LimitRangesSpec) DeepCopyInto(out *LimitRangesSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NetworkPolicies ¶
type NetworkPolicies struct { EnableDefaultStrictMode bool `json:"enableDefaultStrictMode,omitempty"` Items []networkingv1.NetworkPolicySpec `json:"items,omitempty"` }
func (*NetworkPolicies) DeepCopy ¶
func (in *NetworkPolicies) DeepCopy() *NetworkPolicies
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPolicies.
func (*NetworkPolicies) DeepCopyInto ¶
func (in *NetworkPolicies) DeepCopyInto(out *NetworkPolicies)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ServiceAccountSpec ¶
type ServiceAccountSpec struct { // Specifies the service account name to be created. Required Name string `json:"name,omitempty"` // Specifies the annotations to be placed in the ServiceAccount. Optional Annotations Annotations `json:"annotations,omitempty"` }
func (*ServiceAccountSpec) DeepCopy ¶
func (in *ServiceAccountSpec) DeepCopy() *ServiceAccountSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceAccountSpec.
func (*ServiceAccountSpec) DeepCopyInto ¶
func (in *ServiceAccountSpec) DeepCopyInto(out *ServiceAccountSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ServiceAccountsSpec ¶
type ServiceAccountsSpec struct { // Specifies the list of Service Account to be created. Optional Items []ServiceAccountSpec `json:"items,omitempty"` }
func (*ServiceAccountsSpec) DeepCopy ¶
func (in *ServiceAccountsSpec) DeepCopy() *ServiceAccountsSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceAccountsSpec.
func (*ServiceAccountsSpec) DeepCopyInto ¶
func (in *ServiceAccountsSpec) DeepCopyInto(out *ServiceAccountsSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Space ¶
type Space struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec SpaceSpec `json:"spec,omitempty"` Status SpaceStatus `json:"status,omitempty"` }
Space is the Schema for the spaces API.
func (*Space) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Space.
func (*Space) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Space) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Space) GetConditions ¶ added in v0.2.0
func (*Space) HasIgnoreUnderlyingDeletionAnnotation ¶ added in v0.1.2
func (*Space) SetConditions ¶ added in v0.2.0
type SpaceList ¶
type SpaceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Space `json:"items"` }
SpaceList contains a list of Space.
func (*SpaceList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpaceList.
func (*SpaceList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SpaceList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SpaceSpec ¶
type SpaceSpec struct { // Specifies a list of ResourceQuota resources assigned to the Space. The assigned values are inherited by the namespace created by the Space. Optional. ResourceQuota corev1.ResourceQuotaSpec `json:"resourceQuota,omitempty"` // Specifies the owners of the Space. Mandatory. Owners []v1.Subject `json:"owners,omitempty"` // Specifies additional RoleBindings assigned to the Space. Nauticus will ensure that the namespace in the Space always contain the RoleBinding for the given ClusterRole. Optional. AdditionalRoleBindings AdditionalRoleBindingsSpec `json:"additionalRoleBindings,omitempty"` // Specifies the NetworkPolicies assigned to the Tenant. The assigned NetworkPolicies are inherited by the namespace created in the Space. Optional. NetworkPolicies NetworkPolicies `json:"networkPolicies,omitempty"` // Specifies the resource min/max usage restrictions to the Space. Optional. LimitRanges LimitRangesSpec `json:"limitRanges,omitempty"` // Specifies a list of service account to create within the Space. Optional ServiceAccounts ServiceAccountsSpec `json:"serviceAccounts,omitempty"` // Reference to a SpaceTemplate TemplateRef SpaceTemplateReference `json:"templateRef,omitempty"` }
SpaceSpec defines the desired state of Space.
func (*SpaceSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpaceSpec.
func (*SpaceSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SpaceStatus ¶
type SpaceStatus struct { // NamespaceName the name of the created underlying namespace. NamespaceName string `json:"namespaceName,omitempty"` // Conditions List of status conditions to indicate the status of Space Conditions []metav1.Condition `json:"conditions,omitempty"` }
SpaceStatus defines the observed state of Space.
func (*SpaceStatus) DeepCopy ¶
func (in *SpaceStatus) DeepCopy() *SpaceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpaceStatus.
func (*SpaceStatus) DeepCopyInto ¶
func (in *SpaceStatus) DeepCopyInto(out *SpaceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SpaceTemplate ¶ added in v0.2.0
type SpaceTemplate struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec SpaceTemplateSpec `json:"spec,omitempty"` Status SpaceTemplateStatus `json:"status,omitempty"` }
SpaceTemplate is the Schema for the spacetemplates API.
func (*SpaceTemplate) DeepCopy ¶ added in v0.2.0
func (in *SpaceTemplate) DeepCopy() *SpaceTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpaceTemplate.
func (*SpaceTemplate) DeepCopyInto ¶ added in v0.2.0
func (in *SpaceTemplate) DeepCopyInto(out *SpaceTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SpaceTemplate) DeepCopyObject ¶ added in v0.2.0
func (in *SpaceTemplate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*SpaceTemplate) GetConditions ¶ added in v0.2.0
func (in *SpaceTemplate) GetConditions() []metav1.Condition
func (*SpaceTemplate) SetConditions ¶ added in v0.2.0
func (in *SpaceTemplate) SetConditions(conditions []metav1.Condition)
type SpaceTemplateList ¶ added in v0.2.0
type SpaceTemplateList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []SpaceTemplate `json:"items"` }
SpaceTemplateList contains a list of SpaceTemplate.
func (*SpaceTemplateList) DeepCopy ¶ added in v0.2.0
func (in *SpaceTemplateList) DeepCopy() *SpaceTemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpaceTemplateList.
func (*SpaceTemplateList) DeepCopyInto ¶ added in v0.2.0
func (in *SpaceTemplateList) DeepCopyInto(out *SpaceTemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SpaceTemplateList) DeepCopyObject ¶ added in v0.2.0
func (in *SpaceTemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SpaceTemplateReference ¶ added in v0.2.0
type SpaceTemplateReference struct { // Name of the SpaceTemplate. Name string `json:"name,omitempty"` // Kind specifies the kind of the referenced resource, which should be "SpaceTemplate". Kind string `json:"kind,omitempty"` // Group is the API group of the SpaceTemplate, "nauticus.io/v1alpha1". Group string `json:"group,omitempty"` }
SpaceTemplateReference.
func (*SpaceTemplateReference) DeepCopy ¶ added in v0.2.0
func (in *SpaceTemplateReference) DeepCopy() *SpaceTemplateReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpaceTemplateReference.
func (*SpaceTemplateReference) DeepCopyInto ¶ added in v0.2.0
func (in *SpaceTemplateReference) DeepCopyInto(out *SpaceTemplateReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SpaceTemplateSpec ¶ added in v0.2.0
type SpaceTemplateSpec struct { // Specifies a list of ResourceQuota resources assigned to the Space. The assigned values are inherited by the namespace created by the Space. Optional. ResourceQuota corev1.ResourceQuotaSpec `json:"resourceQuota,omitempty"` // Specifies additional RoleBindings assigned to the Space. Nauticus will ensure that the namespace in the Space always contain the RoleBinding for the given ClusterRole. Optional. AdditionalRoleBindings AdditionalRoleBindingsSpec `json:"additionalRoleBindings,omitempty"` // Specifies the NetworkPolicies assigned to the Tenant. The assigned NetworkPolicies are inherited by the namespace created in the Space. Optional. NetworkPolicies NetworkPolicies `json:"networkPolicies,omitempty"` // Specifies the resource min/max usage restrictions to the Space. Optional. LimitRanges LimitRangesSpec `json:"limitRanges,omitempty"` }
SpaceTemplateSpec defines the desired state of SpaceTemplate.
func (*SpaceTemplateSpec) DeepCopy ¶ added in v0.2.0
func (in *SpaceTemplateSpec) DeepCopy() *SpaceTemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpaceTemplateSpec.
func (*SpaceTemplateSpec) DeepCopyInto ¶ added in v0.2.0
func (in *SpaceTemplateSpec) DeepCopyInto(out *SpaceTemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SpaceTemplateStatus ¶ added in v0.2.0
type SpaceTemplateStatus struct { // Conditions List of status conditions to indicate the status of Space Conditions []metav1.Condition `json:"conditions,omitempty"` }
SpaceTemplateStatus defines the observed state of SpaceTemplate.
func (*SpaceTemplateStatus) DeepCopy ¶ added in v0.2.0
func (in *SpaceTemplateStatus) DeepCopy() *SpaceTemplateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpaceTemplateStatus.
func (*SpaceTemplateStatus) DeepCopyInto ¶ added in v0.2.0
func (in *SpaceTemplateStatus) DeepCopyInto(out *SpaceTemplateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.