-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSSMDOC-133 Roll back autoscaling options in 4.3, 4.4, 4.5 branches. #27263
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@vikram-redhat , requesting permission to update the 4.3 branch with this PR. |
The preview will be available shortly at: |
Ack. |
The scripts for syncing this to the portal are turned off for 4.3. If this needs to be updated on the portal as well, let me know. |
6b97154
to
45d64de
Compare
modules/jaeger-config-collector.adoc
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@objectiser , this is somewhat of a stale PR. I'm creating a new issue to deal with splitting the table format so that
1 - we can move forward with removing this content from these branches and
2 - the tables get updated in the current and future branches.
JIRA is OSSMDOC-233.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @jpkrohling
45d64de
to
a6d31c7
Compare
Deploy preview for osdocs ready! Built with commit 2a5280b |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving, with the idea that we'll review the tables with the parameters, so that they are consistent and it's clear what belongs where (.spec.collector.options.collector.num-replicas
vs. .collector.num-replicas
).
a6d31c7
to
2a5280b
Compare
/cherry-pick enterprise-4.4 |
/cherry-pick enterprise-4.5 |
@neal-timpe: #27263 failed to apply on top of branch "enterprise-4.4":
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
@neal-timpe: #27263 failed to apply on top of branch "enterprise-4.5":
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Manual cherry pick #27263 to 4.5 branch.
Manual cherry pick #27263 to Enterprise 4.4 branch
Part two of two.
I made a mistake and the Jaeger autoscaling doc were merged and published prematurely. This feature is only available on the latest release, so the content needs to be rolled back and removed from the 4.3, 4.4, and 4.5 branches,.