Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1956822

Summary: [doc] assisted operator.md example for agent mirror reference is incorrect and needs configmap example
Product: OpenShift Container Platform Reporter: Chad Crum <ccrum>
Component: assisted-installerAssignee: Flavio Percoco <fpercoco>
assisted-installer sub component: Deployment Operator QA Contact: Chad Crum <ccrum>
Status: CLOSED CURRENTRELEASE Docs Contact:
Severity: high    
Priority: medium CC: bzvonar, ccrum, fpercoco, ohochman
Version: 4.8Keywords: Triaged
Target Milestone: ---   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard: AI-Team-Platform KNI-EDGE-4.8
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-08-28 08:45:59 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Chad Crum 2021-05-04 13:32:52 UTC
Description of problem:
Example for AgentServiceConfig CRD mirroring [1] is incorrect, missing a ca/registries.conf configmap example, and wording in the configmap explanation is confusing.

[1] https://github.com/openshift/assisted-service/blob/master/docs/operator.md#deploying-the-operand-with-mirror-registry-configuration


Version-Release number of selected component (if applicable):
Latest

How reproducible:
100%

Steps to Reproduce:
1.Read [1] 


Actual results:
N/A

Expected results:
N/A

Additional info:
(1) mirrorRegistryConfigmapName: mirrorRegistyMap is listed, when it should be
  mirrorRegistryRef:
    name: registry-ca
per the CRD

(2) The configmap wording is confusing - " but it is still one string registries.conf - contents of the registries.conf file that configures mapping to the mirror registry."

(3) An example of the configmap would help immensely

Comment 1 Chad Crum 2021-05-04 13:45:33 UTC
Another point is that it seems like registries.conf content should be a single line - I'm assuming this would be base64 encoded? Or how should it be?

Comment 3 Flavio Percoco 2021-09-03 04:46:46 UTC
The ConfigMap and files mentioned in the description of this issue seem to be documented now: 

https://github.com/openshift/assisted-service/blob/master/docs/operator.md#mirror-registry-configuration

@ccrum Is this good enough?

Comment 4 Chad Crum 2021-09-03 14:29:06 UTC
Yes that looks good to me. Will close as verified.