Skip to content

Commit

Permalink
External Network: Connection API
Browse files Browse the repository at this point in the history
  • Loading branch information
@cheina97
cheina97 committed Oct 10, 2023
1 parent 4695feb commit 01942dd
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 156 deletions.
91 changes: 37 additions & 54 deletions apis/networking/v1alpha1/connection_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,33 @@ var ConnectionGroupVersionResource = GroupVersion.WithResource(ConnectionResourc
// ConnectionType represents the type of a connection.
type ConnectionType string

// ConnectionStatusValue represents the status of a connection.
type ConnectionStatusValue string

// ConnectionStatusMessage represents the message of a connection.
type ConnectionStatusMessage string

const (
// ConnectionTypeServer represents a server connection.
ConnectionTypeServer ConnectionType = "Server"
// ConnectionTypeClient represents a client connection.
ConnectionTypeClient ConnectionType = "Client"
)

// PingSpec defines the desired state of Ping.
type PingSpec struct {
// Enabled specifies whether the ping is enabled or not.
// +kubebuilder:default=true
Enabled *bool `json:"enabled,omitempty"`
// Endpoint specifies the endpoint to ping.
Endpoint EndpointStatus `json:"endpoint,omitempty"`
}
// Connected used when the connection is up and running.
Connected ConnectionStatusValue = "Connected"
// ConnectedMessage human-readable info when the vpn connection is in "connected" state.
ConnectedMessage ConnectionStatusMessage = "VPN connection established"

// Connecting used as temporary status while waiting for the vpn tunnel to come up.
Connecting ConnectionStatusValue = "Connecting"
// ConnectingMessage human-readable info when the vpn is in "connecting" state.
ConnectingMessage ConnectionStatusMessage = "Waiting VPN connection to be established"

// ConnectionError used to se the status in case of errors.
ConnectionError ConnectionStatusValue = "Error"
// ConnectionErrorMessage is the message sent when a connection error occurs.
ConnectionErrorMessage ConnectionStatusMessage = "No network connectivity towards remote cluster"
)

