Skip to content

Commit

Permalink
Add API field for switch-hub.
Browse files Browse the repository at this point in the history 
Signed-off-by: xuezhaojun <zxue@redhat.com>
  • Loading branch information
@xuezhaojun
xuezhaojun committed Apr 17, 2024
1 parent 29e1b1d commit 90159c7
Show file tree
Hide file tree
Showing 4 changed files with 159 additions and 5 deletions.
33 changes: 33 additions & 0 deletions crdsv1beta1/0001_00_operator.open-cluster-management.io_klusterlets.crd.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,12 @@ spec:
enum:
- Enable
- Disable
hubConnectionTimeoutSeconds:
description: HubConnectionTimeoutSeconds is used to set the timeout of connecting to the hub cluster. When agent loses the connection to the hub over the timeout seconds, the agent do a rebootstrap. By default is 10 mins.
type: integer
format: int32
default: 600
minimum: 0
kubeAPIBurst:
description: 'KubeAPIBurst indicates the maximum burst of the throttle while talking with apiserver of hub cluster from the spoke cluster. If it is set empty, use the default value: 100'
type: integer
Expand All @@ -155,6 +161,33 @@ spec:
type: integer
format: int32
default: 50
priorityBootstrapKubeconfigs:
description: "PriorityBootstrapKubeconfigs defines the list of bootstrap kubeconfigs in the order of priority. They are used for an agent to connect to multiple hubs in cases like auto-failover, backup&restore, rollout upgrade etc. \n When the agent loses the connection to the current hub over HubConnectionTimeoutSeconds, or the managedcluster CR is set `hubAcceptsClient=false` on the hub, we mark the related bootstrap secret as failed. A failed bootstrapkubeconfig won't be used for the duration specified by SkipFailedBootstrapKubeconfigSeconds. \n If the user updates the content of a failed bootstrapkubeconfig, the \"failed\" mark will be cleared. \n Then the agent will try to choose another bootstrapkubeconfig from the list by order, replace the current bootstrapkubeconfig and trigger the rebootstrap."
type: object
properties:
localSecrets:
description: LocalSecrets is a list of secrets that contains the kubeconfigs for priority bootstrap. The secrets must be in the same namespace where the agent controller runs.
type: array
items:
description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
type: object
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
skipFailedBootstrapKubeconfigSeconds:
description: SkipFailedBootstrapKubeconfigSeconds. When selecting a new bootstrapkubeconfig, the controller will skip the item in the list that fails recently. By default is 3 mins.
type: integer
format: int32
default: 180
minimum: 0
type:
description: Type specifies the type of priority bootstrap kubeconfigs. By default, it is set to None, representing no priority bootstrap kubeconfigs are set.
type: string
default: None
enum:
- None
- LocalSecrets
registrationImagePullSpec:
description: RegistrationImagePullSpec represents the desired image configuration of registration agent. quay.io/open-cluster-management.io/registration:latest will be used if unspecified.
type: string
Expand Down
58 changes: 58 additions & 0 deletions operator/v1/0000_00_operator.open-cluster-management.io_klusterlets.crd.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,15 @@ spec:
- feature
type: object
type: array
hubConnectionTimeoutSeconds:
default: 600
description: HubConnectionTimeoutSeconds is used to set the timeout
of connecting to the hub cluster. When agent loses the connection
to the hub over the timeout seconds, the agent do a rebootstrap.
By default is 10 mins.
format: int32
minimum: 0
type: integer
kubeAPIBurst:
default: 100
description: 'KubeAPIBurst indicates the maximum burst of the
Expand All @@ -242,6 +251,55 @@ spec:
is set empty, use the default value: 50'
format: int32
type: integer
priorityBootstrapKubeconfigs:
description: "PriorityBootstrapKubeconfigs defines the list of
bootstrap kubeconfigs in the order of priority. They are used
for an agent to connect to multiple hubs in cases like auto-failover,
backup&restore, rollout upgrade etc. \n When the agent loses
the connection to the current hub over HubConnectionTimeoutSeconds,
or the managedcluster CR is set `hubAcceptsClient=false` on
the hub, we mark the related bootstrap secret as failed. A failed
bootstrapkubeconfig won't be used for the duration specified
by SkipFailedBootstrapKubeconfigSeconds. \n If the user updates
the content of a failed bootstrapkubeconfig, the \"failed\"
mark will be cleared. \n Then the agent will try to choose another
bootstrapkubeconfig from the list by order, replace the current
bootstrapkubeconfig and trigger the rebootstrap."
properties:
localSecrets:
description: LocalSecrets is a list of secrets that contains
the kubeconfigs for priority bootstrap. The secrets must
be in the same namespace where the agent controller runs.
items:
description: LocalObjectReference contains enough information
to let you locate the referenced object inside the same
namespace.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
type: array
skipFailedBootstrapKubeconfigSeconds:
default: 180
description: SkipFailedBootstrapKubeconfigSeconds. When selecting
a new bootstrapkubeconfig, the controller will skip the
item in the list that fails recently. By default is 3 mins.
format: int32
minimum: 0
type: integer
type:
default: None
description: Type specifies the type of priority bootstrap
kubeconfigs. By default, it is set to None, representing
no priority bootstrap kubeconfigs are set.
enum:
- None
- LocalSecrets
type: string
type: object
type: object
registrationImagePullSpec:
description: RegistrationImagePullSpec represents the desired image
Expand Down
51 changes: 51 additions & 0 deletions operator/v1/types_klusterlet.go
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package v1

