comment on the property that is applicable only in collector mode

verrazzano · Jul 24, 2023 · 0a86296 · 0a86296
1 parent 3896ce2
commit 0a86296
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 8 deletions.
diff --git a/apis/fluentd/v1alpha1/fluentd_types.go b/apis/fluentd/v1alpha1/fluentd_types.go
@@ -43,6 +43,7 @@ type FluentdSpec struct {
 	// By default will build the related service according to the globalinputs definition.
 	DisableService bool `json:"disableService,omitempty"`
 	// Numbers of the Fluentd instance
+	// Applicable when the mode is "collector", and will be ignored when the mode is "agent"
 	Replicas *int32 `json:"replicas,omitempty"`
 	// Numbers of the workers in Fluentd instance
 	Workers *int32 `json:"workers,omitempty"`
@@ -92,6 +93,7 @@ type FluentdSpec struct {
 	// claims in a way that maintains the identity of a pod. Every claim in
 	// this list must have at least one matching (by name) volumeMount in one
 	// container in the template.
+	// Applicable when the mode is "collector", and will be ignored when the mode is "agent"
 	VolumeClaimTemplates []corev1.PersistentVolumeClaim `json:"volumeClaimTemplates,omitempty"`
 	// Service represents configurations on the fluentd service.
 	Service FluentDService `json:"service,omitempty"`
@@ -106,6 +108,7 @@ type FluentdSpec struct {
 	// ContainerSecurityContext represents the security context for the fluentd container.
 	ContainerSecurityContext *corev1.SecurityContext `json:"containerSecurityContext,omitempty"`
 	// Storage for position db. You will use it if tail input is enabled.
+	// Applicable when the mode is "collector", and will be ignored when the mode is "agent"
 	PositionDB corev1.VolumeSource `json:"positionDB,omitempty"`
 }
 

diff --git a/charts/fluent-operator/charts/fluentd-crds/crds/fluentd.fluent.io_fluentds.yaml b/charts/fluent-operator/charts/fluentd-crds/crds/fluentd.fluent.io_fluentds.yaml
@@ -2418,7 +2418,8 @@ spec:
                 type: object
               positionDB:
                 description: Storage for position db. You will use it if tail input
-                  is enabled.
+                  is enabled. Applicable when the mode is "collector", and will be
+                  ignored when the mode is "agent"
                 properties:
                   awsElasticBlockStore:
                     description: 'awsElasticBlockStore represents an AWS Disk resource
@@ -4013,7 +4014,8 @@ spec:
                   type: object
                 type: array
               replicas:
-                description: Numbers of the Fluentd instance
+                description: Numbers of the Fluentd instance Applicable when the mode
+                  is "collector", and will be ignored when the mode is "agent"
                 format: int32
                 type: integer
               resources:
@@ -4307,6 +4309,8 @@ spec:
                   for mapping network identities to claims in a way that maintains
                   the identity of a pod. Every claim in this list must have at least
                   one matching (by name) volumeMount in one container in the template.
+                  Applicable when the mode is "collector", and will be ignored when
+                  the mode is "agent"
                 items:
                   description: PersistentVolumeClaim is a user's request for and claim
                     to a persistent volume

diff --git a/charts/fluent-operator/values.yaml b/charts/fluent-operator/values.yaml
@@ -273,6 +273,8 @@ fluentd:
   image:
     repository: "kubesphere/fluentd"
     tag: "v1.15.3"
+  # Numbers of the Fluentd instance
+  # Applicable when the mode is "collector", and will be ignored when the mode is "agent"
   replicas: 1
   forward:
     port: 24224

diff --git a/config/crd/bases/fluentd.fluent.io_fluentds.yaml b/config/crd/bases/fluentd.fluent.io_fluentds.yaml
@@ -2418,7 +2418,8 @@ spec:
                 type: object
               positionDB:
                 description: Storage for position db. You will use it if tail input
-                  is enabled.
+                  is enabled. Applicable when the mode is "collector", and will be
+                  ignored when the mode is "agent"
                 properties:
                   awsElasticBlockStore:
                     description: 'awsElasticBlockStore represents an AWS Disk resource
@@ -4013,7 +4014,8 @@ spec:
                   type: object
                 type: array
               replicas:
-                description: Numbers of the Fluentd instance
+                description: Numbers of the Fluentd instance Applicable when the mode
+                  is "collector", and will be ignored when the mode is "agent"
                 format: int32
                 type: integer
               resources:
@@ -4307,6 +4309,8 @@ spec:
                   for mapping network identities to claims in a way that maintains
                   the identity of a pod. Every claim in this list must have at least
                   one matching (by name) volumeMount in one container in the template.
+                  Applicable when the mode is "collector", and will be ignored when
+                  the mode is "agent"
                 items:
                   description: PersistentVolumeClaim is a user's request for and claim
                     to a persistent volume

diff --git a/manifests/setup/fluent-operator-crd.yaml b/manifests/setup/fluent-operator-crd.yaml
@@ -20570,7 +20570,8 @@ spec:
                 type: object
               positionDB:
                 description: Storage for position db. You will use it if tail input
-                  is enabled.
+                  is enabled. Applicable when the mode is "collector", and will be
+                  ignored when the mode is "agent"
                 properties:
                   awsElasticBlockStore:
                     description: 'awsElasticBlockStore represents an AWS Disk resource
@@ -22165,7 +22166,8 @@ spec:
                   type: object
                 type: array
               replicas:
-                description: Numbers of the Fluentd instance
+                description: Numbers of the Fluentd instance Applicable when the mode
+                  is "collector", and will be ignored when the mode is "agent"
                 format: int32
                 type: integer
               resources:
@@ -22459,6 +22461,8 @@ spec:
                   for mapping network identities to claims in a way that maintains
                   the identity of a pod. Every claim in this list must have at least
                   one matching (by name) volumeMount in one container in the template.
+                  Applicable when the mode is "collector", and will be ignored when
+                  the mode is "agent"
                 items:
                   description: PersistentVolumeClaim is a user's request for and claim
                     to a persistent volume

diff --git a/manifests/setup/setup.yaml b/manifests/setup/setup.yaml
@@ -20570,7 +20570,8 @@ spec:
                 type: object
               positionDB:
                 description: Storage for position db. You will use it if tail input
-                  is enabled.
+                  is enabled. Applicable when the mode is "collector", and will be
+                  ignored when the mode is "agent"
                 properties:
                   awsElasticBlockStore:
                     description: 'awsElasticBlockStore represents an AWS Disk resource
@@ -22165,7 +22166,8 @@ spec:
                   type: object
                 type: array
               replicas:
-                description: Numbers of the Fluentd instance
+                description: Numbers of the Fluentd instance Applicable when the mode
+                  is "collector", and will be ignored when the mode is "agent"
                 format: int32
                 type: integer
               resources:
@@ -22459,6 +22461,8 @@ spec:
                   for mapping network identities to claims in a way that maintains
                   the identity of a pod. Every claim in this list must have at least
                   one matching (by name) volumeMount in one container in the template.
+                  Applicable when the mode is "collector", and will be ignored when
+                  the mode is "agent"
                 items:
                   description: PersistentVolumeClaim is a user's request for and claim
                     to a persistent volume