An operator to support OKD aggregated cluster logging. Cluster logging configuration information is found in the configuration documentation.

Running locally outside an OKD cluster:

 $ ELASTICSEARCH_IMAGE=docker.io/openshift/origin-logging-elasticsearch5:latest \
   FLUENTD_IMAGE=docker.io/openshift/origin-logging-fluentd:latest \
   KIBANA_IMAGE=docker.io/openshift/origin-logging-kibana5:latest \
   CURATOR_IMAGE=docker.io/openshift/origin-logging-curator5:latest \
   OAUTH_PROXY_IMAGE=docker.io/openshift/oauth-proxy:latest \
   RSYSLOG_IMAGE=docker.io/viaq/rsyslog:latest \
   OPERATOR_NAME=cluster-logging-operator \
   WATCH_NAMESPACE=openshift-logging \
   KUBERNETES_CONFIG=/etc/origin/master/admin.kubeconfig \
   go run cmd/cluster-logging-operator/main.go

Various make targets are included to simplify building and deploying the operator from the repository root directory, all of which are not listed here. Hacking and deploying the operator assumes:

• a running OKD cluster
• oc binary in your $PATH
• Logged into a cluster with an admin user who has the cluster role of cluster-admin
• Access to a clone of the openshift/elasticsearch-operator repository
• make targets are executed from the openshift/cluster-logging-operator root directory
• various other commands such as imagebuilder and operator-sdk - it is suggested that you use the logging sdk_setup.sh script at https://raw.githubusercontent.com/openshift/origin-aggregated-logging/master/hack/sdk_setup.sh

Note: If you are using REMOTE_REGISTRY=true, ensure you have docker package installed and docker daemon up and running on the workstation you are running these commands.

The deployment can be optionally modified using any of the following:

• IMAGE_BUILDER is the command to build the container image (default: docker build)
• EXCLUSIONS is list of manifest files that should be ignored (default: '')
• OC is the openshift binary to use to deploy resources (default: oc in path)
• REMOTE_REGISTRY Set to true if you are running the cluster on a different machine than the one you are developing on. For example, if you are running a cluster in a local libvirt or minishift environment, you may want to build the image on the host and push them to the cluster running in the VM. You will need a username with a password (i.e. not the default system:admin user). If your cluster was deployed with the allow_all identity provider, you can create a user like this: oc login --username=admin --password=admin, then assign it rights: oc login --username=system:admin oc adm policy add-cluster-role-to-user cluster-admin admin If you used the new openshift-installer, it created a user named kubeadmin with the password in the file installer/auth/kubeadmin_password. oc login --username=kubeadmin --password=$( cat ../installer/auth/kubeadmin_password ) The user should already have cluster-admin rights.

Note: If while hacking you find your changes are not being applied, use docker images to see if there is a local version of the cluster-logging-operator on your machine which may being used by the cluster instead of the one pushed to the docker registry. You may need to delete it (e.g. docker rmi $IMAGE)

Deploys all resources and creates an instance of the cluster-logging-operator, creates a ClusterLogging custom resource named example, starts the Elasticsearch, Kibana, and Fluentd pods running.

$ [REMOTE_REGISTRY=true] make deploy-example

Deploys all resources and creates an instance of the cluster-logging-operator, but does not create the CR nor start the components running.

$ [REMOTE_REGISTRY=true] make deploy

Removes all cluster-logging resources and openshift-logging project

$ [REMOTE_REGISTRY=true] make undeploy

Setup the OKD cluster to support cluster-logging without deploying an instance of the cluster-logging-operator

$ [REMOTE_REGISTRY=true] make deploy-setup

If you already have a remote cluster, and you just want to rebuild and redeploy the image to the remote cluster. Use make image instead if you only want to build the image but not push it.

$ REMOTE_REGISTRY=true make deploy-image

This test assumes the cluster-logging component images were already pushed to the OKD cluster and can be found at $docker_registry_ip/openshift/$component

Note: This test will fail if the component images are not pushed to the cluster on which the operator runs.

Running the tests directly from the repo directory:

$ make test-e2e