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
[](https://quay.io/repository/operator-framework/olm)
User documentation can be found on the [OLM website][olm-docs].
12
12
13
-
14
13
## Overview
15
14
16
15
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 the [OLM website][olm-docs].
@@ -56,18 +55,6 @@ Install OLM on a Kubernetes cluster by following the [installation guide][instal
56
55
57
56
For a complete end-to-end example of how OLM fits into the Operator Framework, see the [Operator Framework website](https://operatorframework.io/about/) and the [Getting Started guide on OperatorHub.io](https://operatorhub.io/getting-started).
58
57
59
-
## User Interface (Running the console Locally)
60
-
61
-
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.
62
-
63
-
Ensure `kubectl` is pointing at a cluster and run:
64
-
65
-
```shell
66
-
make run-console-local
67
-
```
68
-
69
-
Then visit `http://localhost:9000` to view the console.
70
-
71
58
## Contributing your Operator
72
59
73
60
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/).
@@ -97,7 +84,7 @@ Learn more about the components used by OLM by reading about the [architecture]
97
84
98
85
OLM standardizes interactions with operators by requiring that the interface to an operator be via the Kubernetes API. Because we expect users to define the interfaces to their applications, OLM currently uses CRDs to define the Kubernetes API interactions.
@@ -112,10 +99,10 @@ To minimize the effort required to run an application on kubernetes, OLM handles
112
99
113
100
This is achieved through additional metadata on the application definition. Each operator must define:
114
101
115
-
- The CRDs that it is responsible for managing.
116
-
- e.g., the etcd operator manages `EtcdCluster`.
117
-
- The CRDs that it depends on.
118
-
- e.g., the vault operator depends on `EtcdCluster`, because Vault is backed by etcd.
102
+
- The CRDs that it is responsible for managing.
103
+
- e.g., the etcd operator manages `EtcdCluster`.
104
+
- The CRDs that it depends on.
105
+
- e.g., the vault operator depends on `EtcdCluster`, because Vault is backed by etcd.
119
106
120
107
Basic dependency resolution is then possible by finding, for each “required” CRD, the corresponding operator that manages it and installing it as well. Dependency resolution can be further constrained by the way a user interacts with catalogs.
0 commit comments