Skip to content

Commit 8dea29f

Browse files
[Monorepo] Move catalogd/README.md content to project README
- Integrated relevant content from catalogd/README.md into the project's main README by adding Demo and Quick-Start steps from catalogd/README.md to the main README. - Removed the old catalogd/README.md as its remaining content (e.g., contribution guidelines) is already covered in CONTRIBUTING.md.
1 parent 8ef9242 commit 8dea29f

File tree

2 files changed

+147
-170
lines changed

2 files changed

+147
-170
lines changed

README.md

Lines changed: 147 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ controllers, and tooling that support the packaging, distribution, and lifecycli
1414
OLM v1 consists of two different components:
1515

1616
* operator-controller (this repository)
17-
* [catalogd](https://github.com/operator-framework/catalogd)
17+
* catalogd (this repository under the directory catalogd/)
1818

1919
For a more complete overview of OLM v1 and how it differs from OLM v0, see our [overview](docs/project/olmv1_design_decisions.md).
2020

@@ -26,6 +26,152 @@ The documentation currently lives at [website](https://operator-framework.github
2626

2727
To get started with OLM v1, please see our [Getting Started](https://operator-framework.github.io/operator-controller/getting-started/olmv1_getting_started/) documentation.
2828

29+
## Quickstart DEMO
30+
31+
[![asciicast](https://asciinema.org/a/682344.svg)](https://asciinema.org/a/682344)
32+
33+
## Quickstart Steps
34+
35+
Procedure steps marked with an asterisk (`*`) are likely to change with future API updates.
36+
37+
**NOTE:** The examples below use the `-k` flag in curl to skip validating the TLS certificates. This is for demonstration purposes only.
38+
39+
1. To get started with OLM v1, please see our [Getting Started](https://operator-framework.github.io/operator-controller/getting-started/olmv1_getting_started/) documentation.
40+
41+
1. Create a `ClusterCatalog` object that points to the OperatorHub Community catalog by running the following command:
42+
43+
```sh
44+
$ kubectl apply -f - << EOF
45+
apiVersion: olm.operatorframework.io/v1
46+
kind: ClusterCatalog
47+
metadata:
48+
name: operatorhubio
49+
spec:
50+
source:
51+
type: Image
52+
image:
53+
ref: quay.io/operatorhubio/catalog:latest
54+
EOF
55+
```
56+
57+
1. Verify the `ClusterCatalog` object was created successfully by running the following command:
58+
59+
```sh
60+
$ kubectl describe clustercatalog/operatorhubio
61+
```
62+
63+
*Example output*
64+
```sh
65+
Name: operatorhubio
66+
Namespace:
67+
Labels: olm.operatorframework.io/metadata.name=operatorhubio
68+
Annotations: <none>
69+
API Version: olm.operatorframework.io/v1
70+
Kind: ClusterCatalog
71+
Metadata:
72+
Creation Timestamp: 2024-10-17T13:48:46Z
73+
Finalizers:
74+
olm.operatorframework.io/delete-server-cache
75+
Generation: 1
76+
Resource Version: 7908
77+
UID: 34eeaa91-9f8e-4254-9937-0ae9d25e92df
78+
Spec:
79+
Availability Mode: Available
80+
Priority: 0
81+
Source:
82+
Image:
83+
Ref: quay.io/operatorhubio/catalog:latest
84+
Type: Image
85+
Status:
86+
Conditions:
87+
Last Transition Time: 2024-10-17T13:48:59Z
88+
Message: Successfully unpacked and stored content from resolved source
89+
Observed Generation: 1
90+
Reason: Succeeded
91+
Status: False
92+
Type: Progressing
93+
Last Transition Time: 2024-10-17T13:48:59Z
94+
Message: Serving desired content from resolved source
95+
Observed Generation: 1
96+
Reason: Available
97+
Status: True
98+
Type: Serving
99+
Last Unpacked: 2024-10-17T13:48:58Z
100+
Resolved Source:
101+
Image:
102+
Last Successful Poll Attempt: 2024-10-17T14:49:59Z
103+
Ref: quay.io/operatorhubio/catalog@sha256:82be554b15ff246d8cc428f8d2f4cf5857c02ce3225d95d92a769ea3095e1fc7
104+
Type: Image
105+
Urls:
106+
Base: https://catalogd-service.olmv1-system.svc/catalogs/operatorhubio
107+
Events: <none>
108+
```
109+
110+
1. Port forward the `catalogd-service` service in the `olmv1-system` namespace:
111+
```sh
112+
$ kubectl -n olmv1-system port-forward svc/catalogd-service 8080:443
113+
```
114+
115+
1. Access the `v1/all` service endpoint and filter the results to a list of packages by running the following command:
116+
117+
```sh
118+
$ curl https://localhost:8080/catalogs/operatorhubio/api/v1/all | jq -s '.[] | select(.schema == "olm.package") | .name'
119+
```
120+
121+
*Example output*
122+
```sh
123+
% Total % Received % Xferd Average Speed Time Time Time Current
124+
Dload Upload Total Spent Left Speed
125+
100 110M 100 110M 0 0 112M 0 --:--:-- --:--:-- --:--:-- 112M
126+
"ack-acm-controller"
127+
"ack-apigatewayv2-controller"
128+
"ack-applicationautoscaling-controller"
129+
"ack-cloudtrail-controller"
130+
"ack-cloudwatch-controller"
131+
"ack-dynamodb-controller"
132+
"ack-ec2-controller"
133+
"ack-ecr-controller"
134+
"ack-eks-controller"
135+
"ack-elasticache-controller"
136+
"ack-emrcontainers-controller"
137+
"ack-eventbridge-controller"
138+
"ack-iam-controller"
139+
"ack-kinesis-controller"
140+
...
141+
```
142+
1. Run the following command to get a list of channels for the `ack-acm-controller` package:
143+
144+
```sh
145+
$ curl https://localhost:8080/catalogs/operatorhubio/api/v1/all | jq -s '.[] | select(.schema == "olm.channel") | select(.package == "ack-acm-controller") | .name'
146+
```
147+
148+
*Example output*
149+
```sh
150+
% Total % Received % Xferd Average Speed Time Time Time Current
151+
Dload Upload Total Spent Left Speed
152+
100 110M 100 110M 0 0 115M 0 --:--:-- --:--:-- --:--:-- 116M
153+
"alpha"
154+
```
155+
156+
1. Run the following command to get a list of bundles belonging to the `ack-acm-controller` package:
157+
158+
```sh
159+
$ curl https://localhost:8080/catalogs/operatorhubio/api/v1/all | jq -s '.[] | select(.schema == "olm.bundle") | select(.package == "ack-acm-controller") | .name'
160+
```
161+
162+
*Example output*
163+
```sh
164+
% Total % Received % Xferd Average Speed Time Time Time Current
165+
Dload Upload Total Spent Left Speed
166+
100 110M 100 110M 0 0 122M 0 --:--:-- --:--:-- --:--:-- 122M
167+
"ack-acm-controller.v0.0.1"
168+
"ack-acm-controller.v0.0.2"
169+
"ack-acm-controller.v0.0.4"
170+
"ack-acm-controller.v0.0.5"
171+
"ack-acm-controller.v0.0.6"
172+
"ack-acm-controller.v0.0.7"
173+
```
174+
29175
## License
30176
31177
Copyright 2022-2024.

catalogd/README.md

Lines changed: 0 additions & 169 deletions
This file was deleted.

0 commit comments

Comments
 (0)