Merge pull request #243 from kube-logging/4.7-doc-preparations

4.7 doc preparations

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

@@ -0,0 +1,86 @@
+name: Publish version 4.6
+
+env:
+  doc_versionnumber: "4.6"
+
+on:
+  push:
+    branches:
+      - release-4.6
+  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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          ref: release-4.6
+          submodules: 'recursive'
+
+      - name: Set up Pages
+        id: pages
+        uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4.0.0
+
+      - name: Set up Hugo
+        uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d # v2.6.0
+        with:
+          hugo-version: '0.110.0'
+          extended: true
+
+      - name: Set up Node
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+        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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        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

@@ -32,7 +32,7 @@ weight = 1
 
 [social]
 # Used as twitter:site in page metadata
-twitter = "calisti12"
+twitter = "AxoflowIO"
 
 [markup]
   [markup.goldmark]
@@ -69,7 +69,7 @@ twitter = "calisti12"
   # Used in the "version-banner" partial to display a version number for the 
   # current doc set.
 
-  version = "4.6.0"
+  version = "4.7.0"
   version_menu = "Releases"
   version_menu_canonicallinks = true
   version_menu_pagelinks = true
@@ -169,9 +169,13 @@ twitter = "calisti12"
 #######################
 # Add your release versions here
 [[params.versions]]
-  version = "latest (4.6.0)"
+  version = "latest (4.7.0)"
   githubbranch = "master"
   url = ""
+[[params.versions]]
+  version = "4.6"
+  githubbranch = "release-4.6"
+  url = "/4.6/"
 [[params.versions]]
   version = "4.5"
   githubbranch = "release-4.5"
@@ -196,7 +200,7 @@ twitter = "calisti12"
 # Cascade version number to every doc page (needed to create sections for pagefind search)
 # Update this parameter when creating a new version
 [[cascade]]
-body_attribute = 'data-pagefind-filter="section:4.6"'
+body_attribute = 'data-pagefind-filter="section:4.7"'
 [cascade._target]
   path = '/docs/**'
 

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

@@ -31,6 +31,9 @@ ClusterOutputSpec contains Kubernetes spec for ClusterOutput
 ### enabledNamespaces ([]string, optional) {#clusteroutputspec-enablednamespaces}
 
 
+### protected (bool, optional) {#clusteroutputspec-protected}
+
+
 
 ## ClusterOutputList
 

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

@@ -71,10 +71,10 @@ ServiceMonitorConfig defines the ServiceMonitor properties
 ### honorLabels (bool, optional) {#servicemonitorconfig-honorlabels}
 
 
-### metricRelabelings ([]*v1.RelabelConfig, optional) {#servicemonitorconfig-metricrelabelings}
+### metricRelabelings ([]v1.RelabelConfig, optional) {#servicemonitorconfig-metricrelabelings}
 
 
-### relabelings ([]*v1.RelabelConfig, optional) {#servicemonitorconfig-relabelings}
+### relabelings ([]v1.RelabelConfig, optional) {#servicemonitorconfig-relabelings}
 
 
 ### scheme (string, optional) {#servicemonitorconfig-scheme}
@@ -95,6 +95,7 @@ Security defines Fluentd, FluentbitAgent deployment security properties
 
 Warning: this is not supported anymore and does nothing 
 
+
 ### roleBasedAccessControlCreate (*bool, optional) {#security-rolebasedaccesscontrolcreate}
 
 

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

@@ -339,6 +339,12 @@ How many times a TCP keepalive connection can be used before being recycled
 
 Default: 0, disabled
 
+### maxWorkerConnections (int, optional) {#fluentbitnetwork-maxworkerconnections}
+
+Set maximum number of TCP connections that can be established per worker.
+
+Default: 0, unlimited
+
 ### sourceAddress (string, optional) {#fluentbitnetwork-sourceaddress}
 
 Specify network address (interface) to use for connection and data traffic.