import (
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

Expand Down Expand Up @@ -162,6 +163,56 @@ type RegistrationConfiguration struct {
// +optional
// +kubebuilder:default:=100
KubeAPIBurst int32 `json:"kubeAPIBurst,omitempty"`

// PriorityBootstrapKubeconfigs defines the list of bootstrap kubeconfigs in the order of priority.
// They are used for an agent to connect to multiple hubs in cases like auto-failover, backup&restore, rollout upgrade etc.
//
// When the agent loses the connection to the current hub over HubConnectionTimeoutSeconds, or the managedcluster CR
// is set `hubAcceptsClient=false` on the hub, we mark the related bootstrap secret as failed.
// A failed bootstrapkubeconfig won't be used for the duration specified by SkipFailedBootstrapKubeconfigSeconds.
//
// If the user updates the content of a failed bootstrapkubeconfig, the "failed" mark will be cleared.
//
// Then the agent will try to choose another bootstrapkubeconfig from the list by order, replace the current bootstrapkubeconfig and trigger the rebootstrap.
// +optional
PriorityBootstrapKubeconfigs PriorityBootstrapKubeconfigs `json:"priorityBootstrapKubeconfigs,omitempty"`

// HubConnectionTimeoutSeconds is used to set the timeout of connecting to the hub cluster.
// When agent loses the connection to the hub over the timeout seconds, the agent do a rebootstrap.
// By default is 10 mins.
// +optional
// +kubebuilder:default:=600
// +kubebuilder:validation:Minimum=0
HubConnectionTimeoutSeconds int32 `json:"hubConnectionTimeoutSeconds,omitempty"`
}

type TypePriorityBootstrapKubeconfigs string

const (
LocalSecrets TypePriorityBootstrapKubeconfigs = "LocalSecrets"
None TypePriorityBootstrapKubeconfigs = "None"
)

type PriorityBootstrapKubeconfigs struct {
// Type specifies the type of priority bootstrap kubeconfigs.
// By default, it is set to None, representing no priority bootstrap kubeconfigs are set.
// +required
// +kubebuilder:default:=None
// +kubebuilder:validation:Enum=None;LocalSecrets
Type TypePriorityBootstrapKubeconfigs `json:"type,omitempty"`

// LocalSecrets is a list of secrets that contains the kubeconfigs for priority bootstrap.
// The secrets must be in the same namespace where the agent controller runs.
// +optional
LocalSecrets []corev1.LocalObjectReference `json:"localSecrets,omitempty"`

// SkipFailedBootstrapKubeconfigSeconds. When selecting a new bootstrapkubeconfig, the controller will skip the item in the list
// that fails recently.
// By default is 3 mins.
// +optional
// +kubebuilder:default:=180
// +kubebuilder:validation:Minimum=0
SkipFailedBootstrapKubeconfigSeconds int32 `json:"skipFailedBootstrapKubeconfigSeconds,omitempty"`
}

type WorkAgentConfiguration struct {
Expand Down
22 changes: 17 additions & 5 deletions operator/v1/zz_generated.swagger_doc_generated.go
View file

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

0 comments on commit 90159c7

Please sign in to comment.