Skip to content

Commit 3d6505a

Browse files
neal-timpeneal-timpe
authored
Merge pull request #27263 from JStickler/OSSMDOC-133
OSSMDOC-133 Roll back autoscaling options in 4.3, 4.4, 4.5 branches.
2 parents 8f56e8a + 2a5280b commit 3d6505a

File tree

2 files changed

+57
-111
lines changed

2 files changed

+57
-111
lines changed

‎modules/jaeger-config-collector.adoc‎

Lines changed: 33 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,29 @@ The Jaeger Collector is the component responsible for receiving the spans that w
1010

1111
The collectors are stateless and thus many instances of Jaeger Collector can be run in parallel. Collectors require almost no configuration, except for the location of the Elasticsearch cluster.
1212

13-
.Jaeger Collector parameters
13+
.Jaeger Collector parameters used by the Operator
14+
[options="header"]
15+
[cols="l, a, a"]
16+
|===
17+
|Parameter |Description |Values
18+
|collector:
19+
num-workers:
20+
|The number of workers pulling from the queue.
21+
|Integer, for example, `50`
22+
23+
|collector:
24+
queue-size:
25+
|The size of the Collector queue.
26+
|Integer, for example, `2000`
27+
28+
|collector:
29+
replicas:
30+
|Specifies the number of Collector replicas to create.
31+
|Integer, for example, `5`
32+
|===
33+
34+
35+
.Jaeger parameters passed to the Collector
1436
[options="header"]
1537
[cols="l, a, a"]
1638
|===
@@ -21,70 +43,22 @@ The collectors are stateless and thus many instances of Jaeger Collector can be
2143
|Configuration options that define the Jaeger Collector.
2244
|
2345

24-
|autoscale:
25-
|This parameter controls whether to enable/disable autoscaling for the Collector. Set to `false` to explicitly disable autoscaling. Note that autoscaling is only supported for Jaeger 1.20 or later.
26-
|`true`/`false`
27-
28-
|kafka:
29-
producer:
30-
topic: jaeger-spans
46+
|options:
47+
kafka:
48+
producer:
49+
topic: jaeger-spans
3150
|The `topic` parameter identifies the Kafka configuration used by the collector to produce the messages, and the ingester to consume the messages.
3251
|Label for the producer
3352

34-
|kafka:
35-
producer:
36-
brokers: my-cluster-kafka-brokers.kafka:9092
53+
|options:
54+
kafka:
55+
producer:
56+
brokers: my-cluster-kafka-brokers.kafka:9092
3757
|Identifies the Kafka configuration used by the Collector to produce the messages. If brokers are not specified, and you have AMQ Streams 1.4.0+ installed, Jaeger will self-provision Kafka.
3858
|
3959

40-
|log-level:
60+
|options:
61+
log-level:
4162
|Logging level for the collector.
4263
|`trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`
43-
44-
|maxReplicas:
45-
|Specifies the maximum number of replicas to create when autoscaling the Collector.
46-
|Integer, for example, `100`
47-
48-
|num-workers:
49-
|The number of workers pulling from the queue.
50-
|Integer, for example, `50`
51-
52-
|queue-size:
53-
|The size of the Collector queue.
54-
|Integer, for example, `2000`
55-
56-
|replicas:
57-
|Specifies the number of Collector replicas to create.
58-
|Integer, for example, `5`
5964
|===
60-
61-
62-
== Configuring the Collector for autoscaling
63-
64-
[NOTE]
65-
====
66-
Autoscaling is only supported for Jaeger 1.20 or later.
67-
====
68-
69-
You can configure the Collector to autoscale; the Collector will scale up or down based on the CPU and/or memory consumption. Configuring the Collector to autoscale can help you ensure your Jaeger environment scales up during times of increased load, and scales down when less resources are needed, saving on costs. You configure autoscaling by setting the `autoscale` parameter to `true` and specifying a value for `.spec.collector.maxReplicas` along with a reasonable value for the resources that you expect the Collector’s pod to consume. If you do not set a value for `.spec.collector.maxReplicas` the Operator will set it to `100`.
70-
71-
By default, when there is no value provided for `.spec.collector.replicas`, the Jaeger Operator creates a horizontal pod autoscaler (HPA) configuration for the Collector. For more information about HPA, refer to the link:https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/[Kubernetes documentation].
72-
73-
The following is an example autoscaling configuration, setting the Collector’s limits as well as the maximum number of replicas:
74-
75-
.Collector autoscaling example
76-
[source,yaml]
77-
----
78-
apiVersion: jaegertracing.io/v1
79-
kind: Jaeger
80-
metadata:
81-
name: simple-prod
82-
spec:
83-
strategy: production
84-
collector:
85-
maxReplicas: 5
86-
resources:
87-
limits:
88-
cpu: 100m
89-
memory: 128Mi
90-
----

