assisted-service icon indicating copy to clipboard operation
assisted-service copied to clipboard

MGMT-16242: Enumerate valid release images in error message to user.

Open paul-maidment opened this issue 1 year ago • 4 comments

It is desired that we should be able to see a list of valid image URLs in the error message in the AgentClusterInstall when a release image could not be located. This PR addresses that by enumerating the URLs in the message.

List all the issues related to this PR

  • [ ] New Feature
  • [x] Enhancement
  • [ ] Bug fix
  • [ ] Tests
  • [ ] Documentation
  • [ ] CI/CD

What environments does this code impact?

  • [x] Automation (CI, tools, etc)
  • [x] Cloud
  • [x] Operator Managed Deployments
  • [x] None

How was this code tested?

  • [ ] assisted-test-infra environment
  • [ ] dev-scripts environment
  • [ ] Reviewer's test appreciated
  • [x] Waiting for CI to do a full test run
  • [ ] Manual (Elaborate on how it was tested)
  • [x] No tests needed

Checklist

  • [x] Title and description added to both, commit and PR.
  • [x] Relevant issues have been associated (see CONTRIBUTING guide)
  • [x] This change does not require a documentation update (docstring, docs, README, etc)
  • [x] Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

  • Are the title and description (in both PR and commit) meaningful and clear?
  • Is there a bug required (and linked) for this change?
  • Should this PR be backported?

paul-maidment avatar May 05 '24 16:05 paul-maidment

@paul-maidment: This pull request references MGMT-16242 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

It is desired that we should be able to see a list of valid image URLs in the error message in the AgentClusterInstall when a release image could not be located. This PR addresses that by enumerating the URLs in the message.

List all the issues related to this PR

  • [ ] New Feature
  • [x] Enhancement
  • [ ] Bug fix
  • [ ] Tests
  • [ ] Documentation
  • [ ] CI/CD

What environments does this code impact?

  • [x] Automation (CI, tools, etc)
  • [x] Cloud
  • [x] Operator Managed Deployments
  • [x] None

How was this code tested?

  • [ ] assisted-test-infra environment
  • [ ] dev-scripts environment
  • [ ] Reviewer's test appreciated
  • [x] Waiting for CI to do a full test run
  • [ ] Manual (Elaborate on how it was tested)
  • [x] No tests needed

Checklist

  • [x] Title and description added to both, commit and PR.
  • [x] Relevant issues have been associated (see CONTRIBUTING guide)
  • [x] This change does not require a documentation update (docstring, docs, README, etc)
  • [x] Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

  • Are the title and description (in both PR and commit) meaningful and clear?
  • Is there a bug required (and linked) for this change?
  • Should this PR be backported?

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot avatar May 05 '24 16:05 openshift-ci-robot

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: paul-maidment

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

The pull request process is described here

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

openshift-ci[bot] avatar May 05 '24 16:05 openshift-ci[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 68.55%. Comparing base (8da29db) to head (a7c7595).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6262      +/-   ##
==========================================
- Coverage   68.56%   68.55%   -0.01%     
==========================================
  Files         246      246              
  Lines       36670    36676       +6     
==========================================
+ Hits        25141    25145       +4     
- Misses       9291     9292       +1     
- Partials     2238     2239       +1     
Files Coverage Δ
internal/versions/common.go 64.75% <100.00%> (+1.82%) :arrow_up:

... and 3 files with indirect coverage changes

codecov[bot] avatar May 05 '24 16:05 codecov[bot]

@paul-maidment: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/edge-lint a945d1e796bdc18c68fa914c5c994d8da4acde1b link true /test edge-lint

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

openshift-ci[bot] avatar May 05 '24 16:05 openshift-ci[bot]

@paul-maidment: This pull request references MGMT-16242 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.17.0" version, but no target version was set.

In response to this:

When creating an infraenv, a validation is performed to ensure that the release images contain a compatible image for a given Openshift version. This based on the MajorMinor version of The desired Openshift version and and MajorMinor version of the relase image Openshift version. This is performed within the context of a specific architecture.

The error message presented to the user when no suitable release image could be isolated is not helpful and needs to contain more clues on how the user might resolve the issue.

This PR will list available Openshift versions supported in the release images for the user's architecture when this error occurs.

List all the issues related to this PR

  • [ ] New Feature
  • [x] Enhancement
  • [ ] Bug fix
  • [ ] Tests
  • [ ] Documentation
  • [ ] CI/CD

What environments does this code impact?

  • [x] Automation (CI, tools, etc)
  • [x] Cloud
  • [x] Operator Managed Deployments
  • [x] None

How was this code tested?

  • [ ] assisted-test-infra environment
  • [ ] dev-scripts environment
  • [ ] Reviewer's test appreciated
  • [x] Waiting for CI to do a full test run
  • [ ] Manual (Elaborate on how it was tested)
  • [x] No tests needed

Checklist

  • [x] Title and description added to both, commit and PR.
  • [x] Relevant issues have been associated (see CONTRIBUTING guide)
  • [x] This change does not require a documentation update (docstring, docs, README, etc)
  • [x] Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

  • Are the title and description (in both PR and commit) meaningful and clear?
  • Is there a bug required (and linked) for this change?
  • Should this PR be backported?

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot avatar Jul 14 '24 14:07 openshift-ci-robot

@paul-maidment: This pull request references MGMT-16242 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.17.0" version, but no target version was set.

In response to this:

When creating an infraenv, a validation is performed to ensure that the release images contain a compatible image for a given Openshift version.

This based on the MajorMinor version of The desired Openshift version and and MajorMinor version of the relase image Openshift version.

This is performed within the context of a specific architecture.

The error message presented to the user when no suitable release image could be isolated is not helpful and needs to contain more clues on how the user might resolve the issue.

This PR will list available Openshift versions supported in the release images for the user's architecture when this error occurs.

List all the issues related to this PR

  • [ ] New Feature
  • [x] Enhancement
  • [ ] Bug fix
  • [ ] Tests
  • [ ] Documentation
  • [ ] CI/CD

What environments does this code impact?

  • [x] Automation (CI, tools, etc)
  • [x] Cloud
  • [x] Operator Managed Deployments
  • [x] None

How was this code tested?

  • [ ] assisted-test-infra environment
  • [ ] dev-scripts environment
  • [ ] Reviewer's test appreciated
  • [x] Waiting for CI to do a full test run
  • [ ] Manual (Elaborate on how it was tested)
  • [x] No tests needed

Checklist

  • [x] Title and description added to both, commit and PR.
  • [x] Relevant issues have been associated (see CONTRIBUTING guide)
  • [x] This change does not require a documentation update (docstring, docs, README, etc)
  • [x] Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

  • Are the title and description (in both PR and commit) meaningful and clear?
  • Is there a bug required (and linked) for this change?
  • Should this PR be backported?

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot avatar Jul 14 '24 14:07 openshift-ci-robot

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danmanor, paul-maidment

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

The pull request process is described here

Needs approval from an approver in each of these files:
  • ~~OWNERS~~ [danmanor,paul-maidment]

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

openshift-ci[bot] avatar Jul 28 '24 09:07 openshift-ci[bot]

/lgtm

danmanor avatar Jul 28 '24 09:07 danmanor

@paul-maidment: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci[bot] avatar Jul 28 '24 12:07 openshift-ci[bot]

[ART PR BUILD NOTIFIER]

Distgit: ose-agent-installer-api-server This PR has been included in build ose-agent-installer-api-server-container-v4.17.0-202407281312.p0.g4db47cf.assembly.stream.el9. All builds following this will include this PR.

openshift-bot avatar Jul 28 '24 14:07 openshift-bot