-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
(docs): Add docs on fetching contents via HTTP server #166
Merged
stevekuznetsov
merged 2 commits into
operator-framework:main
from
everettraven:docs/fetch-catalog-http
Sep 13, 2023
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Fetching `Catalog` contents from the Catalogd HTTP Server | ||
This document covers how to fetch the contents for a `Catalog` from the | ||
Catalogd HTTP Server that runs when the `HTTPServer` feature-gate is enabled | ||
(enabled by default). | ||
|
||
All `Catalog`s currently have their contents served via the following endpoint pattern: | ||
`http://{httpServerBaseUrl}/catalogs/{Catalog.Name}/all.json` | ||
|
||
All responses will be a JSON stream where each JSON object is a File-Based Catalog (FBC) | ||
object. | ||
|
||
For example purposes we make the following assumption: | ||
- A `Catalog` named `operatorhubio` has been created and successfully unpacked | ||
(denoted in the `Catalog.Status`) | ||
|
||
## On cluster | ||
|
||
When making a request for the contents of the `operatorhubio` `Catalog` from within | ||
the cluster issue a HTTP `GET` request to | ||
`http://catalogd-catalogserver.catalogd-system.svc/catalogs/operatorhubio/all.json` | ||
|
||
An example command to run a `Pod` to `curl` the catalog contents: | ||
```sh | ||
kubectl run fetcher --image=curlimages/curl:latest -- curl http://catalogd-catalogserver.catalogd-system.svc/catalogs/operatorhubio/all.json | ||
``` | ||
|
||
## Off cluster | ||
|
||
When making a request for the contents of the `operatorhubio` `Catalog` from outside | ||
the cluster, we have to perform an extra step: | ||
1. Port forward the `catalogd-catalogserver` service in the `catalogd-system` namespace: | ||
```sh | ||
kubectl -n catalogd-system port-forward svc/catalogd-catalogserver <port>:80 | ||
``` | ||
|
||
Once the service has been successfully forwarded to a localhost port, issue a HTTP `GET` | ||
request to `http://localhost:<port>/catalogs/operatorhubio/all.json` | ||
|
||
An example `curl` request that assumes the port-forwarding is mapped to port 8080 on the local machine: | ||
```sh | ||
curl http://localhost:8080/catalogs/operatorhubio/all.json | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When I'm a user looking at these, I usually want copy-paste-able blobs. Can we add a
curl
example to this?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added some copy-paste-able blobs in 755ce7a