Bug 1956822 - [doc] assisted operator.md example for agent mirror reference is incorrect and needs configmap example
Summary: [doc] assisted operator.md example for agent mirror reference is incorrect an...
Keywords:
Status: ASSIGNED
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: assisted-installer
Version: 4.8
Hardware: x86_64
OS: Linux
unspecified
medium
Target Milestone: ---
: ---
Assignee: Flavio Percoco
QA Contact: Chad Crum
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-05-04 13:32 UTC by Chad Crum
Modified: 2021-05-10 11:34 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:


Attachments (Terms of Use)

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?


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