OTA-1339: UpdateStatus: API to expose information about update progress & health

update/.codegen.yaml

@@ -0,0 +1,2 @@
+swaggerdocs:
+  commentPolicy: Enforce

update/install.go

@@ -0,0 +1,26 @@
+package config
+
+import (
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+
+	updatev1alpha1 "github.com/openshift/api/update/v1alpha1"
+)
+
+const (
+	GroupName = "update.openshift.io"
+)
+
+var (
+	schemeBuilder = runtime.NewSchemeBuilder(updatev1alpha1.Install)
+	// Install is a function which adds every version of this group to a scheme
+	Install = schemeBuilder.AddToScheme
+)
+
+func Resource(resource string) schema.GroupResource {
+	return schema.GroupResource{Group: GroupName, Resource: resource}
+}
+
+func Kind(kind string) schema.GroupKind {
+	return schema.GroupKind{Group: GroupName, Kind: kind}
+}

update/v1alpha1/Makefile

@@ -0,0 +1,3 @@
+.PHONY: test
+test:
+	make -C ../../tests test GINKGO_EXTRA_ARGS=--focus="update.openshift.io/v1alpha1"

update/v1alpha1/doc.go

@@ -0,0 +1,7 @@
+// +k8s:deepcopy-gen=package,register
+// +k8s:defaulter-gen=TypeMeta
+// +k8s:openapi-gen=true
+
+// +groupName=update.openshift.io
+// Package v1alpha1 is the v1alpha1 version of the API.
+package v1alpha1

update/v1alpha1/register.go

@@ -0,0 +1,46 @@
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+var (
+	GroupName     = "update.openshift.io"
+	GroupVersion  = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
+	schemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
+	// Install is a function which adds this version to a scheme
+	Install = schemeBuilder.AddToScheme
+
+	// SchemeGroupVersion generated code relies on this name
+	// Deprecated
+	SchemeGroupVersion = GroupVersion
+	// AddToScheme exists solely to keep the old generators creating valid code
+	// DEPRECATED
+	AddToScheme = schemeBuilder.AddToScheme
+)
+
+// Resource generated code relies on this being here, but it logically belongs to the group
+// DEPRECATED
+func Resource(resource string) schema.GroupResource {
+	return schema.GroupResource{Group: GroupName, Resource: resource}
+}
+
+// Adds the list of known types to api.Scheme.
+func addKnownTypes(scheme *runtime.Scheme) error {
+	scheme.AddKnownTypes(GroupVersion,
+		&ClusterVersionProgressInsight{},
+		&ClusterVersionProgressInsightList{},
+		&ClusterOperatorProgressInsight{},
+		&ClusterOperatorProgressInsightList{},
+		&MachineConfigPoolProgressInsight{},
+		&MachineConfigPoolProgressInsightList{},
+		&NodeProgressInsight{},
+		&NodeProgressInsightList{},
+		&HealthInsight{},
+		&HealthInsightList{},
+	)
+	metav1.AddToGroupVersion(scheme, GroupVersion)
+	return nil
+}

update/v1alpha1/tests/clusteroperatorprogressinsights.update.openshift.io/UpgradeStatus.yaml

@@ -0,0 +1,93 @@
+apiVersion: apiextensions.k8s.io/v1 # Hack because controller-gen complains if we don't have this
+name: "ClusterOperatorProgressInsight"
+crdName: clusteroperatorprogressinsights.update.openshift.io
+featureGate: UpgradeStatus
+tests:
+  onCreate:
+  - name: Should be able to create a minimal ClusterOperatorProgressInsight
+    initial: |
+      apiVersion: update.openshift.io/v1alpha1
+      kind: ClusterOperatorProgressInsight
+      spec: {} # No spec is required for a ClusterOperatorProgressInsight
+    expected: |
+      apiVersion: update.openshift.io/v1alpha1
+      kind: ClusterOperatorProgressInsight
+      spec: {}
+  onUpdate:
+  - name: ClusterOperatorProgressInsight example
+    initial: |
+      apiVersion: update.openshift.io/v1alpha1
+      kind: ClusterOperatorProgressInsight
+      metadata:
+        name: authentication
+      spec: {}
+    updated: |
+      apiVersion: update.openshift.io/v1alpha1
+      kind: ClusterOperatorProgressInsight
+      metadata:
+        name: authentication
+      spec: {}
+      status:
+        name: authentication
+        conditions:
+        - type: Updating
+          status: "False"
+          lastTransitionTime: "2021-01-01T00:00:00Z"
+          reason: Pending
+          message: "Installing version 4.18.0"
+        - type: Healthy
+          status: "False"
+          lastTransitionTime: "2021-01-01T00:00:00Z"
+          reason: Degraded
+          message: "Authentication operator is not healthy"
+    expected: |
+      apiVersion: update.openshift.io/v1alpha1
+      kind: ClusterOperatorProgressInsight
+      metadata:
+        name: authentication
+      spec: {}
+      status:
+        name: authentication
+        conditions:
+        - type: Updating
+          status: "False"
+          lastTransitionTime: "2021-01-01T00:00:00Z"
+          reason: Pending
+          message: "Installing version 4.18.0"
+        - type: Healthy
+          status: "False"
+          lastTransitionTime: "2021-01-01T00:00:00Z"
+          reason: Degraded
+          message: "Authentication operator is not healthy"
+  - name: Name and .status.name must match
+    initial: |
+      apiVersion: update.openshift.io/v1alpha1
+      kind: ClusterOperatorProgressInsight
+      metadata:
+        name: etcd
+      spec: {}
+    updated: |
+      apiVersion: update.openshift.io/v1alpha1
+      kind: ClusterOperatorProgressInsight
+      metadata:
+        name: etcd
+      spec: {}
+      status:
+        name: not-etc
+        conditions:
+        - type: Updating
+          status: "False"
+          lastTransitionTime: "2021-01-01T00:00:00Z"
+          reason: Pending
+          message: "Installing version 4.18.0"
+        - type: Healthy
+          status: "False"
+          lastTransitionTime: "2021-01-01T00:00:00Z"
+          reason: Degraded
+          message: "Authentication operator is not healthy"
+    expected: |
+      apiVersion: update.openshift.io/v1alpha1
+      kind: ClusterOperatorProgressInsight
+      spec: {}
+    expectedStatusError: "Invalid value: \"object\": When status is present, .status must match .metadata.name"
+