Skip to content

Commit b4c8810

Browse files
Merge pull request #268 from kube-logging/5.0-preparations
5.0 preparations
2 parents 0f1c9fa + 3f51ef6 commit b4c8810

File tree

18 files changed

+694
-533
lines changed

18 files changed

+694
-533
lines changed
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Publish version 5.0
2+
3+
env:
4+
doc_versionnumber: "5.0"
5+
6+
on:
7+
push:
8+
branches:
9+
- release-5.0
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.0
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 = "4.11.0"
68+
version = "5.0"
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 (4.11.0)"
172+
version = "latest (5.0)"
173173
githubbranch = "master"
174174
url = ""
175+
[[params.versions]]
176+
version = "4.11.0"
177+
githubbranch = "release-4.11"
178+
url = ""
175179
[[params.versions]]
176180
version = "4.10"
177181
githubbranch = "release-4.10"
@@ -216,7 +220,7 @@ twitter = "AxoflowIO"
216220
# Cascade version number to every doc page (needed to create sections for pagefind search)
217221
# Update this parameter when creating a new version
218222
[[cascade]]
219-
body_attribute = 'data-pagefind-filter="section:4.11"'
223+
body_attribute = 'data-pagefind-filter="section:5.0"'
220224
[cascade._target]
221225
path = '/docs/**'
222226

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For more information please click on the name
2323
| **[OutputSpec](output_types/)** | OutputSpec defines the desired state of Output | v1beta1 |
2424
| **[SyslogNGClusterFlow](syslogng_clusterflow_types/)** | SyslogNGClusterFlow is the Schema for the syslog-ng clusterflows API | v1beta1 |
2525
| **[SyslogNGClusterOutput](syslogng_clusteroutput_types/)** | SyslogNGClusterOutput is the Schema for the syslog-ng clusteroutputs API | v1beta1 |
26-
| **[SyslogNG](syslogng_types/)** | SyslogNG is a reference to the desired SyslogNG state | v1beta1 |
26+
| **[SyslogNG](syslogng_types/)** | SyslogNG is a standalone reference to the desired SyslogNG configuration | v1beta1 |
2727
| **[SyslogNGFlowSpec](syslogng_flow_types/)** | SyslogNGFlowSpec is the Kubernetes spec for SyslogNGFlows | v1beta1 |
2828
| **[SyslogNGOutputSpec](syslogng_output_types/)** | SyslogNGOutputSpec defines the desired state of SyslogNGOutput | v1beta1 |
2929
| **[SyslogNGSpec](syslogng_types/)** | SyslogNGSpec defines the desired state of SyslogNG | v1beta1 |

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,9 @@ ServiceMonitorConfig defines the ServiceMonitor properties
140140

141141
Security defines Fluentd, FluentbitAgent deployment security properties
142142

143+
### createOpenShiftSCC (*bool, optional) {#security-createopenshiftscc}
144+
145+
143146
### podSecurityContext (*corev1.PodSecurityContext, optional) {#security-podsecuritycontext}
144147

145148

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,6 @@ Filter definition for FlowSpec
9292
### elasticsearch_genid (*filter.ElasticsearchGenId, optional) {#filter-elasticsearch_genid}
9393

9494

95-
### enhanceK8s (*filter.EnhanceK8s, optional) {#filter-enhancek8s}
96-
97-
9895
### geoip (*filter.GeoIP, optional) {#filter-geoip}
9996

10097

@@ -119,9 +116,6 @@ Filter definition for FlowSpec
119116
### stdout (*filter.StdOutFilterConfig, optional) {#filter-stdout}
120117

121118

122-
### sumologic (*filter.SumoLogic, optional) {#filter-sumologic}
123-
124-
125119
### tag_normaliser (*filter.TagNormaliser, optional) {#filter-tag_normaliser}
126120

