-
Notifications
You must be signed in to change notification settings - Fork 676
/
all-crds.yaml
8315 lines (8315 loc) · 510 KB
/
all-crds.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.8.0
creationTimestamp: null
name: agents.agent.k8s.elastic.co
spec:
group: agent.k8s.elastic.co
names:
categories:
- elastic
kind: Agent
listKind: AgentList
plural: agents
shortNames:
- agent
singular: agent
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.health
name: health
type: string
- description: Available nodes
jsonPath: .status.availableNodes
name: available
type: integer
- description: Expected nodes
jsonPath: .status.expectedNodes
name: expected
type: integer
- description: Agent version
jsonPath: .status.version
name: version
type: string
- jsonPath: .metadata.creationTimestamp
name: age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: Agent is the Schema for the Agents API.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: AgentSpec defines the desired state of the Agent
properties:
config:
description: Config holds the Agent configuration. At most one of
[`Config`, `ConfigRef`] can be specified.
type: object
x-kubernetes-preserve-unknown-fields: true
configRef:
description: ConfigRef contains a reference to an existing Kubernetes
Secret holding the Agent configuration. Agent settings must be specified
as yaml, under a single "agent.yml" entry. At most one of [`Config`,
`ConfigRef`] can be specified.
properties:
secretName:
description: SecretName is the name of the secret.
type: string
type: object
daemonSet:
description: DaemonSet specifies the Agent should be deployed as a
DaemonSet, and allows providing its spec. Cannot be used along with
`deployment`.
properties:
podTemplate:
description: PodTemplateSpec describes the data a pod should have
when created from a template
type: object
x-kubernetes-preserve-unknown-fields: true
updateStrategy:
description: DaemonSetUpdateStrategy is a struct used to control
the update strategy for a DaemonSet.
properties:
rollingUpdate:
description: 'Rolling update config params. Present only if
type = "RollingUpdate". --- TODO: Update this to follow
our convention for oneOf, whatever we decide it to be. Same
as Deployment `strategy.rollingUpdate`. See https://github.com/kubernetes/kubernetes/issues/35345'
properties:
maxSurge:
anyOf:
- type: integer
- type: string
description: 'The maximum number of nodes with an existing
available DaemonSet pod that can have an updated DaemonSet
pod during during an update. Value can be an absolute
number (ex: 5) or a percentage of desired pods (ex:
10%). This can not be 0 if MaxUnavailable is 0. Absolute
number is calculated from percentage by rounding up
to a minimum of 1. Default value is 0. Example: when
this is set to 30%, at most 30% of the total number
of nodes that should be running the daemon pod (i.e.
status.desiredNumberScheduled) can have their a new
pod created before the old pod is marked as deleted.
The update starts by launching new pods on 30% of nodes.
Once an updated pod is available (Ready for at least
minReadySeconds) the old DaemonSet pod on that node
is marked deleted. If the old pod becomes unavailable
for any reason (Ready transitions to false, is evicted,
or is drained) an updated pod is immediatedly created
on that node without considering surge limits. Allowing
surge implies the possibility that the resources consumed
by the daemonset on any given node can double if the
readiness check fails, and so resource intensive daemonsets
should take into account that they may cause evictions
during disruption. This is beta field and enabled/disabled
by DaemonSetUpdateSurge feature gate.'
x-kubernetes-int-or-string: true
maxUnavailable:
anyOf:
- type: integer
- type: string
description: 'The maximum number of DaemonSet pods that
can be unavailable during the update. Value can be an
absolute number (ex: 5) or a percentage of total number
of DaemonSet pods at the start of the update (ex: 10%).
Absolute number is calculated from percentage by rounding
up. This cannot be 0 if MaxSurge is 0 Default value
is 1. Example: when this is set to 30%, at most 30%
of the total number of nodes that should be running
the daemon pod (i.e. status.desiredNumberScheduled)
can have their pods stopped for an update at any given
time. The update starts by stopping at most 30% of those
DaemonSet pods and then brings up new DaemonSet pods
in their place. Once the new pods are available, it
then proceeds onto other DaemonSet pods, thus ensuring
that at least 70% of original number of DaemonSet pods
are available at all times during the update.'
x-kubernetes-int-or-string: true
type: object
type:
description: Type of daemon set update. Can be "RollingUpdate"
or "OnDelete". Default is RollingUpdate.
type: string
type: object
type: object
deployment:
description: Deployment specifies the Agent should be deployed as
a Deployment, and allows providing its spec. Cannot be used along
with `daemonSet`.
properties:
podTemplate:
description: PodTemplateSpec describes the data a pod should have
when created from a template
type: object
x-kubernetes-preserve-unknown-fields: true
replicas:
format: int32
type: integer
strategy:
description: DeploymentStrategy describes how to replace existing
pods with new ones.
properties:
rollingUpdate:
description: 'Rolling update config params. Present only if
DeploymentStrategyType = RollingUpdate. --- TODO: Update
this to follow our convention for oneOf, whatever we decide
it to be.'
properties:
maxSurge:
anyOf:
- type: integer
- type: string
description: 'The maximum number of pods that can be scheduled
above the desired number of pods. Value can be an absolute
number (ex: 5) or a percentage of desired pods (ex:
10%). This can not be 0 if MaxUnavailable is 0. Absolute
number is calculated from percentage by rounding up.
Defaults to 25%. Example: when this is set to 30%, the
new ReplicaSet can be scaled up immediately when the
rolling update starts, such that the total number of
old and new pods do not exceed 130% of desired pods.
Once old pods have been killed, new ReplicaSet can be
scaled up further, ensuring that total number of pods
running at any time during the update is at most 130%
of desired pods.'
x-kubernetes-int-or-string: true
maxUnavailable:
anyOf:
- type: integer
- type: string
description: 'The maximum number of pods that can be unavailable
during the update. Value can be an absolute number (ex:
5) or a percentage of desired pods (ex: 10%). Absolute
number is calculated from percentage by rounding down.
This can not be 0 if MaxSurge is 0. Defaults to 25%.
Example: when this is set to 30%, the old ReplicaSet
can be scaled down to 70% of desired pods immediately
when the rolling update starts. Once new pods are ready,
old ReplicaSet can be scaled down further, followed
by scaling up the new ReplicaSet, ensuring that the
total number of pods available at all times during the
update is at least 70% of desired pods.'
x-kubernetes-int-or-string: true
type: object
type:
description: Type of deployment. Can be "Recreate" or "RollingUpdate".
Default is RollingUpdate.
type: string
type: object
type: object
elasticsearchRefs:
description: ElasticsearchRefs is a reference to a list of Elasticsearch
clusters running in the same Kubernetes cluster. Due to existing
limitations, only a single ES cluster is currently supported.
items:
properties:
name:
description: Name of an existing Kubernetes object corresponding
to an Elastic resource managed by ECK.
type: string
namespace:
description: Namespace of the Kubernetes object. If empty, defaults
to the current namespace.
type: string
outputName:
type: string
secretName:
description: 'SecretName is the name of an existing Kubernetes
secret that contains connection information for associating
an Elastic resource not managed by the operator. The referenced
secret must contain the following: - `url`: the URL to reach
the Elastic resource - `username`: the username of the user
to be authenticated to the Elastic resource - `password`:
the password of the user to be authenticated to the Elastic
resource - `ca.crt`: the CA certificate in PEM format (optional).
This field cannot be used in combination with the other fields
name, namespace or serviceName.'
type: string
serviceName:
description: ServiceName is the name of an existing Kubernetes
service which is used to make requests to the referenced object.
It has to be in the same namespace as the referenced resource.
If left empty, the default HTTP service of the referenced
resource is used.
type: string
type: object
type: array
fleetServerEnabled:
description: FleetServerEnabled determines whether this Agent will
launch Fleet Server. Don't set unless `mode` is set to `fleet`.
type: boolean
fleetServerRef:
description: FleetServerRef is a reference to Fleet Server that this
Agent should connect to to obtain it's configuration. Don't set
unless `mode` is set to `fleet`.
properties:
name:
description: Name of an existing Kubernetes object corresponding
to an Elastic resource managed by ECK.
type: string
namespace:
description: Namespace of the Kubernetes object. If empty, defaults
to the current namespace.
type: string
secretName:
description: 'SecretName is the name of an existing Kubernetes
secret that contains connection information for associating
an Elastic resource not managed by the operator. The referenced
secret must contain the following: - `url`: the URL to reach
the Elastic resource - `username`: the username of the user
to be authenticated to the Elastic resource - `password`: the
password of the user to be authenticated to the Elastic resource
- `ca.crt`: the CA certificate in PEM format (optional). This
field cannot be used in combination with the other fields name,
namespace or serviceName.'
type: string
serviceName:
description: ServiceName is the name of an existing Kubernetes
service which is used to make requests to the referenced object.
It has to be in the same namespace as the referenced resource.
If left empty, the default HTTP service of the referenced resource
is used.
type: string
type: object
http:
description: HTTP holds the HTTP layer configuration for the Agent
in Fleet mode with Fleet Server enabled.
properties:
service:
description: Service defines the template for the associated Kubernetes
Service object.
properties:
metadata:
description: ObjectMeta is the metadata of the service. The
name and namespace provided here are managed by ECK and
will be ignored.
properties:
annotations:
additionalProperties:
type: string
type: object
finalizers:
items:
type: string
type: array
labels:
additionalProperties:
type: string
type: object
name:
type: string
namespace:
type: string
type: object
spec:
description: Spec is the specification of the service.
properties:
allocateLoadBalancerNodePorts:
description: allocateLoadBalancerNodePorts defines if
NodePorts will be automatically allocated for services
with type LoadBalancer. Default is "true". It may be
set to "false" if the cluster load-balancer does not
rely on NodePorts. If the caller requests specific
NodePorts (by specifying a value), those requests will
be respected, regardless of this field. This field may
only be set for services with type LoadBalancer and
will be cleared if the type is changed to any other
type.
type: boolean
clusterIP:
description: 'clusterIP is the IP address of the service
and is usually assigned randomly. If an address is specified
manually, is in-range (as per system configuration),
and is not in use, it will be allocated to the service;
otherwise creation of the service will fail. This field
may not be changed through updates unless the type field
is also being changed to ExternalName (which requires
this field to be blank) or the type field is being changed
from ExternalName (in which case this field may optionally
be specified, as describe above). Valid values are
"None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual
IP), which is useful when direct endpoint connections
are preferred and proxying is not required. Only applies
to types ClusterIP, NodePort, and LoadBalancer. If this
field is specified when creating a Service of type ExternalName,
creation will fail. This field will be wiped when updating
a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies'
type: string
clusterIPs:
description: "ClusterIPs is a list of IP addresses assigned
to this service, and are usually assigned randomly.
\ If an address is specified manually, is in-range (as
per system configuration), and is not in use, it will
be allocated to the service; otherwise creation of the
service will fail. This field may not be changed through
updates unless the type field is also being changed
to ExternalName (which requires this field to be empty)
or the type field is being changed from ExternalName
(in which case this field may optionally be specified,
as describe above). Valid values are \"None\", empty
string (\"\"), or a valid IP address. Setting this
to \"None\" makes a \"headless service\" (no virtual
IP), which is useful when direct endpoint connections
are preferred and proxying is not required. Only applies
to types ClusterIP, NodePort, and LoadBalancer. If this
field is specified when creating a Service of type ExternalName,
creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not
specified, it will be initialized from the clusterIP
field. If this field is specified, clients must ensure
that clusterIPs[0] and clusterIP have the same value.
\n This field may hold a maximum of two entries (dual-stack
IPs, in either order). These IPs must correspond to
the values of the ipFamilies field. Both clusterIPs
and ipFamilies are governed by the ipFamilyPolicy field.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies"
items:
type: string
type: array
x-kubernetes-list-type: atomic
externalIPs:
description: externalIPs is a list of IP addresses for
which nodes in the cluster will also accept traffic
for this service. These IPs are not managed by Kubernetes. The
user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external
load-balancers that are not part of the Kubernetes system.
items:
type: string
type: array
externalName:
description: externalName is the external reference that
discovery mechanisms will return as an alias for this
service (e.g. a DNS CNAME record). No proxying will
be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type`
to be "ExternalName".
type: string
externalTrafficPolicy:
description: externalTrafficPolicy denotes if this Service
desires to route external traffic to node-local or cluster-wide
endpoints. "Local" preserves the client source IP and
avoids a second hop for LoadBalancer and Nodeport type
services, but risks potentially imbalanced traffic spreading.
"Cluster" obscures the client source IP and may cause
a second hop to another node, but should have good overall
load-spreading.
type: string
healthCheckNodePort:
description: healthCheckNodePort specifies the healthcheck
nodePort for the service. This only applies when type
is set to LoadBalancer and externalTrafficPolicy is
set to Local. If a value is specified, is in-range,
and is not in use, it will be used. If not specified,
a value will be automatically allocated. External systems
(e.g. load-balancers) can use this port to determine
if a given node holds endpoints for this service or
not. If this field is specified when creating a Service
which does not need it, creation will fail. This field
will be wiped when updating a Service to no longer need
it (e.g. changing type).
format: int32
type: integer
internalTrafficPolicy:
description: InternalTrafficPolicy specifies if the cluster
internal traffic should be routed to all endpoints or
node-local endpoints only. "Cluster" routes internal
traffic to a Service to all endpoints. "Local" routes
traffic to node-local endpoints only, traffic is dropped
if no node-local endpoints are ready. The default value
is "Cluster".
type: string
ipFamilies:
description: "IPFamilies is a list of IP families (e.g.
IPv4, IPv6) assigned to this service. This field is
usually assigned automatically based on cluster configuration
and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise
creation of the service will fail. This field is conditionally
mutable: it allows for adding or removing a secondary
IP family, but it does not allow changing the primary
IP family of the Service. Valid values are \"IPv4\"
and \"IPv6\". This field only applies to Services of
types ClusterIP, NodePort, and LoadBalancer, and does
apply to \"headless\" services. This field will be wiped
when updating a Service to type ExternalName. \n This
field may hold a maximum of two entries (dual-stack
families, in either order). These families must correspond
to the values of the clusterIPs field, if specified.
Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy
field."
items:
description: IPFamily represents the IP Family (IPv4
or IPv6). This type is used to express the family
of an IP expressed by a type (e.g. service.spec.ipFamilies).
type: string
type: array
x-kubernetes-list-type: atomic
ipFamilyPolicy:
description: IPFamilyPolicy represents the dual-stack-ness
requested or required by this Service. If there is no
value provided, then this field will be set to SingleStack.
Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured
clusters or a single IP family on single-stack clusters),
or "RequireDualStack" (two IP families on dual-stack
configured clusters, otherwise fail). The ipFamilies
and clusterIPs fields depend on the value of this field.
This field will be wiped when updating a service to
type ExternalName.
type: string
loadBalancerClass:
description: loadBalancerClass is the class of the load
balancer implementation this Service belongs to. If
specified, the value of this field must be a label-style
identifier, with an optional prefix, e.g. "internal-vip"
or "example.com/internal-vip". Unprefixed names are
reserved for end-users. This field can only be set when
the Service type is 'LoadBalancer'. If not set, the
default load balancer implementation is used, today
this is typically done through the cloud provider integration,
but should apply for any default implementation. If
set, it is assumed that a load balancer implementation
is watching for Services with a matching class. Any
default load balancer implementation (e.g. cloud providers)
should ignore Services that set this field. This field
can only be set when creating or updating a Service
to type 'LoadBalancer'. Once set, it can not be changed.
This field will be wiped when a service is updated to
a non 'LoadBalancer' type.
type: string
loadBalancerIP:
description: 'Only applies to Service Type: LoadBalancer.
This feature depends on whether the underlying cloud-provider
supports specifying the loadBalancerIP when a load balancer
is created. This field will be ignored if the cloud-provider
does not support the feature. Deprecated: This field
was under-specified and its meaning varies across implementations,
and it cannot support dual-stack. As of Kubernetes v1.24,
users are encouraged to use implementation-specific
annotations when available. This field may be removed
in a future API version.'
type: string
loadBalancerSourceRanges:
description: 'If specified and supported by the platform,
this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client
IPs. This field will be ignored if the cloud-provider
does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/'
items:
type: string
type: array
ports:
description: 'The list of ports that are exposed by this
service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies'
items:
description: ServicePort contains information on service's
port.
properties:
appProtocol:
description: The application protocol for this port.
This field follows standard Kubernetes label syntax.
Un-prefixed names are reserved for IANA standard
service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
Non-standard protocols should use prefixed names
such as mycompany.com/my-custom-protocol.
type: string
name:
description: The name of this port within the service.
This must be a DNS_LABEL. All ports within a ServiceSpec
must have unique names. When considering the endpoints
for a Service, this must match the 'name' field
in the EndpointPort. Optional if only one ServicePort
is defined on this service.
type: string
nodePort:
description: 'The port on each node on which this
service is exposed when type is NodePort or LoadBalancer. Usually
assigned by the system. If a value is specified,
in-range, and not in use it will be used, otherwise
the operation will fail. If not specified, a
port will be allocated if this Service requires
one. If this field is specified when creating
a Service which does not need it, creation will
fail. This field will be wiped when updating a
Service to no longer need it (e.g. changing type
from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport'
format: int32
type: integer
port:
description: The port that will be exposed by this
service.
format: int32
type: integer
protocol:
default: TCP
description: The IP protocol for this port. Supports
"TCP", "UDP", and "SCTP". Default is TCP.
type: string
targetPort:
anyOf:
- type: integer
- type: string
description: 'Number or name of the port to access
on the pods targeted by the service. Number must
be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a
named port in the target Pod''s container ports.
If this is not specified, the value of the ''port''
field is used (an identity map). This field is
ignored for services with clusterIP=None, and
should be omitted or set equal to the ''port''
field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service'
x-kubernetes-int-or-string: true
required:
- port
type: object
type: array
x-kubernetes-list-map-keys:
- port
- protocol
x-kubernetes-list-type: map
publishNotReadyAddresses:
description: publishNotReadyAddresses indicates that any
agent which deals with endpoints for this Service should
disregard any indications of ready/not-ready. The primary
use case for setting this field is for a StatefulSet's
Headless Service to propagate SRV DNS records for its
Pods for the purpose of peer discovery. The Kubernetes
controllers that generate Endpoints and EndpointSlice
resources for Services interpret this to mean that all
endpoints are considered "ready" even if the Pods themselves
are not. Agents which consume only Kubernetes generated
endpoints through the Endpoints or EndpointSlice resources
can safely assume this behavior.
type: boolean
selector:
additionalProperties:
type: string
description: 'Route service traffic to pods with label
keys and values matching this selector. If empty or
not present, the service is assumed to have an external
process managing its endpoints, which Kubernetes will
not modify. Only applies to types ClusterIP, NodePort,
and LoadBalancer. Ignored if type is ExternalName. More
info: https://kubernetes.io/docs/concepts/services-networking/service/'
type: object
x-kubernetes-map-type: atomic
sessionAffinity:
description: 'Supports "ClientIP" and "None". Used to
maintain session affinity. Enable client IP based session
affinity. Must be ClientIP or None. Defaults to None.
More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies'
type: string
sessionAffinityConfig:
description: sessionAffinityConfig contains the configurations
of session affinity.
properties:
clientIP:
description: clientIP contains the configurations
of Client IP based session affinity.
properties:
timeoutSeconds:
description: timeoutSeconds specifies the seconds
of ClientIP type session sticky time. The value
must be >0 && <=86400(for 1 day) if ServiceAffinity
== "ClientIP". Default value is 10800(for 3
hours).
format: int32
type: integer
type: object
type: object
type:
description: 'type determines how the Service is exposed.
Defaults to ClusterIP. Valid options are ExternalName,
ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates
a cluster-internal IP address for load-balancing to
endpoints. Endpoints are determined by the selector
or if that is not specified, by manual construction
of an Endpoints object or EndpointSlice objects. If
clusterIP is "None", no virtual IP is allocated and
the endpoints are published as a set of endpoints rather
than a virtual IP. "NodePort" builds on ClusterIP and
allocates a port on every node which routes to the same
endpoints as the clusterIP. "LoadBalancer" builds on
NodePort and creates an external load-balancer (if supported
in the current cloud) which routes to the same endpoints
as the clusterIP. "ExternalName" aliases this service
to the specified externalName. Several other fields
do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types'
type: string
type: object
type: object
tls:
description: TLS defines options for configuring TLS for HTTP.
properties:
certificate:
description: "Certificate is a reference to a Kubernetes secret
that contains the certificate and private key for enabling
TLS. The referenced secret should contain the following:
\n - `ca.crt`: The certificate authority (optional). - `tls.crt`:
The certificate (or a chain). - `tls.key`: The private key
to the first certificate in the certificate chain."
properties:
secretName:
description: SecretName is the name of the secret.
type: string
type: object
selfSignedCertificate:
description: SelfSignedCertificate allows configuring the
self-signed certificate generated by the operator.
properties:
disabled:
description: Disabled indicates that the provisioning
of the self-signed certifcate should be disabled.
type: boolean
subjectAltNames:
description: SubjectAlternativeNames is a list of SANs
to include in the generated HTTP TLS certificate.
items:
description: SubjectAlternativeName represents a SAN
entry in a x509 certificate.
properties:
dns:
description: DNS is the DNS name of the subject.
type: string
ip:
description: IP is the IP address of the subject.
type: string
type: object
type: array
type: object
type: object
type: object
image:
description: Image is the Agent Docker image to deploy. Version has
to match the Agent in the image.
type: string
kibanaRef:
description: KibanaRef is a reference to Kibana where Fleet should
be set up and this Agent should be enrolled. Don't set unless `mode`
is set to `fleet`.
properties:
name:
description: Name of an existing Kubernetes object corresponding
to an Elastic resource managed by ECK.
type: string
namespace:
description: Namespace of the Kubernetes object. If empty, defaults
to the current namespace.
type: string
secretName:
description: 'SecretName is the name of an existing Kubernetes
secret that contains connection information for associating
an Elastic resource not managed by the operator. The referenced
secret must contain the following: - `url`: the URL to reach
the Elastic resource - `username`: the username of the user
to be authenticated to the Elastic resource - `password`: the
password of the user to be authenticated to the Elastic resource
- `ca.crt`: the CA certificate in PEM format (optional). This
field cannot be used in combination with the other fields name,
namespace or serviceName.'
type: string
serviceName:
description: ServiceName is the name of an existing Kubernetes
service which is used to make requests to the referenced object.
It has to be in the same namespace as the referenced resource.
If left empty, the default HTTP service of the referenced resource
is used.
type: string
type: object
mode:
description: Mode specifies the source of configuration for the Agent.
The configuration can be specified locally through `config` or `configRef`
(`standalone` mode), or come from Fleet during runtime (`fleet`
mode). Defaults to `standalone` mode.
enum:
- standalone
- fleet
type: string
secureSettings:
description: SecureSettings is a list of references to Kubernetes
Secrets containing sensitive configuration options for the Agent.
Secrets data can be then referenced in the Agent config using the
Secret's keys or as specified in `Entries` field of each SecureSetting.
items:
description: SecretSource defines a data source based on a Kubernetes
Secret.
properties:
entries:
description: Entries define how to project each key-value pair
in the secret to filesystem paths. If not defined, all keys
will be projected to similarly named paths in the filesystem.
If defined, only the specified keys will be projected to the
corresponding paths.
items:
description: KeyToPath defines how to map a key in a Secret
object to a filesystem path.
properties:
key:
description: Key is the key contained in the secret.
type: string
path:
description: Path is the relative file path to map the
key to. Path must not be an absolute file path and must
not contain any ".." components.
type: string
required:
- key
type: object
type: array
secretName:
description: SecretName is the name of the secret.
type: string
required:
- secretName
type: object
type: array
serviceAccountName:
description: ServiceAccountName is used to check access from the current
resource to an Elasticsearch resource in a different namespace.
Can only be used if ECK is enforcing RBAC on references.
type: string
version:
description: Version of the Agent.
type: string
required:
- version
type: object
status:
description: AgentStatus defines the observed state of the Agent
properties:
availableNodes:
format: int32
type: integer
elasticsearchAssociationsStatus:
additionalProperties:
description: AssociationStatus is the status of an association resource.
type: string
description: AssociationStatusMap is the map of association's namespaced
name string to its AssociationStatus. For resources that have a
single Association of a given type (for ex. single ES reference),
this map contains a single entry.
type: object
expectedNodes:
format: int32
type: integer
fleetServerAssociationStatus:
description: AssociationStatus is the status of an association resource.
type: string
health:
type: string
kibanaAssociationStatus:
description: AssociationStatus is the status of an association resource.
type: string
observedGeneration:
description: ObservedGeneration is the most recent generation observed
for this Elastic Agent. It corresponds to the metadata generation,
which is updated on mutation by the API Server. If the generation
observed in status diverges from the generation in metadata, the
Elastic Agent controller has not yet processed the changes contained
in the Elastic Agent specification.
format: int64
type: integer
version:
description: 'Version of the stack resource currently running. During
version upgrades, multiple versions may run in parallel: this value
specifies the lowest version currently running.'
type: string
type: object
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.8.0
creationTimestamp: null
name: apmservers.apm.k8s.elastic.co
spec:
group: apm.k8s.elastic.co
names:
categories:
- elastic
kind: ApmServer
listKind: ApmServerList
plural: apmservers
shortNames:
- apm
singular: apmserver
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.health
name: health
type: string
- description: Available nodes
jsonPath: .status.availableNodes
name: nodes
type: integer
- description: APM version
jsonPath: .status.version
name: version
type: string
- jsonPath: .metadata.creationTimestamp
name: age
type: date
name: v1
schema:
openAPIV3Schema:
description: ApmServer represents an APM Server resource in a Kubernetes cluster.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: ApmServerSpec holds the specification of an APM Server.
properties:
config:
description: 'Config holds the APM Server configuration. See: https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html'
type: object
x-kubernetes-preserve-unknown-fields: true
count:
description: Count of APM Server instances to deploy.
format: int32
type: integer
elasticsearchRef:
description: ElasticsearchRef is a reference to the output Elasticsearch
cluster running in the same Kubernetes cluster.
properties:
name:
description: Name of an existing Kubernetes object corresponding
to an Elastic resource managed by ECK.
type: string
namespace:
description: Namespace of the Kubernetes object. If empty, defaults
to the current namespace.
type: string
secretName:
description: 'SecretName is the name of an existing Kubernetes
secret that contains connection information for associating
an Elastic resource not managed by the operator. The referenced
secret must contain the following: - `url`: the URL to reach
the Elastic resource - `username`: the username of the user
to be authenticated to the Elastic resource - `password`: the
password of the user to be authenticated to the Elastic resource
- `ca.crt`: the CA certificate in PEM format (optional). This
field cannot be used in combination with the other fields name,
namespace or serviceName.'
type: string
serviceName:
description: ServiceName is the name of an existing Kubernetes
service which is used to make requests to the referenced object.
It has to be in the same namespace as the referenced resource.
If left empty, the default HTTP service of the referenced resource
is used.
type: string
type: object
http:
description: HTTP holds the HTTP layer configuration for the APM Server
resource.
properties:
service:
description: Service defines the template for the associated Kubernetes
Service object.
properties:
metadata:
description: ObjectMeta is the metadata of the service. The
name and namespace provided here are managed by ECK and
will be ignored.
properties:
annotations:
additionalProperties:
type: string
type: object
finalizers:
items:
type: string
type: array
labels:
additionalProperties:
type: string
type: object
name:
type: string
namespace:
type: string
type: object
spec:
description: Spec is the specification of the service.
properties:
allocateLoadBalancerNodePorts:
description: allocateLoadBalancerNodePorts defines if
NodePorts will be automatically allocated for services
with type LoadBalancer. Default is "true". It may be
set to "false" if the cluster load-balancer does not
rely on NodePorts. If the caller requests specific
NodePorts (by specifying a value), those requests will
be respected, regardless of this field. This field may
only be set for services with type LoadBalancer and
will be cleared if the type is changed to any other
type.
type: boolean
clusterIP:
description: 'clusterIP is the IP address of the service
and is usually assigned randomly. If an address is specified
manually, is in-range (as per system configuration),
and is not in use, it will be allocated to the service;
otherwise creation of the service will fail. This field
may not be changed through updates unless the type field
is also being changed to ExternalName (which requires
this field to be blank) or the type field is being changed
from ExternalName (in which case this field may optionally