Skip to content

Commit

Permalink
Update quick start procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelryanpeter committed Jun 9, 2023
1 parent 274d052 commit b174d8d
Showing 1 changed file with 42 additions and 52 deletions.
94 changes: 42 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,62 +4,52 @@ Catalogd is a Kubernetes extension that unpacks and serves the package and bundl

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.

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

https://hackmd.io/@i2YBW1rSQ8GcKcTIHn9CCA/B1cMe1kHj
### OLM v1 components

## Quickstart.

## 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
```
$ kind create cluster
$ kubectl apply -f https://github.com/operator-framework/catalogd/config/crd/bases/
$ kubectl apply -f https://github.com/operator-framework/catalogd/config/
$ kubectl create ns test
$ kubectl apply -f config/samples/core_v1alpha1_catalog.yaml
$ kubectl get catalog -n test
NAME AGE
catalog-sample 98s
$ kubectl get bundlemetadata -n test
NAME AGE
3scale-community-operator.v0.7.0 28s
3scale-community-operator.v0.8.2 28s
3scale-community-operator.v0.9.0 28s
falcon-operator.v0.5.1 2s
falcon-operator.v0.5.2 2s
falcon-operator.v0.5.3 1s
falcon-operator.v0.5.4 1s
falcon-operator.v0.5.5 1s
flux.v0.13.4 1s
flux.v0.14.0 1s
flux.v0.14.1 1s
flux.v0.14.2 1s
flux.v0.15.2 1s
flux.v0.15.3 1s
.
.
.
$ kubectl get packages -n test
NAME AGE
3scale-community-operator 77m
ack-apigatewayv2-controller 77m
ack-applicationautoscaling-controller 77m
ack-dynamodb-controller 77m
ack-ec2-controller 77m
ack-ecr-controller 77m
ack-eks-controller 77m
ack-elasticache-controller 77m
ack-emrcontainers-controller 77m
ack-iam-controller 77m
ack-kms-controller 77m
ack-lambda-controller 77m
ack-mq-controller 77m
ack-opensearchservice-controller 77m
.
.
.
- 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
```

1. Verify the `Catalog` object was created successfully by running the following command:
```sh
$ kubectl describe catalog/operatorhubio
```
- **Example output**

1. Run the following command to get a list of packages: `*`
```sh
$ kubectl get packages
```

1. Run the following command to get a list of bundles: `*`
```sh
$ kubectl get bundlemetadata
```

## Contributing
Expand Down

0 comments on commit b174d8d

Please sign in to comment.