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

Bug 1933110

Summary: Bad elasticsearch proxy configuration in ClusterLogging Operator documentation for 4.6
Product: OpenShift Container Platform Reporter: Andreas Karis <akaris>
Component: DocumentationAssignee: Rolfe Dlugy-Hegwer <rdlugyhe>
Status: CLOSED CURRENTRELEASE QA Contact: Xiaoli Tian <xtian>
Severity: unspecified Docs Contact: Rolfe Dlugy-Hegwer <rdlugyhe>
Priority: unspecified    
Version: 4.6CC: aos-bugs, jokerman, rdlugyhe
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-03-08 18:58:09 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 Andreas Karis 2021-02-25 17:18:29 UTC
Document URL: 
https://docs.openshift.com/container-platform/4.6/logging/cluster-logging-deploying.html

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

Describe the issue: 

Suggestions for improvement: 

Additional information: 

This affects 4.5, 4.6, 4.7 alike. When applying the CLI example:
~~~
apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  name: "instance" 
  namespace: "openshift-logging"
spec:
  managementState: "Managed"  
  logStore:
    type: "elasticsearch"  
    retentionPolicy: 
      application:
        maxAge: 1d
      infra:
        maxAge: 7d
      audit:
        maxAge: 7d
    elasticsearch:
      nodeCount: 3 
      storage:
        storageClassName: "<storage-class-name>" 
        size: 200G
      resources: 
        requests:
          memory: "8Gi"
      proxy: 
        limits:
          memory: 256Mi
        requests:
           memory: 256Mi
      redundancyPolicy: "SingleRedundancy"
  visualization:
    type: "kibana"  
    kibana:
      replicas: 1
  curation:
    type: "curator"
    curator:
      schedule: "30 3 * * *" 
  collection:
    logs:
      type: "fluentd"  
      fluentd: {}
~~~

~~~
$ oc apply -f clo.yaml
The ClusterLogging "instance" is invalid: spec.logStore.elasticsearch.proxy.resources: Required value
~~~

Instead, we change this to:
~~~
apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  name: "instance" 
  namespace: "openshift-logging"
spec:
  managementState: "Managed"  
  logStore:
    type: "elasticsearch"  
    retentionPolicy: 
      application:
        maxAge: 1d
      infra:
        maxAge: 7d
      audit:
        maxAge: 7d
    elasticsearch:
      nodeCount: 3 
      storage:
        storageClassName: "<storage-class-name>" 
        size: 200G
      resources: 
        requests:
          memory: "8Gi"
      proxy:
        resources:
          limits:
            memory: 256Mi
          requests:
            memory: 256Mi
      redundancyPolicy: "SingleRedundancy"
  visualization:
    type: "kibana"  
    kibana:
      replicas: 1
  curation:
    type: "curator"
    curator:
      schedule: "30 3 * * *" 
  collection:
    logs:
      type: "fluentd"  
      fluentd: {}
~~~

Thanks,

Andreas

Comment 1 Rolfe Dlugy-Hegwer 2021-03-07 00:01:18 UTC
Being fixed by https://github.com/openshift/openshift-docs/pull/30170

Comment 2 Rolfe Dlugy-Hegwer 2021-03-08 18:58:09 UTC
Fixed by https://github.com/openshift/openshift-docs/pull/30170