Merge pull request #168 from kube-logging/4.3-preparations

4.3-preparations

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

@@ -0,0 +1,86 @@
+name: Publish version 4.2
+
+env:
+  doc_versionnumber: "4.2"
+
+on:
+  push:
+    branches:
+      - release-4.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@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
+        with:
+          ref: release-4.2
+          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@e33196f7422957bea03ed53f6fbb155025ffc7b8 # v3.7.0
+        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@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.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'

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.2.0"
+  version = "4.3.0"
   version_menu = "Releases"
   version_menu_canonicallinks = true
   version_menu_pagelinks = true
@@ -167,9 +167,13 @@ twitter = "calisti12"
 #######################
 # Add your release versions here
 [[params.versions]]
-  version = "latest (4.2.0)"
+  version = "latest (4.3.0)"
   githubbranch = "master"
   url = ""
+[[params.versions]]
+  version = "4.2"
+  githubbranch = "release-4.2"
+  url = "/4.2/"
 [[params.versions]]
   version = "4.0"
   githubbranch = "release-4.0"
@@ -178,7 +182,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.2"'
+body_attribute = 'data-pagefind-filter="section:4.3"'
 [cascade._target]
   path = '/docs/**'
 

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

@@ -46,7 +46,7 @@ Default: -
 
 FluentbitSpec defines the desired state of FluentbitAgent
 
-### LoggingRef (string, optional) {#fluentbitspec-loggingref}
+### loggingRef (string, optional) {#fluentbitspec-loggingref}
 
 Default: -
 
@@ -711,7 +711,7 @@ Default: Off
 
 Allow Kubernetes Pods to exclude their logs from the log processor (read more about it in Kubernetes Annotations section).  
 
-Default: Off
+Default: On
 
 ### Labels (string, optional) {#filterkubernetes-labels}
 
@@ -1067,11 +1067,11 @@ Default: -
 
 Defines a FluentbitNameProvider
 
-### LoggingRef (*Logging, optional) {#fluentbitnameprovider-loggingref}
+### Logging (*Logging, optional) {#fluentbitnameprovider-logging}
 
 Default: -
 
-### fluentbit (*FluentbitAgent, optional) {#fluentbitnameprovider-fluentbit}
+### FluentbitAgent (*FluentbitAgent, optional) {#fluentbitnameprovider-fluentbitagent}
 
 Default: -
 

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

@@ -74,6 +74,12 @@ Limit namespaces to watch Flow and Output custom resources.
 
 Default: -
 
+### watchNamespaceSelector (*metav1.LabelSelector, optional) {#loggingspec-watchnamespaceselector}
+
+WatchNamespaceSelector is a LabelSelector to find matching namespaces to watch as in WatchNamespaces 
+
+Default: -
+
 ### clusterDomain (*string, optional) {#loggingspec-clusterdomain}
 
 Cluster domain name to be used when templating URLs to services . 

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

@@ -100,7 +100,7 @@ Default: -
 
 ### stats_freq (*int, optional) {#globaloptions-stats_freq}
 
-Deprecated. Use stats/level from 4.1+ 
+Deprecated. Use stats/freq from 4.1+ 
 
 Default: -
 

content/docs/configuration/flow.md

@@ -65,9 +65,9 @@ The filters in the flow are applied in the order in the definition. You can find
 
 At the end of the Flow, you can attach one or more [outputs]({{< relref "/docs/configuration/output.md" >}}), which may also be `Output` or `ClusterOutput` resources.
 
-> `SyslogNGFlow` resources are `namespaced`, the `selector` only select `Pod` logs within namespace.
+> `SyslogNGFlow` resources are `namespaced`, the `selector` only selects `Pod` logs within the namespace.
 > `SyslogNGClusterFlow` defines a SyslogNGFlow **without** namespace restrictions. It is also only effective in the `controlNamespace`.
- `SyslogNGClusterFlow` selects logs from **ALL** namespace.
+ `SyslogNGClusterFlow` selects logs from **ALL** namespaces.
 
 The following example selects only messages sent by the log-generator application and forwards them to a syslog output.
 

content/docs/examples/cloudwatch-nginx.md

