diff --git a/.github/workflows/publish-version-4.4.yaml b/.github/workflows/publish-version-4.4.yaml new file mode 100644 index 000000000..3cd290497 --- /dev/null +++ b/.github/workflows/publish-version-4.4.yaml @@ -0,0 +1,86 @@ +name: Publish version 4.4 + +env: + doc_versionnumber: "4.4" + +on: + push: + branches: + - release-4.4 + 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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + with: + ref: release-4.4 + submodules: 'recursive' + + - name: Set up Pages + id: pages + uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4.0.0 + + - 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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + 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' diff --git a/.htmltest.yml b/.htmltest.yml new file mode 100644 index 000000000..05704fb05 --- /dev/null +++ b/.htmltest.yml @@ -0,0 +1,8 @@ +DirectoryPath: public/docs/install +CheckDoctype: false # Sadly, this is false only because of `static/google*.html` +IgnoreAltMissing: true # FIXME +IgnoreDirectoryMissingTrailingSlash: true # FIXME +IgnoreDirs: [_print] # FIXME +IgnoreEmptyHref: true # FIXME +IgnoreInternalEmptyHash: true # FIXME +IgnoreURLs: [http://localhost, https://https://github.com/kube-logging/kube-logging.github.io/new/*, _print/] diff --git a/config/_default/config.toml b/config/_default/config.toml index 5d4423ac8..305a05ad2 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -69,7 +69,7 @@ twitter = "calisti12" # Used in the "version-banner" partial to display a version number for the # current doc set. - version = "4.4.0" + version = "4.5.0" version_menu = "Releases" version_menu_canonicallinks = true version_menu_pagelinks = true @@ -169,9 +169,13 @@ twitter = "calisti12" ####################### # Add your release versions here [[params.versions]] - version = "latest (4.4.0)" + version = "latest (4.5.0)" githubbranch = "master" url = "" +[[params.versions]] + version = "4.4" + githubbranch = "release-4.4" + url = "/4.4/" [[params.versions]] version = "4.3" githubbranch = "release-4.3" @@ -188,7 +192,7 @@ twitter = "calisti12" # Cascade version number to every doc page (needed to create sections for pagefind search) # Update this parameter when creating a new version [[cascade]] -body_attribute = 'data-pagefind-filter="section:4.4"' +body_attribute = 'data-pagefind-filter="section:4.5"' [cascade._target] path = '/docs/**' diff --git a/content/docs/configuration/crds/extensions/eventtailer_types.md b/content/docs/configuration/crds/extensions/eventtailer_types.md index d3653a1ca..994b512ca 100644 --- a/content/docs/configuration/crds/extensions/eventtailer_types.md +++ b/content/docs/configuration/crds/extensions/eventtailer_types.md @@ -8,41 +8,35 @@ generated_file: true EventTailerSpec defines the desired state of EventTailer +### containerOverrides (*types.ContainerBase, optional) {#eventtailerspec-containeroverrides} + +Override container fields for the given statefulset + + ### controlNamespace (string, required) {#eventtailerspec-controlnamespace} The resources of EventTailer will be placed into this namespace -Default: - -### positionVolume (volume.KubernetesVolume, optional) {#eventtailerspec-positionvolume} +### image (*tailer.ImageSpec, optional) {#eventtailerspec-image} -Volume definition for tracking fluentbit file positions (optional) +Override image related fields for the given statefulset, highest precedence -Default: - -### workloadMetaOverrides (*types.MetaBase, optional) {#eventtailerspec-workloadmetaoverrides} +### positionVolume (volume.KubernetesVolume, optional) {#eventtailerspec-positionvolume} -Override metadata of the created resources +Volume definition for tracking fluentbit file positions (optional) -Default: - ### workloadOverrides (*types.PodSpecBase, optional) {#eventtailerspec-workloadoverrides} Override podSpec fields for the given statefulset -Default: - - -### containerOverrides (*types.ContainerBase, optional) {#eventtailerspec-containeroverrides} - -Override container fields for the given statefulset -Default: - - -### image (*tailer.ImageSpec, optional) {#eventtailerspec-image} +### workloadMetaOverrides (*types.MetaBase, optional) {#eventtailerspec-workloadmetaoverrides} -Override image related fields for the given statefulset, highest precedence +Override metadata of the created resources -Default: - ## EventTailerStatus @@ -56,19 +50,15 @@ EventTailer is the Schema for the eventtailers API ### (metav1.TypeMeta, required) {#eventtailer-} -Default: - ### metadata (metav1.ObjectMeta, optional) {#eventtailer-metadata} -Default: - ### spec (EventTailerSpec, optional) {#eventtailer-spec} -Default: - ### status (EventTailerStatus, optional) {#eventtailer-status} -Default: - ## EventTailerList @@ -77,14 +67,11 @@ EventTailerList contains a list of EventTailer ### (metav1.TypeMeta, required) {#eventtailerlist-} -Default: - ### metadata (metav1.ListMeta, optional) {#eventtailerlist-metadata} -Default: - ### items ([]EventTailer, required) {#eventtailerlist-items} -Default: - diff --git a/content/docs/configuration/crds/extensions/hosttailer_types.md b/content/docs/configuration/crds/extensions/hosttailer_types.md index 9a61caa27..c408742ff 100644 --- a/content/docs/configuration/crds/extensions/hosttailer_types.md +++ b/content/docs/configuration/crds/extensions/hosttailer_types.md @@ -8,39 +8,33 @@ generated_file: true HostTailerSpec defines the desired state of HostTailer -### fileTailers ([]FileTailer, optional) {#hosttailerspec-filetailers} - -List of [file tailers](#filetailer). +### enableRecreateWorkloadOnImmutableFieldChange (bool, optional) {#hosttailerspec-enablerecreateworkloadonimmutablefieldchange} -Default: - +EnableRecreateWorkloadOnImmutableFieldChange enables the operator to recreate the daemonset (and possibly other resource in the future) in case there is a change in an immutable field that otherwise couldn't be managed with a simple update. -### systemdTailers ([]SystemdTailer, optional) {#hosttailerspec-systemdtailers} -List of [systemd tailers](#systemdtailer). +### fileTailers ([]FileTailer, optional) {#hosttailerspec-filetailers} -Default: - +List of [file tailers](#filetailer). -### enableRecreateWorkloadOnImmutableFieldChange (bool, optional) {#hosttailerspec-enablerecreateworkloadonimmutablefieldchange} -EnableRecreateWorkloadOnImmutableFieldChange enables the operator to recreate the daemonset (and possibly other resource in the future) in case there is a change in an immutable field that otherwise couldn't be managed with a simple update. +### image (tailer.ImageSpec, optional) {#hosttailerspec-image} -Default: - -### workloadMetaOverrides (*types.MetaBase, optional) {#hosttailerspec-workloadmetaoverrides} +### systemdTailers ([]SystemdTailer, optional) {#hosttailerspec-systemdtailers} -Override metadata of the created resources +List of [systemd tailers](#systemdtailer). -Default: - ### workloadOverrides (*types.PodSpecBase, optional) {#hosttailerspec-workloadoverrides} Override podSpec fields for the given daemonset -Default: - -### image (tailer.ImageSpec, optional) {#hosttailerspec-image} +### workloadMetaOverrides (*types.MetaBase, optional) {#hosttailerspec-workloadmetaoverrides} + +Override metadata of the created resources -Default: - ## HostTailerStatus @@ -54,19 +48,15 @@ HostTailer is the Schema for the hosttailers API ### (metav1.TypeMeta, required) {#hosttailer-} -Default: - ### metadata (metav1.ObjectMeta, optional) {#hosttailer-metadata} -Default: - ### spec (HostTailerSpec, optional) {#hosttailer-spec} -Default: - ### status (HostTailerStatus, optional) {#hosttailer-status} -Default: - ## HostTailerList @@ -75,132 +65,101 @@ HostTailerList contains a list of [HostTailers](#hosttailer). ### (metav1.TypeMeta, required) {#hosttailerlist-} -Default: - ### metadata (metav1.ListMeta, optional) {#hosttailerlist-metadata} -Default: - ### items ([]HostTailer, required) {#hosttailerlist-items} -Default: - ## FileTailer FileTailer configuration options -### name (string, required) {#filetailer-name} +### buffer_chunk_size (string, optional) {#filetailer-buffer_chunk_size} -Name for the tailer +Set the buffer chunk size per active filetailer -Default: - -### path (string, optional) {#filetailer-path} +### buffer_max_size (string, optional) {#filetailer-buffer_max_size} -Path to the loggable file +Set the limit of the buffer size per active filetailer + + +### containerOverrides (*types.ContainerBase, optional) {#filetailer-containeroverrides} + +Override container fields for the given tailer -Default: - ### disabled (bool, optional) {#filetailer-disabled} Disable tailing the file -Default: - -### buffer_max_size (string, optional) {#filetailer-buffer_max_size} +### image (*tailer.ImageSpec, optional) {#filetailer-image} -Set the limit of the buffer size per active filetailer +Override image field for the given trailer -Default: - -### buffer_chunk_size (string, optional) {#filetailer-buffer_chunk_size} +### name (string, required) {#filetailer-name} -Set the buffer chunk size per active filetailer +Name for the tailer -Default: - -### skip_long_lines (string, optional) {#filetailer-skip_long_lines} +### path (string, optional) {#filetailer-path} -Skip long line when exceeding Buffer_Max_Size +Path to the loggable file -Default: - ### read_from_head (bool, optional) {#filetailer-read_from_head} Start reading from the head of new log files -Default: - -### buffer_max_size (string, optional) {#filetailer-buffer_max_size} +### skip_long_lines (string, optional) {#filetailer-skip_long_lines} -Set the limit of the buffer size per active filetailer +Skip long line when exceeding Buffer_Max_Size -Default: - -### buffer_chunk_size (string, optional) {#filetailer-buffer_chunk_size} -Set the buffer chunk size per active filetailer +## SystemdTailer -Default: - +SystemdTailer configuration options -### skip_long_lines (string, optional) {#filetailer-skip_long_lines} +### containerOverrides (*types.ContainerBase, optional) {#systemdtailer-containeroverrides} -Skip long line when exceeding Buffer_Max_Size +Override container fields for the given tailer -Default: - -### read_from_head (bool, optional) {#filetailer-read_from_head} +### disabled (bool, optional) {#systemdtailer-disabled} -Start reading from the head of new log files +Disable component -Default: - -### containerOverrides (*types.ContainerBase, optional) {#filetailer-containeroverrides} +### image (*tailer.ImageSpec, optional) {#systemdtailer-image} -Override container fields for the given tailer +Override image field for the given trailer -Default: - +### maxEntries (int, optional) {#systemdtailer-maxentries} -## SystemdTailer +Maximum entries to read when starting to tail logs to avoid high pressure -SystemdTailer configuration options ### name (string, required) {#systemdtailer-name} Name for the tailer -Default: - ### path (string, optional) {#systemdtailer-path} Override systemd log path -Default: - - -### disabled (bool, optional) {#systemdtailer-disabled} - -Disable component - -Default: - ### systemdFilter (string, optional) {#systemdtailer-systemdfilter} Filter to select systemd unit example: kubelet.service -Default: - - -### maxEntries (int, optional) {#systemdtailer-maxentries} - -Maximum entries to read when starting to tail logs to avoid high pressure - -Default: - - -### containerOverrides (*types.ContainerBase, optional) {#systemdtailer-containeroverrides} - -Override container fields for the given tailer - -Default: - diff --git a/content/docs/configuration/crds/v1beta1/_index.md b/content/docs/configuration/crds/v1beta1/_index.md index 20c9b9355..2962cb163 100644 --- a/content/docs/configuration/crds/v1beta1/_index.md +++ b/content/docs/configuration/crds/v1beta1/_index.md @@ -15,7 +15,7 @@ For more information please click on the name | **[Common](common_types/)** | ImageSpec Metrics Security | v1beta1 | | **[FlowSpec](flow_types/)** | FlowSpec is the Kubernetes spec for Flows | v1beta1 | | **[FluentbitSpec](fluentbit_types/)** | FluentbitSpec defines the desired state of FluentbitAgent | v1beta1 | -| **[FluentdSpec](fluentd_types/)** | FluentdSpec defines the desired state of Fluentd | v1beta1 | +| **[Fluent](fluentd_types/)** | FluentdConfig is a reference to the desired Fluentd state | v1beta1 | | **[Logging](logging_types/)** | Logging system configuration | v1beta1 | | **[LoggingRouteSpec](loggingroute_types/)** | LoggingRouteSpec defines the desired state of LoggingRoute | v1beta1 | | **[NodeAgent](node_agent_types/)** | | v1beta1 | @@ -24,6 +24,6 @@ For more information please click on the name | **[SyslogNGClusterOutput](syslogng_clusteroutput_types/)** | SyslogNGClusterOutput is the Schema for the syslog-ng clusteroutputs API | v1beta1 | | **[SyslogNGFlowSpec](syslogng_flow_types/)** | SyslogNGFlowSpec is the Kubernetes spec for SyslogNGFlows | v1beta1 | | **[SyslogNGOutputSpec](syslogng_output_types/)** | SyslogNGOutputSpec defines the desired state of SyslogNGOutput | v1beta1 | -| **[SyslogNGSpec](syslogng_types/)** | SyslogNGSpec defines the desired state of SyslogNG | v1beta1 | +| **[SyslogNG](syslogng_types/)** | SyslogNG is a reference to the desired SyslogNG state | v1beta1 | diff --git a/content/docs/configuration/crds/v1beta1/clusterflow_types.md b/content/docs/configuration/crds/v1beta1/clusterflow_types.md index 0c454e762..77f9dc90f 100644 --- a/content/docs/configuration/crds/v1beta1/clusterflow_types.md +++ b/content/docs/configuration/crds/v1beta1/clusterflow_types.md @@ -10,111 +10,89 @@ ClusterFlow is the Schema for the clusterflows API ### (metav1.TypeMeta, required) {#clusterflow-} -Default: - ### metadata (metav1.ObjectMeta, optional) {#clusterflow-metadata} -Default: - ### spec (ClusterFlowSpec, optional) {#clusterflow-spec} Name of the logging cluster to be attached -Default: - ### status (FlowStatus, optional) {#clusterflow-status} -Default: - ## ClusterMatch ### select (*ClusterSelect, optional) {#clustermatch-select} -Default: - ### exclude (*ClusterExclude, optional) {#clustermatch-exclude} -Default: - ## ClusterSelect -### namespaces ([]string, optional) {#clusterselect-namespaces} +### container_names ([]string, optional) {#clusterselect-container_names} -Default: - -### labels (map[string]string, optional) {#clusterselect-labels} +### hosts ([]string, optional) {#clusterselect-hosts} -Default: - -### hosts ([]string, optional) {#clusterselect-hosts} +### labels (map[string]string, optional) {#clusterselect-labels} -Default: - -### container_names ([]string, optional) {#clusterselect-container_names} +### namespaces ([]string, optional) {#clusterselect-namespaces} -Default: - ## ClusterExclude -### namespaces ([]string, optional) {#clusterexclude-namespaces} +### container_names ([]string, optional) {#clusterexclude-container_names} -Default: - -### labels (map[string]string, optional) {#clusterexclude-labels} +### hosts ([]string, optional) {#clusterexclude-hosts} -Default: - -### hosts ([]string, optional) {#clusterexclude-hosts} +### labels (map[string]string, optional) {#clusterexclude-labels} -Default: - -### container_names ([]string, optional) {#clusterexclude-container_names} +### namespaces ([]string, optional) {#clusterexclude-namespaces} -Default: - ## ClusterFlowSpec ClusterFlowSpec is the Kubernetes spec for ClusterFlows -### selectors (map[string]string, optional) {#clusterflowspec-selectors} +### filters ([]Filter, optional) {#clusterflowspec-filters} -Deprecated -Default: - +### flowLabel (string, optional) {#clusterflowspec-flowlabel} -### match ([]ClusterMatch, optional) {#clusterflowspec-match} -Default: - +### globalOutputRefs ([]string, optional) {#clusterflowspec-globaloutputrefs} -### filters ([]Filter, optional) {#clusterflowspec-filters} -Default: - +### includeLabelInRouter (*bool, optional) {#clusterflowspec-includelabelinrouter} -### loggingRef (string, optional) {#clusterflowspec-loggingref} -Default: - +### loggingRef (string, optional) {#clusterflowspec-loggingref} -### outputRefs ([]string, optional) {#clusterflowspec-outputrefs} -Deprecated +### match ([]ClusterMatch, optional) {#clusterflowspec-match} -Default: - -### globalOutputRefs ([]string, optional) {#clusterflowspec-globaloutputrefs} +### outputRefs ([]string, optional) {#clusterflowspec-outputrefs} -Default: - +Deprecated -### flowLabel (string, optional) {#clusterflowspec-flowlabel} -Default: - +### selectors (map[string]string, optional) {#clusterflowspec-selectors} -### includeLabelInRouter (*bool, optional) {#clusterflowspec-includelabelinrouter} +Deprecated -Default: - ## ClusterFlowList @@ -123,14 +101,11 @@ ClusterFlowList contains a list of ClusterFlow ### (metav1.TypeMeta, required) {#clusterflowlist-} -Default: - ### metadata (metav1.ListMeta, optional) {#clusterflowlist-metadata} -Default: - ### items ([]ClusterFlow, required) {#clusterflowlist-items} -Default: - diff --git a/content/docs/configuration/crds/v1beta1/clusteroutput_types.md b/content/docs/configuration/crds/v1beta1/clusteroutput_types.md index 13000a4f8..7f2991cf4 100644 --- a/content/docs/configuration/crds/v1beta1/clusteroutput_types.md +++ b/content/docs/configuration/crds/v1beta1/clusteroutput_types.md @@ -10,19 +10,15 @@ ClusterOutput is the Schema for the clusteroutputs API ### (metav1.TypeMeta, required) {#clusteroutput-} -Default: - ### metadata (metav1.ObjectMeta, optional) {#clusteroutput-metadata} -Default: - ### spec (ClusterOutputSpec, required) {#clusteroutput-spec} -Default: - ### status (OutputStatus, optional) {#clusteroutput-status} -Default: - ## ClusterOutputSpec @@ -31,11 +27,9 @@ ClusterOutputSpec contains Kubernetes spec for ClusterOutput ### (OutputSpec, required) {#clusteroutputspec-} -Default: - ### enabledNamespaces ([]string, optional) {#clusteroutputspec-enablednamespaces} -Default: - ## ClusterOutputList @@ -44,14 +38,11 @@ ClusterOutputList contains a list of ClusterOutput ### (metav1.TypeMeta, required) {#clusteroutputlist-} -Default: - ### metadata (metav1.ListMeta, optional) {#clusteroutputlist-metadata} -Default: - ### items ([]ClusterOutput, required) {#clusteroutputlist-items} -Default: - diff --git a/content/docs/configuration/crds/v1beta1/common_types.md b/content/docs/configuration/crds/v1beta1/common_types.md index 8f656258f..e5b479732 100644 --- a/content/docs/configuration/crds/v1beta1/common_types.md +++ b/content/docs/configuration/crds/v1beta1/common_types.md @@ -8,21 +8,17 @@ generated_file: true ImageSpec struct hold information about image specification -### repository (string, optional) {#imagespec-repository} +### imagePullSecrets ([]corev1.LocalObjectReference, optional) {#imagespec-imagepullsecrets} -Default: - -### tag (string, optional) {#imagespec-tag} +### pullPolicy (string, optional) {#imagespec-pullpolicy} -Default: - -### pullPolicy (string, optional) {#imagespec-pullpolicy} +### repository (string, optional) {#imagespec-repository} -Default: - -### imagePullSecrets ([]corev1.LocalObjectReference, optional) {#imagespec-imagepullsecrets} +### tag (string, optional) {#imagespec-tag} -Default: - ## Metrics @@ -31,35 +27,27 @@ Metrics defines the service monitor endpoints ### interval (string, optional) {#metrics-interval} -Default: - -### timeout (string, optional) {#metrics-timeout} +### path (string, optional) {#metrics-path} -Default: - ### port (int32, optional) {#metrics-port} -Default: - -### path (string, optional) {#metrics-path} +### prometheusAnnotations (bool, optional) {#metrics-prometheusannotations} -Default: - -### serviceMonitor (bool, optional) {#metrics-servicemonitor} +### prometheusRules (bool, optional) {#metrics-prometheusrules} -Default: - -### serviceMonitorConfig (ServiceMonitorConfig, optional) {#metrics-servicemonitorconfig} +### serviceMonitor (bool, optional) {#metrics-servicemonitor} -Default: - -### prometheusAnnotations (bool, optional) {#metrics-prometheusannotations} +### serviceMonitorConfig (ServiceMonitorConfig, optional) {#metrics-servicemonitorconfig} -Default: - -### prometheusRules (bool, optional) {#metrics-prometheusrules} +### timeout (string, optional) {#metrics-timeout} -Default: - ## BufferMetrics @@ -68,11 +56,9 @@ BufferMetrics defines the service monitor endpoints ### (Metrics, required) {#buffermetrics-} -Default: - ### mount_name (string, optional) {#buffermetrics-mount_name} -Default: - ## ServiceMonitorConfig @@ -81,94 +67,74 @@ ServiceMonitorConfig defines the ServiceMonitor properties ### additionalLabels (map[string]string, optional) {#servicemonitorconfig-additionallabels} -Default: - ### honorLabels (bool, optional) {#servicemonitorconfig-honorlabels} -Default: - -### relabelings ([]*v1.RelabelConfig, optional) {#servicemonitorconfig-relabelings} +### metricRelabelings ([]*v1.RelabelConfig, optional) {#servicemonitorconfig-metricrelabelings} -Default: - -### metricRelabelings ([]*v1.RelabelConfig, optional) {#servicemonitorconfig-metricrelabelings} +### relabelings ([]*v1.RelabelConfig, optional) {#servicemonitorconfig-relabelings} -Default: - ### scheme (string, optional) {#servicemonitorconfig-scheme} -Default: - ### tlsConfig (*v1.TLSConfig, optional) {#servicemonitorconfig-tlsconfig} -Default: - ## Security Security defines Fluentd, FluentbitAgent deployment security properties -### serviceAccount (string, optional) {#security-serviceaccount} +### podSecurityContext (*corev1.PodSecurityContext, optional) {#security-podsecuritycontext} -Default: - -### roleBasedAccessControlCreate (*bool, optional) {#security-rolebasedaccesscontrolcreate} +### podSecurityPolicyCreate (bool, optional) {#security-podsecuritypolicycreate} -Default: - -### podSecurityPolicyCreate (bool, optional) {#security-podsecuritypolicycreate} +### roleBasedAccessControlCreate (*bool, optional) {#security-rolebasedaccesscontrolcreate} -Default: - ### securityContext (*corev1.SecurityContext, optional) {#security-securitycontext} -Default: - -### podSecurityContext (*corev1.PodSecurityContext, optional) {#security-podsecuritycontext} +### serviceAccount (string, optional) {#security-serviceaccount} -Default: - ## ReadinessDefaultCheck ReadinessDefaultCheck Enable default readiness checks -### bufferFreeSpace (bool, optional) {#readinessdefaultcheck-bufferfreespace} +### bufferFileNumber (bool, optional) {#readinessdefaultcheck-bufferfilenumber} -Enable default Readiness check it'll fail if the buffer volume free space exceeds the `readinessDefaultThreshold` percentage (90%). -Default: - +### bufferFileNumberMax (int32, optional) {#readinessdefaultcheck-bufferfilenumbermax} -### bufferFreeSpaceThreshold (int32, optional) {#readinessdefaultcheck-bufferfreespacethreshold} -Default: - +### bufferFreeSpace (bool, optional) {#readinessdefaultcheck-bufferfreespace} -### bufferFileNumber (bool, optional) {#readinessdefaultcheck-bufferfilenumber} +Enable default Readiness check it'll fail if the buffer volume free space exceeds the `readinessDefaultThreshold` percentage (90%). -Default: - -### bufferFileNumberMax (int32, optional) {#readinessdefaultcheck-bufferfilenumbermax} +### bufferFreeSpaceThreshold (int32, optional) {#readinessdefaultcheck-bufferfreespacethreshold} -Default: - -### initialDelaySeconds (int32, optional) {#readinessdefaultcheck-initialdelayseconds} +### failureThreshold (int32, optional) {#readinessdefaultcheck-failurethreshold} -Default: - -### timeoutSeconds (int32, optional) {#readinessdefaultcheck-timeoutseconds} +### initialDelaySeconds (int32, optional) {#readinessdefaultcheck-initialdelayseconds} -Default: - ### periodSeconds (int32, optional) {#readinessdefaultcheck-periodseconds} -Default: - ### successThreshold (int32, optional) {#readinessdefaultcheck-successthreshold} -Default: - -### failureThreshold (int32, optional) {#readinessdefaultcheck-failurethreshold} +### timeoutSeconds (int32, optional) {#readinessdefaultcheck-timeoutseconds} -Default: - diff --git a/content/docs/configuration/crds/v1beta1/flow_types.md b/content/docs/configuration/crds/v1beta1/flow_types.md index d19bff90e..315742ed2 100644 --- a/content/docs/configuration/crds/v1beta1/flow_types.md +++ b/content/docs/configuration/crds/v1beta1/flow_types.md @@ -8,155 +8,125 @@ generated_file: true FlowSpec is the Kubernetes spec for Flows -### selectors (map[string]string, optional) {#flowspec-selectors} +### filters ([]Filter, optional) {#flowspec-filters} -Deprecated -Default: - +### flowLabel (string, optional) {#flowspec-flowlabel} -### match ([]Match, optional) {#flowspec-match} -Default: - +### globalOutputRefs ([]string, optional) {#flowspec-globaloutputrefs} -### filters ([]Filter, optional) {#flowspec-filters} -Default: - +### includeLabelInRouter (*bool, optional) {#flowspec-includelabelinrouter} -### loggingRef (string, optional) {#flowspec-loggingref} -Default: - +### localOutputRefs ([]string, optional) {#flowspec-localoutputrefs} -### outputRefs ([]string, optional) {#flowspec-outputrefs} -Deprecated +### loggingRef (string, optional) {#flowspec-loggingref} -Default: - -### globalOutputRefs ([]string, optional) {#flowspec-globaloutputrefs} +### match ([]Match, optional) {#flowspec-match} -Default: - -### localOutputRefs ([]string, optional) {#flowspec-localoutputrefs} +### outputRefs ([]string, optional) {#flowspec-outputrefs} -Default: - +Deprecated -### flowLabel (string, optional) {#flowspec-flowlabel} -Default: - +### selectors (map[string]string, optional) {#flowspec-selectors} -### includeLabelInRouter (*bool, optional) {#flowspec-includelabelinrouter} +Deprecated -Default: - ## Match ### select (*Select, optional) {#match-select} -Default: - ### exclude (*Exclude, optional) {#match-exclude} -Default: - ## Select -### labels (map[string]string, optional) {#select-labels} +### container_names ([]string, optional) {#select-container_names} -Default: - ### hosts ([]string, optional) {#select-hosts} -Default: - -### container_names ([]string, optional) {#select-container_names} +### labels (map[string]string, optional) {#select-labels} -Default: - ## Exclude -### labels (map[string]string, optional) {#exclude-labels} +### container_names ([]string, optional) {#exclude-container_names} -Default: - ### hosts ([]string, optional) {#exclude-hosts} -Default: - -### container_names ([]string, optional) {#exclude-container_names} +### labels (map[string]string, optional) {#exclude-labels} -Default: - ## Filter Filter definition for FlowSpec -### stdout (*filter.StdOutFilterConfig, optional) {#filter-stdout} +### concat (*filter.Concat, optional) {#filter-concat} -Default: - -### parser (*filter.ParserConfig, optional) {#filter-parser} +### dedot (*filter.DedotFilterConfig, optional) {#filter-dedot} -Default: - -### tag_normaliser (*filter.TagNormaliser, optional) {#filter-tag_normaliser} +### detectExceptions (*filter.DetectExceptions, optional) {#filter-detectexceptions} -Default: - -### dedot (*filter.DedotFilterConfig, optional) {#filter-dedot} +### elasticsearch_genid (*filter.ElasticsearchGenId, optional) {#filter-elasticsearch_genid} -Default: - -### elasticsearch_genid (*filter.ElasticsearchGenId, optional) {#filter-elasticsearch_genid} +### enhanceK8s (*filter.EnhanceK8s, optional) {#filter-enhancek8s} -Default: - -### record_transformer (*filter.RecordTransformer, optional) {#filter-record_transformer} +### geoip (*filter.GeoIP, optional) {#filter-geoip} -Default: - -### record_modifier (*filter.RecordModifier, optional) {#filter-record_modifier} +### grep (*filter.GrepConfig, optional) {#filter-grep} -Default: - -### geoip (*filter.GeoIP, optional) {#filter-geoip} +### kube_events_timestamp (*filter.KubeEventsTimestampConfig, optional) {#filter-kube_events_timestamp} -Default: - -### concat (*filter.Concat, optional) {#filter-concat} +### parser (*filter.ParserConfig, optional) {#filter-parser} -Default: - -### detectExceptions (*filter.DetectExceptions, optional) {#filter-detectexceptions} +### prometheus (*filter.PrometheusConfig, optional) {#filter-prometheus} -Default: - -### grep (*filter.GrepConfig, optional) {#filter-grep} +### record_modifier (*filter.RecordModifier, optional) {#filter-record_modifier} -Default: - -### prometheus (*filter.PrometheusConfig, optional) {#filter-prometheus} +### record_transformer (*filter.RecordTransformer, optional) {#filter-record_transformer} -Default: - -### throttle (*filter.Throttle, optional) {#filter-throttle} +### stdout (*filter.StdOutFilterConfig, optional) {#filter-stdout} -Default: - ### sumologic (*filter.SumoLogic, optional) {#filter-sumologic} -Default: - -### enhanceK8s (*filter.EnhanceK8s, optional) {#filter-enhancek8s} +### tag_normaliser (*filter.TagNormaliser, optional) {#filter-tag_normaliser} -Default: - -### kube_events_timestamp (*filter.KubeEventsTimestampConfig, optional) {#filter-kube_events_timestamp} +### throttle (*filter.Throttle, optional) {#filter-throttle} + + +### useragent (*filter.UserAgent, optional) {#filter-useragent} -Default: - ## FlowStatus @@ -165,15 +135,12 @@ FlowStatus defines the observed state of Flow ### active (*bool, optional) {#flowstatus-active} -Default: - ### problems ([]string, optional) {#flowstatus-problems} -Default: - ### problemsCount (int, optional) {#flowstatus-problemscount} -Default: - ## Flow @@ -182,19 +149,15 @@ Flow Kubernetes object ### (metav1.TypeMeta, required) {#flow-} -Default: - ### metadata (metav1.ObjectMeta, optional) {#flow-metadata} -Default: - ### spec (FlowSpec, optional) {#flow-spec} -Default: - ### status (FlowStatus, optional) {#flow-status} -Default: - ## FlowList @@ -203,14 +166,11 @@ FlowList contains a list of Flow ### (metav1.TypeMeta, required) {#flowlist-} -Default: - ### metadata (metav1.ListMeta, optional) {#flowlist-metadata} -Default: - ### items ([]Flow, required) {#flowlist-items} -Default: - diff --git a/content/docs/configuration/crds/v1beta1/fluentbit_types.md b/content/docs/configuration/crds/v1beta1/fluentbit_types.md index b37c6044a..da188bf65 100644 --- a/content/docs/configuration/crds/v1beta1/fluentbit_types.md +++ b/content/docs/configuration/crds/v1beta1/fluentbit_types.md @@ -10,19 +10,15 @@ FluentbitAgent is the Schema for the loggings API ### (metav1.TypeMeta, required) {#fluentbitagent-} -Default: - ### metadata (metav1.ObjectMeta, optional) {#fluentbitagent-metadata} -Default: - ### spec (FluentbitSpec, optional) {#fluentbitagent-spec} -Default: - ### status (FluentbitStatus, optional) {#fluentbitagent-status} -Default: - ## FluentbitAgentList @@ -31,277 +27,225 @@ FluentbitAgentList contains a list of FluentbitAgent ### (metav1.TypeMeta, required) {#fluentbitagentlist-} -Default: - ### metadata (metav1.ListMeta, optional) {#fluentbitagentlist-metadata} -Default: - ### items ([]FluentbitAgent, required) {#fluentbitagentlist-items} -Default: - ## FluentbitSpec FluentbitSpec defines the desired state of FluentbitAgent -### loggingRef (string, optional) {#fluentbitspec-loggingref} - -Default: - - -### daemonsetAnnotations (map[string]string, optional) {#fluentbitspec-daemonsetannotations} +### affinity (*corev1.Affinity, optional) {#fluentbitspec-affinity} -Default: - ### annotations (map[string]string, optional) {#fluentbitspec-annotations} -Default: - -### labels (map[string]string, optional) {#fluentbitspec-labels} +### bufferStorage (BufferStorage, optional) {#fluentbitspec-bufferstorage} -Default: - -### envVars ([]corev1.EnvVar, optional) {#fluentbitspec-envvars} +### bufferStorageVolume (volume.KubernetesVolume, optional) {#fluentbitspec-bufferstoragevolume} -Default: - +[volume.KubernetesVolume](https://github.com/cisco-open/operator-tools/tree/master/docs/types) -### image (ImageSpec, optional) {#fluentbitspec-image} -Default: - +### bufferVolumeArgs ([]string, optional) {#fluentbitspec-buffervolumeargs} -### tls (*FluentbitTLS, optional) {#fluentbitspec-tls} -Default: - +### bufferVolumeImage (ImageSpec, optional) {#fluentbitspec-buffervolumeimage} -### targetHost (string, optional) {#fluentbitspec-targethost} -Default: - +### bufferVolumeMetrics (*Metrics, optional) {#fluentbitspec-buffervolumemetrics} -### targetPort (int32, optional) {#fluentbitspec-targetport} -Default: - +### bufferVolumeResources (corev1.ResourceRequirements, optional) {#fluentbitspec-buffervolumeresources} -### flush (int32, optional) {#fluentbitspec-flush} -Set the flush time in seconds.nanoseconds. The engine loop uses a Flush timeout to define when is required to flush the records ingested by input plugins through the defined output plugins. (default: 1) +### coroStackSize (int32, optional) {#fluentbitspec-corostacksize} -Default: 1 +Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Don't set too small value (say 4096), or coroutine threads can overrun the stack buffer. Do not change the default value of this parameter unless you know what you are doing. (default: 24576) -### grace (int32, optional) {#fluentbitspec-grace} +Default: 24576 -Set the grace time in seconds as Integer value. The engine loop uses a Grace timeout to define wait time on exit (default: 5) +### customConfigSecret (string, optional) {#fluentbitspec-customconfigsecret} -Default: 5 -### logLevel (string, optional) {#fluentbitspec-loglevel} +### customParsers (string, optional) {#fluentbitspec-customparsers} -Set the logging verbosity level. Allowed values are: error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug. Note that trace mode is only available if Fluent Bit was built with the WITH_TRACE option enabled. (default: info) +Available in Logging operator version 4.2 and later. Specify a custom parser file to load in addition to the default parsers file. It must be a valid key in the configmap specified by customConfig. -Default: info +The following example defines a [Fluentd parser]({{< relref "/docs/configuration/plugins/filters/parser.md" >}}) that places the parsed containerd log messages into the `log` field instead of the `message` field. -### coroStackSize (int32, optional) {#fluentbitspec-corostacksize} +```yaml +apiVersion: logging.banzaicloud.io/v1beta1 +kind: FluentbitAgent +metadata: + name: containerd +spec: + inputTail: + Parser: cri-log-key + # Parser that populates `log` instead of `message` to enable the Kubernetes filter's Merge_Log feature to work + # Mind the indentation, otherwise Fluent Bit will parse the whole message into the `log` key + customParsers: | + [PARSER] + Name cri-log-key + Format regex + Regex ^(?