Merge pull request #183 from kube-logging/updates-for-4.4

Updates for 4.4

Author: pepov

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

@@ -0,0 +1,86 @@
+name: Publish version 4.3
+
+env:
+  doc_versionnumber: "4.3"
+
+on:
+  push:
+    branches:
+      - release-4.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@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+        with:
+          ref: release-4.3
+          submodules: 'recursive'
+
+      - name: Set up Pages
+        id: pages
+        uses: actions/configure-pages@f156874f8191504dae5b037505266ed5dda6c382 # v3.0.6
+
+      - 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@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        with:
+          node-version: 16
+
+      - 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@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.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

@@ -69,7 +69,7 @@ twitter = "calisti12"
   # Used in the "version-banner" partial to display a version number for the 
   # current doc set.
 
-  version = "4.3.0"
+  version = "4.4.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.3.0)"
+  version = "latest (4.4.0)"
   githubbranch = "master"
   url = ""
+[[params.versions]]
+  version = "4.3"
+  githubbranch = "release-4.3"
+  url = "/4.3/"
 [[params.versions]]
   version = "4.2"
   githubbranch = "release-4.2"

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

@@ -202,6 +202,10 @@ Default: -
 
 Default: -
 
+### bufferVolumeResources (corev1.ResourceRequirements, optional) {#fluentbitspec-buffervolumeresources}
+
+Default: -
+
 ### customConfigSecret (string, optional) {#fluentbitspec-customconfigsecret}
 
 Default: -
@@ -607,7 +611,7 @@ Default: "0"
 
 ### Kube_URL (string, optional) {#filterkubernetes-kube_url}
 
-API Server end-point (default: `https://kubernetes.default.svc:443`)
+API Server end-point.
 
 Default: `https://kubernetes.default.svc:443`
 

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

@@ -132,6 +132,10 @@ Default: -
 
 Default: -
 
+### bufferVolumeResources (corev1.ResourceRequirements, optional) {#fluentdspec-buffervolumeresources}
+
+Default: -
+
 ### security (*Security, optional) {#fluentdspec-security}
 
 Default: -
@@ -299,6 +303,10 @@ Container image to use for the drain watch sidecar
 
 Default: -
 
+### labels (map[string]string, optional) {#fluentddrainconfig-labels}
+
+Labels to use for the drain watch sidecar on top of labels added by the operator by default. Default values can be overwritten. 
+
 ### deleteVolume (bool, optional) {#fluentddrainconfig-deletevolume}
 
 Should persistent volume claims be deleted after draining is done 

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

@@ -32,6 +32,12 @@ Override generated config. This is a *raw* configuration string for troubleshoot
 
 Default: -
 
+### configCheck (ConfigCheck, optional) {#loggingspec-configcheck}
+
+ConfigCheck settings that apply to both fluentd and syslog-ng 
+
+Default: -
+
 ### fluentbit (*FluentbitSpec, optional) {#loggingspec-fluentbit}
 
 FluentbitAgent daemonset configuration. Deprecated, will be removed with next major version Migrate to the standalone NodeAgent resource 
@@ -84,7 +90,7 @@ Default: -
 
 Cluster domain name to be used when templating URLs to services . 
 
-Default:  "cluster.local"
+Default:  "cluster.local."
 
 ### controlNamespace (string, required) {#loggingspec-controlnamespace}
 
@@ -111,6 +117,27 @@ EnableRecreateWorkloadOnImmutableFieldChange enables the operator to recreate th
 Default: -
 
 
+## ConfigCheck
+
+### strategy (ConfigCheckStrategy, optional) {#configcheck-strategy}
+
+Select the config check strategy to use. `DryRun`: parse and validate configuration `StartWithTimeout`: start with given configuration and exit after specified timeout.
+
+Default: `DryRun` 
+
+### timeoutSeconds (int, optional) {#configcheck-timeoutseconds}
+
+Configure timeout in seconds if strategy is StartWithTimeout 
+
+Default: -
+
+### labels (map[string]string, optional) {#configcheck-labels}
+
+Labels to use for the configcheck pods on top of labels added by the operator by default. Default values can be overwritten. 
+
+Default: -
+
+
 ## LoggingStatus
 
 LoggingStatus defines the observed state of Logging

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

