Bug 1972436 - [4.8.0] [DOCS] AgentServiceConfig examples in operator.md doc should each contain databaseStorage + filesystemStorage
Summary: [4.8.0] [DOCS] AgentServiceConfig examples in operator.md doc should each con...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: assisted-installer
Version: 4.8
Hardware: Unspecified
OS: Unspecified
high
medium
Target Milestone: ---
: 4.8.0
Assignee: Pawan Pinjarkar
QA Contact: bjacot
URL:
Whiteboard: AI-Team-Platform
Depends On: 1968125
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-06-15 21:33 UTC by Pawan Pinjarkar
Modified: 2021-07-27 23:13 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of: 1968125
Environment:
Last Closed: 2021-07-27 23:12:54 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift assisted-service pull 2025 0 None open [ocm-2.3] Bug 1972436: AgentServiceConfig examples in operator.md doc should each contain databaseStorage + filesystemSt... 2021-06-23 12:16:00 UTC
Red Hat Product Errata RHSA-2021:2438 0 None None None 2021-07-27 23:13:35 UTC

Description Pawan Pinjarkar 2021-06-15 21:33:20 UTC
+++ This bug was initially created as a clone of Bug #1968125 +++

Description of problem:
In the "Creating an AgentServiceConfig Resource" section of the Assisted Service operator.md doc [1] , there is a note that "At a minimum, you must specify the databaseStorage and filesystemStorage to be used." But in subsequent examples of the AgentServiceConfig [2][3], the databaseStorage and filesystemStorage spec is omitted. This can cause confusion as it could appear that multiple AgentServiceConfig CRs must be created, rather than just the one.



[1] https://github.com/openshift/assisted-service/blob/master/docs/operator.md#creating-an-agentserviceconfig-resource
[2] https://github.com/openshift/assisted-service/blob/master/docs/operator.md#available-operator-system-images
[3] https://github.com/openshift/assisted-service/blob/master/docs/operator.md#mirror-registry-configuration

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

--- Additional comment from Pawan Pinjarkar on 2021-06-14 18:44:29 UTC ---

PR https://github.com/openshift/assisted-service/pull/2002

Comment 3 Chad Crum 2021-07-07 17:57:12 UTC
Docs look correct.

Comment 5 errata-xmlrpc 2021-07-27 23:12:54 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 (Moderate: OpenShift Container Platform 4.8.2 bug fix and security 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/RHSA-2021:2438


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