Bug 1939788 - The updateservice example file should be updated
Summary: The updateservice example file should be updated
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: OpenShift Update Service
Version: 4.6
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: 4.9.0
Assignee: Jack Ottofaro
QA Contact: liujia
Kathryn Alexander
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-03-17 04:53 UTC by liujia
Modified: 2021-10-15 16:20 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Cause: The default OSUS application name is "updateservice-sample". Consequence: Use of the current default OSUS application name causes an invalidhost error due to length limitation. Fix: Changed default name from "updateservice-sample" to "sample". Result: If default name used do not get invalihost error.
Clone Of:
Environment:
Last Closed: 2021-10-15 16:20:30 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift cincinnati-operator pull 103 0 None open Bug 1939788: config/samples: Shorten name 2021-03-19 16:08:29 UTC
Red Hat Product Errata RHBA-2021:3735 0 None None None 2021-10-15 16:20:40 UTC

Description liujia 2021-03-17 04:53:34 UTC
Description of problem (please be detailed as possible and provide log
snippests):
When creating updateservice from web-console:
1) the default updateservice's name is too long which will cause invalidhost issue as following:
# ./oc get route
NAME                                       HOST/PORT     PATH   SERVICES                             PORT            TERMINATION   WILDCARD
updateservice-sample-policy-engine-route   InvalidHost          updateservice-sample-policy-engine   policy-engine   edge/None     None

So if user create a updateservice with default name(updateservice-sample), no policyEngineURI can be available , we'd better to short the default name. Moreover it's better to give a limitation for this name's input from console.

2) there is unnecessary item in updateservice.spec which created automatically when creating osus instance through web-console.
spec:
  foo: bar
  graphDataImage: >-
    jliu-46.mirror-registry.qe.gcp.devcluster.openshift.com:5000/rh-osbs/cincinnati-graph-data-container:1.0
  releases: 'jliu-46.mirror-registry.qe.gcp.devcluster.openshift.com:5000/ocp-release'
  replicas: 1
There is not "foo: bar" item in updateservice api.
https://github.com/openshift/cincinnati-operator/blob/master/api/v1/updateservice_types.go#L11

I think it should be related with the sample file https://github.com/openshift/cincinnati-operator/blob/master/config/samples/updateservice.operator_v1_updateservice.yaml

Version of all relevant components (if applicable):
OSUS operator image: v4.6.0-6


Does this issue impact your ability to continue to work with the product
(please explain in detail what is the user impact)?


Is there any workaround available to the best of your knowledge?


Rate from 1 - 5 the complexity of the scenario you performed that caused this
bug (1 - very simple, 5 - very complex)?


Can this issue reproducible?
yes

Can this issue reproduce from the UI?
yes

If this is a regression, please provide more details to justify this:


Steps to Reproduce:
1. Create osus instance from web-console after osus operator installed successfully
2.
3.


Actual results:
Default updateservice is too long to get a valid policyEngineURI and the updateserve.spec is not consistent with updateservice api.

Expected results:
The default updateservice's name and spec for example should be updated.

Additional info:

Comment 2 liujia 2021-09-29 06:15:51 UTC
Version: 
cincinnati-container-v4.9.0-1
cincinnati-operator-bundle-container-v4.9.0-1
cincinnati-operator-container-v4.9.0-1

# ./oc get po
NAME                                      READY   STATUS    RESTARTS   AGE
sample-68cc9f7bb-p64tl                    2/2     Running   0          138m
updateservice-operator-6b9479d86d-srnp6   1/1     Running   0          3h2m

# ./oc get route
NAME                         HOST/PORT                                                                                          PATH   SERVICES               PORT            TERMINATION   WILDCARD
sample-policy-engine-route   sample-policy-engine-route-openshift-update-service.apps.jliu-49.qe.gcp.devcluster.openshift.com          sample-policy-engine   policy-engine   edge/None     None

# ./oc get updateservice -ojson|jq .items[].spec
{
  "graphDataImage": "quay.io/openshifttest/graph-data:latest",
  "releases": "quay.io/openshift-release-dev/ocp-release",
  "replicas": 1
}

Default name was updated to `sample` and unnecessary item in updateservice.spec was removed.

Comment 5 errata-xmlrpc 2021-10-15 16:20:30 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (RHEA: OSUS enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2021:3735


Note You need to log in before you can comment on or make changes to this bug.