@@ -0,0 +1,106 @@
+---
+title: LoggingRouteSpec
+weight: 200
+generated_file: true
+---
+
+## LoggingRouteSpec
+
+LoggingRouteSpec defines the desired state of LoggingRoute
+
+### source (string, required) {#loggingroutespec-source}
+
+Source identifies the logging that this policy applies to 
+
+Default: -
+
+### targets (metav1.LabelSelector, required) {#loggingroutespec-targets}
+
+Targets refers to the list of logging resources specified by a label selector to forward logs to. Filtering of namespaces will happen based on the watchNamespaces and watchNamespaceSelector fields of the target logging resource 
+
+Default: -
+
+
+## LoggingRouteStatus
+
+LoggingRouteStatus defines the actual state of the LoggingRoute
+
+### tenants ([]Tenant, optional) {#loggingroutestatus-tenants}
+
+Enumerate all loggings with all the destination namespaces expanded 
+
+Default: -
+
+### problems ([]string, optional) {#loggingroutestatus-problems}
+
+Enumerate problems that prohibits this route to take effect and populate the tenants field 
+
+Default: -
+
+### problemsCount (int, optional) {#loggingroutestatus-problemscount}
+
+Summarize the number of problems for the CLI output 
+
+Default: -
+
+### notices ([]string, optional) {#loggingroutestatus-notices}
+
+Enumerate non-blocker issues the user should pay attention to 
+
+Default: -
+
+### noticesCount (int, optional) {#loggingroutestatus-noticescount}
+
+Summarize the number of notices for the CLI output 
+
+Default: -
+
+
+## Tenant
+
+### name (string, required) {#tenant-name}
+
+Default: -
+
+### namespaces ([]string, optional) {#tenant-namespaces}
+
+Default: -
+
+
+## LoggingRoute
+
+LoggingRoute (experimental)
+Connects a log collector with log aggregators from other logging domains and routes relevant logs based on watch namespaces
+
+###  (metav1.TypeMeta, required) {#loggingroute-}
+
+Default: -
+
+### metadata (metav1.ObjectMeta, optional) {#loggingroute-metadata}
+
+Default: -
+
+### spec (LoggingRouteSpec, optional) {#loggingroute-spec}
+
+Default: -
+
+### status (LoggingRouteStatus, optional) {#loggingroute-status}
+
+Default: -
+
+
+## LoggingRouteList
+
+###  (metav1.TypeMeta, required) {#loggingroutelist-}
+
+Default: -
+
+### metadata (metav1.ListMeta, optional) {#loggingroutelist-metadata}
+
+Default: -
+
+### items ([]LoggingRoute, required) {#loggingroutelist-items}
+
+Default: -
+
+

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

@@ -28,6 +28,14 @@ Default: -
 
 Default: -
 
+### redis (*output.RedisOutput, optional) {#syslogngoutputspec-redis}
+
+Default: -
+
+### mongodb (*output.MongoDB, optional) {#syslogngoutputspec-mongodb}
+
+Default: -
+
 ### sumologic-http (*output.SumologicHTTPOutput, optional) {#syslogngoutputspec-sumologic-http}
 
 Default: -
@@ -40,10 +48,22 @@ Default: -
 
 Default: -
 
+### elasticsearch (*output.ElasticsearchOutput, optional) {#syslogngoutputspec-elasticsearch}
+
+Default: -
+
 ### logscale (*output.LogScaleOutput, optional) {#syslogngoutputspec-logscale}
 
 Default: -
 
+### splunk_hec_event (*output.SplunkHECOutput, optional) {#syslogngoutputspec-splunk_hec_event}
+
+Default: -
+
+### loki (*output.LokiOutput, optional) {#syslogngoutputspec-loki}
+
+Default: -
+
 
 ## SyslogNGOutput
 

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

@@ -106,7 +106,13 @@ Default: -
 
 ### stats (*Stats, optional) {#globaloptions-stats}
 
-TODO switch to this by default 
+See the [AxoSyslog Core documentation](https://axoflow.com/docs/axosyslog-core/chapter-global-options/reference-options/#global-option-stats)
+
+Default: -
+
+### log_level (*string, optional) {#globaloptions-log_level}
+
+See the [AxoSyslog Core documentation](https://axoflow.com/docs/axosyslog-core/chapter-global-options/reference-options/#global-options-log-level)
 
 Default: -
 

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

@@ -13,7 +13,8 @@ More info at [https://github.com/DataDog/fluent-plugin-datadog](https://github.c
 ```yaml
  spec:
   datadog:
-    api_key '<YOUR_API_KEY>'
+	  api_key:
+	    value: '<YOUR_API_KEY>' # for referencing a secret see https://kube-logging.dev/docs/configuration/plugins/outputs/secret/
     dd_source: '<INTEGRATION_NAME>'
     dd_tags: '<KEY1:VALUE1>,<KEY2:VALUE2>'
     dd_sourcecategory: '<YOUR_SOURCE_CATEGORY>'

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

@@ -573,4 +573,8 @@ Specify whether overwriting data stream ilm policy or not.
 
 Default: -
 
+### use_legacy_template (*bool, optional) {#elasticsearch-use_legacy_template}
 
+If set to true, the output uses the [legacy index template format](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates-v1.html). Otherwise, it uses the [composable index template](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/index-templates.html) format.
+
+Default:  true