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
Copy file name to clipboardExpand all lines: README.md
+8-14Lines changed: 8 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ Operators can behave like managed service providers. Their user interface on the
43
43
-[kubectl][kubectl_tool] version v1.11.3+.
44
44
- Access to a Kubernetes v1.11.3+ cluster.
45
45
46
-
## Getting Started
46
+
## Getting Started
47
47
48
48
Check the [Getting Started][olm-getting-started] section.
49
49
@@ -60,7 +60,7 @@ Use the admin console to interact with and visualize the resources managed by OL
60
60
Ensure `kubectl` is pointing at a cluster and run:
61
61
62
62
```shell
63
-
$ make run-console-local
63
+
make run-console-local
64
64
```
65
65
66
66
Then visit `http://localhost:9000` to view the console.
@@ -69,13 +69,6 @@ Then visit `http://localhost:9000` to view the console.
69
69
70
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/).
71
71
72
-
## Subscribe to a Package and Channel
73
-
74
-
Cloud Services can be installed from the catalog by subscribing to a channel in the corresponding package.
An Operator is an application-specific controller that extends the Kubernetes API to create, configure, manage, and operate instances of complex applications on behalf of a user.
@@ -95,7 +88,7 @@ Learn more about the components used by OLM by reading about the [architecture]
95
88
96
89
## CustomResourceDefinitions
97
90
98
-
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.
91
+
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.
@@ -111,9 +104,9 @@ To minimize the effort required to run an application on kubernetes, OLM handles
111
104
112
105
This is achieved through additional metadata on the application definition. Each operator must define:
113
106
114
-
- The CRDs that it is responsible for managing.
107
+
- The CRDs that it is responsible for managing.
115
108
- e.g., the etcd operator manages `EtcdCluster`.
116
-
- The CRDs that it depends on.
109
+
- The CRDs that it depends on.
117
110
- e.g., the vault operator depends on `EtcdCluster`, because Vault is backed by etcd.
118
111
119
112
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.
@@ -125,7 +118,8 @@ Dependency resolution is driven through the `(Group, Version, Kind)` of CRDs. Th
125
118
There is no way to express a dependency on a particular version of an operator (e.g. `etcd-operator v0.9.0`) or application instance (e.g. `etcd v3.2.1`). This encourages application authors to depend on the interface and not the implementation.
126
119
127
120
## Discovery, Catalogs, and Automated Upgrades
128
-
OLM has the concept of catalogs, which are repositories of application definitions and CRDs.
121
+
122
+
OLM has the concept of catalogs, which are repositories of application definitions and CRDs.
129
123
130
124
Catalogs contain a set of Packages, which map “channels” to a particular application definition. Channels allow package authors to write different upgrade paths for different users (e.g. alpha vs. stable).
131
125
@@ -154,7 +148,7 @@ Catalogs are served internally over a grpc interface to OLM from [operator-regis
154
148
155
149
## Samples
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).
151
+
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).
0 commit comments