Skip to content

Commit ee319a8

Browse files
smallc2009cw-Guo
smallc2009
authored and
cw-Guo
committed
docs(fluentbit): clarify networking option docs and type semantics
Signed-off-by: Anson <anson.liu@live.com>
1 parent 7c51546 commit ee319a8

11 files changed

Lines changed: 233 additions & 231 deletions

File tree

‎apis/fluentbit/v1alpha2/plugins/net_types.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ type Networking struct {
2424
// Select the primary DNS resolver type (LEGACY or ASYNC).
2525
// +kubebuilder:validation:Enum:="LEGACY";"ASYNC"
2626
DNSResolver *string `json:"DNSResolver,omitempty"`
27-
// Enable or disable connection keepalive support. Accepts a boolean value: on / off.
27+
// Enable or disable connection keepalive support. Accepts string enum values: on / off.
2828
// +kubebuilder:validation:Enum:="on";"off"
2929
Keepalive *string `json:"keepalive,omitempty"`
3030
// Set maximum time expressed in seconds for an idle keepalive connection.
@@ -35,7 +35,7 @@ type Networking struct {
3535
MaxWorkerConnections *int32 `json:"maxWorkerConnections,omitempty"`
3636
// Ignore the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY when set.
3737
ProxyEnvIgnore *bool `json:"proxyEnvIgnore,omitempty"`
38-
// Enable or disable Keepalive support. Accepts a boolean value: on / off.
38+
// Enable or disable Keepalive support. Accepts string enum values: on / off.
3939
// +kubebuilder:validation:Enum:="on";"off"
4040
TCPKeepalive *string `json:"tcpKeepalive,omitempty"`
4141
// Interval between the last data packet sent and the first TCP keepalive probe.

‎apis/fluentbit/v1alpha2/plugins/output/s3_types_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ func TestOutput_S3_Params(t *testing.T) {
4949
DNSMode: utils.ToPtr("TCP"),
5050
DNSPreferIPv4: utils.ToPtr(false),
5151
DNSPreferIPv6: utils.ToPtr(false),
52-
IoTimeout: utils.ToPtr[int32](0),
52+
IOTimeout: utils.ToPtr[int32](0),
5353
KeepaliveMaxRecycle: utils.ToPtr[int32](2000),
5454
MaxWorkerConnections: utils.ToPtr[int32](0),
5555
ProxyEnvIgnore: utils.ToPtr(false),

‎charts/fluent-operator-fluent-bit-crds/templates/fluentbit.fluent.io_clusteroutputs.yaml‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ spec:
133133
type: integer
134134
keepalive:
135135
description: 'Enable or disable connection keepalive support.
136-
Accepts a boolean value: on / off.'
136+
Accepts string enum values: on / off.'
137137
enum:
138138
- "on"
139139
- "off"
@@ -162,7 +162,7 @@ spec:
162162
type: string
163163
tcpKeepalive:
164164
description: 'Enable or disable Keepalive support. Accepts
165-
a boolean value: on / off.'
165+
string enum values: on / off.'
166166
enum:
167167
- "on"
168168
- "off"
@@ -835,7 +835,7 @@ spec:
835835
type: integer
836836
keepalive:
837837
description: 'Enable or disable connection keepalive support.
838-
Accepts a boolean value: on / off.'
838+
Accepts string enum values: on / off.'
839839
enum:
840840
- "on"
841841
- "off"
@@ -864,7 +864,7 @@ spec:
864864
type: string
865865
tcpKeepalive:
866866
description: 'Enable or disable Keepalive support. Accepts
867-
a boolean value: on / off.'
867+
string enum values: on / off.'
868868
enum:
869869
- "on"
870870
- "off"
@@ -1194,7 +1194,7 @@ spec:
11941194
type: integer
11951195
keepalive:
11961196
description: 'Enable or disable connection keepalive support.
1197-
Accepts a boolean value: on / off.'
1197+
Accepts string enum values: on / off.'
11981198
enum:
11991199
- "on"
12001200
- "off"
@@ -1223,7 +1223,7 @@ spec:
12231223
type: string
12241224
tcpKeepalive:
12251225
description: 'Enable or disable Keepalive support. Accepts
1226-
a boolean value: on / off.'
1226+
string enum values: on / off.'
12271227
enum:
12281228
- "on"
12291229
- "off"
@@ -1486,7 +1486,7 @@ spec:
14861486
type: integer
14871487
keepalive:
14881488
description: 'Enable or disable connection keepalive support.
1489-
Accepts a boolean value: on / off.'
1489+
Accepts string enum values: on / off.'
14901490
enum:
14911491
- "on"
14921492
- "off"
@@ -1515,7 +1515,7 @@ spec:
15151515
type: string
15161516
tcpKeepalive:
15171517
description: 'Enable or disable Keepalive support. Accepts
1518-
a boolean value: on / off.'
1518+
string enum values: on / off.'
15191519
enum:
15201520
- "on"
15211521
- "off"
@@ -1800,7 +1800,7 @@ spec:
18001800
type: integer
18011801
keepalive:
18021802
description: 'Enable or disable connection keepalive support.
1803-
Accepts a boolean value: on / off.'
1803+
Accepts string enum values: on / off.'
18041804
enum:
18051805
- "on"
18061806
- "off"
@@ -1829,7 +1829,7 @@ spec:
18291829
type: string
18301830
tcpKeepalive:
18311831
description: 'Enable or disable Keepalive support. Accepts
1832-
a boolean value: on / off.'
1832+
string enum values: on / off.'
18331833
enum:
18341834
- "on"
18351835
- "off"
@@ -2096,7 +2096,7 @@ spec:
20962096
type: integer
20972097
keepalive:
20982098
description: 'Enable or disable connection keepalive support.
2099-
Accepts a boolean value: on / off.'
2099+
Accepts string enum values: on / off.'
21002100
enum:
21012101
- "on"
21022102
- "off"
@@ -2125,7 +2125,7 @@ spec:
21252125
type: string
21262126
tcpKeepalive:
21272127
description: 'Enable or disable Keepalive support. Accepts
2128-
a boolean value: on / off.'
2128+
string enum values: on / off.'
21292129
enum:
21302130
- "on"
21312131
- "off"
@@ -2571,7 +2571,7 @@ spec:
25712571
type: integer
25722572
keepalive:
25732573
description: 'Enable or disable connection keepalive support.
2574-
Accepts a boolean value: on / off.'
2574+
Accepts string enum values: on / off.'
25752575
enum:
25762576
- "on"
25772577
- "off"
@@ -2600,7 +2600,7 @@ spec:
26002600
type: string
26012601
tcpKeepalive:
26022602
description: 'Enable or disable Keepalive support. Accepts
2603-
a boolean value: on / off.'
2603+
string enum values: on / off.'
26042604
enum:
26052605
- "on"
26062606
- "off"
@@ -2968,7 +2968,7 @@ spec:
29682968
type: integer
29692969
keepalive:
29702970
description: 'Enable or disable connection keepalive support.
2971-
Accepts a boolean value: on / off.'
2971+
Accepts string enum values: on / off.'
29722972
enum:
29732973
- "on"
29742974
- "off"
@@ -2997,7 +2997,7 @@ spec:
29972997
type: string
29982998
tcpKeepalive:
29992999
description: 'Enable or disable Keepalive support. Accepts
3000-
a boolean value: on / off.'
3000+
string enum values: on / off.'
30013001
enum:
30023002
- "on"
30033003
- "off"
@@ -3305,7 +3305,7 @@ spec:
33053305
type: integer
33063306
keepalive:
33073307
description: 'Enable or disable connection keepalive support.
3308-
Accepts a boolean value: on / off.'
3308+
Accepts string enum values: on / off.'
33093309
enum:
33103310
- "on"
33113311
- "off"
@@ -3334,7 +3334,7 @@ spec:
33343334
type: string
33353335
tcpKeepalive:
33363336
description: 'Enable or disable Keepalive support. Accepts
3337-
a boolean value: on / off.'
3337+
string enum values: on / off.'
33383338
enum:
33393339
- "on"
33403340
- "off"
@@ -3609,7 +3609,7 @@ spec:
36093609
type: integer
36103610
keepalive:
36113611
description: 'Enable or disable connection keepalive support.
3612-
Accepts a boolean value: on / off.'
3612+
Accepts string enum values: on / off.'
36133613
enum:
36143614
- "on"
36153615
- "off"
@@ -3638,7 +3638,7 @@ spec:
36383638
type: string
36393639
tcpKeepalive:
36403640
description: 'Enable or disable Keepalive support. Accepts
3641-
a boolean value: on / off.'
3641+
string enum values: on / off.'
36423642
enum:
36433643
- "on"
36443644
- "off"
@@ -3921,7 +3921,7 @@ spec:
39213921
type: integer
39223922
keepalive:
39233923
description: 'Enable or disable connection keepalive support.
3924-
Accepts a boolean value: on / off.'
3924+
Accepts string enum values: on / off.'
39253925
enum:
39263926
- "on"
39273927
- "off"
@@ -3950,7 +3950,7 @@ spec:
39503950
type: string
39513951
tcpKeepalive:
39523952
description: 'Enable or disable Keepalive support. Accepts
3953-
a boolean value: on / off.'
3953+
string enum values: on / off.'
39543954
enum:
39553955
- "on"
39563956
- "off"
@@ -4218,7 +4218,7 @@ spec:
42184218
type: integer
42194219
keepalive:
42204220
description: 'Enable or disable connection keepalive support.
4221-
Accepts a boolean value: on / off.'
4221+
Accepts string enum values: on / off.'
42224222
enum:
42234223
- "on"
42244224
- "off"
@@ -4247,7 +4247,7 @@ spec:
42474247
type: string
42484248
tcpKeepalive:
42494249
description: 'Enable or disable Keepalive support. Accepts
4250-
a boolean value: on / off.'
4250+
string enum values: on / off.'
42514251
enum:
42524252
- "on"
42534253
- "off"
@@ -4614,7 +4614,7 @@ spec:
46144614
type: integer
46154615
keepalive:
46164616
description: 'Enable or disable connection keepalive support.
4617-
Accepts a boolean value: on / off.'
4617+
Accepts string enum values: on / off.'
46184618
enum:
46194619
- "on"
46204620
- "off"
@@ -4643,7 +4643,7 @@ spec:
46434643
type: string
46444644
tcpKeepalive:
46454645
description: 'Enable or disable Keepalive support. Accepts
4646-
a boolean value: on / off.'
4646+
string enum values: on / off.'
46474647
enum:
46484648
- "on"
46494649
- "off"
@@ -4863,7 +4863,7 @@ spec:
48634863
type: integer
48644864
keepalive:
48654865
description: 'Enable or disable connection keepalive support.
4866-
Accepts a boolean value: on / off.'
4866+
Accepts string enum values: on / off.'
48674867
enum:
48684868
- "on"
48694869
- "off"
@@ -4892,7 +4892,7 @@ spec:
48924892
type: string
48934893
tcpKeepalive:
48944894
description: 'Enable or disable Keepalive support. Accepts
4895-
a boolean value: on / off.'
4895+
string enum values: on / off.'
48964896
enum:
48974897
- "on"
48984898
- "off"

0 commit comments

Comments
 (0)