diff --git a/.github/workflows/publish-version-5.3.yaml b/.github/workflows/publish-version-5.3.yaml new file mode 100644 index 000000000..51adf48c8 --- /dev/null +++ b/.github/workflows/publish-version-5.3.yaml @@ -0,0 +1,86 @@ +name: Publish version 5.3 + +env: + doc_versionnumber: "5.3" + +on: + push: + branches: + - release-5.3 + 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-5.3 + 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 b84125ecd..ccb1c1bef 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -65,7 +65,7 @@ weight = 1 # Used in the "version-banner" partial to display a version number for the # current doc set. - version = "5.2" + version = "5.3" version_menu = "Releases" version_menu_canonicallinks = true version_menu_pagelinks = true @@ -169,9 +169,13 @@ twitter = "AxoflowIO" ####################### # Add your release versions here [[params.versions]] - version = "latest (5.2)" + version = "latest (5.3)" githubbranch = "master" url = "" +[[params.versions]] + version = "5.2" + githubbranch = "release-5.2" + url = "/5.2/" [[params.versions]] version = "5.1" githubbranch = "release-5.1" diff --git a/content/docs/configuration/crds/extensions/hosttailer_types.md b/content/docs/configuration/crds/extensions/hosttailer_types.md index 613cee3e5..ba48e7a08 100644 --- a/content/docs/configuration/crds/extensions/hosttailer_types.md +++ b/content/docs/configuration/crds/extensions/hosttailer_types.md @@ -122,6 +122,13 @@ Start reading from the head of new log files Skip long line when exceeding Buffer_Max_Size +### verbose (bool, optional) {#filetailer-verbose} + +Available in Logging operator version 5.3 and later. + +Verbose mode + + ## SystemdTailer diff --git a/content/docs/configuration/crds/v1beta1/clusterflow_types.md b/content/docs/configuration/crds/v1beta1/clusterflow_types.md index fdd15320b..73a743e49 100644 --- a/content/docs/configuration/crds/v1beta1/clusterflow_types.md +++ b/content/docs/configuration/crds/v1beta1/clusterflow_types.md @@ -49,6 +49,9 @@ Name of the logging cluster to be attached ### namespaces ([]string, optional) {#clusterselect-namespaces} +### namespaces_regex ([]string, optional) {#clusterselect-namespaces_regex} + +Available in Logging operator version 5.3 and later. ## ClusterExclude @@ -67,6 +70,9 @@ Name of the logging cluster to be attached ### namespaces ([]string, optional) {#clusterexclude-namespaces} +### namespaces_regex ([]string, optional) {#clusterexclude-namespaces_regex} + +Available in Logging operator version 5.3 and later. ## ClusterFlowSpec diff --git a/content/docs/configuration/crds/v1beta1/fluentbit_types.md b/content/docs/configuration/crds/v1beta1/fluentbit_types.md index 7cd055f3b..1d3c927b4 100644 --- a/content/docs/configuration/crds/v1beta1/fluentbit_types.md +++ b/content/docs/configuration/crds/v1beta1/fluentbit_types.md @@ -147,6 +147,7 @@ DisableVarLibDockerContainers controls whether the /var/lib/docker/containers vo ### filterGrep (*FilterGrep, optional) {#fluentbitspec-filtergrep} +Available in Logging operator version 5.3 and later. ### filterKubernetes (FilterKubernetes, optional) {#fluentbitspec-filterkubernetes} @@ -881,6 +882,8 @@ Default: false FilterGrep The Grep Filter plugin +Available in Logging operator version 5.3 and later. + ### Exclude ([]string, optional) {#filtergrep-exclude} Exclude records where the content of KEY matches the regular expression. diff --git a/content/docs/configuration/plugins/filters/elasticsearch_genid.md b/content/docs/configuration/plugins/filters/elasticsearch_genid.md index 169ef1d78..efee752c9 100644 --- a/content/docs/configuration/plugins/filters/elasticsearch_genid.md +++ b/content/docs/configuration/plugins/filters/elasticsearch_genid.md @@ -61,7 +61,7 @@ You can specify keys which are record in events for hash generation seed. This p ### separator (string, optional) {#elasticsearchgenid-separator} -You can specify separator charactor to creating seed for hash generation. +You can specify separator character to creating seed for hash generation. ### use_entire_record (bool, optional) {#elasticsearchgenid-use_entire_record} diff --git a/content/docs/configuration/plugins/filters/parser.md b/content/docs/configuration/plugins/filters/parser.md index 077076187..f544c49b8 100644 --- a/content/docs/configuration/plugins/filters/parser.md +++ b/content/docs/configuration/plugins/filters/parser.md @@ -100,6 +100,12 @@ Only available when using type: multi_format Only available when using type: multi_format +### format_key (string, optional) {#parse-section-format_key} + +Available in Logging operator version 5.3 and later. + +Only available when using type: multi_format If set, add this key to record with value being pattern format_name + ### grok_failure_key (string, optional) {#parse-section-grok_failure_key} Only available when using type: grok, multiline_grok. The key has grok failure reason. @@ -191,7 +197,7 @@ Default: nil ### type (string, optional) {#parse-section-type} -Parse type: apache2, apache_error, nginx, syslog, csv, tsv, ltsv, json, multiline, none, logfmt, grok, multiline_grok +Parse type: apache2, apache_error, nginx, syslog, csv, tsv, ltsv, json, multiline, none, logfmt, grok, multiline_grok, multi_format ### types (string, optional) {#parse-section-types} @@ -227,6 +233,13 @@ Regexp expression to evaluate Only available when using type: multi_format +### format_name (string, optional) {#parse-section-format_name} + +Available in Logging operator version 5.3 and later. + +Only available when using `type: multi_format`. Value added to format key entry + + ### grok_failure_key (string, optional) {#parse-section-grok_failure_key} Only available when using format: grok, multiline_grok. The key has grok failure reason. @@ -296,7 +309,7 @@ Default: nil ### type (string, optional) {#parse-section-type} -Parse type: apache2, apache_error, nginx, syslog, csv, tsv, ltsv, json, multiline, none, logfmt, grok, multiline_grok +Parse type: apache2, apache_error, nginx, syslog, csv, tsv, ltsv, json, multiline, none, logfmt, grok, multiline_grok, multi_format ### types (string, optional) {#parse-section-types} @@ -361,11 +374,14 @@ spec: reserve_data: true parse: type: multi_format + format_key: format patterns: - format: nginx + format_name: nginx - format: regexp expression: /foo/ - format: none + format_name: none selectors: {} localOutputRefs: - demo-output @@ -382,8 +398,10 @@ Fluentd config result: reserve_data true @type multi_format + format_key format format nginx + format_name nginx expression /foo/ @@ -391,6 +409,7 @@ Fluentd config result: format none + format_name none diff --git a/content/docs/configuration/plugins/outputs/gelf.md b/content/docs/configuration/plugins/outputs/gelf.md index 96e44eb94..5d40191b5 100644 --- a/content/docs/configuration/plugins/outputs/gelf.md +++ b/content/docs/configuration/plugins/outputs/gelf.md @@ -59,7 +59,13 @@ TLS Options. For details, see [https://github.com/graylog-labs/gelf-rb/blob/7291 Default: {} +### udp_transport_type (string, optional) {#output-config-udp_transport_type} +Available in Logging operator version 5.3 and later. + +UdpTransportType specifies the UDP chunk size by choosing either WAN or LAN mode. The choice between WAN and LAN affects the UDP chunk size depending on whether you are sending logs within your local network (LAN) or over a longer route (e.g., through the internet). Set this option accordingly. For more details, see: [https://github.com/manet-marketing/gelf_redux/blob/9db64353b6672805152c17642ea8ad39eafb5875/lib/gelf/notifier.rb#L22](https://github.com/manet-marketing/gelf_redux/blob/9db64353b6672805152c17642ea8ad39eafb5875/lib/gelf/notifier.rb#L22) Available since ghcr.io/kube-logging/logging-operator/fluentd:5.3.0-full + +Default: WAN ## Example `GELF` output configurations diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md b/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md index fa7ecb3c3..cef1d3817 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md @@ -32,7 +32,7 @@ Use this option if the option reliable() is set to no. This option contains the Use this option if the option reliable() is set to yes. This option contains the size of the messages in bytes that is used in the memory part of the disk buffer. -### q_out_size (*int64, optional) {#diskbuffer-q_out_size} +### qout_size (*int64, optional) {#diskbuffer-qout_size} The number of messages stored in the output buffer of the destination. diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/loki.md b/content/docs/configuration/plugins/syslog-ng-outputs/loki.md index f1694f5b1..41de530be 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/loki.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/loki.md @@ -82,6 +82,13 @@ The number of times syslog-ng OSE attempts to send a message to this destination Template for customizing the log message format. +### tenant-id (string, optional) {#lokioutput-tenant-id} + +Available in Logging operator version 5.3 and later. + +Sets the tenant ID for multi-tenant scenarios. See the [AxoSyslog docs](https://axoflow.com/docs/axosyslog-core/chapter-destinations/destination-loki/#tenant-id) for more information. + + ### time_reopen (int, optional) {#lokioutput-time_reopen} The time to wait in seconds before a dead connection is reestablished. diff --git a/content/docs/image-versions.md b/content/docs/image-versions.md index 90c225c34..33a4d7168 100644 --- a/content/docs/image-versions.md +++ b/content/docs/image-versions.md @@ -5,6 +5,22 @@ weight: 750 Logging operator uses the following image versions. +## Logging operator version 5.3 + +| 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 | 5.3.0 | +| ghcr.io/kube-logging/logging-operator/config-reloader | https://github.com/kube-logging/logging-operator/tree/master/images/config-reloader | 5.3.0 | +| ghcr.io/kube-logging/logging-operator/fluentd-drain-watch | https://github.com/kube-logging/logging-operator/tree/master/images/fluentd-drain-watch | 5.3.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.11.0 | +| ghcr.io/fluent/fluent-bit | https://github.com/fluent/fluent-bit | 3.2.5 | +| ghcr.io/kube-logging/logging-operator/fluentd | https://github.com/kube-logging/logging-operator/tree/master/images/fluentd | 5.3.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 | 5.3.0 | +| ghcr.io/kube-logging/eventrouter | https://github.com/kube-logging/eventrouter | 0.4.0 | + ## Logging operator version 5.2 | Image repository | GitHub repository | Version | diff --git a/content/docs/whats-new/_index.md b/content/docs/whats-new/_index.md index cc35727d8..4f0054683 100644 --- a/content/docs/whats-new/_index.md +++ b/content/docs/whats-new/_index.md @@ -3,6 +3,26 @@ title: What's new weight: 50 --- +## Version 5.3 + +The following are the highlights and main changes of Logging operator 5.3. For a complete list of changes and bugfixes, see the [Logging operator 5.3 releases page](https://github.com/kube-logging/logging-operator/releases/tag/5.3.0). + +### Breaking change + +Starting with this version, Logging operator sets default security context values for the Fluentd logging configuration, so from now on: + +- Fluentd runs as the `fluentd` user (instead of root) +- Default user and group IDs are set in the SecurityContext and PodSecurityContext + +### Other changes + +- In this release we've moved `fluentd-drain-watch` and `node-exporter` into the Logging operator repository. From now on, we build these images from our repository (https://github.com/kube-logging/logging-operator/tree/master/images/) and their version numbering follows the version numbers of Logging operator. +- You can now set the `format_key` and `format_name` options for when using the [Fluentd parser filter]({{< relref "/docs/configuration/plugins/filters/parser.md" >}}) to use multi-format parsing. +- You can use Filter Grep (https://docs.fluentbit.io/manual/pipeline/filters/grep) in the [FluentbitSpec]({{< relref "/docs/configuration/crds/v1beta1/fluentbit_types.md#filtergrep" >}}) section of your logging configuration. That way you can exclude logs before passing them to Fluentd. +- When using Fluentd and ClusterFlows, you can now select and exclude namespaces with regular expressions using the `namespaces_regex` option. +- When using the [Loki destination]({{< relref "/docs/configuration/plugins/syslog-ng-outputs/loki.md#lokioutput-tenant-id" >}}) in a SyslogNGClusterOutput/SyslogNGOutput, you can now set the tenant-id. +- You can now enable verbose mode in {{% xref "/docs/configuration/crds/extensions/hosttailer_types.md" %}}. Also, the default log level of the HostTailer has been reduced to error. + ## Version 5.2 The following are the highlights and main changes of Logging operator 5.2. For a complete list of changes and bugfixes, see the [Logging operator 5.2 releases page](https://github.com/kube-logging/logging-operator/releases/tag/5.2.0).