You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
User documentation can be found on the [OLM website][olm-docs].
10
+
7
11
## Overview
8
12
9
13
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/).
10
14
11
15
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:
12
16
13
17
### Over-the-Air Updates and Catalogs
18
+
14
19
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.
15
20
16
21
### Dependency Model
22
+
17
23
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.
18
24
19
25
### Discoverability
26
+
20
27
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.
21
28
22
29
### Cluster Stability
30
+
23
31
Operators must claim ownership of their APIs. OLM will prevent conflicting Operators owning the same APIs being installed, ensuring cluster stability.
24
32
25
33
### 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.
27
34
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.
28
36
29
37
## Prerequisites
30
38
@@ -37,17 +45,17 @@ Operators can behave like managed service providers. Their user interface on the
37
45
38
46
## Getting Started
39
47
48
+
Check the [Getting Started][olm-getting-started] section.
49
+
40
50
### Installation
41
51
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].
43
53
44
54
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
55
46
-
**NOTE:** OLM is installed by default in OpenShift 4.0 and above.
47
-
48
56
## User Interface (Running the console Locally)
49
57
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.
51
59
52
60
Ensure `kubectl` is pointing at a cluster and run:
53
61
@@ -57,7 +65,6 @@ $ make run-console-local
57
65
58
66
Then visit `http://localhost:9000` to view the console.
59
67
60
-
61
68
## Contributing your Operator
62
69
63
70
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
149
156
150
157
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).
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.
155
168
156
169
## Reporting bugs
157
170
@@ -163,13 +176,19 @@ Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][licens
0 commit comments