Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the v1 API group. +kubebuilder:object:generate=true +groupName=netbird.io
Index ¶
- Variables
- type NBCondition
- type NBConditionType
- type NBGroup
- type NBGroupList
- type NBGroupSpec
- type NBGroupStatus
- type NBPolicy
- type NBPolicyList
- type NBPolicySpec
- type NBPolicyStatus
- type NBResource
- type NBResourceList
- type NBResourceSpec
- type NBResourceStatus
- type NBRoutingPeer
- type NBRoutingPeerList
- type NBRoutingPeerSpec
- type NBRoutingPeerStatus
- type NBSetupKey
- type NBSetupKeyList
- type NBSetupKeySpec
- type NBSetupKeyStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects. GroupVersion = schema.GroupVersion{Group: "netbird.io", Version: "v1"} // 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 )
Functions ¶
This section is empty.
Types ¶
type NBCondition ¶
type NBCondition struct {
// Type is the type of the condition.
Type NBConditionType `json:"type"`
// Status is the status of the condition.
// Can be True, False, Unknown.
Status corev1.ConditionStatus `json:"status"`
// Last time we probed the condition.
// +optional
LastProbeTime metav1.Time `json:"lastProbeTime,omitempty"`
// Last time the condition transitioned from one status to another.
// +optional
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
// Unique, one-word, CamelCase reason for the condition's last transition.
// +optional
Reason string `json:"reason,omitempty"`
// Human-readable message indicating details about last transition.
// +optional
Message string `json:"message,omitempty"`
}
NBCondition defines a condition in NBSetupKey status.
func NBConditionFalse ¶
func NBConditionFalse(reason, msg string) []NBCondition
NBConditionFalse returns default false condition
func NBConditionTrue ¶
func NBConditionTrue() []NBCondition
NBConditionTrue returns default true condition
func (*NBCondition) DeepCopy ¶
func (in *NBCondition) DeepCopy() *NBCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBCondition.
func (*NBCondition) DeepCopyInto ¶
func (in *NBCondition) DeepCopyInto(out *NBCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NBConditionType ¶
type NBConditionType string
NBConditionType is a valid value for PodCondition.Type
const ( // NBSetupKeyReady indicates whether NBSetupKey is valid and ready to use. NBSetupKeyReady NBConditionType = "Ready" )
These are built-in conditions of pod. An application may use a custom condition not listed here.
type NBGroup ¶
type NBGroup struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec NBGroupSpec `json:"spec,omitempty"`
Status NBGroupStatus `json:"status,omitempty"`
}
NBGroup is the Schema for the nbgroups API.
func (*NBGroup) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBGroup.
func (*NBGroup) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBGroup) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBGroupList ¶
type NBGroupList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NBGroup `json:"items"`
}
NBGroupList contains a list of NBGroup.
func (*NBGroupList) DeepCopy ¶
func (in *NBGroupList) DeepCopy() *NBGroupList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBGroupList.
func (*NBGroupList) DeepCopyInto ¶
func (in *NBGroupList) DeepCopyInto(out *NBGroupList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBGroupList) DeepCopyObject ¶
func (in *NBGroupList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBGroupSpec ¶
type NBGroupSpec struct {
// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
// +kubebuilder:validation:MinLength=1
Name string `json:"name"`
}
NBGroupSpec defines the desired state of NBGroup.
func (*NBGroupSpec) DeepCopy ¶
func (in *NBGroupSpec) DeepCopy() *NBGroupSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBGroupSpec.
func (*NBGroupSpec) DeepCopyInto ¶
func (in *NBGroupSpec) DeepCopyInto(out *NBGroupSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NBGroupStatus ¶
type NBGroupStatus struct {
// +optional
GroupID *string `json:"groupID"`
// +optional
Conditions []NBCondition `json:"conditions,omitempty"`
}
NBGroupStatus defines the observed state of NBGroup.
func (*NBGroupStatus) DeepCopy ¶
func (in *NBGroupStatus) DeepCopy() *NBGroupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBGroupStatus.
func (*NBGroupStatus) DeepCopyInto ¶
func (in *NBGroupStatus) DeepCopyInto(out *NBGroupStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NBGroupStatus) Equal ¶
func (a NBGroupStatus) Equal(b NBGroupStatus) bool
Equal returns if NBGroupStatus is equal to this one
type NBPolicy ¶
type NBPolicy struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec NBPolicySpec `json:"spec,omitempty"`
Status NBPolicyStatus `json:"status,omitempty"`
}
NBPolicy is the Schema for the nbpolicies API.
func (*NBPolicy) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBPolicy.
func (*NBPolicy) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBPolicy) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBPolicyList ¶
type NBPolicyList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NBPolicy `json:"items"`
}
NBPolicyList contains a list of NBPolicy.
func (*NBPolicyList) DeepCopy ¶
func (in *NBPolicyList) DeepCopy() *NBPolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBPolicyList.
func (*NBPolicyList) DeepCopyInto ¶
func (in *NBPolicyList) DeepCopyInto(out *NBPolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBPolicyList) DeepCopyObject ¶
func (in *NBPolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBPolicySpec ¶
type NBPolicySpec struct {
// Name Policy name
// +kubebuilder:validation:MinLength=1
Name string `json:"name"`
// +optional
Description string `json:"description,omitempty"`
// +optional
// +kubebuilder:validation:items:MinLength=1
SourceGroups []string `json:"sourceGroups,omitempty"`
// +optional
// +kubebuilder:validation:items:MinLength=1
DestinationGroups []string `json:"destinationGroups,omitempty"`
// +optional
// +kubebuilder:validation:items:Enum=tcp;udp
Protocols []string `json:"protocols,omitempty"`
// +optional
// +kubebuilder:validation:items:Minimum=0
// +kubebuilder:validation:items:Maximum=65535
Ports []int32 `json:"ports,omitempty"`
// +optional
// +default:value=true
Bidirectional bool `json:"bidirectional"`
}
NBPolicySpec defines the desired state of NBPolicy.
func (*NBPolicySpec) DeepCopy ¶
func (in *NBPolicySpec) DeepCopy() *NBPolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBPolicySpec.
func (*NBPolicySpec) DeepCopyInto ¶
func (in *NBPolicySpec) DeepCopyInto(out *NBPolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NBPolicyStatus ¶
type NBPolicyStatus struct {
// +optional
TCPPolicyID *string `json:"tcpPolicyID"`
// +optional
UDPPolicyID *string `json:"udpPolicyID"`
// +optional
LastUpdatedAt *metav1.Time `json:"lastUpdatedAt"`
// +optional
ManagedServiceList []string `json:"managedServiceList"`
// +optional
Conditions []NBCondition `json:"conditions,omitempty"`
}
NBPolicyStatus defines the observed state of NBPolicy.
func (*NBPolicyStatus) DeepCopy ¶
func (in *NBPolicyStatus) DeepCopy() *NBPolicyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBPolicyStatus.
func (*NBPolicyStatus) DeepCopyInto ¶
func (in *NBPolicyStatus) DeepCopyInto(out *NBPolicyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NBPolicyStatus) Equal ¶
func (a NBPolicyStatus) Equal(b NBPolicyStatus) bool
Equal returns if NBPolicyStatus is equal to this one
type NBResource ¶
type NBResource struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec NBResourceSpec `json:"spec,omitempty"`
Status NBResourceStatus `json:"status,omitempty"`
}
NBResource is the Schema for the nbresources API.
func (*NBResource) DeepCopy ¶
func (in *NBResource) DeepCopy() *NBResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBResource.
func (*NBResource) DeepCopyInto ¶
func (in *NBResource) DeepCopyInto(out *NBResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBResource) DeepCopyObject ¶
func (in *NBResource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBResourceList ¶
type NBResourceList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NBResource `json:"items"`
}
NBResourceList contains a list of NBResource.
func (*NBResourceList) DeepCopy ¶
func (in *NBResourceList) DeepCopy() *NBResourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBResourceList.
func (*NBResourceList) DeepCopyInto ¶
func (in *NBResourceList) DeepCopyInto(out *NBResourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBResourceList) DeepCopyObject ¶
func (in *NBResourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBResourceSpec ¶
type NBResourceSpec struct {
// +kubebuilder:validation:MinLength=1
Name string `json:"name"`
// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
NetworkID string `json:"networkID"`
// +kubebuilder:validation:MinLength=1
Address string `json:"address"`
// +kubebuilder:validation:items:MinLength=1
Groups []string `json:"groups"`
// +optional
PolicyName string `json:"policyName,omitempty"`
// +optional
PolicySourceGroups []string `json:"policySourceGroups,omitempty"`
// +optional
PolicyFriendlyName map[string]string `json:"policyFriendlyName,omitempty"`
// +optional
TCPPorts []int32 `json:"tcpPorts,omitempty"`
// +optional
UDPPorts []int32 `json:"udpPorts,omitempty"`
}
NBResourceSpec defines the desired state of NBResource.
func (*NBResourceSpec) DeepCopy ¶
func (in *NBResourceSpec) DeepCopy() *NBResourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBResourceSpec.
func (*NBResourceSpec) DeepCopyInto ¶
func (in *NBResourceSpec) DeepCopyInto(out *NBResourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NBResourceSpec) Equal ¶ added in v0.1.2
func (a NBResourceSpec) Equal(b NBResourceSpec) bool
Equal returns if NBResource is equal to this one
type NBResourceStatus ¶
type NBResourceStatus struct {
// +optional
NetworkResourceID *string `json:"networkResourceID,omitempty"`
// +optional
PolicyName *string `json:"policyName,omitempty"`
// +optional
TCPPorts []int32 `json:"tcpPorts,omitempty"`
// +optional
UDPPorts []int32 `json:"udpPorts,omitempty"`
// +optional
Groups []string `json:"groups,omitempty"`
// +optional
PolicySourceGroups []string `json:"policySourceGroups,omitempty"`
// +optional
PolicyFriendlyName map[string]string `json:"policyFriendlyName,omitempty"`
// +optional
Conditions []NBCondition `json:"conditions,omitempty"`
// +optional
PolicyNameMapping map[string]string `json:"policyNameMapping"`
}
NBResourceStatus defines the observed state of NBResource.
func (*NBResourceStatus) DeepCopy ¶
func (in *NBResourceStatus) DeepCopy() *NBResourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBResourceStatus.
func (*NBResourceStatus) DeepCopyInto ¶
func (in *NBResourceStatus) DeepCopyInto(out *NBResourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NBResourceStatus) Equal ¶
func (a NBResourceStatus) Equal(b NBResourceStatus) bool
Equal returns if NBResourceStatus is equal to this one
type NBRoutingPeer ¶
type NBRoutingPeer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec NBRoutingPeerSpec `json:"spec,omitempty"`
Status NBRoutingPeerStatus `json:"status,omitempty"`
}
NBRoutingPeer is the Schema for the nbroutingpeers API.
func (*NBRoutingPeer) DeepCopy ¶
func (in *NBRoutingPeer) DeepCopy() *NBRoutingPeer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBRoutingPeer.
func (*NBRoutingPeer) DeepCopyInto ¶
func (in *NBRoutingPeer) DeepCopyInto(out *NBRoutingPeer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBRoutingPeer) DeepCopyObject ¶
func (in *NBRoutingPeer) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBRoutingPeerList ¶
type NBRoutingPeerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NBRoutingPeer `json:"items"`
}
NBRoutingPeerList contains a list of NBRoutingPeer.
func (*NBRoutingPeerList) DeepCopy ¶
func (in *NBRoutingPeerList) DeepCopy() *NBRoutingPeerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBRoutingPeerList.
func (*NBRoutingPeerList) DeepCopyInto ¶
func (in *NBRoutingPeerList) DeepCopyInto(out *NBRoutingPeerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBRoutingPeerList) DeepCopyObject ¶
func (in *NBRoutingPeerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBRoutingPeerSpec ¶
type NBRoutingPeerSpec struct {
// +optional
Replicas *int32 `json:"replicas"`
// +optional
Resources corev1.ResourceRequirements `json:"resources"`
// +optional
Labels map[string]string `json:"labels"`
// +optional
Annotations map[string]string `json:"annotations"`
// +optional
NodeSelector map[string]string `json:"nodeSelector"`
// +optional
Tolerations []corev1.Toleration `json:"tolerations"`
// +optional
Volumes []corev1.Volume `json:"volumes"`
// +optional
VolumeMounts []corev1.VolumeMount `json:"volumeMounts"`
}
NBRoutingPeerSpec defines the desired state of NBRoutingPeer.
func (*NBRoutingPeerSpec) DeepCopy ¶
func (in *NBRoutingPeerSpec) DeepCopy() *NBRoutingPeerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBRoutingPeerSpec.
func (*NBRoutingPeerSpec) DeepCopyInto ¶
func (in *NBRoutingPeerSpec) DeepCopyInto(out *NBRoutingPeerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NBRoutingPeerStatus ¶
type NBRoutingPeerStatus struct {
// +optional
NetworkID *string `json:"networkID"`
// +optional
SetupKeyID *string `json:"setupKeyID"`
// +optional
RouterID *string `json:"routerID"`
// +optional
Conditions []NBCondition `json:"conditions,omitempty"`
}
NBRoutingPeerStatus defines the observed state of NBRoutingPeer.
func (*NBRoutingPeerStatus) DeepCopy ¶
func (in *NBRoutingPeerStatus) DeepCopy() *NBRoutingPeerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBRoutingPeerStatus.
func (*NBRoutingPeerStatus) DeepCopyInto ¶
func (in *NBRoutingPeerStatus) DeepCopyInto(out *NBRoutingPeerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NBRoutingPeerStatus) Equal ¶
func (a NBRoutingPeerStatus) Equal(b NBRoutingPeerStatus) bool
Equal returns if NBRoutingPeerStatus is equal to this one
type NBSetupKey ¶
type NBSetupKey struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec NBSetupKeySpec `json:"spec,omitempty"`
Status NBSetupKeyStatus `json:"status,omitempty"`
}
NBSetupKey is the Schema for the nbsetupkeys API.
func (*NBSetupKey) DeepCopy ¶
func (in *NBSetupKey) DeepCopy() *NBSetupKey
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBSetupKey.
func (*NBSetupKey) DeepCopyInto ¶
func (in *NBSetupKey) DeepCopyInto(out *NBSetupKey)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBSetupKey) DeepCopyObject ¶
func (in *NBSetupKey) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBSetupKeyList ¶
type NBSetupKeyList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NBSetupKey `json:"items"`
}
NBSetupKeyList contains a list of NBSetupKey.
func (*NBSetupKeyList) DeepCopy ¶
func (in *NBSetupKeyList) DeepCopy() *NBSetupKeyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBSetupKeyList.
func (*NBSetupKeyList) DeepCopyInto ¶
func (in *NBSetupKeyList) DeepCopyInto(out *NBSetupKeyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NBSetupKeyList) DeepCopyObject ¶
func (in *NBSetupKeyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NBSetupKeySpec ¶
type NBSetupKeySpec struct {
// SecretKeyRef is a reference to the secret containing the setup key
SecretKeyRef corev1.SecretKeySelector `json:"secretKeyRef"`
// ManagementURL optional, override operator management URL
ManagementURL string `json:"managementURL,omitempty"`
// Volumes optional, additional volumes for NetBird container
// +optional
Volumes []corev1.Volume `json:"volumes,omitempty"`
// VolumeMounts optional, additional volumeMounts for NetBird container
// +optional
VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"`
}
NBSetupKeySpec defines the desired state of NBSetupKey.
func (*NBSetupKeySpec) DeepCopy ¶
func (in *NBSetupKeySpec) DeepCopy() *NBSetupKeySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBSetupKeySpec.
func (*NBSetupKeySpec) DeepCopyInto ¶
func (in *NBSetupKeySpec) DeepCopyInto(out *NBSetupKeySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NBSetupKeyStatus ¶
type NBSetupKeyStatus struct {
// +optional
Conditions []NBCondition `json:"conditions,omitempty"`
}
NBSetupKeyStatus defines the observed state of NBSetupKey.
func (*NBSetupKeyStatus) DeepCopy ¶
func (in *NBSetupKeyStatus) DeepCopy() *NBSetupKeyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NBSetupKeyStatus.
func (*NBSetupKeyStatus) DeepCopyInto ¶
func (in *NBSetupKeyStatus) DeepCopyInto(out *NBSetupKeyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.