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

To get started with cluster logging and the cluster-logging-operator:

• Ensure docker is installed on your local system (Note for Fedora 31)
• Ensure skopeo is installed, e.g. sudo dnf install -y skopeo

$ oc login $CLUSTER -u $ADMIN_USER -p $ADMIN_PASSWD
$ REMOTE_CLUSTER=true make deploy-example

This will stand up a cluster logging stack named 'example'.

You must first oc login api.ci.openshift.org. You'll need these credentials in order to pull images from the UBI registry.

The image build process for UBI based images uses a private yum repo. In order to use the private yum repo, you will need access to https://github.com/openshift/release/blob/master/ci-operator/infra/openshift/release-controller/repos/ocp-4.1-default.repo and https://github.com/openshift/shared-secrets/blob/master/mirror/ops-mirror.pem Note that the latter is private and requires special permission to access.

The best approach is to clone these repos under $GOPATH/src/github.com/openshift which the build scripts will pick up automatically. If you do not, the build script will attempt to clone them to a temporary directory.

If you have a local clone of origin-aggregated-logging under $GOPATH/github.com/openshift/origin-aggregated-logging you can use its hack/get-cluster-run-tests.sh to build the logging, elasticsearch-operator, and cluster-logging-operator images; deploy a 4.x cluster; push the images to the cluster; deploy logging; and launch the logging CI tests.

Make targets use commands such as oc, imagebuilder and operator-sdk. If a suitable command is not found in ./bin:$PATH, make will automatically build or download the command in ./bin.

See also: sdk_setup.sh to set up your environment.

These targets assume:

• Logged into an OKD cluster with cluster role cluster-admin
• Clone of openshift/elasticsearch-operator repository in $GOPATH

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

Note: If you do make deploy-image, you need a docker daemon running where you are running these commands. Also ensure you have podman (docker may be deprecated in the future). You need to set PUSH_USER and PUSH_PASSWORD If you used the openshift-installer, it creates a user named kubeadmin with the password in the file <install-dir>/auth/kubeadmin_password.

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)

Some make targets to facilitate deployment:

This test assumes:

• the cluster-logging-catalog image is available
• the cluster-logging-operator image is available
• the cluster-logging component images are available (i.e. $docker_registry_ip/openshift/$component)

Note: This test will fail if the images are not pushed to the cluster on which the operator runs or can be pulled from a visible registry.

Note: It is necessary to set the IMAGE_CLUSTER_LOGGING_OPERATOR environment variable to a valid pull spec in order to run this test against local changes to the cluster-logging-operator. For example:

$ make deploy-image && IMAGE_CLUSTER_LOGGING_OPERATOR=image-registry.openshift-image-registry.svc:5000/openshift/origin-cluster-logging-operator:latest make test-e2e
``**

**Note:** To skip cleanup of resources while hacking/debugging an E2E test apply `DO_CLEANUP=false`.