Skip to content

[release-6.4]feat: make terminationGracePeriodSeconds configurable via field of CollectorSpec #3342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-bot merged 1 commit into from
Jul 8, 2026
Merged

[release-6.4]feat: make terminationGracePeriodSeconds configurable via field of CollectorSpec #3342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions api/observability/v1/clusterlogforwarder_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,15 @@ type CollectorSpec struct {
// +kubebuilder:validation:Pattern="^(?:[0-9]{1,2}|100)%?$"
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Max Unavailable",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty"`

// TerminationGracePeriodSeconds defines the termination grace period for collector pods
// in seconds. If not specified, the default is 10 seconds.
//
// +nullable
// +kubebuilder:validation:Optional
// +kubebuilder:validation:Minimum:=1
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Termination Grace Period Seconds",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:number"}
TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`
}

type NetworkPolicy struct {
Expand Down
5 changes: 5 additions & 0 deletions api/observability/v1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions bundle/manifests/cluster-logging.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,13 @@ spec:
path: collector.resources
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:resourceRequirements
- description: |-
TerminationGracePeriodSeconds defines the termination grace period for collector pods
in seconds. If not specified, the default is 10 seconds.
displayName: Termination Grace Period Seconds
path: collector.terminationGracePeriodSeconds
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: Define the tolerations the collector pods will accept
displayName: Tolerations
path: collector.tolerations
Expand Down
8 changes: 8 additions & 0 deletions bundle/manifests/observability.openshift.io_clusterlogforwarders.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1033,6 +1033,14 @@ spec:
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
type: object
terminationGracePeriodSeconds:
description: |-
TerminationGracePeriodSeconds defines the termination grace period for collector pods
in seconds. If not specified, the default is 10 seconds.
format: int64
minimum: 1
nullable: true
type: integer
tolerations:
description: Define the tolerations the collector pods will accept
items:
Expand Down
8 changes: 8 additions & 0 deletions config/crd/bases/observability.openshift.io_clusterlogforwarders.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1033,6 +1033,14 @@ spec:
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
type: object
terminationGracePeriodSeconds:
description: |-
TerminationGracePeriodSeconds defines the termination grace period for collector pods
in seconds. If not specified, the default is 10 seconds.
format: int64
minimum: 1
nullable: true
type: integer
tolerations:
description: Define the tolerations the collector pods will accept
items:
Expand Down
7 changes: 7 additions & 0 deletions config/manifests/bases/cluster-logging.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,13 @@ spec:
path: collector.resources
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:resourceRequirements
- description: |-
TerminationGracePeriodSeconds defines the termination grace period for collector pods
in seconds. If not specified, the default is 10 seconds.
displayName: Termination Grace Period Seconds
path: collector.terminationGracePeriodSeconds
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: Define the tolerations the collector pods will accept
displayName: Tolerations
path: collector.tolerations
Expand Down
18 changes: 18 additions & 0 deletions docs/reference/operator/api_observability_v1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ Value can be a number (e.g., 50) or a percentage string (e.g., "50%").

|resources|object| The resource requirements for the collector

|terminationGracePeriodSeconds|int| TerminationGracePeriodSeconds defines the termination grace period for collector pods
in seconds. If not specified, the default is 10 seconds.

|tolerations|array| Define the tolerations the collector pods will accept

|======================
Expand Down Expand Up @@ -958,6 +961,10 @@ Type:: object

Type:: object

=== .spec.collector.terminationGracePeriodSeconds

Type:: int

=== .spec.collector.tolerations[]

Type:: array
Expand Down Expand Up @@ -1279,6 +1286,8 @@ NOTE1: `In` CANNOT contain `.log_type`, `.log_source` or `.message` as those fie

NOTE2: If this filter is used in a pipeline with GoogleCloudLogging, `.hostname` CANNOT be added to this list as it is a required field.

NOTE3: If used in a pipeline with a Lokistack output type, see Lokistack output documentation for additional fields that cannot be pruned.

|notIn|array| `NotIn` is an array of dot-delimited field paths. All fields besides the ones listed here are removed from the log record.

Each field path expression must start with a "."
Expand All @@ -1303,6 +1312,8 @@ NOTE1: `NotIn` MUST contain `.log_type`, `.log_source` and `.message` as those f

NOTE2: If this filter is used in a pipeline with GoogleCloudLogging, `.hostname` MUST be added to this list as it is a required field.

NOTE3: If used in a pipeline with a Lokistack output type, see Lokistack output documentation for additional fields that cannot be pruned.

|======================

=== .spec.filters[].prune.in[]
Expand Down Expand Up @@ -1860,6 +1871,13 @@ Type:: array
|lokiStack|object| LokiStack configures forwarding log events to a Red Hat managed Loki deployment
using the Red Hat tenancy model

The listed labelKeys cannot be pruned as they are required as default stream labels for LokiStack.
1. .kubernetes.container_name
2. .kubernetes.namespace_name
3. .kubernetes.pod_name

If these fields are not present in the log record, they will be set to the empty string.

|name|string| Name used to refer to the output from a `pipeline`.

|otlp|object| OTLP configures forwarding log events to a receiver using the OpenTelemetry Protocol
Expand Down
58 changes: 33 additions & 25 deletions internal/collector/collector.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,31 @@ const (
//DefaultMaxUnavailable is the maxUnavailable collector setting when not defined by spec.collector.maxUnavailable
DefaultMaxUnavailable = "100%"

defaultAudience = "openshift"
clusterLoggingPriorityClassName = "system-node-critical"
metricsVolumeName = "metrics"
metricsVolumePath = "/etc/collector/metrics"
saTokenVolumeName = "sa-token"
saTokenExpirationSecs = 3600 //1 hour
sourcePodsName = "varlogpods"
sourcePodsPath = "/var/log/pods"
sourceJournalName = "varlogjournal"
sourceJournalPath = "/var/log/journal"
sourceAuditdName = "varlogaudit"
sourceAuditdPath = "/var/log/audit"
sourceAuditOVNName = "varlogovn"
sourceOVNPath = "/var/log/ovn"
sourceOAuthServerName = "varlogoauthserver"
sourceOAuthServerPath = "/var/log/oauth-server"
sourceOAuthAPIServerName = "varlogoauthapiserver"
sourceOAuthAPIServerPath = "/var/log/oauth-apiserver"
sourceOpenshiftAPIServerName = "varlogopenshiftapiserver"
sourceOpenshiftAPIServerPath = "/var/log/openshift-apiserver"
sourceKubeAPIServerName = "varlogkubeapiserver"
sourceKubeAPIServerPath = "/var/log/kube-apiserver"
tmpVolumeName = "tmp"
tmpPath = "/tmp"
defaultAudience = "openshift"
clusterLoggingPriorityClassName = "system-node-critical"
metricsVolumeName = "metrics"
metricsVolumePath = "/etc/collector/metrics"
saTokenVolumeName = "sa-token"
saTokenExpirationSecs = 3600 //1 hour
defaultTerminationGracePeriodSeconds int64 = 10
sourcePodsName = "varlogpods"
sourcePodsPath = "/var/log/pods"
sourceJournalName = "varlogjournal"
sourceJournalPath = "/var/log/journal"
sourceAuditdName = "varlogaudit"
sourceAuditdPath = "/var/log/audit"
sourceAuditOVNName = "varlogovn"
sourceOVNPath = "/var/log/ovn"
sourceOAuthServerName = "varlogoauthserver"
sourceOAuthServerPath = "/var/log/oauth-server"
sourceOAuthAPIServerName = "varlogoauthapiserver"
sourceOAuthAPIServerPath = "/var/log/oauth-apiserver"
sourceOpenshiftAPIServerName = "varlogopenshiftapiserver"
sourceOpenshiftAPIServerPath = "/var/log/openshift-apiserver"
sourceKubeAPIServerName = "varlogkubeapiserver"
sourceKubeAPIServerPath = "/var/log/kube-apiserver"
tmpVolumeName = "tmp"
tmpPath = "/tmp"
)

type Visitor func(collector *v1.Container, podSpec *v1.PodSpec, resNames *factory.ForwarderResourceNames, namespace, logLevel string)
Expand Down Expand Up @@ -142,11 +143,18 @@ func (f *Factory) NewDeployment(namespace, name string, trustedCABundle *v1.Conf

func (f *Factory) NewPodSpec(trustedCABundle *v1.ConfigMap, spec obs.ClusterLogForwarderSpec, clusterID string, tlsProfileSpec configv1.TLSProfileSpec, namespace string) *v1.PodSpec {

var gracePeriod *int64
if f.CollectorSpec.TerminationGracePeriodSeconds != nil {
gracePeriod = f.CollectorSpec.TerminationGracePeriodSeconds
} else {
gracePeriod = utils.GetPtr(defaultTerminationGracePeriodSeconds)
}

podSpec := &v1.PodSpec{
NodeSelector: utils.EnsureLinuxNodeSelector(f.NodeSelector()),
PriorityClassName: clusterLoggingPriorityClassName,
ServiceAccountName: f.ResourceNames.ServiceAccount,
TerminationGracePeriodSeconds: utils.GetPtr[int64](10),
TerminationGracePeriodSeconds: gracePeriod,
Tolerations: append(constants.DefaultTolerations(), f.Tolerations()...),
Affinity: f.Affinity(),

Expand Down
28 changes: 28 additions & 0 deletions internal/collector/collector_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,20 @@ var _ = Describe("Factory#Daemonset", func() {

Describe("when creating the podSpec", func() {

Context("and evaluating terminationGracePeriodSeconds", func() {
It("should default to 10 when not specified", func() {
Expect(*podSpec.TerminationGracePeriodSeconds).To(Equal(int64(10)))
})

It("should use spec value when specified", func() {
factory.CollectorSpec = obs.CollectorSpec{
TerminationGracePeriodSeconds: utils.GetPtr[int64](60),
}
podSpec = *factory.NewPodSpec(nil, obs.ClusterLogForwarderSpec{}, "1234", tls.GetClusterTLSProfileSpec(nil), constants.OpenshiftNS)
Expect(*podSpec.TerminationGracePeriodSeconds).To(Equal(int64(60)))
})
})

Context("and evaluating tolerations", func() {
It("should add only defaults when none are defined", func() {
Expect(podSpec.Tolerations).To(Equal(constants.DefaultTolerations()))
Expand Down Expand Up @@ -528,6 +542,20 @@ var _ = Describe("Factory#Deployment", func() {

Describe("when creating the podSpec", func() {

Context("and evaluating terminationGracePeriodSeconds", func() {
It("should default to 10 when not specified", func() {
Expect(*podSpec.TerminationGracePeriodSeconds).To(Equal(int64(10)))
})

It("should use spec value when specified", func() {
factory.CollectorSpec = obs.CollectorSpec{
TerminationGracePeriodSeconds: utils.GetPtr[int64](60),
}
podSpec = *factory.NewPodSpec(nil, obs.ClusterLogForwarderSpec{}, "1234", tls.GetClusterTLSProfileSpec(nil), constants.OpenshiftNS)
Expect(*podSpec.TerminationGracePeriodSeconds).To(Equal(int64(60)))
})
})

Context("and mounting volumes", func() {
It("should not mount host path or sa token volumes", func() {
Expect(podSpec.Volumes).NotTo(ContainElement(v1.Volume{Name: saTokenVolumeName, VolumeSource: v1.VolumeSource{Projected: &v1.ProjectedVolumeSource{Sources: []v1.VolumeProjection{saToken}}}}))
Expand Down
Loading