From 02bfa599c893319b5fa6d2a708062526316a0b78 Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Wed, 16 Jul 2025 13:46:44 +0200 Subject: [PATCH 1/6] version bump preparations --- .github/workflows/publish-version-6.0.yaml | 86 ++++++++++++++++++++++ config/_default/config.toml | 6 +- 2 files changed, 91 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/publish-version-6.0.yaml diff --git a/.github/workflows/publish-version-6.0.yaml b/.github/workflows/publish-version-6.0.yaml new file mode 100644 index 000000000..26a187fc8 --- /dev/null +++ b/.github/workflows/publish-version-6.0.yaml @@ -0,0 +1,86 @@ +name: Publish version 6.0 + +env: + doc_versionnumber: "6.0" + +on: + push: + branches: + - release-6.0 + workflow_dispatch: + +jobs: + build: + name: Build + runs-on: ubuntu-latest + + permissions: + contents: write + pages: write + id-token: write + + concurrency: + group: "pages" + cancel-in-progress: false + + environment: + name: github-pages-test + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Checkout code + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + ref: release-6.0 + submodules: 'recursive' + + - name: Set up Pages + id: pages + uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 + + - name: Set up Hugo + uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0 + with: + hugo-version: '0.110.0' + extended: true + + - name: Set up Node + uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + with: + node-version: 18 + + - name: Install dependencies + run: | + cd themes/docsy + npm install + + - name: Set up PostCSS + run: npm install --save-dev autoprefixer postcss-cli postcss + + - name: Build + run: hugo --environment production --baseURL ${{ steps.pages.outputs.base_url }}/${{ env.doc_versionnumber }}/ + + # - name: Upload artifact + # uses: actions/upload-pages-artifact@64bcae551a7b18bcb9a09042ddf1960979799187 # v1.0.8 + # with: + # path: ./public/ + + - name: Checkout code to update + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + ref: 'gh-pages-test' + path: 'tmp/gh-pages' + # - name: Display file structure + # run: ls -R + - name: Copy built site to GH pages + run: | + rm -rf tmp/gh-pages/${{ env.doc_versionnumber }} + mkdir -p tmp/gh-pages/${{ env.doc_versionnumber }} + mv public/* tmp/gh-pages/${{ env.doc_versionnumber }} + - name: Commit & Push changes + uses: actions-js/push@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + message: 'Publish updated docs for ${{ env.doc_versionnumber }}, ${{ github.event.repository.pushed_at}}' + branch: 'gh-pages-test' + directory: 'tmp/gh-pages' diff --git a/config/_default/config.toml b/config/_default/config.toml index 1312b0e56..dc1c13ebb 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -169,9 +169,13 @@ twitter = "AxoflowIO" ####################### # Add your release versions here [[params.versions]] - version = "latest (5.4)" + version = "latest (6.0)" githubbranch = "master" url = "" +[[params.versions]] + version = "5.4" + githubbranch = "release-5.4" + url = "/5.4/" [[params.versions]] version = "5.3" githubbranch = "release-5.3" From 4c0c487bcf3c04076ea2dc6726550223a530e06a Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Wed, 16 Jul 2025 15:11:06 +0200 Subject: [PATCH 2/6] Remove nodeagent references --- .../docs/configuration/crds/v1beta1/_index.md | 1 - .../crds/v1beta1/logging_types.md | 8 +- .../crds/v1beta1/node_agent_types.md | 188 ------------------ content/docs/install/_index.md | 1 - content/docs/whats-new/_index.md | 2 +- 5 files changed, 2 insertions(+), 198 deletions(-) delete mode 100644 content/docs/configuration/crds/v1beta1/node_agent_types.md diff --git a/content/docs/configuration/crds/v1beta1/_index.md b/content/docs/configuration/crds/v1beta1/_index.md index 57dfbcfb7..7152359e3 100644 --- a/content/docs/configuration/crds/v1beta1/_index.md +++ b/content/docs/configuration/crds/v1beta1/_index.md @@ -20,7 +20,6 @@ For more information please click on the name | **[FluentdSpec](fluentd_types/)** | FluentdSpec defines the desired state of Fluentd | v1beta1 | | **[Logging](logging_types/)** | Logging system configuration | v1beta1 | | **[LoggingRouteSpec](loggingroute_types/)** | LoggingRouteSpec defines the desired state of LoggingRoute | v1beta1 | -| **[NodeAgent](node_agent_types/)** | | v1beta1 | | **[OutputSpec](output_types/)** | OutputSpec defines the desired state of Output | v1beta1 | | **[SyslogNGClusterFlow](syslogng_clusterflow_types/)** | SyslogNGClusterFlow is the Schema for the syslog-ng clusterflows API | v1beta1 | | **[SyslogNGClusterOutput](syslogng_clusteroutput_types/)** | SyslogNGClusterOutput is the Schema for the syslog-ng clusteroutputs API | v1beta1 | diff --git a/content/docs/configuration/crds/v1beta1/logging_types.md b/content/docs/configuration/crds/v1beta1/logging_types.md index a3e70ff19..0d5d69971 100644 --- a/content/docs/configuration/crds/v1beta1/logging_types.md +++ b/content/docs/configuration/crds/v1beta1/logging_types.md @@ -66,8 +66,7 @@ Override generated config. This is a *raw* configuration string for troubleshoot ### fluentbit (*FluentbitSpec, optional) {#loggingspec-fluentbit} -FluentbitAgent daemonset configuration. Deprecated, will be removed with next major version Migrate to the standalone NodeAgent resource - +FluentbitAgent daemonset configuration. Deprecated, migrate to [FluentbitAgent]({{< relref "/docs/configuration/crds/v1beta1/fluentbit_types.md" >}}), or to the [Telemetry Controller](https://github.com/kube-logging/telemetry-controller) ### fluentd (*FluentdSpec, optional) {#loggingspec-fluentd} @@ -83,11 +82,6 @@ Global filters to apply on logs before any match or filter mechanism. Reference to the logging system. Each of the `loggingRef`s can manage a fluentbit daemonset and a fluentd statefulset. -### nodeAgents ([]*InlineNodeAgent, optional) {#loggingspec-nodeagents} - -InlineNodeAgent Configuration Deprecated, will be removed with next major version - - ### routeConfig (*RouteConfig, optional) {#loggingspec-routeconfig} RouteConfig determines whether to use loggingRoutes or to create resources based on the logging resource that can be managed by the Telemetry Controller. diff --git a/content/docs/configuration/crds/v1beta1/node_agent_types.md b/content/docs/configuration/crds/v1beta1/node_agent_types.md deleted file mode 100644 index 5ac60e70d..000000000 --- a/content/docs/configuration/crds/v1beta1/node_agent_types.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: NodeAgent -weight: 200 -generated_file: true ---- - -## NodeAgent - -NodeAgent - -### (metav1.TypeMeta, required) {#nodeagent-} - - -### metadata (metav1.ObjectMeta, optional) {#nodeagent-metadata} - - -### spec (NodeAgentSpec, optional) {#nodeagent-spec} - - -### status (NodeAgentStatus, optional) {#nodeagent-status} - - - -## NodeAgentSpec - -NodeAgentSpec - -### (NodeAgentConfig, required) {#nodeagentspec-} - -InlineNodeAgent - - -### loggingRef (string, optional) {#nodeagentspec-loggingref} - - - -## NodeAgentConfig - -### nodeAgentFluentbit (*NodeAgentFluentbit, optional) {#nodeagentconfig-nodeagentfluentbit} - - -### metadata (types.MetaBase, optional) {#nodeagentconfig-metadata} - - -### profile (string, optional) {#nodeagentconfig-profile} - - - -## NodeAgentStatus - -NodeAgentStatus - - -## NodeAgentList - -NodeAgentList - -### (metav1.TypeMeta, required) {#nodeagentlist-} - - -### metadata (metav1.ListMeta, optional) {#nodeagentlist-metadata} - - -### items ([]NodeAgent, required) {#nodeagentlist-items} - - - -## InlineNodeAgent - -InlineNodeAgent -@deprecated, replaced by NodeAgent - -### (NodeAgentConfig, required) {#inlinenodeagent-} - - -### name (string, optional) {#inlinenodeagent-name} - -InlineNodeAgent unique name. - - - -## NodeAgentFluentbit - -### bufferStorage (BufferStorage, optional) {#nodeagentfluentbit-bufferstorage} - - -### bufferStorageVolume (volume.KubernetesVolume, optional) {#nodeagentfluentbit-bufferstoragevolume} - -[volume.KubernetesVolume](https://github.com/cisco-open/operator-tools/tree/master/docs/types) - - -### containersPath (string, optional) {#nodeagentfluentbit-containerspath} - - -### coroStackSize (int32, optional) {#nodeagentfluentbit-corostacksize} - -Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Don't set too small value (say 4096), or coroutine threads can overrun the stack buffer. Do not change the default value of this parameter unless you know what you are doing. (default: 24576) - -Default: 24576 - -### customConfigSecret (string, optional) {#nodeagentfluentbit-customconfigsecret} - - -### daemonSet (*typeoverride.DaemonSet, optional) {#nodeagentfluentbit-daemonset} - - -### disableKubernetesFilter (*bool, optional) {#nodeagentfluentbit-disablekubernetesfilter} - - -### enableUpstream (*bool, optional) {#nodeagentfluentbit-enableupstream} - - -### enabled (*bool, optional) {#nodeagentfluentbit-enabled} - - -### extraVolumeMounts ([]*VolumeMount, optional) {#nodeagentfluentbit-extravolumemounts} - - -### filterAws (*FilterAws, optional) {#nodeagentfluentbit-filteraws} - - -### filterKubernetes (FilterKubernetes, optional) {#nodeagentfluentbit-filterkubernetes} - - -### flush (int32, optional) {#nodeagentfluentbit-flush} - -Set the flush time in seconds.nanoseconds. The engine loop uses a Flush timeout to define when is required to flush the records ingested by input plugins through the defined output plugins. (default: 1) - -Default: 1 - -### forwardOptions (*ForwardOptions, optional) {#nodeagentfluentbit-forwardoptions} - - -### grace (int32, optional) {#nodeagentfluentbit-grace} - -Set the grace time in seconds as Integer value. The engine loop uses a Grace timeout to define wait time on exit (default: 5) - -Default: 5 - -### inputTail (InputTail, optional) {#nodeagentfluentbit-inputtail} - - -### livenessDefaultCheck (*bool, optional) {#nodeagentfluentbit-livenessdefaultcheck} - -Default: true - -### logLevel (string, optional) {#nodeagentfluentbit-loglevel} - -Set the logging verbosity level. Allowed values are: error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug. Note that trace mode is only available if Fluent Bit was built with the WITH_TRACE option enabled. (default: info) - -Default: info - -### metrics (*Metrics, optional) {#nodeagentfluentbit-metrics} - - -### metricsService (*typeoverride.Service, optional) {#nodeagentfluentbit-metricsservice} - - -### network (*FluentbitNetwork, optional) {#nodeagentfluentbit-network} - - -### podPriorityClassName (string, optional) {#nodeagentfluentbit-podpriorityclassname} - - -### positiondb (volume.KubernetesVolume, optional) {#nodeagentfluentbit-positiondb} - -[volume.KubernetesVolume](https://github.com/cisco-open/operator-tools/tree/master/docs/types) - - -### security (*Security, optional) {#nodeagentfluentbit-security} - - -### serviceAccount (*typeoverride.ServiceAccount, optional) {#nodeagentfluentbit-serviceaccount} - - -### tls (*FluentbitTLS, optional) {#nodeagentfluentbit-tls} - - -### targetHost (string, optional) {#nodeagentfluentbit-targethost} - - -### targetPort (int32, optional) {#nodeagentfluentbit-targetport} - - -### varLogsPath (string, optional) {#nodeagentfluentbit-varlogspath} - - - diff --git a/content/docs/install/_index.md b/content/docs/install/_index.md index 68b442920..10aed8590 100644 --- a/content/docs/install/_index.md +++ b/content/docs/install/_index.md @@ -102,7 +102,6 @@ To verify that the installation was successful, complete the following steps. fluentbitagents.logging.banzaicloud.io 2023-08-10T12:05:04Z hosttailers.logging-extensions.banzaicloud.io 2023-08-10T12:05:04Z loggings.logging.banzaicloud.io 2023-08-10T12:05:05Z - nodeagents.logging.banzaicloud.io 2023-08-10T12:05:05Z outputs.logging.banzaicloud.io 2023-08-10T12:05:05Z syslogngclusterflows.logging.banzaicloud.io 2023-08-10T12:05:05Z syslogngclusteroutputs.logging.banzaicloud.io 2023-08-10T12:05:05Z diff --git a/content/docs/whats-new/_index.md b/content/docs/whats-new/_index.md index 15f9a8f40..3798da425 100644 --- a/content/docs/whats-new/_index.md +++ b/content/docs/whats-new/_index.md @@ -19,7 +19,7 @@ We are planning on deprecating the following components in the next major releas #### NodeAgent CRD and inline NodeAgents in the Logging resource -[NodeAgents]({{< relref "/docs/configuration/crds/v1beta1/node_agent_types.md" >}}) were an attempt to generalize log agents configuration, but it never got out PoC status, with the main feature of running Fluent Bit on Windows hosts. The code hasn't been updated recently, and the original FluentbitSpec (in the Logging resource and in the separate FluentbitAgent resource) and the features behind it have significantly diverged. +NodeAgents were an attempt to generalize log agents configuration, but it never got out PoC status, with the main feature of running Fluent Bit on Windows hosts. The code hasn't been updated recently, and the original FluentbitSpec (in the Logging resource and in the separate FluentbitAgent resource) and the features behind it have significantly diverged. Last year we've introduced [Telemetry Controller](https://github.com/kube-logging/telemetry-controller) as a replacement for the NodeAgent and FluentbitAgent resources, with additional multi-tenant capabilities and more flexible agent-side log selection. From ac4eecf84d603221b96b8374faef3eb0ae01de82 Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Wed, 16 Jul 2025 15:11:26 +0200 Subject: [PATCH 3/6] Updates image versions --- content/docs/image-versions.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/content/docs/image-versions.md b/content/docs/image-versions.md index 8116c7da9..8ad04bef0 100644 --- a/content/docs/image-versions.md +++ b/content/docs/image-versions.md @@ -5,6 +5,23 @@ weight: 750 Logging operator uses the following image versions. +## Logging operator version 6.0 + +| Image repository | GitHub repository | Version | +| -------- | --- | -- | +| ghcr.io/kube-logging/logging-operator/node-exporter | https://github.com/kube-logging/logging-operator/tree/master/images/node-exporter | 6.0.0 | +| ghcr.io/kube-logging/logging-operator/config-reloader | https://github.com/kube-logging/logging-operator/tree/master/images/config-reloader | 6.0.0 | +| ghcr.io/kube-logging/logging-operator/fluentd-drain-watch | https://github.com/kube-logging/logging-operator/tree/master/images/fluentd-drain-watch | 6.0.0 | +| registry.k8s.io/pause | https://github.com/kubernetes/registry.k8s.io | 3.9 | +| docker.io/library/busybox | https://github.com/docker-library/busybox | latest | +| ghcr.io/axoflow/axosyslog | https://github.com/axoflow/axosyslog/ | 4.13.0 | +| ghcr.io/fluent/fluent-bit | https://github.com/fluent/fluent-bit | 4.0.3 | +| ghcr.io/kube-logging/logging-operator/fluentd | https://github.com/kube-logging/logging-operator/tree/master/images/fluentd | 6.0.0-full | +| ghcr.io/axoflow/axosyslog-metrics-exporter | https://github.com/axoflow/axosyslog-metrics-exporter | 0.0.9 | +| ghcr.io/kube-logging/logging-operator/syslog-ng-reloader | https://github.com/kube-logging/logging-operator/tree/master/images/syslog-ng-reloader | 6.0.0 | +| ghcr.io/kube-logging/eventrouter | https://github.com/kube-logging/eventrouter | 0.4.0 | +| rubygems.org/gems/fluentd/versions/ | | 1.18.0 | + ## Logging operator version 5.4 | Image repository | GitHub repository | Version | From 8aec6f7efb9d8e2ce7fd2d2dcbb8727f967ba588 Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Wed, 16 Jul 2025 15:11:44 +0200 Subject: [PATCH 4/6] Whatsnew draft --- content/docs/whats-new/_index.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/docs/whats-new/_index.md b/content/docs/whats-new/_index.md index 3798da425..6b10a1f13 100644 --- a/content/docs/whats-new/_index.md +++ b/content/docs/whats-new/_index.md @@ -3,6 +3,17 @@ title: What's new weight: 50 --- +## Version 6.0 + +### Breaking changes + +As announced in the 5.4 release notes, the 6.0 release includes the following breaking changes: + +- NodeAgent CRD and inline NodeAgents in the Logging resource have been removed +- hostTailer cannot be configured from the Helm chart anymore. + +For details, see the [deprecation notice for 5.4](#upcoming-deprecations-and-breaking-changes). Note that 5.4.0 remains officially supported until October 6. (If needed, patch releases from community contributions for version 5.4.0 will be supported even after 6th of October.) + ## Version 5.4 The following are the highlights and main changes of Logging operator 5.4. For a complete list of changes and bugfixes, see the [Logging operator 5.4 releases page](https://github.com/kube-logging/logging-operator/releases/tag/5.4.0). From ec4c3f43399f5c09d99138b8a976aecdf945d725 Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Wed, 16 Jul 2025 15:44:48 +0200 Subject: [PATCH 5/6] Typo fix --- content/docs/configuration/crds/v1beta1/fluentbit_types.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/configuration/crds/v1beta1/fluentbit_types.md b/content/docs/configuration/crds/v1beta1/fluentbit_types.md index 0cc63bd86..63f1288e3 100644 --- a/content/docs/configuration/crds/v1beta1/fluentbit_types.md +++ b/content/docs/configuration/crds/v1beta1/fluentbit_types.md @@ -172,7 +172,7 @@ Default: 1 ### forceHotReloadAfterGrace (bool, optional) {#fluentbitspec-forcehotreloadaftergrace} -HotReload pauses all inputs and waits until they finish. In certain situations this is unacceptable, for example if an output is down for a longer time. An undocumented option called "Hot_Reload.Ensure_Thread_Safety Off" can be used at the [SERVICE] config to force hotreload after the grace period. Please note that it might result in a SIGSEGV, but worst case kubelet will restart the container. See https://github.com/fluent/fluent-bit/pull/7509 +HotReload pauses all inputs and waits until they finish. In certain situations this is unacceptable, for example, if an output is down for a longer time. An undocumented option called "Hot_Reload.Ensure_Thread_Safety Off" can be used at the [SERVICE] config to force hotreload after the grace period. Note that it might result in a SIGSEGV, but worst case kubelet will restart the container. See https://github.com/fluent/fluent-bit/pull/7509 ### forwardOptions (*ForwardOptions, optional) {#fluentbitspec-forwardoptions} @@ -609,7 +609,7 @@ Default: Off ### storage.pause_on_chunks_overlimit (string, optional) {#inputtail-storage.pause_on_chunks_overlimit} -Specifies whether to pause or drop data when the buffer is full. This helps to make sure we apply backpressure on the input if enabled, see https://docs.fluentbit.io/manual/administration/backpressure +Specifies whether to pause or drop data when the buffer is full. This helps to make sure we apply backpressure on the input if enabled, see https://docs.fluentbit.io/manual/administration/backpressure Default: on From f20260a3fe0c8eb77cfcc4b38a6e837f84b7e966 Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Thu, 17 Jul 2025 11:50:07 +0200 Subject: [PATCH 6/6] Review fixes --- content/docs/whats-new/_index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/whats-new/_index.md b/content/docs/whats-new/_index.md index 6b10a1f13..eb446a97a 100644 --- a/content/docs/whats-new/_index.md +++ b/content/docs/whats-new/_index.md @@ -9,8 +9,8 @@ weight: 50 As announced in the 5.4 release notes, the 6.0 release includes the following breaking changes: -- NodeAgent CRD and inline NodeAgents in the Logging resource have been removed -- hostTailer cannot be configured from the Helm chart anymore. +- NodeAgent CRD and inline NodeAgents in the Logging resource have been removed. See [migration tips](#nodeagent-migration). +- hostTailer cannot be configured from the Helm chart anymore, [use hosttailers instead](#hosttailer-migration). For details, see the [deprecation notice for 5.4](#upcoming-deprecations-and-breaking-changes). Note that 5.4.0 remains officially supported until October 6. (If needed, patch releases from community contributions for version 5.4.0 will be supported even after 6th of October.) @@ -28,7 +28,7 @@ The following are the highlights and main changes of Logging operator 5.4. For a We are planning on deprecating the following components in the next major release. These breaking changes will be part of version 6.0.0 (scheduled for July 14), while 5.4.0 remains officially supported until October 6. (If needed, patch releases from community contributions for version 5.4.0 will be supported even after 6th of October.) -#### NodeAgent CRD and inline NodeAgents in the Logging resource +#### NodeAgent CRD and inline NodeAgents in the Logging resource {#nodeagent-migration} NodeAgents were an attempt to generalize log agents configuration, but it never got out PoC status, with the main feature of running Fluent Bit on Windows hosts. The code hasn't been updated recently, and the original FluentbitSpec (in the Logging resource and in the separate FluentbitAgent resource) and the features behind it have significantly diverged. @@ -37,7 +37,7 @@ Last year we've introduced [Telemetry Controller](https://github.com/kube-loggin - If you're using NodeAgent on Windows, get in touch with us (the Logging operator maintainers) over the [community channels]({{< relref "/docs/community.md" >}}), so we can help you find a viable path forward using the Telemetry Controller. - Non-windows users should either migrate to [FluentbitAgent]({{< relref "/docs/configuration/crds/v1beta1/fluentbit_types.md" >}}), or to the [Telemetry Controller](https://github.com/kube-logging/telemetry-controller). In case you need help with either case, [feel free to contact us]({{< relref "/docs/community.md" >}}). -#### hostTailer in the Helm chart +#### hostTailer in the Helm chart {#hosttailer-migration} Configuring a hostTailer in the [Logging operator Helm chart](https://github.com/kube-logging/logging-operator/tree/master/charts/logging-operator) is deprecated in favor of using hostTailers. Migrate your hostTailer configuration like this: