Merge pull request #2004 from kube-logging/chore/naming

csatib02 · web-flow · commit 5b66b95c6e2c · 2025-04-11T21:27:15.000+02:00
diff --git a/ADOPTERS.md b/ADOPTERS.md
@@ -1,22 +1,22 @@
-# Logging Operator Adopters
+# Logging operator Adopters
 
-This is a list of production adopters of Logging Operator:
+This is a list of production adopters of Logging operator:
 
 | Company                                                                | Industry                                                                                                                                                                |
 | :--------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [Acquia](https://www.acquia.com)                                       | Drupal site hosting as a service                                                                                                                                        |
-| [amazee.io](https://www.amazee.io)                                     | Developer-first application delivery and hosting - includes the Logging Operator in the fully open source [Lagoon](https://github.com/uselagoon) platform               |
+| [amazee.io](https://www.amazee.io)                                     | Developer-first application delivery and hosting - includes the Logging operator in the fully open source [Lagoon](https://github.com/uselagoon) platform               |
 | [Carrefour](https://carrefour.com)                                     | Retail                                                                                                                                                                  |
 | [Cisco](https://www.cisco.com)                                         | Digital communications technology                                                                                                                                       |
 | [Code Factory](https://codefactory.hu)                                 | Software Development/Consultancy                                                                                                                                        |
 | [Dailymotion](https://dailymotion.com)                                 | Video streaming, Adtech                                                                                                                                                 |
 | [DISH](https://www.dish.com/)                                          | Video streaming and satellite broadcasting.                                                                                                                             |
-| [D2IQ](https://d2iq.com)                                               | Kubernetes management tool. D2IQ's logging offering is based on the Logging Operator https://docs.d2iq.com/dkp/2.5/logging                                              |
+| [D2IQ](https://d2iq.com)                                               | Kubernetes management tool. D2IQ's logging offering is based on the Logging operator https://docs.d2iq.com/dkp/2.5/logging                                              |
 | [Flexera](https://www.flexera.com)                                     | Optimizing your IT assets from on-premises to the cloud                                                                                                                 |
 | [Fulcrum](https://www.fulcrumapp.com/)                                 | Organizations worldwide trust Fulcrum to help them capture and share reliable data about any field activity, much faster than paper or other digital solutions.         |
 | [hipages](https://hipages.com.au)                                      | E-commerce                                                                                                                                                              |
 | [KubeGems](https://kubegems.io)                                        | KubeGems observability/logging is powerd by Banzai Cloud Logging operator                                                                                               |
 | [Liquid Reply](https://liquidreply.net)                                | AWS Premier Consulting Partner for professional cloud computing services https://liquidreply.net/monitor-your-multi-cluster-environments                                |
-| [NAIS](https://nais.io)                                                | The Norwegian Labour and Welfare Administration (NAV) uses the Logging Operator in the NAIS application platform                                                        |
+| [NAIS](https://nais.io)                                                | The Norwegian Labour and Welfare Administration (NAV) uses the Logging operator in the NAIS application platform                                                        |
 | [PITS Global Data Recovery Services](https://www.pitsdatarecovery.net) | Data Recovery Services                                                                                                                                                  |
-| [Rancher](https://rancher.com)                                         | Kubernetes management tool. RKE’s default logging solution is based on the Logging Operator   https://ranchermanager.docs.rancher.com/v2.5/pages-for-subheaders/logging |
+| [Rancher](https://rancher.com)                                         | Kubernetes management tool. RKE’s default logging solution is based on the Logging operator   https://ranchermanager.docs.rancher.com/v2.5/pages-for-subheaders/logging |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,7 +11,7 @@ There are multiple ways you can help with the project.
 
 ### Questions
 
-The following channels are available for logging operator related discussions:
+The following channels are available for Logging operator related discussions:
 
 - [Github discussions](https://github.com/orgs/kube-logging/discussions)
 - [#logging-operator Discord channel](https://discord.gg/eAcqmAVU2u)
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 
 # Logging operator
 
-The Logging Operator is now a [CNCF Sandbox](https://www.cncf.io/sandbox-projects/) project.
+The Logging operator is now a [CNCF Sandbox](https://www.cncf.io/sandbox-projects/) project.
 
 The Logging operator solves your logging-related problems in Kubernetes environments by automating the deployment and configuration of a Kubernetes logging pipeline.
 
@@ -67,7 +67,7 @@ Follow these [quickstart guides](https://kube-logging.github.io/docs/quickstarts
 
 ### Install
 
-Deploy Logging Operator with our [Helm chart](https://kube-logging.github.io/docs/install/#deploy-logging-operator-with-helm).
+Deploy Logging operator with our [Helm chart](https://kube-logging.github.io/docs/install/#deploy-logging-operator-with-helm).
 
 > Caution: The **master branch** is under heavy development. Use [releases](https://github.com/kube-logging/logging-operator/releases) instead of the master branch to get stable software.
 
diff --git a/charts/logging-operator/README.md b/charts/logging-operator/README.md
@@ -20,7 +20,7 @@ helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/loggi
 
 ## Introduction
 
-This chart bootstraps a [Logging Operator](https://github.com/kube-logging/logging-operator) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
+This chart bootstraps a [Logging operator](https://github.com/kube-logging/logging-operator) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
 
 ## Prerequisites
 
@@ -47,7 +47,7 @@ Use `createCustomResource=false` with Helm v3 to avoid trying to create CRDs fro
 | fullnameOverride | string | `""` | A name to substitute for the full names of resources. |
 | namespaceOverride | string | `""` | A namespace override for the app. |
 | annotations | object | `{}` | Define annotations for logging-operator pods. |
-| createCustomResource | bool | `false` | Deploy CRDs used by Logging Operator. |
+| createCustomResource | bool | `false` | Deploy CRDs used by Logging operator. |
 | logging-operator-crds.install | bool | `false` | Toggle to install and upgrade CRDs from a subchart. Make sure to use it with `--skip-crds` to avoid conflicts. [More info about limitations on CRDs in Helm 3](https://helm.sh/docs/topics/charts/#limitations-on-crds) |
 | logging-operator-crds.annotations | object | `{}` | Annotations to be added to all CRDs |
 | telemetry-controller.install | bool | `false` | Toggle to install and upgrade Telemetry Controller from a subchart. |
diff --git a/charts/logging-operator/README.md.gotmpl b/charts/logging-operator/README.md.gotmpl
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-This chart bootstraps a [Logging Operator](https://github.com/kube-logging/logging-operator) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
+This chart bootstraps a [Logging operator](https://github.com/kube-logging/logging-operator) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
 
 ## Prerequisites
 
diff --git a/charts/logging-operator/values.yaml b/charts/logging-operator/values.yaml
@@ -34,7 +34,7 @@ namespaceOverride: ""
 # -- Define annotations for logging-operator pods.
 annotations: {}
 
-# -- Deploy CRDs used by Logging Operator.
+# -- Deploy CRDs used by Logging operator.
 createCustomResource: false
 
 ## Custom resource configuration defined as a dependency chart
diff --git a/docs/configuration/plugins/outputs/kafka.md b/docs/configuration/plugins/outputs/kafka.md
@@ -10,7 +10,7 @@ generated_file: true
 
 For details, see [https://github.com/fluent/fluent-plugin-kafka](https://github.com/fluent/fluent-plugin-kafka).
 
-For an example deployment, see [Transport Nginx Access Logs into Kafka with Logging Operator](../../../../quickstarts/kafka-nginx/).
+For an example deployment, see [Transport Nginx Access Logs into Kafka with Logging operator](../../../../quickstarts/kafka-nginx/).
 
 ## Example output configurations
 
diff --git a/docs/configuration/plugins/outputs/loki.md b/docs/configuration/plugins/outputs/loki.md
@@ -9,7 +9,7 @@ generated_file: true
 
 Fluentd output plugin to ship logs to a Loki server. For details, see [https://grafana.com/docs/loki/latest/clients/fluentd/](https://grafana.com/docs/loki/latest/clients/fluentd/).
 
-For a detailed example, see [Store Nginx Access Logs in Grafana Loki with Logging Operator](../../../../quickstarts/loki-nginx/).
+For a detailed example, see [Store Nginx Access Logs in Grafana Loki with Logging operator](../../../../quickstarts/loki-nginx/).
 
 ## Example output configurations
 
diff --git a/docs/configuration/plugins/outputs/relabel.md b/docs/configuration/plugins/outputs/relabel.md
@@ -7,7 +7,7 @@ generated_file: true
 # Relabel
 ## Overview
 
-Available in Logging Operator version 4.2 and later.
+Available in Logging operator version 4.2 and later.
 
 The relabel output uses the [relabel output plugin of Fluentd](https://docs.fluentd.org/output/relabel) to route events back to a specific Flow, where they can be processed again.
 
diff --git a/docs/scaling.md b/docs/scaling.md
@@ -39,7 +39,7 @@ kubectl get --raw '/apis/custom.metrics.k8s.io/v1beta1/namespaces/default/pods/*
 
 The replica count of the stateful set is enforced by the logging-operator only if it is explicitly set in the logging resource's replica count.
 
-If it's not set explicitly in the logging resource, then the logging operator allows managing it from the outside.
+If it's not set explicitly in the logging resource, then the Logging operator allows managing it from the outside.
 
 To allow for HPA to control the replica count of the statefulset simply avoid setting the replica count through the logging resource.
 
diff --git a/docs/syslogng-quickstart.md b/docs/syslogng-quickstart.md
@@ -1,16 +1,16 @@
-# Logging Operator Syslog-ng quickstart
+# Logging operator Syslog-ng quickstart
 
-This document describes how to get started with the preview version of the Logging Operator using syslog-ng as the forward agent.
+This document describes how to get started with the preview version of the Logging operator using syslog-ng as the forward agent.
 
 ## What is new?
 
-There are 4 new CRDs to manage Logging Operator with syslog-ng:
+There are 4 new CRDs to manage Logging operator with syslog-ng:
 - SyslogNGFlow
 - SyslogNGClusterFlow
 - SyslogNGOutput
 - SyslogNGClusterOutput
 
-These resources works identical to their counterparts used to manage Logging Operator with Fluentd, but are tailored to features available via syslog-ng.
+These resources works identical to their counterparts used to manage Logging operator with Fluentd, but are tailored to features available via syslog-ng.
 
 Also, the Logging CRD has been extended with a section for configuring syslog-ng under `logging.spec.syslogNG`.
 
@@ -189,7 +189,7 @@ The `regexp` field can have the following fields
 
 ### Filters
 
-Logging Operator currently supports the following filters for syslog-ng:
+Logging operator currently supports the following filters for syslog-ng:
 - match
 - parser
 - rewrite
@@ -214,7 +214,7 @@ These filters have the same options and syntax as syslog-ng flow match expressio
 
 #### Parser filter
 Parser filters can be used to extract key-value pairs from message data.
-Logging Operator currently supports the following parsers:
+Logging operator currently supports the following parsers:
 - regexp
 - syslog-parser
 
@@ -244,7 +244,7 @@ filters:
 
 #### Rewrite filter
 Rewrite filters can be used to modify record contents.
-Logging Operator currently supports the following rewrite functions:
+Logging operator currently supports the following rewrite functions:
 - rename
 - set
 - substitute
@@ -303,7 +303,7 @@ The `group_unset` function removes keys based on a patterns. If an object have m
 
 SyslogNGOutput and SyslogNGClusterOutput resources have almost the same structure as Output and ClusterOutput resources with the main difference being the number and kind of supported destinations.
 
-Logging Operator currently supports the following kinds of outputs for syslog-ng:
+Logging operator currently supports the following kinds of outputs for syslog-ng:
 - [file](#file-output)
 - [http](#http-output)
 - [loggly](#loggly-output)
diff --git a/docs/volume-drainer.md b/docs/volume-drainer.md
@@ -141,7 +141,7 @@ Downscale fluentd
 kubectl patch logging drainer --type merge -p '{"spec":{"fluentd":{"scaling":{"replicas":1}}}}'
 ```
 
-Wait for the logging operator to reconcile and start the drain job.
+Wait for the Logging operator to reconcile and start the drain job.
 
 In a new terminal, start a watch to examine how buffers change
 ```sh
@@ -163,7 +163,7 @@ Downscale fluentd
 kubectl patch logging drainer --type merge -p '{"spec":{"fluentd":{"scaling":{"replicas":1}}}}'
 ```
 
-Wait for the logging operator to reconcile and start the drain job.
+Wait for the Logging operator to reconcile and start the drain job.
 A placeholder pod should also appear with the same name as the deleted statefulset pod (`drainer-fluentd-1`).
 
 Upscale fluentd
diff --git a/main.go b/main.go
@@ -104,7 +104,7 @@ func main() {
 	flag.BoolVar(&enableprofile, "pprof", false, "Enable pprof")
 	flag.StringVar(&namespace, "watch-namespace", "", "Namespace to filter the list of watched objects")
 	flag.StringVar(&loggingRef, "watch-logging-name", "", "Logging resource name to optionally filter the list of watched objects based on which logging they belong to by checking the app.kubernetes.io/managed-by label")
-	flag.BoolVar(&watchLabeledChildren, "watch-labeled-children", false, "Only watch child resources with logging operator's name label selector: app.kubernetes.io/name: fluentd|fluentbit|syslog-ng")
+	flag.BoolVar(&watchLabeledChildren, "watch-labeled-children", false, "Only watch child resources with Logging operator's name label selector: app.kubernetes.io/name: fluentd|fluentbit|syslog-ng")
 	flag.BoolVar(&watchLabeledSecrets, "watch-labeled-secrets", false, "Only watch secrets with the following label selector: logging.banzaicloud.io/watch: enabled")
 	flag.BoolVar(&finalizerCleanup, "finalizer-cleanup", false, "Remove finalizers from Logging resources during operator shutdown, useful for Helm uninstallation")
 	flag.BoolVar(&enableTelemetryControllerRoute, "enable-telemetry-controller-route", false, "Enable the Telemetry Controller route for Logging resources")
diff --git a/pkg/sdk/logging/model/output/kafka.go b/pkg/sdk/logging/model/output/kafka.go
@@ -29,7 +29,7 @@ type _hugoKafka interface{} //nolint:deadcode,unused
 /*
 For details, see [https://github.com/fluent/fluent-plugin-kafka](https://github.com/fluent/fluent-plugin-kafka).
 
-For an example deployment, see [Transport Nginx Access Logs into Kafka with Logging Operator](../../../../quickstarts/kafka-nginx/).
+For an example deployment, see [Transport Nginx Access Logs into Kafka with Logging operator](../../../../quickstarts/kafka-nginx/).
 
 ## Example output configurations
 
diff --git a/pkg/sdk/logging/model/output/loki.go b/pkg/sdk/logging/model/output/loki.go
@@ -28,7 +28,7 @@ type _hugoLoki interface{} //nolint:deadcode,unused
 /*
 Fluentd output plugin to ship logs to a Loki server. For details, see [https://grafana.com/docs/loki/latest/clients/fluentd/](https://grafana.com/docs/loki/latest/clients/fluentd/).
 
-For a detailed example, see [Store Nginx Access Logs in Grafana Loki with Logging Operator](../../../../quickstarts/loki-nginx/).
+For a detailed example, see [Store Nginx Access Logs in Grafana Loki with Logging operator](../../../../quickstarts/loki-nginx/).
 
 ## Example output configurations
 
diff --git a/pkg/sdk/logging/model/output/relabel.go b/pkg/sdk/logging/model/output/relabel.go
@@ -26,7 +26,7 @@ type _hugoRelabel interface{} //nolint:deadcode,unused
 
 // +docName:"Relabel"
 /*
-Available in Logging Operator version 4.2 and later.
+Available in Logging operator version 4.2 and later.
 
 The relabel output uses the [relabel output plugin of Fluentd](https://docs.fluentd.org/output/relabel) to route events back to a specific Flow, where they can be processed again.
 