‎modules/jaeger-config-ingester.adoc‎

Lines changed: 24 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,20 @@ This REFERENCE module included in the following assemblies:
88

99
Ingester is a service that reads from a Kafka topic and writes to another storage backend (Elasticsearch). If you are using the `allInOne` or `production` deployment strategies, you do not need to configure the Ingester service.
1010

11-
.Jaeger Ingester parameters
11+
.Jaeger Ingester parameters used by the Operator
12+
[options="header"]
13+
[cols="l, a, a"]
14+
|===
15+
|Parameter |Description |Values
16+
|ingester:
17+
deadlockInterval:
18+
| Specifies the interval (in seconds or minutes) that the Ingester should wait for a message before terminating.
19+
The deadlock interval is disabled by default (set to 0), to avoid the Ingester being terminated when no messages arrive while the system is being initialized.
20+
|Minutes and seconds, for example, `1m0s`. Default value is `0`.
21+
|===
22+
23+
24+
.Jaeger parameters passed to the Ingester
1225
[options="header"]
1326
[cols="l, a, a"]
1427
|===
@@ -20,35 +33,24 @@ Ingester is a service that reads from a Kafka topic and writes to another storag
2033
|Configuration options that define the Ingester service.
2134
|
2235

23-
|autoscale:
24-
|This parameter controls whether to enable/disable autoscaling for the Ingester. Autoscaling is enabled by default. Set to `false` to explicitly disable autoscaling. Note that autoscaling is only supported for Jaeger 1.20 or later.
25-
|`true`/`false`
26-
27-
|kafka:
28-
consumer:
29-
topic:
36+
|options:
37+
kafka:
38+
consumer:
39+
topic:
3040
|The `topic` parameter identifies the Kafka configuration used by the collector to produce the messages, and the ingester to consume the messages.
3141
|Label for the consumer. For example, `jaeger-spans`.
3242

33-
|kafka:
34-
consumer:
35-
brokers:
43+
|options:
44+
kafka:
45+
consumer:
46+
brokers:
3647
|Identifies the Kafka configuration used by the Ingester to consume the messages.
3748
|Label for the broker, for example, `my-cluster-kafka-brokers.kafka:9092`.
3849

39-
|ingester:
40-
deadlockInterval:
41-
| Specifies the interval (in seconds or minutes) that the Ingester should wait for a message before terminating.
42-
The deadlock interval is disabled by default (set to 0), to avoid the Ingester being terminated when no messages arrive while the system is being initialized.
43-
|Minutes and seconds, for example, `1m0s`. Default value is `0`.
44-
45-
|log-level:
50+
|options:
51+
log-level:
4652
|Logging level for the Ingester.
4753
|Possible values: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
48-
49-
|maxReplicas:
50-
|Specifies the maximum number of replicas to create when autoscaling the Ingester.
51-
|Integer, for example, `100`.
5254
|===
5355

5456
.Streaming Collector and Ingester example
@@ -80,33 +82,3 @@ spec:
8082
es:
8183
server-urls: http://elasticsearch:9200
8284
----
83-
84-
== Configuring Ingester for autoscaling
85-
86-
[NOTE]
87-
====
88-
Autoscaling is only supported for Jaeger 1.20 or later.
89-
====
90-
91-
You can configure the Ingester to autoscale; the Ingester will scale up or down based on the CPU and/or memory consumption. Configuring the Ingester to autoscale can help you ensure your Jaeger environment scales up during times of increased load, and scales down when less resources are needed, saving on costs. You configure autoscaling by setting the `autoscale` parameter to `true` and specifying a value for `.spec.ingester.maxReplicas` along with a reasonable value for the resources that you expect the Ingester's pod to consume. If you do not set a value for `.spec.ingester.maxReplicas` the Operator will set it to `100`.
92-
93-
By default, when there is no value provided for `.spec.ingester.replicas`, the Jaeger Operator creates a horizontal pod autoscaler (HPA) configuration for the Ingester. For more information about HPA, refer to the link:https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/[Kubernetes documentation].
94-
95-
The following is an example autoscaling configuration, setting the Ingester’s limits as well as the maximum number of replicas:
96-
97-
.Ingester autoscaling example
98-
[source,yaml]
99-
----
100-
apiVersion: jaegertracing.io/v1
101-
kind: Jaeger
102-
metadata:
103-
name: simple-streaming
104-
spec:
105-
strategy: streaming
106-
ingester:
107-
maxReplicas: 8
108-
resources:
109-
limits:
110-
cpu: 100m
111-
memory: 128Mi
112-
----

0 commit comments

Comments
 (0)