docs: fix on comments

projectcapsule · Nov 23, 2023 · 001492b · 001492b
1 parent d629339
commit 001492b
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/api/v1beta2/tenant_types.go b/api/v1beta2/tenant_types.go
@@ -17,7 +17,7 @@ type TenantSpec struct {
 	NamespaceOptions *NamespaceOptions `json:"namespaceOptions,omitempty"`
 	// Specifies options for the Service, such as additional metadata or block of certain type of Services. Optional.
 	ServiceOptions *api.ServiceOptions `json:"serviceOptions,omitempty"`
-	// Specifies options for the Pods, such additional metadata to enforce on each pod part of the tenant
+	// Specifies options for the Pods deployed in the Tenant namespaces, such as additional metadata.
 	PodOptions *api.PodOptions `json:"podOptions,omitempty"`
 	// Specifies the allowed StorageClasses assigned to the Tenant.
 	// Capsule assures that all PersistentVolumeClaim resources created in the Tenant can use only one of the allowed StorageClasses.

diff --git a/config/crd/bases/capsule.clastix.io_tenants.yaml b/config/crd/bases/capsule.clastix.io_tenants.yaml
@@ -2860,12 +2860,12 @@ spec:
                   type: object
                 type: array
               podOptions:
-                description: Specifies options for the Pods, such additional metadata
-                  to enforce on each pod part of the tenant
+                description: Specifies options for the Pods deployed in the Tenant
+                  namespaces, such as additional metadata.
                 properties:
                   additionalMetadata:
                     description: Specifies additional labels and annotations the Capsule
-                      operator places on any Service resource in the Tenant. Optional.
+                      operator places on any Pod resource in the Tenant. Optional.
                     properties:
                       annotations:
                         additionalProperties:

diff --git a/config/install.yaml b/config/install.yaml
@@ -2438,10 +2438,10 @@ spec:
                   type: object
                 type: array
               podOptions:
-                description: Specifies options for the Pods, such additional metadata to enforce on each pod part of the tenant
+                description: Specifies options for the Pods deployed in the Tenant namespaces, such as additional metadata.
                 properties:
                   additionalMetadata:
-                    description: Specifies additional labels and annotations the Capsule operator places on any Service resource in the Tenant. Optional.
+                    description: Specifies additional labels and annotations the Capsule operator places on any Pod resource in the Tenant. Optional.
                     properties:
                       annotations:
                         additionalProperties:

diff --git a/pkg/api/pod_options.go b/pkg/api/pod_options.go
@@ -6,6 +6,6 @@ package api
 // +kubebuilder:object:generate=true
 
 type PodOptions struct {
-	// Specifies additional labels and annotations the Capsule operator places on any Service resource in the Tenant. Optional.
+	// Specifies additional labels and annotations the Capsule operator places on any Pod resource in the Tenant. Optional.
 	AdditionalMetadata *AdditionalMetadataSpec `json:"additionalMetadata,omitempty"`
 }