Skip to content

Commit 0f1c9fa

Browse files
fekete-robertfekete-robert
authored
Merge pull request #265 from kube-logging/4.11-preparations
4.11 docs
2 parents 332855e + 15b7173 commit 0f1c9fa

File tree

13 files changed

+218
-9
lines changed

13 files changed

+218
-9
lines changed

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

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

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,16 @@ For more information please click on the name
1616
| **[FlowSpec](flow_types/)** | FlowSpec is the Kubernetes spec for Flows | v1beta1 |
1717
| **[FluentbitSpec](fluentbit_types/)** | FluentbitSpec defines the desired state of FluentbitAgent | v1beta1 |
1818
| **[Fluent](fluentd_types/)** | FluentdConfig is a reference to the desired Fluentd state | v1beta1 |
19+
| **[FluentdSpec](fluentd_types/)** | FluentdSpec defines the desired state of Fluentd | v1beta1 |
1920
| **[Logging](logging_types/)** | Logging system configuration | v1beta1 |
2021
| **[LoggingRouteSpec](loggingroute_types/)** | LoggingRouteSpec defines the desired state of LoggingRoute | v1beta1 |
2122
| **[NodeAgent](node_agent_types/)** | | v1beta1 |
2223
| **[OutputSpec](output_types/)** | OutputSpec defines the desired state of Output | v1beta1 |
2324
| **[SyslogNGClusterFlow](syslogng_clusterflow_types/)** | SyslogNGClusterFlow is the Schema for the syslog-ng clusterflows API | v1beta1 |
2425
| **[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 |
2527
| **[SyslogNGFlowSpec](syslogng_flow_types/)** | SyslogNGFlowSpec is the Kubernetes spec for SyslogNGFlows | v1beta1 |
2628
| **[SyslogNGOutputSpec](syslogng_output_types/)** | SyslogNGOutputSpec defines the desired state of SyslogNGOutput | v1beta1 |
27-
| **[SyslogNG](syslogng_types/)** | SyslogNG is a reference to the desired SyslogNG state | v1beta1 |
29+
| **[SyslogNGSpec](syslogng_types/)** | SyslogNGSpec defines the desired state of SyslogNG | v1beta1 |
2830
</center>
2931

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ FluentbitSpec defines the desired state of FluentbitAgent
5959
### bufferVolumeImage (ImageSpec, optional) {#fluentbitspec-buffervolumeimage}
6060

6161

62+
### bufferVolumeLivenessProbe (*corev1.Probe, optional) {#fluentbitspec-buffervolumelivenessprobe}
63+
64+
6265
### bufferVolumeMetrics (*Metrics, optional) {#fluentbitspec-buffervolumemetrics}
6366

6467

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ OutputSpec defines the desired state of Output
3232
### gcs (*output.GCSOutput, optional) {#outputspec-gcs}
3333

3434

35-
### gelf (*output.GELFOutputConfig, optional) {#outputspec-gelf}
35+
### gelf (*output.GelfOutputConfig, optional) {#outputspec-gelf}
3636

3737

3838
### http (*output.HTTPOutputConfig, optional) {#outputspec-http}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ SyslogNGClusterOutputSpec contains Kubernetes spec for SyslogNGClusterOutput
3131
### enabledNamespaces ([]string, optional) {#syslogngclusteroutputspec-enablednamespaces}
3232

3333

34+
### protected (bool, optional) {#syslogngclusteroutputspec-protected}
35+
36+
3437

3538
## SyslogNGClusterOutputList
3639

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ SyslogNGSpec defines the desired state of SyslogNG
1414
### bufferVolumeMetricsImage (*BasicImageSpec, optional) {#syslogngspec-buffervolumemetricsimage}
1515

1616

17+
### bufferVolumeMetricsLivenessProbe (*corev1.Probe, optional) {#syslogngspec-buffervolumemetricslivenessprobe}
18+
19+
20+
### bufferVolumeMetricsResources (corev1.ResourceRequirements, optional) {#syslogngspec-buffervolumemetricsresources}
21+
22+
1723
### bufferVolumeMetricsService (*typeoverride.Service, optional) {#syslogngspec-buffervolumemetricsservice}
1824

1925

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,11 @@ Indicates that the OpenSearch-transport will try to reload the nodes addresses i
302302

303303
Default: false
304304

305+
### remove_keys (string, optional) {#opensearch-remove_keys}
306+
307+
https://github.com/fluent/fluent-plugin-opensearch#remove_keys
308+
309+
305310
### remove_keys_on_update (string, optional) {#opensearch-remove_keys_on_update}
306311

307312
Remove keys on update will not update the configured keys in OpenSearch when a record is being updated. This setting only has any effect if the write operation is update or upsert.

‎content/docs/configuration/plugins/syslog-ng-outputs/opentelemetry.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ metadata:
2121
name: otlp
2222
spec:
2323
opentelemetry:
24-
url: otel-server
25-
port: 4379
24+
url: otel-server:4379
2625
{{</ highlight >}}
2726

2827

‎content/docs/configuration/plugins/syslog-ng-outputs/s3.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Default: 32
102102
The object_key for the S3 server.
103103

104104

105-
### object_key_timestamp (RawString, optional) {#s3output-object_key_timestamp}
105+
### object_key_timestamp (string, optional) {#s3output-object_key_timestamp}
106106

107107
Set object_key_timestamp
108108

@@ -132,7 +132,7 @@ The secret_key for the S3 server.
132132
Set the storage_class option.
133133

134134

135-
### template (RawString, optional) {#s3output-template}
135+
### template (string, optional) {#s3output-template}
136136

137137
Template
138138

0 commit comments

Comments
 (0)