Skip to content

Commit e04d440

Browse files
update readme to link to olm docs
1 parent 9359b9d commit e04d440

File tree

1 file changed

+30
-11
lines changed

1 file changed

+30
-11
lines changed

README.md

+30-11
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,35 @@
44
[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
55
[![Go Report Card](https://goreportcard.com/badge/github.com/operator-framework/operator-lifecycle-manager)](https://goreportcard.com/report/github.com/operator-framework/operator-lifecycle-manager)
66

7+
## Documentation
8+
9+
User documentation can be found on the [OLM website][olm-docs].
10+
711
## Overview
812

913
This project is a component of the [Operator Framework](https://github.com/operator-framework), an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post](https://operatorhub.io/what-is-an-operator) and learn about practical use cases at [OLM-Book](https://operator-framework.github.io/olm-book/).
1014

1115
OLM extends Kubernetes to provide a declarative way to install, manage, and upgrade Operators and their dependencies in a cluster. It provides the following features:
1216

1317
### Over-the-Air Updates and Catalogs
18+
1419
Kubernetes clusters are being kept up to date using elaborate update mechanisms today, more often automatically and in the background. Operators, being cluster extensions, should follow that. OLM has a concept of catalogs from which Operators are available to install and being kept up to date. In this model OLM allows maintainers granular authoring of the update path and gives commercial vendors a flexible publishing mechanism using channels.
1520

1621
### Dependency Model
22+
1723
With OLMs packaging format Operators can express dependencies on the platform and on other Operators. They can rely on OLM to respect these requirements as long as the cluster is up. In this way, OLMs dependency model ensures Operators stay working during their long lifecycle across multiple updates of the platform or other Operators.
1824

1925
### Discoverability
26+
2027
OLM advertises installed Operators and their services into the namespaces of tenants. They can discover which managed services are available and which Operator provides them. Administrators can rely on catalog content projected into a cluster, enabling discovery of Operators available to install.
2128

2229
### Cluster Stability
30+
2331
Operators must claim ownership of their APIs. OLM will prevent conflicting Operators owning the same APIs being installed, ensuring cluster stability.
2432

2533
### Declarative UI controls
26-
Operators can behave like managed service providers. Their user interface on the command line are APIs. For graphical consoles OLM annotates those APIs with descriptors that drive the creation of rich interfaces and forms for users to interact with the Operator in a natural, cloud-like way.
2734

35+
Operators can behave like managed service providers. Their user interface on the command line are APIs. For graphical consoles OLM annotates those APIs with descriptors that drive the creation of rich interfaces and forms for users to interact with the Operator in a natural, cloud-like way.
2836

2937
## Prerequisites
3038

@@ -37,17 +45,17 @@ Operators can behave like managed service providers. Their user interface on the
3745

3846
## Getting Started
3947

48+
Check the [Getting Started][olm-getting-started] section.
49+
4050
### Installation
4151

42-
Install OLM on a Kubernetes or OpenShift cluster by following the [installation guide].
52+
Install OLM on a Kubernetes cluster by following the [installation guide][installation-guide].
4353

4454
For a complete end-to-end example of how OLM fits into the Operator Framework, see the [Operator Framework Getting Started Guide](https://github.com/operator-framework/getting-started). Also, see [Getting Started on OperatorHub.io](https://operatorhub.io/getting-started).
4555

46-
**NOTE:** OLM is installed by default in OpenShift 4.0 and above.
47-
4856
## User Interface (Running the console Locally)
4957

50-
Use the OpenShift admin console (compatible with upstream Kubernetes) to interact with and visualize the resources managed by OLM. Create subscriptions, approve install plans, identify Operator-managed resources, and more.
58+
Use the admin console to interact with and visualize the resources managed by OLM. Create subscriptions, approve install plans, identify Operator-managed resources, and more.
5159

5260
Ensure `kubectl` is pointing at a cluster and run:
5361

@@ -57,7 +65,6 @@ $ make run-console-local
5765

5866
Then visit `http://localhost:9000` to view the console.
5967

60-
6168
## Contributing your Operator
6269

6370
Have an awesome Operator you want to share? Checkout the [publishing docs](https://operatorhub.io/contribute) to learn about contributing to [OperatorHub.io](https://operatorhub.io/).
@@ -149,9 +156,15 @@ Catalogs are served internally over a grpc interface to OLM from [operator-regis
149156

150157
To explore any operator samples using the OLM, see the [https://operatorhub.io/](https://operatorhub.io/) and its resources in [Community Operators](https://github.com/operator-framework/community-operators/tree/master/upstream-community-operators).
151158

159+
## Community and how to get involved
160+
161+
- [Operator framework community][operator-framework-community]
162+
- [Communication channels][operator-framework-communication]
163+
- [Project meetings][operator-framework-meetings]
164+
152165
## Contributing
153166

154-
See the [proposal docs][proposals_docs] and issues for ongoing or planned work.
167+
Check out the [contributor documentation][contributor-documentation]. Also, see the [proposal docs][proposals_docs] and issues for ongoing or planned work.
155168

156169
## Reporting bugs
157170

@@ -163,13 +176,19 @@ Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][licens
163176

164177
[architecture]: /doc/design/architecture.md
165178
[philosophy]: /doc/design/philosophy.md
166-
[installation guide]: /doc/install/install.md
179+
[proposals_docs]: ./doc/contributors/design-proposals
180+
[license_file]:./LICENSE
181+
[bug_guide]:./doc/dev/reporting_bugs.md
167182
[git_tool]:https://git-scm.com/downloads
168183
[go_tool]:https://golang.org/dl/
169184
[docker_tool]:https://docs.docker.com/install/
170185
[podman_tool]:https://github.com/containers/libpod/blob/master/install.md
171186
[buildah_tool]:https://github.com/containers/buildah/blob/master/install.md
172187
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
173-
[proposals_docs]: ./doc/contributors/design-proposals
174-
[license_file]:./LICENSE
175-
[bug_guide]:./doc/dev/reporting_bugs.md
188+
[olm-docs]: https://olm.operatorframework.io/
189+
[operator-framework-community]: https://github.com/operator-framework/community
190+
[operator-framework-communication]: https://github.com/operator-framework/community#get-involved
191+
[operator-framework-meetings]: https://github.com/operator-framework/community#meetings
192+
[contributor-documentation]: https://olm.operatorframework.io/docs/contribution-guidelines/
193+
[olm-getting-started]: https://olm.operatorframework.io/docs/getting-started/
194+
[installation-guide]: doc/install/install.md

0 commit comments

Comments
 (0)