Skip to content

Commit f7214b2

Browse files
feat(README) : Update info regards subscription and to address the users to operatorhub.io
1 parent 904e268 commit f7214b2

File tree

1 file changed

+9
-26
lines changed

1 file changed

+9
-26
lines changed

README.md

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [User Interface (Running the console Locally)](#user-interface-running-the-console-locally)
1414
- [Subscribe to a Package and Channel](#subscribe-to-a-package-and-channel)
1515
- [End-to-end example](#end-to-end-example)
16+
- [Contributing with Operator catalogue](#contributing-with-operator-catalogue)
1617
- [Key Concepts](#key-concepts)
1718
- [Kubernetes-native Applications](#kubernetes-native-applications)
1819
- [CustomResourceDefinitions](#customresourcedefinitions)
@@ -79,40 +80,22 @@ $ make run-console-local
7980

8081
Then visit `http://localhost:9000` to view the console.
8182

82-
**Subscription detail view:**
83-
![screenshot_20180628_165240](https://user-images.githubusercontent.com/11700385/42060125-c3cde42c-7af3-11e8-87ec-e5910a554902.png)
84-
8583
## Subscribe to a Package and Channel
8684

8785
Cloud Services can be installed from the catalog by subscribing to a channel in the corresponding package.
8886

89-
If using one of the `local` run options, this will subscribe to `etcd`, `vault`, and `prometheus` operators. Subscribing to a service that doesn't exist yet will install the operator and related CRDs in the namespace.
87+
**Subscription detail view:**
88+
![screenshot_20180628_165240](https://user-images.githubusercontent.com/11700385/42060125-c3cde42c-7af3-11e8-87ec-e5910a554902.png)
9089

91-
```yaml
92-
apiVersion: operators.coreos.com/v1alpha1
93-
kind: Subscription
94-
metadata:
95-
name: etcd
96-
namespace: local
97-
spec:
98-
channel: alpha
99-
name: etcd
100-
source: rh-operators
101-
---
102-
apiVersion: operators.coreos.com/v1alpha1
103-
kind: Subscription
104-
metadata:
105-
name: prometheus
106-
namespace: local
107-
spec:
108-
channel: alpha
109-
name: prometheus
110-
source: rh-operators
111-
```
90+
NOTE: The operators available in the catalogue by default are that ones which are published in https://operatorhub.io/.
11291

11392
## End-to-end example
11493

115-
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).
94+
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).
95+
96+
## Contributing with Operator catalogue
97+
98+
Check how to [Publish your Operator on OperatorHub.io](https://operatorhub.io/contribute).
11699

117100
# Key Concepts
118101

0 commit comments

Comments
 (0)