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
+51-18Lines changed: 51 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,12 @@
1
-
[](https://quay.io/repository/coreos/alm)[](https://quay.io/repository/coreos/catalog)[](https://gitlab.com/operator-framework/operator-framework_operator-lifecycle-manager/pipelines)
[](https://quay.io/repository/coreos/alm)
4
+
[](https://quay.io/repository/coreos/catalog)
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://coreos.com/blog/introducing-operator-framework).
6
11
7
12
OLM extends Kubernetes to provide a declarative way to install, manage, and upgrade operators and their dependencies in a cluster.
* Turn Kubernetes into a [PaaS](https://en.wikipedia.org/wiki/Platform_as_a_service)
21
26
27
+
## Prerequisites
28
+
29
+
-[git][git_tool]
30
+
-[go][go_tool] version v1.12+.
31
+
-[docker][docker_tool] version 17.03+.
32
+
- Alternatively [podman][podman_tool]`v1.2.0+` or [buildah][buildah_tool]`v1.7+`
33
+
-[kubectl][kubectl_tool] version v1.11.3+.
34
+
- Access to a Kubernetes v1.11.3+ cluster.
35
+
22
36
## Getting Started
23
37
24
-
####Installation
38
+
### Installation
25
39
26
40
Install OLM on a Kubernetes or OpenShift cluster by following the [installation guide].
27
41
28
42
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).
29
43
30
-
#### Kubernetes-native Applications
44
+
### User Interface
45
+
46
+
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.
47
+
48
+
Ensure `kubectl` is pointing at a cluster and run:
49
+
50
+
```shell
51
+
$ make run-console-local
52
+
```
53
+
54
+
Then visit `http://localhost:9000` to view the console.
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.
33
62
@@ -42,11 +71,6 @@ ClusterServiceVersions can be collected into `CatalogSource`s which will allow a
42
71
43
72
Learn more about the components used by OLM by reading about the [architecture] and [philosophy].
@@ -108,17 +132,26 @@ This will keep the etcd `ClusterServiceVersion` up to date as new versions becom
108
132
109
133
Catalogs are served internally over a grpc interface to OLM from [operator-registry](https://github.com/operator-framework/operator-registry) pods.
110
134
111
-
### User Interface
135
+
## Samples
112
136
113
-
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.
137
+
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).
114
138
115
-
Ensure `kubectl` is pointing at a cluster and run:
139
+
## Contributing
116
140
117
-
```shell
118
-
$ make run-console-local
119
-
```
141
+
See the [proposal docs][proposals_docs] and issues for ongoing or planned work.
120
142
121
-
Then visit `http://localhost:9000` to view the console.
0 commit comments