Skip to content

Commit 746fd90

Browse files
fekete-robertfekete-robert
authored
Merge pull request #278 from kube-logging/5.1-preparations
5.1 preparations
2 parents d5fb6a4 + 1845999 commit 746fd90

File tree

9 files changed

+193
-11
lines changed

9 files changed

+193
-11
lines changed

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

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Publish version 5.1
2+
3+
env:
4+
doc_versionnumber: "5.1"
5+
6+
on:
7+
push:
8+
branches:
9+
- release-5.1
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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
33+
with:
34+
ref: release-5.1
35+
submodules: 'recursive'
36+
37+
- name: Set up Pages
38+
id: pages
39+
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4.0.0
40+
41+
- name: Set up Hugo
42+
uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d # v2.6.0
43+
with:
44+
hugo-version: '0.110.0'
45+
extended: true
46+
47+
- name: Set up Node
48+
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
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: 7 additions & 3 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.0"
68+
version = "5.1"
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.0)"
172+
version = "latest (5.1)"
173173
githubbranch = "master"
174174
url = ""
175+
[[params.versions]]
176+
version = "5.0"
177+
githubbranch = "release-5.0"
178+
url = "/5.0/"
175179
[[params.versions]]
176180
version = "4.11.0"
177181
githubbranch = "release-4.11"
@@ -220,7 +224,7 @@ twitter = "AxoflowIO"
220224
# Cascade version number to every doc page (needed to create sections for pagefind search)
221225
# Update this parameter when creating a new version
222226
[[cascade]]
223-
body_attribute = 'data-pagefind-filter="section:5.0"'
227+
body_attribute = 'data-pagefind-filter="section:5.1"'
224228
[cascade._target]
225229
path = '/docs/**'
226230

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ ClusterOutputSpec contains Kubernetes spec for ClusterOutput
2828
### (OutputSpec, required) {#clusteroutputspec-}
2929

3030

31-
### enabledNamespaces ([]string, optional) {#clusteroutputspec-enablednamespaces}
32-
33-
3431
### protected (bool, optional) {#clusteroutputspec-protected}
3532

3633

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ Overrides the default logging level configCheck setup. This field is not used di
5454
### configReloaderResources (corev1.ResourceRequirements, optional) {#fluentdspec-configreloaderresources}
5555

5656

57+
### configReloaderUseGracefulReloadWebhook (bool, optional) {#fluentdspec-configreloaderusegracefulreloadwebhook}
58+
59+
5760
### dnsConfig (*corev1.PodDNSConfig, optional) {#fluentdspec-dnsconfig}
5861

5962

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ LoggingSpec defines the desired state of Logging
1212

1313
Allow configuration of cluster resources from any namespace. Mutually exclusive with ControlNamespace restriction of Cluster resources
1414

15+
WARNING: Be careful when turning this on and off as it can result in some resources being orphaned.
16+
1517

1618
### clusterDomain (*string, optional) {#loggingspec-clusterdomain}
1719

@@ -54,7 +56,7 @@ GlobalOutput name to flush ERROR events to
5456

5557
### flowConfigCheckDisabled (bool, optional) {#loggingspec-flowconfigcheckdisabled}
5658

57-
Disable configuration check before applying new fluentd configuration.
59+
Disable configuration check before applying new fluentd or syslog-ng configuration.
5860

5961

6062
### flowConfigOverride (string, optional) {#loggingspec-flowconfigoverride}
@@ -139,7 +141,7 @@ If DisableLoggingRoute is set to true, the logging route controller should remov
139141

140142
### enableTelemetryControllerRoute (bool, optional) {#routeconfig-enabletelemetrycontrollerroute}
141143

142-
If EnableTelemtryControllerRoute set to true, the operator will create the corresponding Tenant, Subscription, and Output based on the logging resource.
144+
If EnableTelemetryControllerRoute set to true, the operator will create the corresponding Tenant, Subscription, and Output based on the logging resource.
143145

144146

145147
### tenantLabels (map[string]string, optional) {#routeconfig-tenantlabels}

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ SyslogNGClusterOutputSpec contains Kubernetes spec for SyslogNGClusterOutput
2828
### (SyslogNGOutputSpec, required) {#syslogngclusteroutputspec-}
2929

3030

31-
### enabledNamespaces ([]string, optional) {#syslogngclusteroutputspec-enablednamespaces}
32-
33-
3431
### protected (bool, optional) {#syslogngclusteroutputspec-protected}
3532

3633

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ spec:
3434
[Buffer](../buffer/)
3535
3636
37+
### compress (string, optional) {#output-config-compress}
38+
39+
The option to compress HTTP request body. [text,gzip]
40+
41+
Default: text
42+
3743
### content_type (string, optional) {#output-config-content_type}
3844
3945
Content-Profile for HTTP request.
@@ -66,6 +72,11 @@ Default: post
6672
Additional headers for HTTP request.
6773
6874
75+
### headers_from_placeholders (map[string]string, optional) {#output config-headers_from_placeholders}
76+
77+
Additional headers from placeholders for HTTP request.
78+
79+
6980
### json_array (bool, optional) {#output-config-json_array}
7081
7182
Using array format of JSON. This parameter is used and valid only for json format. When json_array as true, Content-Profile should be application/json and be able to use JSON data for the HTTP request body.
@@ -93,6 +104,12 @@ List of retryable response codes. If the response code is included in this list,
93104
94105
Default: [503]
95106
107+
### reuse_connections (bool, optional) {#output-config-reuse_connections}
108+
109+
Try to reuse connection. This will improve performance.
110+
111+
Default: false
112+
96113
### ssl_timeout (int, optional) {#output-config-ssl_timeout}
97114
98115
TLS timeout in seconds.

