Skip to content

Commit b9ad572

Browse files
authored
Merge pull request #993 from camilamacedo86/README
Readme adjustments
2 parents 8395ab7 + eee9e14 commit b9ad572

File tree

1 file changed

+51
-18
lines changed

1 file changed

+51
-18
lines changed

README.md

Lines changed: 51 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
[![Docker Repository on Quay](https://quay.io/repository/coreos/alm/status?token=ccfd2fde-446d-4d82-88a8-4386f8deaab0 "Docker Repository on Quay")](https://quay.io/repository/coreos/alm) [![Docker Repository on Quay](https://quay.io/repository/coreos/catalog/status?token=b5fc43ed-9f5f-408b-961b-c8493e983da5 "Docker Repository on Quay")](https://quay.io/repository/coreos/catalog)[![pipeline status](https://gitlab.com/operator-framework/operator-framework_operator-lifecycle-manager/badges/master/pipeline.svg)](https://gitlab.com/operator-framework/operator-framework_operator-lifecycle-manager/pipelines)
2-
31
<img src="/logo.svg" height="125px" alt="Operator Lifecycle Manager"></img>
42

3+
[![Docker Repository on Quay](https://quay.io/repository/coreos/alm/status?token=ccfd2fde-446d-4d82-88a8-4386f8deaab0 "Docker Repository on Quay")](https://quay.io/repository/coreos/alm)
4+
[![Docker Repository on Quay](https://quay.io/repository/coreos/catalog/status?token=b5fc43ed-9f5f-408b-961b-c8493e983da5 "Docker Repository on Quay")](https://quay.io/repository/coreos/catalog)
5+
[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
6+
[![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)
7+
8+
## Overview
9+
510
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).
611

712
OLM extends Kubernetes to provide a declarative way to install, manage, and upgrade operators and their dependencies in a cluster.
@@ -19,15 +24,39 @@ This project does not:
1924
* Replace [Helm](https://github.com/kubernetes/helm)
2025
* Turn Kubernetes into a [PaaS](https://en.wikipedia.org/wiki/Platform_as_a_service)
2126

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+
2236
## Getting Started
2337

24-
#### Installation
38+
### Installation
2539

2640
Install OLM on a Kubernetes or OpenShift cluster by following the [installation guide].
2741

2842
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).
2943

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.
55+
56+
**Subscription detail view:**
57+
![screenshot_20180628_165240](https://user-images.githubusercontent.com/11700385/42060125-c3cde42c-7af3-11e8-87ec-e5910a554902.png)
58+
59+
## Kubernetes-native Applications
3160

3261
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.
3362

@@ -42,11 +71,6 @@ ClusterServiceVersions can be collected into `CatalogSource`s which will allow a
4271

4372
Learn more about the components used by OLM by reading about the [architecture] and [philosophy].
4473

45-
[architecture]: /Documentation/design/architecture.md
46-
[philosophy]: /Documentation/design/philosophy.md
47-
[installation guide]: /Documentation/install/install.md
48-
49-
5074
# Key Concepts
5175

5276
## CustomResourceDefinitions
@@ -108,17 +132,26 @@ This will keep the etcd `ClusterServiceVersion` up to date as new versions becom
108132

109133
Catalogs are served internally over a grpc interface to OLM from [operator-registry](https://github.com/operator-framework/operator-registry) pods.
110134

111-
### User Interface
135+
## Samples
112136

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).
114138

115-
Ensure `kubectl` is pointing at a cluster and run:
139+
## Contributing
116140

117-
```shell
118-
$ make run-console-local
119-
```
141+
See the [proposal docs][proposals_docs] and issues for ongoing or planned work.
120142

121-
Then visit `http://localhost:9000` to view the console.
143+
## License
122144

123-
**Subscription detail view:**
124-
![screenshot_20180628_165240](https://user-images.githubusercontent.com/11700385/42060125-c3cde42c-7af3-11e8-87ec-e5910a554902.png)
145+
Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][license_file] file for details.
146+
147+
[architecture]: /Documentation/design/architecture.md
148+
[philosophy]: /Documentation/design/philosophy.md
149+
[installation guide]: /Documentation/install/install.md
150+
[git_tool]:https://git-scm.com/downloads
151+
[go_tool]:https://golang.org/dl/
152+
[docker_tool]:https://docs.docker.com/install/
153+
[podman_tool]:https://github.com/containers/libpod/blob/master/install.md
154+
[buildah_tool]:https://github.com/containers/buildah/blob/master/install.md
155+
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
156+
[proposals_docs]: ./Documentation/contributors/design-proposals
157+
[license_file]:./LICENSE

0 commit comments

Comments
 (0)