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.14.x or later.
  • For the Helm-based installation you need Helm v3.21.0 or later.

Deploy the Logging operator with One Eye 🔗︎

If you are using the One Eye observability tool, use the one-eye command line tool to install the Logging operator.

one-eye logging install

After that, you can configure your logging flows and outputs using the:

Deploy Logging operator with Helm 🔗︎

To install the Logging operator using Helm, complete these steps. If you want to install the Logging operator using Kubernetes manifests, see Deploy the Logging operator with Kubernetes manifests.

Note: For the Helm-based installation you need Helm v3.21.0 or later.

  1. Add the chart repository of the Logging operator using the following commands:

    helm repo add banzaicloud-stable https://kubernetes-charts.banzaicloud.com
    helm repo update
    
  2. Install the Logging operator.

    helm upgrade --install --wait --create-namespace --namespace logging logging-operator banzaicloud-stable/logging-operator \
      --set createCustomResource=false"
    

    You can install the logging resource with built-in TLS generation using a Helm chart.

  3. Validate your deployment.

Deploy the Logging operator from Kubernetes Manifests 🔗︎

To deploy the Logging operator using Kubernetes manifests, complete these steps. If you want to install the Logging operator using Helm, see Deploy the Logging operator with Helm.

  1. Create a controlNamespace called “logging”.

    kubectl create ns logging
    
  2. Create a ServiceAccount and install cluster roles.

    kubectl -n logging create -f https://raw.githubusercontent.com/banzaicloud/logging-operator-docs/master/docs/install/manifests/rbac.yaml
    
  3. Apply the ClusterResources.

    kubectl -n logging create -f https://raw.githubusercontent.com/banzaicloud/logging-operator/master/config/crd/bases/logging.banzaicloud.io_clusterflows.yaml
    kubectl -n logging create -f https://raw.githubusercontent.com/banzaicloud/logging-operator/master/config/crd/bases/logging.banzaicloud.io_clusteroutputs.yaml
    kubectl -n logging create -f https://raw.githubusercontent.com/banzaicloud/logging-operator/master/config/crd/bases/logging.banzaicloud.io_flows.yaml
    kubectl -n logging create -f https://raw.githubusercontent.com/banzaicloud/logging-operator/master/config/crd/bases/logging.banzaicloud.io_loggings.yaml
    kubectl -n logging create -f https://raw.githubusercontent.com/banzaicloud/logging-operator/master/config/crd/bases/logging.banzaicloud.io_outputs.yaml
    
  4. Deploy the Logging operator.

    kubectl -n logging create -f https://raw.githubusercontent.com/banzaicloud/logging-operator-docs/master/docs/install/manifests/deployment.yaml
    
  5. Validate your deployment.

Validate the deployment 🔗︎

To verify that the installation was successful, complete the following steps.

  1. 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-logging-operator-599c9cf846-5nw2n   1/1     Running   0          52s
    
  2. Check the CRDs. You should see the following five new CRDs.

    $  kubectl get crd
    NAME                                    CREATED AT
    clusterflows.logging.banzaicloud.io     2019-11-01T21:30:18Z
    clusteroutputs.logging.banzaicloud.io   2019-11-01T21:30:18Z
    flows.logging.banzaicloud.io            2019-11-01T21:30:18Z
    loggings.logging.banzaicloud.io         2019-11-01T21:30:18Z
    outputs.logging.banzaicloud.io          2019-11-01T21:30:18Z