‎content/docs/image-versions.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,22 @@ weight: 750
55

66
Logging operator uses the following image versions.
77

8+
## Logging operator version 5.1
9+
10+
| Image repository | GitHub repository | Version |
11+
| -------- | --- | -- |
12+
| ghcr.io/kube-logging/node-exporter | https://github.com/kube-logging/node-exporter-image | v0.9.0 |
13+
| ghcr.io/kube-logging/config-reloader | https://github.com/kube-logging/config-reloader | v0.0.7 |
14+
| ghcr.io/kube-logging/fluentd-drain-watch | https://github.com/kube-logging/fluentd-drain-watch | v0.2.4 |
15+
| k8s.gcr.io/pause | | 3.9 |
16+
| docker.io/busybox | https://github.com/docker-library/busybox | latest |
17+
| ghcr.io/axoflow/axosyslog | https://github.com/axoflow/axosyslog/ | 4.9.0 |
18+
| docker.io/fluent/fluent-bit | https://github.com/fluent/fluent-bit | 3.2.5 |
19+
| ghcr.io/kube-logging/logging-operator/fluentd | ghcr.io/kube-logging/logging-operator/fluentd | 5.1.1-full |
20+
| ghcr.io/axoflow/axosyslog-metrics-exporter | https://github.com/axoflow/axosyslog-metrics-exporter | 0.0.9 |
21+
| ghcr.io/kube-logging/syslogng-reload | https://github.com/kube-logging/syslogng-reload-image | v1.6.0 |
22+
| ghcr.io/kube-logging/eventrouter | https://github.com/kube-logging/eventrouter | 0.4.0 |
23+
824
## Logging operator version 5.0
925

1026
| Image repository | GitHub repository | Version |

‎content/docs/whats-new/_index.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,66 @@ title: What's new
33
weight: 50
44
---
55

6+
## Version 5.1
7+
8+
The following are the highlights and main changes of Logging operator 5.1. For a complete list of changes and bugfixes, see the [Logging operator 5.1 releases page](https://github.com/kube-logging/logging-operator/releases/tag/5.1.1).
9+
10+
### Fluentd http output improvements
11+
12+
- Set the `compress` option to `gzip` to compress the HTTP request body.
13+
- You can use the `headers_from_placeholders` option to add headers to the HTTP requests.
14+
- Set the `reuse_connection` option to `true` to try to reuse HTTP connections to improve performance.
15+
16+
### Multiple hosttailer support
17+
18+
You can now define multiple hosttailers in your logging configuration, for example:
19+
20+
```yaml
21+
logging:
22+
enabled: true
23+
hostTailers:
24+
enabled: true
25+
instances:
26+
- name: kubeauditane
27+
enabled: true
28+
workloadOverrides:
29+
nodeSelector:
30+
node-role.kubernetes.io/control-plane: "true"
31+
tolerations:
32+
- key: node-role.kubernetes.io/control-plane
33+
operator: Exists
34+
effect: NoSchedule
35+
fileTailers:
36+
- name: kube-audit
37+
path: /var/lib/rancher/rke2/server/logs/*.log
38+
39+
- name: workersnodesonly
40+
enabled: true
41+
workloadOverrides:
42+
nodeSelector:
43+
node-role.kubernetes.io/worker: "true"
44+
fileTailers:
45+
- name: kube-audit
46+
path: /var/lib/rancher/rke2/agent/logs/*.log
47+
```
48+
49+
This also means that `logging.hostTailer` has been deprecated and is superseded by `logging.hostTailers` and will be removed in a future release.
50+
51+
## Graceful reload in Fluentd
52+
53+
You can now enable graceful reloading via a webhook using the [`configReloaderUseGracefulReloadWebhook` option]({{< relref "/docs/configuration/crds/v1beta1/fluentd_types.md#fluentdspec-configreloaderusegracefulreloadwebhook" >}}).
54+
55+
### Memory usage
56+
57+
In order to reduce the memory usage of the operator in large environments, you can now use the following flags during installation:
58+
59+
- `watch-labeled-children` to watch only child resources created by the operator. This option will be enabled by default in a future new minor version.
60+
- `watch-labeled-secrets` to watch secrets with `logging.banzaicloud.io/watch: enabled` label. This option will be enabled by default in a future new major version.
61+
62+
### Changes in Fluentd images
63+
64+
Earlier, Logging operator used Fluentd images published at https://github.com/kube-logging/fluentd-images, and its version numbers followed the official Fluentd version numbers. From now on, we build Fluentd images from our repository (https://github.com/kube-logging/logging-operator/tree/master/images/fluentd) and its version numbering follows the version numbers of Logging operator, for example: ghcr.io/kube-logging/logging-operator/fluentd:5.1.1-base/filters/full
65+
666
## Version 5.0
767

868
The following are the highlights and main changes of Logging operator 5.0. For a complete list of changes and bugfixes, see the [Logging operator 5.0 releases page](https://github.com/kube-logging/logging-operator/releases/tag/5.0).

0 commit comments

Comments
 (0)