@@ -724,6 +730,21 @@ Default: On
 Optional parser name to specify how to parse the data contained in the log key. Recommended use is for developers or testing only. 
 
 
+### namespace_annotations (string, optional) {#filterkubernetes-namespace_annotations}
+
+Include Kubernetes namespace annotations on every record 
+
+
+### kube_meta_namespace_cache_ttl (string, optional) {#filterkubernetes-kube_meta_namespace_cache_ttl}
+
+Configurable TTL for K8s cached namespace metadata. (15m) 
+
+
+### namespace_labels (string, optional) {#filterkubernetes-namespace_labels}
+
+Include Kubernetes namespace labels on every record 
+
+
 ### Regex_Parser (string, optional) {#filterkubernetes-regex_parser}
 
 Set an alternative Parser to process record Tag and extract pod_name, namespace_name, container_name and docker_id. The parser must be registered in a parsers file (refer to parser filter-kube-test as an example). 

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

@@ -34,6 +34,11 @@ BufferStorageVolume is by default configured as PVC using FluentdPvcSpec [volume
 ### compressConfigFile (bool, optional) {#fluentdspec-compressconfigfile}
 
 
+### configCheck (*ConfigCheck, optional) {#fluentdspec-configcheck}
+
+Overrides the default logging level configCheck setup. This field is not used directly, just copied over the field in the logging resource if defined.
+
+
 ### configCheckAnnotations (map[string]string, optional) {#fluentdspec-configcheckannotations}
 
 
@@ -107,6 +112,11 @@ Ignore same log lines [more info]( https://docs.fluentd.org/deployment/logging#i
 ### livenessProbe (*corev1.Probe, optional) {#fluentdspec-livenessprobe}
 
 
+### logFormat (string, optional) {#fluentdspec-logformat}
+
+Set the logging format. Allowed values are: "text" (default) and "json". 
+
+
 ### logLevel (string, optional) {#fluentdspec-loglevel}
 
 

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

@@ -21,7 +21,7 @@ Default: "cluster.local."
 
 ### configCheck (ConfigCheck, optional) {#loggingspec-configcheck}
 
-ConfigCheck settings that apply to both fluentd and syslog-ng 
+ConfigCheck settings that apply to both fluentd or syslog-ng. Can be overridden on the fluentd / syslog-ng level. 
 
 
 ### controlNamespace (string, required) {#loggingspec-controlnamespace}

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

@@ -14,6 +14,11 @@ SyslogNGSpec defines the desired state of SyslogNG
 ### bufferVolumeMetricsService (*typeoverride.Service, optional) {#syslogngspec-buffervolumemetricsservice}
 
 
+### configCheck (*ConfigCheck, optional) {#syslogngspec-configcheck}
+
+Overrides the default logging level configCheck setup. This field is not used directly, just copied over the field in the logging resource if defined. 
+
+
 ### configCheckPod (*typeoverride.PodSpec, optional) {#syslogngspec-configcheckpod}
 
 

content/docs/configuration/plugins/outputs/buffer.md

@@ -18,7 +18,7 @@ The max number of events that each chunks can store in it
 
 ### chunk_limit_size (string, optional) {#buffer-chunk_limit_size}
 
-The max size of each chunks: events will be written into chunks until the size of chunks become this size (default: 8MB) 
+The max size of each chunks: events will be written into chunks until the size of chunks become this size
 
 Default: 8MB
 

content/docs/configuration/plugins/outputs/elasticsearch.md

@@ -54,6 +54,12 @@ Configure bulk_message request splitting threshold size. Default value is 20MB.
 
 Default: 20MB
 
+### compression_level (string, optional) {#elasticsearch-compression_level}
+
+Option for compressing the output data using gzip. Valid options: default_compression, best_compression, best_speed, no_compression.
+
+Default: no_compression
+
 ### content_type (string, optional) {#elasticsearch-content_type}
 
 With content_type application/x-ndjson, elasticsearch plugin adds application/x-ndjson as Content-Profile in payload.