127121

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ Disable Kubernetes metadata filter
128128
### enableUpstream (bool, optional) {#fluentbitspec-enableupstream}
129129
130130
131+
### enabledIPv6 (bool, optional) {#fluentbitspec-enabledipv6}
132+
133+
131134
### envVars ([]corev1.EnvVar, optional) {#fluentbitspec-envvars}
132135
133136
@@ -151,6 +154,11 @@ Set the flush time in seconds.nanoseconds. The engine loop uses a Flush timeout
151154
152155
Default: 1
153156
157+
### forceHotReloadAfterGrace (bool, optional) {#fluentbitspec-forcehotreloadaftergrace}
158+
159+
HotReload pauses all inputs and waits until they finish. In certain situations this is unacceptable, for example, if an output is down for a longer time. An undocumented option called "Hot_Reload.Ensure_Thread_Safety Off" can be used at the [SERVICE] config to force hotreload after the grace period. Note that it might result in a SIGSEGV, but worst case kubelet will restart the container. See https://github.com/fluent/fluent-bit/pull/7509
160+
161+
154162
### forwardOptions (*ForwardOptions, optional) {#fluentbitspec-forwardoptions}
155163
156164
@@ -583,6 +591,12 @@ When a monitored file reach it buffer capacity due to a very long line (Buffer_M
583591

584592
Default: Off
585593

594+
### storage.pause_on_chunks_overlimit (string, optional) {#inputtail-storage.pause_on_chunks_overlimit}
595+
596+
Specifies whether to pause or drop data when the buffer is full. This helps to make sure we apply backpressure on the input if enabled, see https://docs.fluentbit.io/manual/administration/backpressure
597+
598+
Default: on
599+
586600
### storage.type (string, optional) {#inputtail-storage.type}
587601

588602
Specify the buffering mechanism to use. It can be memory or filesystem.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ BufferStorageVolume is by default configured as PVC using FluentdPvcSpec [volume
2525
### bufferVolumeImage (ImageSpec, optional) {#fluentdspec-buffervolumeimage}
2626

2727

28+
### bufferVolumeLivenessProbe (*corev1.Probe, optional) {#fluentdspec-buffervolumelivenessprobe}
29+
30+
2831
### bufferVolumeMetrics (*Metrics, optional) {#fluentdspec-buffervolumemetrics}
2932

3033

@@ -65,6 +68,9 @@ Overrides the default logging level configCheck setup. This field is not used di
6568
Allows Time object in buffer's MessagePack serde [more info]( https://docs.fluentd.org/deployment/system-config#enable_msgpack_time_support)
6669

6770

71+
### enabledIPv6 (bool, optional) {#fluentdspec-enabledipv6}
72+
73+
6874
### envVars ([]corev1.EnvVar, optional) {#fluentdspec-envvars}
6975

7076

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,11 @@ Reference to the logging system. Each of the `loggingRef`s can manage a fluentbi
8686
InlineNodeAgent Configuration Deprecated, will be removed with next major version
8787

8888

89+
### routeConfig (*RouteConfig, optional) {#loggingspec-routeconfig}
90+
91+
RouteConfig determines whether to use loggingRoutes or to create resources based on the logging resource that can be managed by the Telemetry Controller.
92+
93+
8994
### skipInvalidResources (bool, optional) {#loggingspec-skipinvalidresources}
9095

9196
Whether to skip invalid Flow and ClusterFlow resources
@@ -125,6 +130,24 @@ Configure timeout in seconds if strategy is StartWithTimeout
125130

126131

127132

133+
## RouteConfig
134+
135+
### disableLoggingRoute (bool, optional) {#routeconfig-disableloggingroute}
136+
137+
If DisableLoggingRoute is set to true, the logging route controller should remove the given tenant from the status of the logging resource.
138+
139+
140+
### enableTelemetryControllerRoute (bool, optional) {#routeconfig-enabletelemetrycontrollerroute}
141+
142+
If EnableTelemtryControllerRoute set to true, the operator will create the corresponding Tenant, Subscription, and Output based on the logging resource.
143+
144+
145+
### tenantLabels (map[string]string, optional) {#routeconfig-tenantlabels}
146+
147+
TenantLabels is a map of labels that will be added to the tenant object so it can be matched with TelemetryController's TenantSelector ref: https://github.com/kube-logging/telemetry-controller/blob/main/api/telemetry/v1alpha1/collector_types.go
148+
149+
150+
128151
## LoggingStatus
129152

130153
LoggingStatus defines the observed state of Logging

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,6 @@ OutputSpec defines the desired state of Output
8989
### splunkHec (*output.SplunkHecOutput, optional) {#outputspec-splunkhec}
9090

9191

92-
### sumologic (*output.SumologicOutput, optional) {#outputspec-sumologic}
93-
94-
9592
### syslog (*output.SyslogOutputConfig, optional) {#outputspec-syslog}
9693

9794

content/docs/configuration/plugins/filters/detect_exceptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ filters:
2626
2727
### force_line_breaks (bool, optional) {#detectexceptions-force_line_breaks}
2828
29-
Force line breaks between each lines when combining exception stacks.
29+
Force line breaks between each line when combining exception stacks.
3030
3131
Default: false
3232

0 commit comments

Comments
 (0)