Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the nfdeploy v1alpha1 API group +kubebuilder:object:generate=true +groupName=nfdeploy.nephio.org
Index ¶
- Variables
- type Connectivity
- type NFDeployCondition
- type NFDeployConditionType
- type NFType
- type NfDeploy
- func (in *NfDeploy) DeepCopy() *NfDeploy
- func (in *NfDeploy) DeepCopyInto(out *NfDeploy)
- func (in *NfDeploy) DeepCopyObject() runtime.Object
- func (r *NfDeploy) SetupWebhookWithManager(mgr ctrl.Manager) error
- func (r *NfDeploy) ValidateCreate() error
- func (r *NfDeploy) ValidateDelete() error
- func (r *NfDeploy) ValidateUpdate(old runtime.Object) error
- type NfDeployList
- type NfDeploySpec
- type NfDeployStatus
- type Plmn
- type Site
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "nfdeploy.nephio.org", 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 )
Functions ¶
This section is empty.
Types ¶
type Connectivity ¶
type Connectivity struct {
NeighborName string `json:"neighborName,omitempty" yaml:"neighborName,omitempty"`
}
func (*Connectivity) DeepCopy ¶
func (in *Connectivity) DeepCopy() *Connectivity
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Connectivity.
func (*Connectivity) DeepCopyInto ¶
func (in *Connectivity) DeepCopyInto(out *Connectivity)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NFDeployCondition ¶
type NFDeployCondition struct { // Type of deployment condition. Type NFDeployConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // The last time this condition was updated. LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"` // Last time the condition transitioned from one status to another. LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` // The reason for the condition's last transition. Reason string `json:"reason,omitempty"` // A human readable message indicating details about the transition. Message string `json:"message,omitempty"` }
func (*NFDeployCondition) DeepCopy ¶
func (in *NFDeployCondition) DeepCopy() *NFDeployCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NFDeployCondition.
func (*NFDeployCondition) DeepCopyInto ¶
func (in *NFDeployCondition) DeepCopyInto(out *NFDeployCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NFDeployConditionType ¶
type NFDeployConditionType string
const ( // Reconciling implies that the deployment is progressing. // Reconciliation for a deployment is considered when a // 1. new version of at-least one NF is adopted, // 2. when new pods scale up or old pods scale down, // 3. when required peering is in progress, or, // 4. location of at-least one NF changes. // // Condition name follows Kpt guidelines. DeploymentReconciling NFDeployConditionType = "Reconciling" // Deployment is unable to make progress towards Reconciliation. // Reasons could be NF creation failure, Peering failure etc. // // Condition name follows Kpt guidelines. DeploymentStalled NFDeployConditionType = "Stalled" // The Deployment is considered available when following conditions hold: // 1. All the NFs are Available. // 2. The NFs are making progress towards peering on the required // interfaces. DeploymentPeering NFDeployConditionType = "Peering" // The Deployment is said to be Ready when all the NFs are Ready. // At this stage, the deployment is ready to serve requests. DeploymentReady NFDeployConditionType = "Ready" )
type NfDeploy ¶
type NfDeploy struct { metav1.TypeMeta `json:",inline" yaml:",inline"` metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata"` Spec NfDeploySpec `json:"spec,omitempty"` Status NfDeployStatus `json:"status,omitempty"` }
NfDeploy is the Schema for the nfdeploys API
func (*NfDeploy) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NfDeploy.
func (*NfDeploy) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NfDeploy) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*NfDeploy) SetupWebhookWithManager ¶
func (*NfDeploy) ValidateCreate ¶
ValidateCreate implements webhook.Validator so a webhook will be registered for the type
func (*NfDeploy) ValidateDelete ¶
ValidateDelete implements webhook.Validator so a webhook will be registered for the type
type NfDeployList ¶
type NfDeployList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []NfDeploy `json:"items"` }
NfDeployList contains a list of NfDeploy
func (*NfDeployList) DeepCopy ¶
func (in *NfDeployList) DeepCopy() *NfDeployList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NfDeployList.
func (*NfDeployList) DeepCopyInto ¶
func (in *NfDeployList) DeepCopyInto(out *NfDeployList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NfDeployList) DeepCopyObject ¶
func (in *NfDeployList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NfDeploySpec ¶
type NfDeploySpec struct { Plmn Plmn `json:"plmn,omitempty" yaml:"plmn,omitempty"` Capacity string `json:"capacity,omitempty" yaml:"capacity,omitempty"` Sites []Site `json:"sites,omitempty" yaml:"sites,omitempty"` }
NfDeploySpec defines the desired state of NfDeploy
func (*NfDeploySpec) DeepCopy ¶
func (in *NfDeploySpec) DeepCopy() *NfDeploySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NfDeploySpec.
func (*NfDeploySpec) DeepCopyInto ¶
func (in *NfDeploySpec) DeepCopyInto(out *NfDeploySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NfDeployStatus ¶
type NfDeployStatus struct { // The generation observed by the deployment controller. ObservedGeneration int32 `json:"observedGeneration,omitempty"` // Total number of NFs targeted by this deployment TargetedNFs int32 `json:"targetedNFs,omitempty"` // Total number of NFs targeted by this deployment with a Ready Condition set. ReadyNFs int32 `json:"readyNFs,omitempty"` // Total number of NFs targeted by this deployment with an Available Condition set. AvailableNFs int32 `json:"availableNFs,omitempty"` // Total number of NFs targeted by this deployment with a Stalled Condition set. StalledNFs int32 `json:"stalledNFs,omitempty"` // Current service state of the UPF. Conditions []NFDeployCondition `json:"conditions,omitempty"` }
func (*NfDeployStatus) DeepCopy ¶
func (in *NfDeployStatus) DeepCopy() *NfDeployStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NfDeployStatus.
func (*NfDeployStatus) DeepCopyInto ¶
func (in *NfDeployStatus) DeepCopyInto(out *NfDeployStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Plmn ¶
type Plmn struct { MCC int `json:"mcc,omitempty" yaml:"mcc,omitempty"` MNC int `json:"mnc,omitempty" yaml:"mnc,omitempty"` }
func (*Plmn) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Plmn.
func (*Plmn) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Site ¶
type Site struct { Id string `json:"id,omitempty" yaml:"id,omitempty"` ClusterName string `json:"clusterName,omitempty" yaml:"clusterName,omitempty"` NFType string `json:"nfType,omitempty" yaml:"nfType,omitempty"` NFTypeName string `json:"nfTypeName,omitempty" yaml:"nfTypeName,omitempty"` NFVendor string `json:"nfVendor,omitempty" yaml:"nfVendor,omitempty"` NFVersion string `json:"nfVersion,omitempty" yaml:"nfVersion,omitempty"` IPAddrBlock []string `json:"ipAddrBlock,omitempty" yaml:"ipAddrBlock,omitempty"` Connectivities []Connectivity `json:"connectivities,omitempty" yaml:"connectivities,omitempty"` }
func (*Site) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Site.
func (*Site) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.