// ConnectionSpec defines the desired state of Connection.
type ConnectionSpec struct {
Expand All @@ -61,62 +73,33 @@ type ConnectionSpec struct {
Type ConnectionType `json:"type"`
// GatewayRef specifies the reference to the gateway.
GatewayRef corev1.ObjectReference `json:"gatewayRef"`
// Ping specifies the ping configuration.
Ping PingSpec `json:"ping,omitempty"`
}

// ConnectionConditionType represents different conditions that a connection could assume.
type ConnectionConditionType string

const (
// ConnectionConditionEstablished represents a connection that is established.
ConnectionConditionEstablished ConnectionConditionType = "Established"
// ConnectionConditionPending represents a connection that is pending.
ConnectionConditionPending ConnectionConditionType = "Pending"
// ConnectionConditionDenied represents a connection that is denied.
ConnectionConditionDenied ConnectionConditionType = "Denied"
// ConnectionConditionError represents a connection that is in error.
ConnectionConditionError ConnectionConditionType = "Error"
)

// ConnectionConditionStatusType represents the status of a connection condition.
type ConnectionConditionStatusType string

const (
// ConnectionConditionStatusTrue represents a connection condition that is true.
ConnectionConditionStatusTrue ConnectionConditionStatusType = "True"
// ConnectionConditionStatusFalse represents a connection condition that is false.
ConnectionConditionStatusFalse ConnectionConditionStatusType = "False"
// ConnectionConditionStatusUnknown represents a connection condition that is unknown.
ConnectionConditionStatusUnknown ConnectionConditionStatusType = "Unknown"
)

// ConnectionCondition contains details about state of the connection.
type ConnectionCondition struct {
// Type of the connection condition.
// +kubebuilder:validation:Enum="Established"
Type ConnectionConditionType `json:"type"`
// Status of the condition.
// +kubebuilder:validation:Enum="True";"False";"Unknown"
// +kubebuilder:default="Unknown"
Status ConnectionConditionStatusType `json:"status"`
// LastTransitionTime -> timestamp for when the condition last transitioned from one status to another.
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
// Reason -> Machine-readable, UpperCamelCase text indicating the reason for the condition's last transition.
Reason string `json:"reason,omitempty"`
// Message -> Human-readable message indicating details about the last status transition.
Message string `json:"message,omitempty"`
// ConnectionLatency represents the latency between two clusters.
type ConnectionLatency struct {
// Value of the latency.
Value string `json:"value,omitempty"`
// Timestamp of the latency.
Timestamp metav1.Time `json:"timestamp,omitempty"`
}

// ConnectionStatus defines the observed state of Connection.
type ConnectionStatus struct {
// Conditions contains the conditions of the connection.
Conditions []ConnectionCondition `json:"conditions,omitempty"`
// Value of the connection.
Value ConnectionStatusValue `json:"value,omitempty"`
// Message of the connection.
Message string `json:"message,omitempty"`
// Latency of the connection.
Latency ConnectionLatency `json:"latency,omitempty"`
}

// +kubebuilder:object:root=true
// +kubebuilder:resource:categories=liqo
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="Type",type=string,JSONPath=`.spec.type`
// +kubebuilder:printcolumn:name="Latency",type=string,JSONPath=`.status.latency.value`,priority=1
// +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.value`
// +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`

// Connection contains the status of a connection between two clusters (a client and a server).
type Connection struct {
Expand Down
42 changes: 7 additions & 35 deletions apis/networking/v1alpha1/zz_generated.deepcopy.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

99 changes: 32 additions & 67 deletions deployments/liqo/charts/liqo-crds/crds/networking.liqo.io_connections.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,21 @@ spec:
singular: connection
scope: Namespaced
versions:
- name: v1alpha1
- additionalPrinterColumns:
- jsonPath: .spec.type
name: Type
type: string
- jsonPath: .status.latency.value
name: Latency
priority: 1
type: string
- jsonPath: .status.value
name: Status
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: Connection contains the status of a connection between two clusters
Expand Down Expand Up @@ -74,35 +88,6 @@ spec:
type: string
type: object
x-kubernetes-map-type: atomic
ping:
description: Ping specifies the ping configuration.
properties:
enabled:
default: true
description: Enabled specifies whether the ping is enabled or
not.
type: boolean
endpoint:
description: Endpoint specifies the endpoint to ping.
properties:
addresses:
description: Addresses specifies the addresses of the endpoint.
items:
type: string
type: array
port:
description: Port specifies the port of the endpoint.
format: int32
type: integer
protocol:
default: TCP
description: Protocol specifies the protocol of the endpoint.
enum:
- TCP
- UDP
type: string
type: object
type: object
type:
description: Type of the connection.
enum:
Expand All @@ -116,43 +101,23 @@ spec:
status:
description: ConnectionStatus defines the observed state of Connection.
properties:
conditions:
description: Conditions contains the conditions of the connection.
items:
description: ConnectionCondition contains details about state of
the connection.
properties:
lastTransitionTime:
description: LastTransitionTime -> timestamp for when the condition
last transitioned from one status to another.
format: date-time
type: string
message:
description: Message -> Human-readable message indicating details
about the last status transition.
type: string
reason:
description: Reason -> Machine-readable, UpperCamelCase text
indicating the reason for the condition's last transition.
type: string
status:
default: Unknown
description: Status of the condition.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: Type of the connection condition.
enum:
- Established
type: string
required:
- status
- type
type: object
type: array
latency:
description: Latency of the connection.
properties:
timestamp:
description: Timestamp of the latency.
format: date-time
type: string
value:
description: Value of the latency.
type: string
type: object
message:
description: Message of the connection.
type: string
value:
description: Value of the connection.
type: string
type: object
type: object
served: true
Expand Down

0 comments on commit 01942dd

Please sign in to comment.