Install
Caution: The master branch is under heavy development. Use releases instead of the master branch to get stable software.
Prerequisites
- Logging operator requires Kubernetes v1.22.x or later.
- For the Helm-based installation you need Helm v3.8.1 or later.
With the 4.3.0 release, the chart is now distributed through an OCI registry.
For instructions on how to interact with OCI registries, please take a look at Use OCI-based registries. For instructions on installing the previous 4.2.3 version, see Installation for 4.2.
Deploy Logging operator with Helm
To install the Logging operator using Helm, complete the following
Note: You need Helm v3.8 or later to be able to install the chart from an OCI registry.
-
Install the Logging operator into the logging namespace:
helm upgrade --install --wait --create-namespace --namespace logging logging-operator oci://ghcr.io/kube-logging/helm-charts/logging-operator
Expected output:
Release "logging-operator" does not exist. Installing it now. Pulled: ghcr.io/kube-logging/helm-charts/logging-operator:4.3.0 Digest: sha256:c2ece861f66a3a2cb9788e7ca39a267898bb5629dc98429daa8f88d7acf76840 NAME: logging-operator LAST DEPLOYED: Wed Aug 9 11:02:12 2023 NAMESPACE: logging STATUS: deployed REVISION: 1 TEST SUITE: None
Note: Helm has a known issue in version 3.13.0 that requires users to log in to the registry, even though the repo is public. Upgrade to 3.13.1 or higher to avoid having to log in, see: https://github.com/kube-logging/logging-operator/issues/1522
Note: By default, the Logging operator Helm chart doesn’t install the
logging
resource. If you want to install it with Helm, set thelogging.enabled
value to true.For details on customizing the installation, see the Helm chart values.
Validate the deployment
To verify that the installation was successful, complete the following steps.
-
Check the status of the pods. You should see a new logging-operator pod.
$ kubectl -n logging get pods NAME READY STATUS RESTARTS AGE logging-operator-5df66b87c9-wgsdf 1/1 Running 0 21s
-
Check the CRDs. You should see the following five new CRDs.
$ kubectl get crd NAME CREATED AT clusterflows.logging.banzaicloud.io 2023-08-10T12:05:04Z clusteroutputs.logging.banzaicloud.io 2023-08-10T12:05:04Z eventtailers.logging-extensions.banzaicloud.io 2023-08-10T12:05:04Z flows.logging.banzaicloud.io 2023-08-10T12:05:04Z fluentbitagents.logging.banzaicloud.io 2023-08-10T12:05:04Z hosttailers.logging-extensions.banzaicloud.io 2023-08-10T12:05:04Z loggings.logging.banzaicloud.io 2023-08-10T12:05:05Z nodeagents.logging.banzaicloud.io 2023-08-10T12:05:05Z outputs.logging.banzaicloud.io 2023-08-10T12:05:05Z syslogngclusterflows.logging.banzaicloud.io 2023-08-10T12:05:05Z syslogngclusteroutputs.logging.banzaicloud.io 2023-08-10T12:05:05Z syslogngflows.logging.banzaicloud.io 2023-08-10T12:05:05Z syslogngoutputs.logging.banzaicloud.io 2023-08-10T12:05:06Z