Skip to content

Commit

Permalink
fixup! Update introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelryanpeter committed Jun 9, 2023
1 parent b174d8d commit 1be4af0
Showing 1 changed file with 34 additions and 31 deletions.
65 changes: 34 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,59 @@
# catalogd

Catalogd is a Kubernetes extension that unpacks and serves the package and bundle metadata of file-based catalog (FBC) content into on-cluster APIs. As component of the Operator Lifecycle Manager (OLM) v1 microservices architecture, catalogd hosts Operators and controllers that extend Kubernetes APIs and helps customers discover installable content.

In its current state, the catalogd prototype is a custom API server that uses a (dedicated ectd instance)[configs/etcd] to serve [FBC](https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs) content on cluster in a Kubernetes-native way.
Catalogd is a Kubernetes extension that unpacks [file-based catalog (FBC)](https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs) content for on-cluster APIs. As component of the Operator Lifecycle Manager (OLM) v1 microservices architecture, catalogd hosts Operators and controllers that extend Kubernetes APIs and helps customers discover installable content.

## OLM v1 ecosystem
[Describe OLM v1 at a high level]
[Link to PRD]
[Link to Milestones]

### OLM v1 components

[List and describe OLM v1 components]

## Quick start
**NOTE:** Procedure steps marked with an astericks (`*`) are likely to change in future API changes.

1. To install catalogd, perform one of the following actions:
- Install the operator-controller, which includes catalogd, by entering the following command:
```sh
$ curl -L -s https://github.com/operator-framework/operator-controller/releases/download/v0.2.0/install.sh | bash -s
```
- Follow the install instructions included in the latest release[link] of catalogd.
- Install the operator-controller, which includes catalogd, by entering the following command:
```sh
$ curl -L -s https://github.com/operator-framework/operator-controller/releases/download/v0.2.0/install.sh | bash -s
```
- To install catalogd, without installing the operator-controller, follow the install instructions included in the latest release[link] of catalogd.

1. Create a `Catalog` object that points to the OperatorHub Community catalog by running the following command:
```sh
$ kubectl apply -f - << EOF
apiVersion: catalogd.operatorframework.io/v1alpha1
kind: Catalog
metadata:
name: operatorhubio
spec:
source:
type: image
image:
ref: quay.io/operatorhubio/catalog:latest
EOF
```

```sh
$ kubectl apply -f - << EOF
apiVersion: catalogd.operatorframework.io/v1alpha1
kind: Catalog
metadata:
name: operatorhubio
spec:
source:
type: image
image:
ref: quay.io/operatorhubio/catalog:latest
EOF
```
1. Verify the `Catalog` object was created successfully by running the following command:
```sh
$ kubectl describe catalog/operatorhubio
```
- **Example output**
```sh
$ kubectl describe catalog/operatorhubio
```
1. Run the following command to get a list of packages: `*`
```sh
$ kubectl get packages
```
```sh
$ kubectl get packages
```
1. Run the following command to get a list of bundles: `*`
```sh
$ kubectl get bundlemetadata
```
```sh
$ kubectl get bundlemetadata
```
## Contributing
Thanks for your interest in contributing to `catalogd`!
Expand Down

0 comments on commit 1be4af0

Please sign in to comment.