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

lokistack.spec.storage.schemas API description

XMLWordPrintable

    • False
    • None
    • False
    • NEW
    • VERIFIED
    • Release Note Not Required
    • Log Storage - Sprint 254, Log Storage - Sprint 255, Log Storage - Sprint 256, Log Storage - Sprint 257, Log Storage - Sprint 258
    • Moderate

      Description of problem:

      When reviewing the description of the API `lokistack.spec.storage.schemas` says:

      $ oc explain lokistack.spec.storage.schemas
      GROUP:      loki.grafana.com
      KIND:       LokiStack
      VERSION:    v1FIELD: schemas <[]Object>DESCRIPTION:
          Schemas for reading and writing logs.
          ObjectStorageSchema defines the requirements needed to configure a new
          storage schema.
          
      FIELDS:
        effectiveDate    <string> -required-
          EffectiveDate is the date in UTC that the schema will be applied on.
          To ensure readibility of logs, this date should be before the current
          date in UTC.
      

      This is not totally correct, exactly the phrase `date should be before the current date` . As it's explained in the "upstream" documentation the field `for a new install, this must be a date in the past, use a recent date. Format is YYYY-MM-DD.`, but if it's for changing the schema,  then: `Always set the from date in the new schema to a date in the future.`

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

      LokiStack Operator 5.7, 5.8 and 5.9

      Actual results:

      Expected results:

      The description of `lokistack.spec.storage.schemas` explains better in what situations the date must be in the past and in what situations the date must be in the future.

      Additional info:

              rojacob@redhat.com Robert Jacob
              rhn-support-ocasalsa Oscar Casal Sanchez
              Kabir Bharti Kabir Bharti
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: