Skip to content

Commit 1df8b0a

Browse files
fekete-robertfekete-robert
authored
Merge pull request #290 from kube-logging/5.4-preparations
5.4 preparations
2 parents a321cc6 + 33be281 commit 1df8b0a

File tree

13 files changed

+508
-3
lines changed

13 files changed

+508
-3
lines changed

‎.github/workflows/publish-version-5.4.yaml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Publish version 5.4
2+
3+
env:
4+
doc_versionnumber: "5.4"
5+
6+
on:
7+
push:
8+
branches:
9+
- release-5.4
10+
workflow_dispatch:
11+
12+
jobs:
13+
build:
14+
name: Build
15+
runs-on: ubuntu-latest
16+
17+
permissions:
18+
contents: write
19+
pages: write
20+
id-token: write
21+
22+
concurrency:
23+
group: "pages"
24+
cancel-in-progress: false
25+
26+
environment:
27+
name: github-pages-test
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
30+
steps:
31+
- name: Checkout code
32+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
33+
with:
34+
ref: release-5.4
35+
submodules: 'recursive'
36+
37+
- name: Set up Pages
38+
id: pages
39+
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
40+
41+
- name: Set up Hugo
42+
uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0
43+
with:
44+
hugo-version: '0.110.0'
45+
extended: true
46+
47+
- name: Set up Node
48+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
49+
with:
50+
node-version: 18
51+
52+
- name: Install dependencies
53+
run: |
54+
cd themes/docsy
55+
npm install
56+
57+
- name: Set up PostCSS
58+
run: npm install --save-dev autoprefixer postcss-cli postcss
59+
60+
- name: Build
61+
run: hugo --environment production --baseURL ${{ steps.pages.outputs.base_url }}/${{ env.doc_versionnumber }}/
62+
63+
# - name: Upload artifact
64+
# uses: actions/upload-pages-artifact@64bcae551a7b18bcb9a09042ddf1960979799187 # v1.0.8
65+
# with:
66+
# path: ./public/
67+
68+
- name: Checkout code to update
69+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
70+
with:
71+
ref: 'gh-pages-test'
72+
path: 'tmp/gh-pages'
73+
# - name: Display file structure
74+
# run: ls -R
75+
- name: Copy built site to GH pages
76+
run: |
77+
rm -rf tmp/gh-pages/${{ env.doc_versionnumber }}
78+
mkdir -p tmp/gh-pages/${{ env.doc_versionnumber }}
79+
mv public/* tmp/gh-pages/${{ env.doc_versionnumber }}
80+
- name: Commit & Push changes
81+
uses: actions-js/push@master
82+
with:
83+
github_token: ${{ secrets.GITHUB_TOKEN }}
84+
message: 'Publish updated docs for ${{ env.doc_versionnumber }}, ${{ github.event.repository.pushed_at}}'
85+
branch: 'gh-pages-test'
86+
directory: 'tmp/gh-pages'

‎config/_default/config.toml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ weight = 1
6565
# Used in the "version-banner" partial to display a version number for the
6666
# current doc set.
6767

68-
version = "5.3"
68+
version = "5.4"
6969
version_menu = "Releases"
7070
version_menu_canonicallinks = true
7171
version_menu_pagelinks = true
@@ -169,9 +169,13 @@ twitter = "AxoflowIO"
169169
#######################
170170
# Add your release versions here
171171
[[params.versions]]
172-
version = "latest (5.3)"
172+
version = "latest (5.4)"
173173
githubbranch = "master"
174174
url = ""
175+
[[params.versions]]
176+
version = "5.3"
177+
githubbranch = "release-5.3"
178+
url = "/5.3/"
175179
[[params.versions]]
176180
version = "5.2"
177181
githubbranch = "release-5.2"

‎content/docs/configuration/crds/v1beta1/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ For more information please click on the name
88

99
| Name | Description | Version |
1010
|---|---|---|
11+
| **[AxoSyslog](axosyslog_types/)** | AxoSyslog is the schema for the AxoSyslogs API. | v1beta1 |
1112
| **[EventTailer](../extensions/eventtailer_types/)** | Eventtailer's main goal is to listen kubernetes events and transmit their changes to stdout. This way the logging-operator is able to process them. | extensions |
1213
| **[HostTailer](../extensions/hosttailer_types/)** | HostTailer's main goal is to tail custom files and transmit their changes to stdout. This way the logging-operator is able to process them. | extensions |
1314
| **[ClusterFlow](clusterflow_types/)** | ClusterFlow is the Schema for the clusterflows API | v1beta1 |

‎content/docs/configuration/crds/v1beta1/axosyslog_types.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
title: AxoSyslog
3+
weight: 200
4+
generated_file: true
5+
---
6+
7+
AxoSyslog is the schema for the AxoSyslogs API.
8+
9+
Available in Logging operator version 5.4 and later.
10+
11+
### (metav1.TypeMeta, required) {#axosyslog-}
12+
13+
14+
### metadata (metav1.ObjectMeta, optional) {#axosyslog-metadata}
15+
16+
17+
### spec (AxoSyslogSpec, optional) {#axosyslog-spec}
18+
19+
20+
### status (AxoSyslogStatus, optional) {#axosyslog-status}
21+
22+
23+
24+
## AxoSyslogSpec
25+
26+
AxoSyslogSpec defines the desired state of AxoSyslog.
27+
28+
### destinations ([]Destination, optional) {#axosyslogspec-destinations}
29+
30+
Destinations is a list of destinations to be rendered in the AxoSyslog configuration.
31+
32+
33+
### logPaths ([]LogPath, optional) {#axosyslogspec-logpaths}
34+
35+
LogPaths is a list of log paths to be rendered in the AxoSyslog configuration.
36+
37+
38+
39+
## LogPath
40+
41+
LogPath defines a single log path that will be rendered in the AxoSyslog configuration.
42+
43+
### destination (string, optional) {#logpath-destination}
44+
45+
Name of a destination to be used in the log path.
46+
47+
48+
### filterx (string, optional) {#logpath-filterx}
49+
50+
FilterX block to be rendered within the log path.
51+
52+
53+
54+
## Destination
55+
56+
Destination defines a single destination that will be rendered in the AxoSyslog configuration.
57+
58+
### config (string, optional) {#destination-config}
59+
60+
Config is the configuration for the destination.
61+
62+
63+
### name (string, optional) {#destination-name}
64+
65+
Name of the destination.
66+
67+
68+
69+
## AxoSyslogStatus
70+
71+
AxoSyslogStatus defines the observed state of AxoSyslog.
72+
73+
### problems ([]string, optional) {#axosyslogstatus-problems}
74+
75+
Problems with the AxoSyslog resource.
76+
77+
78+
### problemsCount (int, optional) {#axosyslogstatus-problemscount}
79+
80+
Number of problems with the AxoSyslog resource.
81+
82+
83+
### sources ([]Source, optional) {#axosyslogstatus-sources}
84+
85+
Sources configured for AxoSyslog.
86+
87+
88+
89+
## Source
90+
91+
Source represents the log sources for AxoSyslog.
92+
93+
### otlp (*OTLPSource, optional) {#source-otlp}
94+
95+
OTLP specific configuration.
96+
97+
98+
99+
## OTLPSource
100+
101+
OTLPSource contains configuration for OpenTelemetry Protocol sources.
102+
103+
### endpoint (string, optional) {#otlpsource-endpoint}
104+
105+
Endpoint for the OTLP source.
106+
107+
108+
109+
## AxoSyslogList
110+
111+
AxoSyslogList contains a list of AxoSyslog
112+
113+
### (metav1.TypeMeta, required) {#axosysloglist-}
114+
115+
116+
### metadata (metav1.ListMeta, optional) {#axosysloglist-metadata}
117+
118+
119+
### items ([]AxoSyslog, required) {#axosysloglist-items}
120+
121+
122+

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,16 @@ Disable Kubernetes metadata filter
127127
128128
### disableVarLibDockerContainers (*bool, optional) {#fluentbitspec-disablevarlibdockercontainers}
129129
130+
Available in Logging operator version 5.4 and later.
131+
130132
DisableVarLibDockerContainers controls whether the /var/lib/docker/containers volume is mounted. If true, the volume is NOT mounted. If false (default), the volume is mounted.
131133
132134
135+
### disableVarLog (*bool, optional) {#fluentbitspec-disablevarlog}
136+
137+
DisableVarLog controls whether the /var/log volume is mounted. If true, the volume is NOT mounted. If false (default), the volume is mounted.
138+
139+
133140
### enableUpstream (bool, optional) {#fluentbitspec-enableupstream}
134141
135142
@@ -675,6 +682,30 @@ Allow Kubernetes Pods to suggest a pre-defined Parser (read more about it in Kub
675682

676683
Default: Off
677684

685+
Important: When enabling this setting, you must also configure
686+
`inputTail.multiline.parser` with appropriate parsers (typically including `cri` for
687+
Container Runtime Interface logs). Without this configuration, the annotation-based
688+
parsing will not work correctly.
689+
690+
#### Example Configuration
691+
692+
```yaml
693+
apiVersion: logging.banzaicloud.io/v1beta1
694+
kind: FluentbitAgent
695+
metadata:
696+
name: example-fluentbit
697+
spec:
698+
inputTail:
699+
multiline.parser: [cri] # Required when K8S-Logging.Parser is enabled
700+
filterKubernetes:
701+
K8S-Logging.Parser: "On"
702+
Merge_Log_Key: "parsed" # Optional but recommended to prevent key conflicts
703+
704+
# Once configured, you can use annotations on your pods:
705+
annotations:
706+
fluentbit.io/parser: "my-custom-parser"
707+
```
708+
678709
### Keep_Log (string, optional) {#filterkubernetes-keep_log}
679710

680711
When Keep_Log is disabled, the log field is removed from the incoming message once it has been successfully merged (Merge_Log must be enabled as well).

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ OutputSpec defines the desired state of Output
4747
### kinesisStream (*output.KinesisStreamOutputConfig, optional) {#outputspec-kinesisstream}
4848

4949

50+
### lmLogs (*output.LMLogsOutputConfig, optional) {#outputspec-lmlogs}
51+
52+
5053
### logdna (*output.LogDNAOutput, optional) {#outputspec-logdna}
5154

5255

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,12 @@ Specify an existing index template for the data stream. If not present, a new te
109109
110110
Default: data_stream_name
111111
112+
### data_stream_template_use_index_patterns_wildcard (*bool, optional) {#elasticsearch-data_stream_template_use_index_patterns_wildcard}
113+
114+
https://github.com/uken/fluent-plugin-elasticsearch?tab=readme-ov-file#data_stream_template_use_index_patterns_wildcard
115+
116+
Default: true
117+
112118
### default_elasticsearch_version (string, optional) {#elasticsearch-default_elasticsearch_version}
113119
114120
This parameter changes that ES plugin assumes default Elasticsearch version.

‎content/docs/configuration/plugins/outputs/forward.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ Default: 190
1717
[Buffer](../buffer/)
1818

1919

20+
### compress (string, optional) {#forwardoutput-compress}
21+
22+
Fluentd supports transparent data compression, the only value accepted is "gzip"
23+
24+
2025
### connect_timeout (int, optional) {#forwardoutput-connect_timeout}
2126

2227
The timeout time for socket connect. When the connection timed out during establishment, Errno::ETIMEDOUT is raised.

0 commit comments

Comments
 (0)