Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MGMT-20022: Handle missing ManagedCluster in non MCE environments #7348

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion cmd/operator/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,10 @@ import (
clusterv1 "open-cluster-management.io/api/cluster/v1"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
"sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
"sigs.k8s.io/controller-runtime/pkg/manager"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
"sigs.k8s.io/controller-runtime/pkg/webhook"
)
Expand Down Expand Up @@ -86,6 +88,17 @@ func init() {
utilruntime.Must(certtypes.AddToScheme(scheme))
}

func validateManagedClusterCRDExist(mgr manager.Manager) error {
gvk, err := apiutil.GVKForObject(&clusterv1.ManagedCluster{}, mgr.GetScheme())
if err != nil {
return err
}
if _, err = mgr.GetRESTMapper().RESTMapping(gvk.GroupKind(), gvk.Version); err != nil {
return err
}
return nil
}

func main() {
var metricsAddr string
var enableLeaderElection bool
Expand Down Expand Up @@ -114,6 +127,11 @@ func main() {
setupLog.Error(err, "unable to start manager")
os.Exit(1)
}
log := logrus.New()
err = validateManagedClusterCRDExist(mgr)
if err != nil {
log.WithError(err).Fatalf("Managed Cluster CRD does not exist in cluster")
}

ns, found := os.LookupEnv(NamespaceEnvVar)
if !found {
Expand Down Expand Up @@ -159,7 +177,6 @@ func main() {
tolerations = operatorPod.Spec.Tolerations
}

log := logrus.New()
spokeClientFactory, err := spoke_k8s_client.NewFactory(log, nil)
if err != nil {
log.WithError(err).Error("failed to create spoke client factory")
Expand Down
2 changes: 1 addition & 1 deletion deploy/operator/hypershift/deploy_hypershift_cluster.sh
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ oc get secret "${SPOKE_KUBECONFIG_SECRET}" -n "${SPOKE_NAMESPACE}" || \
oc create secret generic $SPOKE_KUBECONFIG_SECRET --from-file=kubeconfig=$SPOKE_KUBECONFIG -n $SPOKE_NAMESPACE

echo "Apply hive CRDs"
oc --kubeconfig $SPOKE_KUBECONFIG apply -f ${__root}/hack/crds
oc --kubeconfig $SPOKE_KUBECONFIG apply -f ${__root}/hack/crds/hive

echo "Apply HypershiftAgentServiceConfig on hub"
ansible-playbook "${playbooks_dir}/hasc-playbook.yaml"
Expand Down
3 changes: 3 additions & 0 deletions deploy/operator/setup_assisted_operator.sh
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ EOF
}

function install_from_catalog_source() {
# ensure that the necessary MCE CRDs are installed.
tee oc apply -f ${__root}/hack/crds/mce

catalog_source_name="${1}"
if [ "${ASSISTED_UPGRADE_OPERATOR}" = "true" ]; then
catalog_source=${ASSISTED_SERVICE_OPERATOR_CATALOG}
Expand Down
287 changes: 287 additions & 0 deletions hack/crds/mce/managedclusters.cluster.open-cluster-management.io.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,287 @@
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: managedclusters.cluster.open-cluster-management.io
spec:
group: cluster.open-cluster-management.io
names:
kind: ManagedCluster
listKind: ManagedClusterList
plural: managedclusters
shortNames:
- mcl
- mcls
singular: managedcluster
preserveUnknownFields: false
scope: Cluster
versions:
- additionalPrinterColumns:
- jsonPath: .spec.hubAcceptsClient
name: Hub Accepted
type: boolean
- jsonPath: .spec.managedClusterClientConfigs[*].url
name: Managed Cluster URLs
type: string
- jsonPath: .status.conditions[?(@.type=="ManagedClusterJoined")].status
name: Joined
type: string
- jsonPath: .status.conditions[?(@.type=="ManagedClusterConditionAvailable")].status
name: Available
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1
schema:
openAPIV3Schema:
description: "ManagedCluster represents the desired state and current status
of a managed cluster. ManagedCluster is a cluster-scoped resource. The name
is the cluster UID. \n The cluster join process is a double opt-in process.
See the following join process steps: \n 1. The agent on the managed cluster
creates a CSR on the hub with the cluster UID and agent name. 2. The agent
on the managed cluster creates a ManagedCluster on the hub. 3. The cluster
admin on the hub cluster approves the CSR for the UID and agent name of
the ManagedCluster. 4. The cluster admin sets the spec.acceptClient of the
ManagedCluster to true. 5. The cluster admin on the managed cluster creates
a credential of the kubeconfig for the hub cluster. \n After the hub cluster
creates the cluster namespace, the klusterlet agent on the ManagedCluster
pushes the credential to the hub cluster to use against the kube-apiserver
of the ManagedCluster."
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: Spec represents a desired configuration for the agent on
the managed cluster.
properties:
hubAcceptsClient:
description: hubAcceptsClient represents that hub accepts the joining
of Klusterlet agent on the managed cluster with the hub. The default
value is false, and can only be set true when the user on hub has
an RBAC rule to UPDATE on the virtual subresource of managedclusters/accept.
When the value is set true, a namespace whose name is the same as
the name of ManagedCluster is created on the hub. This namespace
represents the managed cluster, also role/rolebinding is created
on the namespace to grant the permision of access from the agent
on the managed cluster. When the value is set to false, the namespace
representing the managed cluster is deleted.
type: boolean
leaseDurationSeconds:
default: 60
description: LeaseDurationSeconds is used to coordinate the lease
update time of Klusterlet agents on the managed cluster. If its
value is zero, the Klusterlet agent will update its lease every
60 seconds by default
format: int32
type: integer
managedClusterClientConfigs:
description: ManagedClusterClientConfigs represents a list of the
apiserver address of the managed cluster. If it is empty, the managed
cluster has no accessible address for the hub to connect with it.
items:
description: ClientConfig represents the apiserver address of the
managed cluster. TODO include credential to connect to managed
cluster kube-apiserver
properties:
caBundle:
description: CABundle is the ca bundle to connect to apiserver
of the managed cluster. System certs are used if it is not
set.
format: byte
type: string
url:
description: URL is the URL of apiserver endpoint of the managed
cluster.
type: string
type: object
type: array
taints:
description: Taints is a property of managed cluster that allow the
cluster to be repelled when scheduling. Taints, including 'ManagedClusterUnavailable'
and 'ManagedClusterUnreachable', can not be added/removed by agent
running on the managed cluster; while it's fine to add/remove other
taints from either hub cluser or managed cluster.
items:
description: The managed cluster this Taint is attached to has the
"effect" on any placement that does not tolerate the Taint.
properties:
effect:
description: Effect indicates the effect of the taint on placements
that do not tolerate the taint. Valid effects are NoSelect,
PreferNoSelect and NoSelectIfNew.
enum:
- NoSelect
- PreferNoSelect
- NoSelectIfNew
type: string
key:
description: Key is the taint key applied to a cluster. e.g.
bar or foo.example.com/bar. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
timeAdded:
description: TimeAdded represents the time at which the taint
was added.
format: date-time
nullable: true
type: string
value:
description: Value is the taint value corresponding to the taint
key.
maxLength: 1024
type: string
required:
- effect
- key
type: object
type: array
type: object
status:
description: Status represents the current status of joined managed cluster
properties:
allocatable:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: Allocatable represents the total allocatable resources
on the managed cluster.
type: object
capacity:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: Capacity represents the total resource capacity from
all nodeStatuses on the managed cluster.
type: object
clusterClaims:
description: ClusterClaims represents cluster information that a managed
cluster claims, for example a unique cluster identifier (id.k8s.io)
and kubernetes version (kubeversion.open-cluster-management.io).
They are written from the managed cluster. The set of claims is
not uniform across a fleet, some claims can be vendor or version
specific and may not be included from all managed clusters.
items:
description: ManagedClusterClaim represents a ClusterClaim collected
from a managed cluster.
properties:
name:
description: Name is the name of a ClusterClaim resource on
managed cluster. It's a well known or customized name to identify
the claim.
maxLength: 253
minLength: 1
type: string
value:
description: Value is a claim-dependent string
maxLength: 1024
minLength: 1
type: string
type: object
type: array
conditions:
description: Conditions contains the different condition statuses
for this managed cluster.
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
use as an array at the field path .status.conditions. For example,
\n type FooStatus struct{ // Represents the observations of a
foo's current state. // Known .status.conditions.type are: \"Available\",
\"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
// +listType=map // +listMapKey=type Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition
transitioned from one status to another. This should be when
the underlying condition changed. If that is not known, then
using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: message is a human readable message indicating
details about the transition. This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: observedGeneration represents the .metadata.generation
that the condition was set based upon. For instance, if .metadata.generation
is currently 12, but the .status.conditions[x].observedGeneration
is 9, the condition is out of date with respect to the current
state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: reason contains a programmatic identifier indicating
the reason for the condition's last transition. Producers
of specific condition types may define expected values and
meanings for this field, and whether the values are considered
a guaranteed API. The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
--- Many .condition.type values are consistent across resources
like Available, but because arbitrary conditions can be useful
(see .node.status.conditions), the ability to deconflict is
important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
version:
description: Version represents the kubernetes version of the managed
cluster.
properties:
kubernetes:
description: Kubernetes is the kubernetes version of managed cluster.
type: string
type: object
type: object
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []