https://github.com/OpenLiberty/open-liberty-operator

https://github.com/OpenLiberty/open-liberty-operator

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/OpenLiberty/open-liberty-operator
• Owner: OpenLiberty
• License: epl-1.0
• Created: 2019-04-10T21:40:40.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-16T17:01:02.000Z (about 1 month ago)
• Last Synced: 2024-05-17T18:02:11.857Z (about 1 month ago)
• Language: Go
• Size: 41 MB
• Stars: 28
• Watchers: 8
• Forks: 37
• Open Issues: 84
• Metadata Files:
  • Readme: README.adoc
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-operators - OpenLiberty/open-liberty-operator

README

        
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: 

- Gather server traces using resource `Kind: OpenLibertyTrace`

- Generate server dumps using resource `Kind: 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-1.0++[EPL 1.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].