From 56e6d72c3c04e4d8df6b07b16dc76d4f6a3d193c Mon Sep 17 00:00:00 2001 From: Stefan Hauth Date: Wed, 27 Nov 2024 14:50:28 +0100 Subject: [PATCH] Update API reference. --- doc/api/dynakube-api-ref.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/doc/api/dynakube-api-ref.md b/doc/api/dynakube-api-ref.md index b7b913e9de..9a28cdcdfe 100644 --- a/doc/api/dynakube-api-ref.md +++ b/doc/api/dynakube-api-ref.md @@ -10,7 +10,6 @@ |`enableIstio`|When enabled, and if Istio is installed on the Kubernetes environment, Dynatrace Operator will create the corresponding
VirtualService and ServiceEntry objects to allow access to the Dynatrace Cluster from the OneAgent or ActiveGate.
Disabled by default.|-|boolean| |`extensions`|When an (empty) ExtensionsSpec is provided, the extensions related components (extensions controller and extensions collector)
are deployed by the operator.|-|object| |`kspm`|General configuration about the KSPM feature.|-|object| -|`logMonitoring`|General configuration about the LogMonitoring feature.|-|object| |`networkZone`|Sets a network zone for the OneAgent and ActiveGate pods.|-|string| |`proxy`|Set custom proxy settings either directly or from a secret with the field proxy.
Note: Applies to Dynatrace Operator, ActiveGate, and OneAgents.|-|object| |`skipCertCheck`|Disable certificate check for the connection between Dynatrace Operator and the Dynatrace Cluster.
Set to true if you want to skip certification validation checks.|-|boolean| @@ -43,6 +42,12 @@ |`tolerations`|Set tolerations for the ActiveGate pods|-|array| |`topologySpreadConstraints`|Adds TopologySpreadConstraints for the ActiveGate pods|-|array| +### .spec.logMonitoring + +|Parameter|Description|Default value|Data type| +|:-|:-|:-|:-| +|`ingestRuleMatchers`||-|array| + ### .spec.metadataEnrichment |Parameter|Description|Default value|Data type| @@ -55,7 +60,7 @@ |Parameter|Description|Default value|Data type| |:-|:-|:-|:-| |`annotations`|Add custom OneAgent annotations.|-|object| -|`args`|Set additional arguments to the OneAgent installer.
For available options, see Linux custom installation ().
For the list of limitations, see Limitations (For available options, see Linux custom installation ().|-|array| |`autoUpdate`|Disables automatic restarts of OneAgent pods in case a new version is available ().
Enabled by default.|-|boolean| |`dnsPolicy`|Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy ().|-|string| |`env`|Set additional environment variables for the OneAgent pods.|-|array| @@ -87,7 +92,7 @@ |Parameter|Description|Default value|Data type| |:-|:-|:-|:-| |`annotations`|Add custom OneAgent annotations.|-|object| -|`args`|Set additional arguments to the OneAgent installer.
For available options, see Linux custom installation ().
For the list of limitations, see Limitations (For available options, see Linux custom installation ().|-|array| |`autoUpdate`|Disables automatic restarts of OneAgent pods in case a new version is available ().
Enabled by default.|-|boolean| |`dnsPolicy`|Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy ().|-|string| |`env`|Set additional environment variables for the OneAgent pods.|-|array| @@ -105,7 +110,7 @@ |Parameter|Description|Default value|Data type| |:-|:-|:-|:-| |`annotations`|Add custom OneAgent annotations.|-|object| -|`args`|Set additional arguments to the OneAgent installer.
For available options, see Linux custom installation ().
For the list of limitations, see Limitations (For available options, see Linux custom installation ().|-|array| |`autoUpdate`|Disables automatic restarts of OneAgent pods in case a new version is available ().
Enabled by default.|-|boolean| |`codeModulesImage`|Use a custom OneAgent CodeModule image to download binaries.|-|string| |`dnsPolicy`|Set the DNS Policy for OneAgent pods. For details, see Pods DNS Policy ().|-|string| @@ -128,7 +133,6 @@ |`codeModulesImage`|Use a custom OneAgent CodeModule image to download binaries.|-|string| |`initResources`|Define resources requests and limits for the initContainer. For details, see Managing resources for containers
().|-|object| |`namespaceSelector`|Applicable only for applicationMonitoring or cloudNativeFullStack configuration types. The namespaces where you want Dynatrace Operator to inject.
For more information, see Configure monitoring for namespaces and pods (the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.|-|array| -|`requiredDuringSchedulingIgnoredDuringExecution`|If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to an update), the system
may or may not try to eventually evict the pod from its node.|-|object| +|`requiredDuringSchedulingIgnoredDuringExecution`|If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g.|-|object| ### .spec.templates.kspmNodeConfigurationCollector.updateStrategy @@ -216,11 +220,11 @@ |Parameter|Description|Default value|Data type| |:-|:-|:-|:-| |`accessModes`|accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1|-|array| -|`dataSource`|dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.|-|object| -|`resources`|resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.|-|object| +|`dataSource`|dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.|-|object| +|`resources`|resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.|-|object| |`selector`|selector is a label query over volumes to consider for binding.|-|object| |`storageClassName`|storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1|-|string| -|`volumeAttributesClassName`|volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created.|-|string| +|`volumeAttributesClassName`|volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass.|-|string| |`volumeMode`|volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.|-|string| |`volumeName`|volumeName is the binding reference to the PersistentVolume backing this claim.|-|string| @@ -228,8 +232,8 @@ |Parameter|Description|Default value|Data type| |:-|:-|:-|:-| -|`maxSurge`|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.|-|integer or string| -|`maxUnavailable`|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.|-|integer or string| +|`maxSurge`|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.|-|integer or string| +|`maxUnavailable`|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.|-|integer or string| ### .spec.templates.extensionExecutionController.persistentVolumeClaim.dataSourceRef