Uploaded image for project: 'OpenShift Logging'
  1. OpenShift Logging
  2. LOG-6855

Not listed the types for different fields in the clusterLogging

XMLWordPrintable

    • False
    • None
    • False
    • NEW
    • NEW
    • Before this fix, oc explain was incomplete for clusterlogging.spec.visualization and clusterlogging.spec.collection. After this fix, the supported types are displayed accordingly.
    • Bug Fix
    • Log Collection - Sprint 268
    • Low

      Description of problem:

      In "clusterlogging.spec.visualization.types"

      When it's run the command:

      $  oc explain clusterlogging.spec.visualization
      GROUP:      logging.openshift.io
      KIND:       ClusterLogging
      VERSION:    v1
      
      FIELD: visualization <Object>
      
      DESCRIPTION:
          Specification of the Visualization component for the cluster
          
      FIELDS:
        kibana	<Object>
          Specification of the Kibana Visualization component
      
        nodeSelector	<map[string]string>
          Define which Nodes the Pods are scheduled on.
      
        ocpConsole	<Object>
          OCPConsole is the specification for the OCP console plugin
      
        tolerations	<[]Object>
          Define the tolerations the Pods will accept
      
        type	<string> -required-
          The type of Visualization to configure
       

      It's listed in the possible fields: "kibana", "nodeSelector", "ocpConsole", "tolerations" and "type".

      Then, it's observed two different problems in this output returned

      1. It's not listed in the field "type" the possible values
      2. If an user infers that from the fields returned, the valid values that it can take could be "kibana" and "ocpConsole", this is false, as "ocpConsole" is not a valid value as it's "ocp-console"

      In "clusterlogging.spec.collection.types"

      Other example where it's not accurate is "clusterlogging.spec.collection" where when run the command below, it's not listed in the field "type" the possible values, then, an user won't be able to know that the possible types are "fluentd" or "vector":

      $ oc explain clusterlogging.spec.collection
      GROUP:      logging.openshift.io
      KIND:       ClusterLogging
      VERSION:    v1
      
      FIELD: collection <Object>
      
      DESCRIPTION:
          Specification of the Collection component for the cluster
          
      FIELDS:
        fluentd	<Object>
          Fluentd represents the configuration for forwarders of type fluentd.
      
        logs	<Object>
          Deprecated. Specification of Log Collection for the cluster
          See spec.collection
      
        nodeSelector	<map[string]string>
          Define which Nodes the Pods are scheduled on.
      
        resources	<Object>
          The resource requirements for the collector
      
        tolerations	<[]Object>
          Define the tolerations the Pods will accept
      
        type	<string>
          The type of Log Collection to configure
      

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

      Latest Cluster Logging Operator 5.8 and 5.9

      $ oc get csv -n openshift-logging |grep "logging"
      cluster-logging.v5.9.12          Red Hat OpenShift Logging                        5.9.12     cluster-logging.v5.9.11          Succeeded 

      How reproducible:

      Always

      Steps to Reproduce:

      1. Install the ClusterLogging Operator
      2. Run the command "oc explain clusterlogging.spec.visualization" or "oc explain clusterlogging.spec.collection"

      Actual results:

      1. It's not listed in the field "type" the possible values
      2. From the command "oc explain clusterlogging.spec.visualization" if an user infers that from the fields returned, the valid values that it can take could be "kibana" and "ocpConsole", this is false, as "ocpConsole" is not a valid value as it's "ocp-console"
      3. From the command "$ oc explain clusterlogging.spec.collection" is not possible to know that the possible values for the types are "vector" and "fluentd"

      Expected results:

      The field "clusterlogging.spec.visualization.type" contains a list of the possible values.

      The field "clusterlogging.spec.collection.type" contains a list of the possible values.

      Additional info:

              rh-ee-calee Calvin Lee
              rhn-support-ocasalsa Oscar Casal Sanchez
              Anping Li
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: