Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
da38df9
Adds 4.3 docs to the menu
fekete-robert Sep 15, 2023
b58fecd
Updates generated syslog-ng output docs
fekete-robert Sep 15, 2023
7f82761
Updates generated fluentd output docs
fekete-robert Sep 15, 2023
06bef6c
Updates the generated CRD docs
fekete-robert Sep 15, 2023
e0fce88
Update used images for 4.4
fekete-robert Sep 18, 2023
a1b2f8f
Adds mertricsprobe to syslog-ng parser plugin docs
fekete-robert Sep 18, 2023
b714efc
Adds draft whatsnew page
fekete-robert Sep 18, 2023
95d2310
Minimal docs for elasticsearch composable index template
fekete-robert Sep 18, 2023
3a9ff07
Update content/docs/whats-new/_index.md
fekete-robert Sep 19, 2023
ed4dbbc
Update content/docs/whats-new/_index.md
fekete-robert Sep 19, 2023
dc93105
Fluentd logs for troubleshooting
pepov Sep 21, 2023
9efd1d0
Note on EOL fluentd images
pepov Sep 21, 2023
fb0c202
Style fixes
fekete-robert Sep 21, 2023
f6e58cd
Include kinesis firehose output fixes
fekete-robert Sep 21, 2023
79bd1aa
Adds loki output to syslog-ng outputs
fekete-robert Sep 21, 2023
3434d1a
Minor whatsnew corrections
fekete-robert Sep 21, 2023
527937a
Link fix
fekete-robert Sep 21, 2023
6a6df79
Multitenancy basic draft
fekete-robert Sep 22, 2023
9420003
Update content/docs/image-versions.md
fekete-robert Sep 22, 2023
35c59a6
Update content/docs/image-versions.md
fekete-robert Sep 22, 2023
413499e
Update content/docs/image-versions.md
fekete-robert Sep 22, 2023
4bc5bb3
Indentation fixes in the redis output docs
fekete-robert Sep 22, 2023
bb7b201
Move multitenancy example to the end of the list
fekete-robert Sep 22, 2023
9b88263
nodegroup multitenancy example fixes
pepov Sep 29, 2023
c275f78
Update whatsnew with latest multitenant stuff (links to project for now)
pepov Sep 29, 2023
e70f10c
Adds generated LoggingRoute spec docs
fekete-robert Sep 30, 2023
ee0dee9
Adds generated S3 docs
fekete-robert Sep 30, 2023
745538f
Clarify menu name
fekete-robert Sep 30, 2023
b3576a2
buffer metrics update
pepov Oct 2, 2023
62ca8d5
[4.4][loki] Adds an example config to the syslog-ng loki output
fekete-robert Oct 2, 2023
59173e3
Merge branch 'master' into updates-for-4.4
fekete-robert Oct 2, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions .github/workflows/publish-version-4.3.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Publish version 4.3

env:
doc_versionnumber: "4.3"

on:
push:
branches:
- release-4.3
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@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
with:
ref: release-4.3
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@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
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@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
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'
8 changes: 6 additions & 2 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ twitter = "calisti12"
# Used in the "version-banner" partial to display a version number for the
# current doc set.

version = "4.3.0"
version = "4.4.0"
version_menu = "Releases"
version_menu_canonicallinks = true
version_menu_pagelinks = true
Expand Down Expand Up @@ -169,9 +169,13 @@ twitter = "calisti12"
#######################
# Add your release versions here
[[params.versions]]
version = "latest (4.3.0)"
version = "latest (4.4.0)"
githubbranch = "master"
url = ""
[[params.versions]]
version = "4.3"
githubbranch = "release-4.3"
url = "/4.3/"
[[params.versions]]
version = "4.2"
githubbranch = "release-4.2"
Expand Down
6 changes: 5 additions & 1 deletion content/docs/configuration/crds/v1beta1/fluentbit_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ Default: -

Default: -

### bufferVolumeResources (corev1.ResourceRequirements, optional) {#fluentbitspec-buffervolumeresources}

Default: -

### customConfigSecret (string, optional) {#fluentbitspec-customconfigsecret}

Default: -
Expand Down Expand Up @@ -607,7 +611,7 @@ Default: "0"

### Kube_URL (string, optional) {#filterkubernetes-kube_url}

API Server end-point (default: `https://kubernetes.default.svc:443`)
API Server end-point.

Default: `https://kubernetes.default.svc:443`

Expand Down
8 changes: 8 additions & 0 deletions content/docs/configuration/crds/v1beta1/fluentd_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ Default: -

Default: -

### bufferVolumeResources (corev1.ResourceRequirements, optional) {#fluentdspec-buffervolumeresources}

Default: -

### security (*Security, optional) {#fluentdspec-security}

Default: -
Expand Down Expand Up @@ -299,6 +303,10 @@ Container image to use for the drain watch sidecar

Default: -

### labels (map[string]string, optional) {#fluentddrainconfig-labels}

Labels to use for the drain watch sidecar on top of labels added by the operator by default. Default values can be overwritten.

### deleteVolume (bool, optional) {#fluentddrainconfig-deletevolume}

Should persistent volume claims be deleted after draining is done
Expand Down
29 changes: 28 additions & 1 deletion content/docs/configuration/crds/v1beta1/logging_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ Override generated config. This is a *raw* configuration string for troubleshoot

Default: -

### configCheck (ConfigCheck, optional) {#loggingspec-configcheck}

ConfigCheck settings that apply to both fluentd and syslog-ng

Default: -

### fluentbit (*FluentbitSpec, optional) {#loggingspec-fluentbit}

FluentbitAgent daemonset configuration. Deprecated, will be removed with next major version Migrate to the standalone NodeAgent resource
Expand Down Expand Up @@ -84,7 +90,7 @@ Default: -

Cluster domain name to be used when templating URLs to services .

Default: "cluster.local"
Default: "cluster.local."

### controlNamespace (string, required) {#loggingspec-controlnamespace}

Expand All @@ -111,6 +117,27 @@ EnableRecreateWorkloadOnImmutableFieldChange enables the operator to recreate th
Default: -


## ConfigCheck

### strategy (ConfigCheckStrategy, optional) {#configcheck-strategy}

Select the config check strategy to use. `DryRun`: parse and validate configuration `StartWithTimeout`: start with given configuration and exit after specified timeout.

Default: `DryRun`

### timeoutSeconds (int, optional) {#configcheck-timeoutseconds}

Configure timeout in seconds if strategy is StartWithTimeout

Default: -

### labels (map[string]string, optional) {#configcheck-labels}

Labels to use for the configcheck pods on top of labels added by the operator by default. Default values can be overwritten.

Default: -


## LoggingStatus

LoggingStatus defines the observed state of Logging
Expand Down
106 changes: 106 additions & 0 deletions content/docs/configuration/crds/v1beta1/loggingroute_types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
title: LoggingRouteSpec
weight: 200
generated_file: true
---

## LoggingRouteSpec

LoggingRouteSpec defines the desired state of LoggingRoute

### source (string, required) {#loggingroutespec-source}

Source identifies the logging that this policy applies to

Default: -

### targets (metav1.LabelSelector, required) {#loggingroutespec-targets}

Targets refers to the list of logging resources specified by a label selector to forward logs to. Filtering of namespaces will happen based on the watchNamespaces and watchNamespaceSelector fields of the target logging resource

Default: -


## LoggingRouteStatus

LoggingRouteStatus defines the actual state of the LoggingRoute

### tenants ([]Tenant, optional) {#loggingroutestatus-tenants}

Enumerate all loggings with all the destination namespaces expanded

Default: -

### problems ([]string, optional) {#loggingroutestatus-problems}

Enumerate problems that prohibits this route to take effect and populate the tenants field

Default: -

### problemsCount (int, optional) {#loggingroutestatus-problemscount}

Summarize the number of problems for the CLI output

Default: -

### notices ([]string, optional) {#loggingroutestatus-notices}

Enumerate non-blocker issues the user should pay attention to

Default: -

### noticesCount (int, optional) {#loggingroutestatus-noticescount}

Summarize the number of notices for the CLI output

Default: -


## Tenant

### name (string, required) {#tenant-name}

Default: -

### namespaces ([]string, optional) {#tenant-namespaces}

Default: -


## LoggingRoute

LoggingRoute (experimental)
Connects a log collector with log aggregators from other logging domains and routes relevant logs based on watch namespaces

### (metav1.TypeMeta, required) {#loggingroute-}

Default: -

### metadata (metav1.ObjectMeta, optional) {#loggingroute-metadata}

Default: -

### spec (LoggingRouteSpec, optional) {#loggingroute-spec}

Default: -

### status (LoggingRouteStatus, optional) {#loggingroute-status}

Default: -


## LoggingRouteList

### (metav1.TypeMeta, required) {#loggingroutelist-}

Default: -

### metadata (metav1.ListMeta, optional) {#loggingroutelist-metadata}

Default: -

### items ([]LoggingRoute, required) {#loggingroutelist-items}

Default: -


20 changes: 20 additions & 0 deletions content/docs/configuration/crds/v1beta1/syslogng_output_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ Default: -

Default: -

### redis (*output.RedisOutput, optional) {#syslogngoutputspec-redis}

Default: -

### mongodb (*output.MongoDB, optional) {#syslogngoutputspec-mongodb}

Default: -

### sumologic-http (*output.SumologicHTTPOutput, optional) {#syslogngoutputspec-sumologic-http}

Default: -
Expand All @@ -40,10 +48,22 @@ Default: -

Default: -

### elasticsearch (*output.ElasticsearchOutput, optional) {#syslogngoutputspec-elasticsearch}

Default: -

### logscale (*output.LogScaleOutput, optional) {#syslogngoutputspec-logscale}

Default: -

### splunk_hec_event (*output.SplunkHECOutput, optional) {#syslogngoutputspec-splunk_hec_event}

Default: -

### loki (*output.LokiOutput, optional) {#syslogngoutputspec-loki}

Default: -


## SyslogNGOutput

Expand Down
8 changes: 7 additions & 1 deletion content/docs/configuration/crds/v1beta1/syslogng_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,13 @@ Default: -

### stats (*Stats, optional) {#globaloptions-stats}

TODO switch to this by default
See the [AxoSyslog Core documentation](https://axoflow.com/docs/axosyslog-core/chapter-global-options/reference-options/#global-option-stats)

Default: -

### log_level (*string, optional) {#globaloptions-log_level}

See the [AxoSyslog Core documentation](https://axoflow.com/docs/axosyslog-core/chapter-global-options/reference-options/#global-options-log-level)

Default: -

Expand Down
3 changes: 2 additions & 1 deletion content/docs/configuration/plugins/outputs/datadog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ More info at [https://github.com/DataDog/fluent-plugin-datadog](https://github.c
```yaml
spec:
datadog:
api_key '<YOUR_API_KEY>'
api_key:
value: '<YOUR_API_KEY>' # for referencing a secret see https://kube-logging.dev/docs/configuration/plugins/outputs/secret/
dd_source: '<INTEGRATION_NAME>'
dd_tags: '<KEY1:VALUE1>,<KEY2:VALUE2>'
dd_sourcecategory: '<YOUR_SOURCE_CATEGORY>'
Expand Down
4 changes: 4 additions & 0 deletions content/docs/configuration/plugins/outputs/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -573,4 +573,8 @@ Specify whether overwriting data stream ilm policy or not.

Default: -

### use_legacy_template (*bool, optional) {#elasticsearch-use_legacy_template}

If set to true, the output uses the [legacy index template format](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates-v1.html). Otherwise, it uses the [composable index template](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/index-templates.html) format.

Default: true
Loading