Bug 1929319 - Indentation issue in cluster logging installation guide
Summary: Indentation issue in cluster logging installation guide
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: landerso
QA Contact: Xiaoli Tian
Claire Bremble
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-02-16 16:37 UTC by Andreas Karis
Modified: 2023-02-27 17:04 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-02-27 17:04:38 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHDEVDOCS-3085 0 Unprioritized Open Bug 1929319 - Indentation issue in cluster logging installation guide 2021-06-17 16:39:14 UTC

Description Andreas Karis 2021-02-16 16:37:01 UTC
Document URL: 
https://docs.openshift.com/container-platform/4.6/logging/cluster-logging-deploying.html

Section Number and Name: 
Under 5. Create a Cluster Logging instance

Describe the issue: 

Indentation issue for CR ClusterLogging.
~~~
[root@openshift-jumpserver-0 ~]# oc apply -f cl.yaml 
error: error parsing cl.yaml: error converting YAML to JSON: yaml: line 16: did not find expected key
~~~


Suggestions for improvement:
Correctly indent 4.6 ClusterLogging CR (look at the 4.5 guide where it's correct) 

Additional information: 

Compare https://docs.openshift.com/container-platform/4.6/logging/cluster-logging-deploying.html with bad indentation
to 
https://docs.openshift.com/container-platform/4.5/logging/cluster-logging-deploying.html with valid indentation

~~~
[root@openshift-jumpserver-0 ~]# diff 45.yaml 46.yaml  -y
apiVersion: "logging.openshift.io/v1"				apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"						kind: "ClusterLogging"
metadata:							metadata:
  name: "instance" 						  name: "instance" 
  namespace: "openshift-logging"				  namespace: "openshift-logging"
spec:								spec:
  managementState: "Managed"  					  managementState: "Managed"  
  logStore:							  logStore:
    type: "elasticsearch"  					    type: "elasticsearch"  
    retentionPolicy: 						    retentionPolicy: 
      application:						      application:
        maxAge: 1d						        maxAge: 1d
      infra:							      infra:
        maxAge: 7d						        maxAge: 7d
      audit:							      audit:
        maxAge: 7d						        maxAge: 7d
    elasticsearch:					      |	   elasticsearch:
      nodeCount: 3 						      nodeCount: 3 
      storage:							      storage:
        storageClassName: "<storage-class-name>" 		        storageClassName: "<storage-class-name>" 
        size: 200G						        size: 200G
        resources: 					      |	      resources: 
          requests:					      |	        requests:
            memory: "8Gi"				      |	          memory: "8Gi"
        proxy: 						      |	      proxy: 
          limits:					      |	        limits:
            memory: 256Mi				      |	          memory: 256Mi
          requests:					      |	        requests:
             memory: 256Mi				      |	           memory: 256Mi
      redundancyPolicy: "SingleRedundancy"			      redundancyPolicy: "SingleRedundancy"
  visualization:						  visualization:
    type: "kibana"  						    type: "kibana"  
    kibana:							    kibana:
      replicas: 1						      replicas: 1
  curation:							  curation:
    type: "curator"						    type: "curator"
    curator:							    curator:
      schedule: "30 3 * * *" 					      schedule: "30 3 * * *" 
  collection:							  collection:
    logs:							    logs:
      type: "fluentd"  						      type: "fluentd"  
      fluentd: {}						      fluentd: {}
~~~

Comment 3 Andreas Karis 2023-02-27 17:04:38 UTC
lgtm


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