image:https://travis-ci.org/OpenLiberty/open-liberty-operator.svg?branch=main["Build Status", link="https://travis-ci.org/OpenLiberty/open-liberty-operator"] image:https://goreportcard.com/badge/github.com/OpenLiberty/open-liberty-operator["Go Report Card", link=https://goreportcard.com/report/github.com/OpenLiberty/open-liberty-operator"]
= Open Liberty Operator
The Open Liberty Operator can be used to deploy and manage applications running on either Open Liberty or WebSphere Liberty into Kubernetes-based platforms, such as link:++https://www.openshift.com/++[Red Hat OpenShift]. You can also perform Day-2 operations such as gathering traces and dumps using the operator.
If there's a certain functionality you would like to see or a bug you would like to report, please use our link:++https://github.com/OpenLiberty/open-liberty-operator/issues[issues tab] to get in contact with us.
== Operator Installation
You can install the Open Liberty Operator directly via kubectl commands or assisted by the link:++https://github.com/operator-framework/operator-lifecycle-manager++[Operator Lifecycle Manager].
Use the instructions for one of the link:++deploy/releases++[releases] to directly install this Operator into a Kubernetes cluster.
== Overview
The architecture of the Open Liberty Operator follows the basic controller pattern: the Operator container with the controller is deployed into a Pod and listens for incoming resources with Kind: OpenLibertyApplication.
In addition, Open Liberty Operator makes it easy to perform link:++doc/user-guide.adoc#day-2-operations++[Day-2 operations] on an instance of Open Liberty server running inside a Pod:
Kind: OpenLibertyTraceKind: OpenLibertyDump== Documentation
For information on how to use the Open Liberty Operator, see the link:++doc/++[documentation].
== License
Usage is provided under the link:++https://opensource.org/licenses/EPL-2.0++[EPL 2.0 license]. See link:++LICENSE++[LICENSE] for the full details.
== Contributing
We welcome all contributions to the Open Liberty Operator project. Please see our link:++CONTRIBUTING.md++[Contributing guidelines].