@@ -22,18 +22,7 @@ Install the Logging operator and a demo application using [Helm](#helm).
 
 {{< include-headless "deploy-helm-intro.md" >}}
 
-1. Add the chart repository of the Logging operator using the following commands:
-
-    ```bash
-    helm repo add kube-logging https://kube-logging.dev/helm-charts
-    helm repo update
-    ```
-
-1. Install the Logging operator.
-
-    ```bash
-    helm upgrade --install --wait --create-namespace --namespace logging logging-operator kube-logging/logging-operator
-    ```
+1. {{< include-headless "helm-install-logging-operator.md" >}}
 
 1. Create AWS `secret`
 
@@ -137,7 +126,7 @@ Install the Logging operator and a demo application using [Helm](#helm).
 1. Install log-generator to produce logs with the label `app.kubernetes.io/name: log-generator`
 
      ```bash
-     helm upgrade --install --wait --create-namespace --namespace logging log-generator kube-logging/log-generator
+     helm upgrade --install --wait --create-namespace --namespace logging log-generator oci://ghcr.io/kube-logging/helm-charts/log-generator
      ```
 
 1. [Validate your deployment](#validate).

content/docs/examples/kafka-nginx.md

@@ -26,18 +26,7 @@ Install the Logging operator and a demo application to provide sample log messag
 
 {{< include-headless "deploy-helm-intro.md" >}}
 
-1. Add the chart repository of the Logging operator using the following commands:
-
-    ```bash
-    helm repo add kube-logging https://kube-logging.dev/helm-charts
-    helm repo update
-    ```
-
-1. Install the Logging operator into the *logging* namespace:
-
-    ```bash
-    helm upgrade --install --wait --create-namespace --namespace logging logging-operator kube-logging/logging-operator
-    ```
+1. {{< include-headless "helm-install-logging-operator.md" >}}
 
 1. [Validate your deployment](#validate).
 
@@ -110,7 +99,7 @@ Install the Logging operator and a demo application to provide sample log messag
 1. Install log-generator to produce logs with the label `app.kubernetes.io/name: log-generator`
 
      ```bash
-     helm upgrade --install --wait --create-namespace --namespace logging log-generator kube-logging/log-generator
+     helm upgrade --install --wait --create-namespace --namespace logging log-generator oci://ghcr.io/kube-logging/helm-charts/log-generator
      ```
 
 1. [Validate your deployment](#validate).

content/docs/examples/loki-nginx.md

@@ -20,17 +20,40 @@ This guide describes how to collect application and container logs in Kubernetes
 
     ```bash
     helm repo add grafana https://grafana.github.io/helm-charts
-    helm repo add loki https://grafana.github.io/loki/charts
     helm repo update
     ```
 
 1. Install Loki into the *logging* namespace:
 
     ```bash
-    helm upgrade --install --create-namespace --namespace logging loki loki/loki
+    helm upgrade --install --create-namespace --namespace logging loki grafana/loki
     ```
 
-    > [Grafana Loki Documentation](https://github.com/grafana/loki/tree/master/production/helm)
+    Expected output:
+
+    ```shell
+    Release "loki" does not exist. Installing it now.
+    NAME: loki
+    LAST DEPLOYED: Wed Aug  9 10:58:32 2023
+    NAMESPACE: logging
+    STATUS: deployed
+    REVISION: 1
+    NOTES:
+    ***********************************************************************
+    Welcome to Grafana Loki
+    Chart version: 5.10.0
+    Loki version: 2.8.3
+    ***********************************************************************
+
+    Installed components:
+    * grafana-agent-operator
+    * gateway
+    * read
+    * write
+    * backend
+    ```
+
+    > For details, see the [Grafana Loki Documentation](https://grafana.com/docs/loki/next/setup/install/helm/)
 
 1. Install Grafana into the *logging* namespace:
 
@@ -43,6 +66,22 @@ This guide describes how to collect application and container logs in Kubernetes
     --set "datasources.datasources\\.yaml.datasources[0].access=proxy"
     ```
 
+    Expected output:
+
+    ```shell
+    Release "grafana" does not exist. Installing it now.
+    NAME: grafana
+    LAST DEPLOYED: Wed Aug  9 11:00:47 2023
+    NAMESPACE: logging
+    STATUS: deployed
+    REVISION: 1
+    NOTES:
+    1. Get your 'admin' user password by running:
+
+      kubectl get secret --namespace logging grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo
+    ...
+    ```
+
 ## Deploy the Logging operator and a demo application
 
 Install the Logging operator and a demo application to provide sample log messages.
@@ -51,18 +90,7 @@ Install the Logging operator and a demo application to provide sample log messag
 
 {{< include-headless "deploy-helm-intro.md" >}}
 
-1. Add the chart repository of the Logging operator using the following commands:
-
-    ```bash
-    helm repo add kube-logging https://kube-logging.dev/helm-charts
-    helm repo update
-    ```
-
-1. Install the Logging operator into the *logging* namespace:
-
-    ```bash
-    helm upgrade --install --wait --create-namespace --namespace logging logging-operator kube-logging/logging-operator
-    ```
+1. {{< include-headless "helm-install-logging-operator.md" >}}
 
 1. Create the `logging` resource.
 
@@ -130,7 +158,7 @@ Install the Logging operator and a demo application to provide sample log messag
 1. Install log-generator to produce logs with the label `app.kubernetes.io/name: log-generator`
 
      ```bash
-     helm upgrade --install --wait --create-namespace --namespace logging log-generator kube-logging/log-generator
+     helm upgrade --install --wait --create-namespace --namespace logging log-generator oci://ghcr.io/kube-logging/helm-charts/log-generator
      ```
 
 1. [Validate your deployment](#validate).

content/docs/examples/splunk.md

@@ -137,7 +137,7 @@ To install the Logging operator using Helm, see [Deploy the Logging operator wit
 1. Install log-generator to produce logs with the label `app.kubernetes.io/name: log-generator`
 
      ```bash
-     helm upgrade --install --wait --create-namespace --namespace logging log-generator kube-logging/log-generator
+     helm upgrade --install --wait --create-namespace --namespace logging log-generator oci://ghcr.io/kube-logging/helm-charts/log-generator
      ```