Skip to content

Conversation

@smarterclayton
Copy link
Contributor

We consistently use the "release image" terminology in our commands
and design docs when we describe the artifact that carries our manifests
in an update. Payload predates that term (from Omaha) and general
consensus is that we have no plans to deliver our updates in any form
other than as an OCI compatible image.

Update the cluster version object to make it clear that an API consumer
must interpret the payload as a standard Docker image, as they already
do.

@openshift-ci-robot openshift-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 20, 2019
@smarterclayton
Copy link
Contributor Author

I think we should also change the Cincinnati API since the only thing we will return will be an image.

@abhinavdahiya @crawford @steveej

I have corresponding PRs primed for CVO and origin to make the corresponding changes - if we agree on this I'll make sure they're ready and then we'll merge all of these in sequence.

smarterclayton added a commit to smarterclayton/cluster-version-operator that referenced this pull request Jan 20, 2019
The contents of an update must be an image ref. We should name the field
what it is.

Depends on openshift/api#175 merging first, then
we can bump and go.
@abhinavdahiya
Copy link
Contributor

/approve

@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abhinavdahiya, smarterclayton

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

@steveej steveej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with replacing Payload by Image, though it doesn't help much when talking about these things out of context. I think at least in the docs and comments we should prefix that with (r|R)elease, maybe even in the variables.

More importantly I found a language nitpick.

// 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 a image or a tag.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/a image/an image

@smarterclayton
Copy link
Contributor Author

Agree on using image when the context is clear in JSON, release image in casual conversation.

We consistently use the "release image" terminology in our commands
and design docs when we describe the artifact that carries our manifests
in an update. Payload predates that term (from Omaha) and general
consensus is that we have no plans to deliver our updates in any form
other than as an OCI compatible image.

Update the cluster version object to make it clear that an API consumer
must interpret the payload as a standard Docker image, as they already
do.
@smarterclayton
Copy link
Contributor Author

Any other comments? If none by tomorrow I'm going to merge and manage propagation.

@crawford
Copy link

LGTM

@smarterclayton smarterclayton added the lgtm Indicates that a PR is ready to be merged. label Jan 23, 2019
@smarterclayton
Copy link
Contributor Author

Tagging, other PRs coming up shortly which I will ask for review directly on each.

@smarterclayton
Copy link
Contributor Author

/refresh

@openshift-merge-robot openshift-merge-robot merged commit 74cf025 into openshift:master Jan 23, 2019
smarterclayton added a commit to smarterclayton/cluster-version-operator that referenced this pull request Jan 23, 2019
The contents of an update must be an image ref. We should name the field
what it is.

Depends on openshift/api#175 merging first, then
we can bump and go.
smarterclayton added a commit to smarterclayton/cluster-version-operator that referenced this pull request Jan 23, 2019
The contents of an update must be an image ref. We should name the field
what it is.

Depends on openshift/api#175 merging first, then
we can bump and go.
smarterclayton added a commit to smarterclayton/cluster-version-operator that referenced this pull request Jan 23, 2019
The contents of an update must be an image ref. We should name the field
what it is.

Depends on openshift/api#175 merging first, then
we can bump and go.
smarterclayton added a commit to smarterclayton/cluster-version-operator that referenced this pull request Jan 23, 2019
The contents of an update must be an image ref. We should name the field
what it is.

Depends on openshift/api#175 merging first, then
we can bump and go.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants