Merge pull request #302 from kube-logging/6.2.1-docs

6.2.1 docs

Author: fekete-robert

.github/workflows/publish-version-6.2.yaml

@@ -0,0 +1,86 @@
+name: Publish version 6.2
+
+env:
+  doc_versionnumber: "6.2"
+
+on:
+  push:
+    branches:
+      - release-6.2
+  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@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        with:
+          ref: release-6.2
+          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@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.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@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        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'

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 = "6.1"
+  version = "6.2"
   version_menu = "Releases"
   version_menu_canonicallinks = true
   version_menu_pagelinks = true
@@ -162,16 +162,20 @@ weight = 1
 
 [params.social]
 # Used as twitter:site in page metadata
-twitter = "AxoflowIO"
+#twitter = "AxoflowIO"
 
 ########################
 # Release versions
 #######################
 # Add your release versions here
 [[params.versions]]
-  version = "latest (6.1)"
+  version = "latest (6.2)"
   githubbranch = "master"
   url = ""
+[[params.versions]]
+  version = "6.1"
+  githubbranch = "release-6.1"
+  url = "/6.1/"
 [[params.versions]]
   version = "6.0"
   githubbranch = "release-6.0"

content/docs/configuration/crds/v1beta1/fluentd_types.md

@@ -168,6 +168,9 @@ Fluentd port inside the container (24240 by default). The headless service port
 ### serviceAccount (*typeoverride.ServiceAccount, optional) {#fluentdspec-serviceaccount}
 
 
+### service (*typeoverride.Service, optional) {#fluentdspec-service}
+
+
 ### sidecarContainers ([]corev1.Container, optional) {#fluentdspec-sidecarcontainers}
 
 Available in Logging operator version 4.5 and later. Configure sidecar container in Fluentd pods, for example: [https://github.com/kube-logging/logging-operator/config/samples/logging_logging_fluentd_sidecars.yaml](https://github.com/kube-logging/logging-operator/config/samples/logging_logging_fluentd_sidecars.yaml). 
@@ -229,7 +232,7 @@ ExtraVolume defines the fluentd extra volumes
 
 ## FluentdScaling
 
-FluentdScaling enables configuring the scaling behaviour of the fluentd statefulset
+FluentdScaling enables configuring the scaling behavior of the fluentd statefulset
 
 ### drain (FluentdDrainConfig, optional) {#fluentdscaling-drain}
 

content/docs/configuration/crds/v1beta1/output_types.md

@@ -77,6 +77,9 @@ OutputSpec defines the desired state of Output
 ### opensearch (*output.OpenSearchOutput, optional) {#outputspec-opensearch}
 
 
+### rabbitmq (*output.RabbitMQOutputConfig, optional) {#outputspec-rabbitmq}
+
+
 ### redis (*output.RedisOutputConfig, optional) {#outputspec-redis}
 
 

content/docs/configuration/plugins/syslog-ng-outputs/s3.md

@@ -68,6 +68,12 @@ Enable or disable compression.
 
 Default: false
 
+### content_type (string, optional) {#s3output-content_type}
+
+Available in Logging operator version 6.2 and later.
+
+The content-type of the HTTP request. Defaults to `application/octet-stream`.
+
 ### disk_buffer (*DiskBuffer, optional) {#s3output-disk_buffer}
 
 This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the [Syslog-ng DiskBuffer options](../disk_buffer/).
@@ -80,6 +86,17 @@ Set the number of seconds for flush period.
 
 Default: 60
 
+### kms_key (string, optional) {#s3output-kms_key}
+
+Available in Logging operator version 6.2 and later.
+
+The kms-key used for server-side encryption. The value of the `kms_key` parameter must be one of the following:
+
+- The ID of a key.
+- An alias of a key. In that case, make sure to add the alias/prefix, for example: `kms_key: "alias/log-archive"`
+- The ARN of a key.
+
+
 ### log-fifo-size (int, optional) {#s3output-log-fifo-size}
 
 The number of messages that the output queue can store. 
@@ -122,11 +139,25 @@ Set the region option.
 The number of times syslog-ng OSE attempts to send a message to this destination. If syslog-ng OSE could not send a message, it will try again until the number of attempts reaches retries, then drops the message. 
 
 
+### role (string, optional) {#s3output-role}
+
+Available in Logging operator version 6.2 and later.
+
+The role for the S3 server.
+
+
 ### secret_key (*secret.Secret, optional) {#s3output-secret_key}
 
 The secret_key for the S3 server. 
 
 
+### server_side_encryption (string, optional) {#s3output-server_side_encryption}
+
+Available in Logging operator version 6.2 and later.
+
+You can use the server-side-encryption() and kms-key() options to configure encryption. Currently only `server-side-encryption("aws:kms")` is supported. 
+
+
 ### storage_class (string, optional) {#s3output-storage_class}
 
 Set the storage_class option. 

content/docs/image-versions.md

@@ -5,6 +5,33 @@ weight: 750
 
 Logging operator uses the following image versions.
 
+## Logging operator version 6.2.1
+
+| 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.2.1 |
+| ghcr.io/kube-logging/logging-operator/config-reloader | https://github.com/kube-logging/logging-operator/tree/master/images/config-reloader | 6.2.1 |
+| ghcr.io/kube-logging/logging-operator/fluentd-drain-watch | https://github.com/kube-logging/logging-operator/tree/master/images/fluentd-drain-watch | 6.2.1 |
+| ghcr.io/kube-logging/logging-operator/fluentd | https://github.com/kube-logging/logging-operator/tree/master/images/fluentd | 6.2.1-full |
+| ghcr.io/kube-logging/logging-operator/syslog-ng-reloader | https://github.com/kube-logging/logging-operator/tree/master/images/syslog-ng-reloader | 6.2.1 |
+
+## Logging operator version 6.2.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.2.0 |
+| ghcr.io/kube-logging/logging-operator/config-reloader | https://github.com/kube-logging/logging-operator/tree/master/images/config-reloader | 6.2.0 |
+| ghcr.io/kube-logging/logging-operator/fluentd-drain-watch | https://github.com/kube-logging/logging-operator/tree/master/images/fluentd-drain-watch | 6.2.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.20.0 |
+| ghcr.io/fluent/fluent-bit | https://github.com/fluent/fluent-bit | 4.2.0 |
+| ghcr.io/kube-logging/logging-operator/fluentd | https://github.com/kube-logging/logging-operator/tree/master/images/fluentd | 6.2.0-full |
+| ghcr.io/axoflow/axosyslog-metrics-exporter | https://github.com/axoflow/axosyslog-metrics-exporter | 0.0.14 |
+| ghcr.io/kube-logging/logging-operator/syslog-ng-reloader | https://github.com/kube-logging/logging-operator/tree/master/images/syslog-ng-reloader | 6.2.0 |
+| ghcr.io/kube-logging/eventrouter | https://github.com/kube-logging/eventrouter | 0.4.0 |
+| rubygems.org/gems/fluentd/versions/ |  | 1.19.1 |
+
 ## Logging operator version 6.1
 
 | Image repository | GitHub repository | Version |

content/docs/whats-new/_index.md

@@ -3,6 +3,11 @@ title: What's new
 weight: 50
 ---
 
+## Version 6.2
+
+- Logging operator now uses a custom Elasticsearch gem that supports older Elasticsearch major versions besides the latest (version 9).
+- Added additional paths to performance profiling (pprof).
+
 ## Version 6.1
 
 - New Fluentd output to send logs into {{% xref "/docs/configuration/plugins/outputs/rabbitmq.md" %}}.