Skip to content

Commit 10107e2

Browse files
doc: update readme with olm website doc info
Signed-off-by: Camila Macedo <[email protected]>
1 parent b101947 commit 10107e2

File tree

2 files changed

+26
-162
lines changed

2 files changed

+26
-162
lines changed

README.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,34 @@
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+
Docs 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
34+
2635
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.
2736

2837

@@ -37,26 +46,7 @@ Operators can behave like managed service providers. Their user interface on the
3746

3847
## Getting Started
3948

40-
### Installation
41-
42-
Install OLM on a Kubernetes or OpenShift cluster by following the [installation guide].
43-
44-
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).
45-
46-
**NOTE:** OLM is installed by default in OpenShift 4.0 and above.
47-
48-
## User Interface (Running the console Locally)
49-
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.
51-
52-
Ensure `kubectl` is pointing at a cluster and run:
53-
54-
```shell
55-
$ make run-console-local
56-
```
57-
58-
Then visit `http://localhost:9000` to view the console.
59-
49+
Check the [Getting Started][olm-getting-started] section.
6050

6151
## Contributing your Operator
6252

@@ -149,9 +139,15 @@ Catalogs are served internally over a grpc interface to OLM from [operator-regis
149139

150140
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).
151141

142+
## Community and how to get involved
143+
144+
- [Operator framework community][operator-framework-community]
145+
- [Communication channels][operator-framework-communication]
146+
- [Project meetings][operator-framework-meetings]
147+
152148
## Contributing
153149

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

156152
## Reporting bugs
157153

@@ -161,15 +157,18 @@ See [reporting bugs][bug_guide] for details about reporting any issues.
161157

162158
Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][license_file] file for details.
163159

164-
[architecture]: /doc/design/architecture.md
165-
[philosophy]: /doc/design/philosophy.md
166-
[installation guide]: /doc/install/install.md
160+
[proposals_docs]: ./doc/contributors/design-proposals
161+
[license_file]:./LICENSE
162+
[bug_guide]:./doc/dev/reporting_bugs.md
167163
[git_tool]:https://git-scm.com/downloads
168164
[go_tool]:https://golang.org/dl/
169165
[docker_tool]:https://docs.docker.com/install/
170166
[podman_tool]:https://github.com/containers/libpod/blob/master/install.md
171167
[buildah_tool]:https://github.com/containers/buildah/blob/master/install.md
172168
[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
169+
[olm-docs]: https://olm.operatorframework.io/
170+
[operator-framework-community]: https://github.com/operator-framework/community
171+
[operator-framework-communication]: https://github.com/operator-framework/community#get-involved
172+
[operator-framework-meetings]: https://github.com/operator-framework/community#meetings
173+
[contributor-documentation]: https://olm.operatorframework.io/docs/contribution-guidelines/
174+
[olm-getting-started]: https://olm.operatorframework.io/docs/getting-started/

doc/install/install.md

Lines changed: 0 additions & 135 deletions
This file was deleted.

0 commit comments

Comments
 (0)