Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-2742

[Jaeger] Break the component parameters into two tables

XMLWordPrintable

      This needs to happen for both the v1 and v2 docs.

       

      From comments on https://github.com/openshift/openshift-docs/pull/27263#discussion_r524056880

       

      objectiser [ on Nov 16, 2020 |https://github.com/openshift/openshift-docs/pull/27263#discussion_r524056880]

      This is still going to cause confusion, as this option and the next are defined under collector/options, e.g.
       {{collector:
      options:
      collector:
      num-workers: 50}}
      whereas the replicas field is:
       {{collector:
      replicas: 5}}
      I think we need two tables - one for the parameters that are used by the operator (or k8s), and the other for the options that are passed to the component (collector in this case).

      JStickler [ on Nov 17, 2020 |https://github.com/openshift/openshift-docs/pull/27263#discussion_r525315548]

      Let's see if I've got the distinction clear before I start movings things around into new tables.

      • Parameters used by the operator are specified under the component in the YAML file (in this case under "collector")
      • Parameters specified under "component: options{}" are passed to the component

      And is there somewhere where all this is written down? I've been trying to piece things together from various example files in the Jaeger Operator repo, but a definitive list would be really useful. The CLI flags (https://www.jaegertracing.io/docs/1.21/cli/#jaeger-collector-elasticsearch) don't really help in figuring out where the options would be nested in the configuration files.
       

      objectiser [ on Nov 17, 2020 |https://github.com/openshift/openshift-docs/pull/27263#discussion_r525329435]

      Correct, you have the distinction clear.

      The CLI flags only appear in the component/options section (i.e. the second category), passed to the component.

      Unfortunately the other types are not generated into easily understandable docs yet - there are some godocs: https://godoc.org/github.com/jaegertracing/jaeger-operator/pkg/apis/jaegertracing/v1

      So for these, probably the examples are a good source still.
       

      JStickler [ on Nov 17, 2020 |https://github.com/openshift/openshift-docs/pull/27263#discussion_r525423313]

      The CLI flags only appear in the component/options section (i.e. the second category), passed to the component.

      Well, that is actually very helpful. And thanks for the link to the godocs, I hadn't seen those before.

              jstickler Julie Stickler (Inactive)
              jstickler Julie Stickler (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: