Skip to content
Merged
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
23 changes: 12 additions & 11 deletions config/v1/types_cluster_version.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ type ClusterVersionSpec struct {
// the current version does not match the desired version). The set of
// recommended update values is listed as part of available updates in
// status, and setting values outside that range may cause the upgrade
// to fail.
// to fail. You may specify the version field without setting image if
// an update exists with that version in the availableUpdates or history.
//
// If an upgrade fails the operator will halt and report status
// about the failing component. Setting the desired update value back to
Expand Down Expand Up @@ -75,7 +76,7 @@ type ClusterVersionSpec struct {
type ClusterVersionStatus struct {
// desired is the version that the cluster is reconciling towards.
// If the cluster is not yet fully initialized desired will be set
// with the information available, which may be a payload or a tag.
// with the information available, which may be an image or a tag.
Desired Update `json:"desired"`

// history contains a list of the most recent versions applied to the cluster.
Expand Down Expand Up @@ -144,14 +145,14 @@ type UpdateHistory struct {
CompletionTime *metav1.Time `json:"completionTime"`

// version is a semantic versioning identifying the update version. If the
// requested payload does not define a version, or if a failure occurs
// retrieving the payload, this value may be empty.
// requested image does not define a version, or if a failure occurs
// retrieving the image, this value may be empty.
//
// +optional
Version string `json:"version"`
// payload is a container image location that contains the update. This value
// image is a container image location that contains the update. This value
// is always populated.
Payload string `json:"payload"`
Image string `json:"image"`
}

// ClusterID is string RFC4122 uuid.
Expand Down Expand Up @@ -182,20 +183,20 @@ type ComponentOverride struct {
type URL string

// Update represents a release of the ClusterVersionOperator, referenced by the
// Payload member.
// Image member.
// +k8s:deepcopy-gen=true
type Update struct {
// version is a semantic versioning identifying the update version. When this
// field is part of spec, version is optional if payload is specified.
// field is part of spec, version is optional if image is specified.
//
// +optional
Version string `json:"version"`
// payload is a container image location that contains the update. When this
// field is part of spec, payload is optional if version is specified and the
// image is a container image location that contains the update. When this
// field is part of spec, image is optional if version is specified and the
// availableUpdates field contains a matching version.
//
// +optional
Payload string `json:"payload"`
Image string `json:"image"`
}

// RetrievedUpdates reports whether available updates have been retrieved from
Expand Down
14 changes: 7 additions & 7 deletions config/v1/zz_generated.swagger_doc_generated.go

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