wip

Author: nikatza

Tiltfile

@@ -42,16 +42,11 @@ k8s_yaml(device_yaml())
 k8s_resource(new_name='leaf1', objects=['leaf1:device', 'secret-basic-auth:secret'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
 
 k8s_yaml('./config/samples/v1alpha1_interface.yaml')
-k8s_yaml('./config/samples/cisco/nx/v1alpha1_portchannelconfig.yaml')
 k8s_resource(new_name='lo0', objects=['lo0:interface'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
 k8s_resource(new_name='lo1', objects=['lo1:interface'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
 k8s_resource(new_name='eth1-1', objects=['eth1-1:interface'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
 k8s_resource(new_name='eth1-2', objects=['eth1-2:interface'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
 k8s_resource(new_name='svi-10', objects=['svi-10:interface'], resource_deps=['vlan-10'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
-k8s_resource(new_name='eth1-10', objects=['eth1-10:interface'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
-# Interface resources relevant to vPC configuration are defined below in the "vpcdomain" sample
-#k8s_resource(new_name='po1-cfg', objects=['po1-cfg:portchannelconfig'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
-#k8s_resource(new_name='po2', objects=['po2:interface'],  trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)
 
 k8s_yaml('./config/samples/v1alpha1_banner.yaml')
 k8s_resource(new_name='banner', objects=['banner:banner'], trigger_mode=TRIGGER_MODE_MANUAL, auto_init=False)

api/cisco/nx/v1alpha1/portchannelconfig_types.go

@@ -141,18 +141,16 @@ type KeepAlive struct {
 	Source string `json:"source"`
 
 	// VRFRef is an optional reference to a VRF resource.
-	// If specified, the keepalive will use this VRF for routing keepalive packets.
-	// Typically used when keepalive is over a management VRF.
-	// Maps to: "peer-keepalive destination <Destination> source <Source> vrf <VRFRef.Name>"
-	// The VRF must exist on the Device referenced by the parent VPCDomain resource.
+	// If specified, the keepalive will use this VRF for routing keepalive packets,
+	// e.g., the management VRF.
 	// If omitted, the default VRF is used.
+	// Maps to: "peer-keepalive destination <Destination> source <Source> vrf <VRFRef.Name>"
 	// +optional
 	VRFRef *corev1.LocalObjectReference `json:"vrfRef,omitempty"`
 }
 
-// AutoRecovery holds auto-recovery settings.
-// It allows a vPCDomain peer to automatically restore vPCDomain operation after detecting
-// that the peer is no longer reachable via keepalive link.
+// AutoRecovery holds settings to automatically restore vPCDomain operation after detecting
+// that the peer is no longer reachable via the keepalive link.
 // +kubebuilder:validation:XValidation:rule="self.enabled ? has(self.reloadDelay) : !has(self.reloadDelay)",message="reloadDelay must be set when enabled and absent when disabled"
 type AutoRecovery struct {
 	// Enabled indicates whether auto-recovery is enabled.
@@ -162,8 +160,7 @@ type AutoRecovery struct {
 	Enabled bool `json:"enabled,omitempty"`
 
 	// ReloadDelay is the time in seconds (60-3600) to wait before assuming the peer is dead
-	// and automatically recovering vPCDomain operation.
-	// Must be set when Enabled is true.
+	// and automatically attempting to restore the communication with the peer.
 	// Maps to: "auto-recovery reload-delay <ReloadDelay>"
 	// +optional
 	// +kubebuilder:validation:Minimum=60
@@ -177,7 +174,16 @@ type VPCDomainStatus struct {
 	// Standard conditions include:
 	// - Ready: overall readiness of the vPCDomain domain
 	// - Configured: whether the vPCDomain configuration was successfully applied to the device
-	// - Operational: whether the vPCDomain domain is operationally up (peer-link and keepalive status)
+	// - Operational: whether the vPCDomain domain is operationally up. This condition is true when
+	//   the status fields `PeerLinkIfOperStatus`, `KeepAliveStatus`, and `PeerStatus` are all set
+	//   to `UP`.
+	// - Degraded: whether the vPCDomain peerlink or the keepalive sessions are in a degraded state.
+	//
+	// For this Cisco model there is not one single unique operational property that reflects the
+	// operational status of the vPC domain. The combination of peer status, keepalive status, and
+	// the interface used as peer-link determine the overall health and operational condition of
+	// the vPC domain.
+	//
 	//+listType=map
 	//+listMapKey=type
 	//+patchStrategy=merge
@@ -190,24 +196,38 @@ type VPCDomainStatus struct {
 	DomainID uint16 `json:"domainId,omitempty"`
 
 	// Role indicates the current operational role of this vPCDomain peer.
-	// Possible values:
-	// - Primary: This switch is the primary vPCDomain peer (lower role priority or elected)
-	// - Secondary: This switch is the secondary vPCDomain peer
-	// - Unknown: Role has not been established (e.g., peer-link down, domain not formed)
 	// +optional
 	Role VPCDomainRole `json:"role,omitempty"`
 
-	// KeepaliveStatus indicates the status of the peer via the keepalive link.
+	// KeepAliveStatus indicates the status of the peer via the keepalive link.
+	// +optional
+	KeepAliveStatus Status `json:"keepaliveStatus,omitempty"`
+
+	// KeepAliveStatusMsg provides additional information about the keepalive status as comma separated codes, as returned by the device.
 	// +optional
-	KeepaliveStatus KeepAliveStatus `json:"keepaliveStatus,omitempty"`
+	KeepAliveStatusMsg string `json:"keepaliveStatusMsg,omitempty"`
 
-	// PeerStatus indicates the status of the vPCDomain peer-link.
+	// PeerStatus indicates the status of the vPCDomain peer-link in the latest consistency check with the peer. This means that if
+	// the adjacency is lost, e.g., due to a shutdown link, the device will not be able to perform such check and the reported status
+	// will remain unchanged (with the value of the last check).
 	// +optional
-	PeerStatus PeerStatus `json:"peerStatus,omitempty"`
+	PeerStatus Status `json:"peerStatus,omitempty"`
+
+	// PeerStatusMsg provides additional information about the peer status as comma separated codes, as returned by the device.
+	// +optional
+	PeerStatusMsg string `json:"peerStatusMsg,omitempty"`
 
 	// PeerUptime indicates how long the vPCDomain peer has been up and reachable via keepalive.
 	// +optional
 	PeerUptime metav1.Duration `json:"peerUptime,omitempty"`
+
+	// PeerLinkIf is the name of the interface used as the vPCDomain peer-link.
+	// +optional
+	PeerLinkIf string `json:"peerLinkIf,omitempty"`
+
+	// PeerLinkIfOperStatus is the Operational status of `PeerLinkIf`.
+	// +optional
+	PeerLinkIfOperStatus Status `json:"peerLinkIfOperStatus,omitempty"`
 }
 
 // The VPCDomainRole type represents the operational role of a vPCDomain peer as returned by the device.
@@ -221,18 +241,12 @@ const (
 	VPCDomainRoleUnknown                     VPCDomainRole = "Unknown"
 )
 
-type KeepAliveStatus string
-
-const (
-	KeepAliveStatusUp   KeepAliveStatus = "Up"
-	KeepAliveStatusDown KeepAliveStatus = "Down"
-)
-
-type PeerStatus string
+type Status string
 
 const (
-	PeerStatusUp   PeerStatus = "Up"
-	PeerStatusDown PeerStatus = "Down"
+	StatusUnknown Status = "Unknown"
+	StatusUp      Status = "Up"
+	StatusDown    Status = "Down"
 )
 
 // +kubebuilder:object:root=true
@@ -246,10 +260,12 @@ const (
 // +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.conditions[?(@.type=="Ready")].status`
 // +kubebuilder:printcolumn:name="Configured",type=string,JSONPath=`.status.conditions[?(@.type=="Configured")].status`,priority=1
 // +kubebuilder:printcolumn:name="Operational",type=string,JSONPath=`.status.conditions[?(@.type=="Operational")].status`,priority=1
-// +kubebuilder:printcolumn:name="Role",type=string,JSONPath=`.status.role`,priority=1
-// +kubebuilder:printcolumn:name="KeepAliveStatus",type=string,JSONPath=`.status.keepaliveStatus`,priority=1
 // +kubebuilder:printcolumn:name="PeerStatus",type=string,JSONPath=`.status.peerStatus`,priority=1
-// +kubebuilder:printcolumn:name="PeerUptime",type="string",JSONPath=`.status.peerUptime`,priority=1
+// +kubebuilder:printcolumn:name="Role",type=string,JSONPath=`.status.role`,priority=1
+// +kubebuilder:printcolumn:name="PeerLinkIf",type="string",JSONPath=".status.peerLinkIf",priority=1
+// +kubebuilder:printcolumn:name="PeerLinkIfOperSt",type="string",JSONPath=".status.peerLinkIfOperStatus",priority=1
+// +kubebuilder:printcolumn:name="KA-PeerStatus",type=string,JSONPath=`.status.keepaliveStatus`,priority=1
+// +kubebuilder:printcolumn:name="KA-PeerUptime",type="string",JSONPath=`.status.peerUptime`,priority=1
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
 
 // VPCDomain is the Schema for the VPCDomains API

api/cisco/nx/v1alpha1/vpcdomain_types.go

@@ -75,6 +75,11 @@ const (
 	// intended (e.g., a interface is up). It corresponds to the "oper-status" commonly found
 	// in the OpenConfig models (or "operSt" on Cisco).
 	OperationalCondition = "Operational"
+
+	// DegradedCondition indicates whether the resource is in a degraded state.
+	// This condition indicates whether the resource is experiencing issues that impact its performance
+	// or functionality, but does not render it completely non-functional.
+	DegradedCondition = "Degraded"
 )
 
 // Reasons that are used across different objects.