Skip to content

Commit

Permalink
[Monorepo] Update documentation for old catalogd repository references
Browse files Browse the repository at this point in the history
- Replaced references to https://github.com/operator-framework/catalogd/ across the documentation.
- Ensures that all mentions of the old catalogd repository are correctly updated.
  • Loading branch information
camilamacedo86 committed Jan 14, 2025
1 parent 7a6fa07 commit 8ef9242
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 9 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ As you may or may not know, the Operator-Controller project aims to deliver the
The user experience captured in the OLM V1 PRD introduces many requirements that are best satisfied by a microservices architecture. The OLM V1 experience currently relies on two projects:

- [The Operator-Controller project](https://github.com/operator-framework/operator-controller/), which is the top level component allowing users to specify operators they'd like to install.
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.
- [The Catalogd project](https://github.com/operator-framework/operator-controller/tree/main/catalogd), which hosts operator content and helps users discover installable content.

Each of the projects listed above have their own governance, release milestones, and release cadence. However, from a technical perspective, the "OLM V1 experience" matches the experienced offered by the operator-controller project, the top level component which depends on Catalogd.

Expand Down Expand Up @@ -120,7 +120,6 @@ As discussed earlier, the operator-controller adheres to a microservice architec
Unsure where to submit an issue?
- [The Operator-Controller project](https://github.com/operator-framework/operator-controller/), which is the top level component allowing users to specify operators they'd like to install.
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.

Don't worry if you accidentally submit an issue against the wrong project, if we notice that an issue would fit better with a separate project we'll move it to the correct repository and mention it in the #olm-dev slack channel.

Expand Down
6 changes: 3 additions & 3 deletions catalogd/docs/fetching-catalog-contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,11 @@ This section outlines a way of exposing the `Catalogd` Service's endpoints outsi

- [Install kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
- Assuming `kind` is installed, create a `kind` cluster with `extraPortMappings` and `node-labels` as shown in the [kind documentation](https://kind.sigs.k8s.io/docs/user/ingress/)
- Install latest version of `Catalogd` by navigating to the [releases page](https://github.com/operator-framework/catalogd/releases) and following the install instructions included in the release you want to install.
- Install OLMV1, see the [Getting Started](https://operator-framework.github.io/operator-controller/getting-started/olmv1_getting_started/) documentation.
- Install the `Ingress NGINX` Controller by running the below command:

```sh
$ kubectl apply -k https://github.com/operator-framework/catalogd/tree/main/config/nginx-ingress
$ kubectl apply -k https://github.com/operator-framework/operator-controller/tree/main/catalogd/config/base/nginx-ingress
```
By running that above command, the `Ingress` Controller is installed. Along with it, the `Ingress` Resource will be applied automatically as well, thereby creating an `Ingress` Object on the cluster.

Expand Down Expand Up @@ -201,4 +201,4 @@ This section outlines a way of exposing the `Catalogd` Service's endpoints outsi
$ kubectl -n olmv1-system get ingress
```

You can further use the `curl` commands outlined in the [Catalogd README](https://github.com/operator-framework/catalogd/blob/main/README.md) to filter out the JSON content by list of bundles, channels & packages.
You can further use the `curl` commands outlined in the [README](https://github.com/operator-framework/operator-controller/blob/main/README.md) to filter out the JSON content by list of bundles, channels & packages.
2 changes: 1 addition & 1 deletion docs/api-reference/catalogd-webserver.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Catalogd web server

[Catalogd](https://github.com/operator-framework/catalogd), the OLM v1 component for making catalog contents available on cluster, includes
[Catalogd](https://github.com/operator-framework/operator-controller/tree/main/catalogd), the OLM v1 component for making catalog contents available on cluster, includes
a web server that serves catalog contents to clients via an HTTP(S) endpoint.

The endpoint to retrieve this information can be composed from the `.status.urls.base` of a `ClusterCatalog` resource with the selected access API path.
Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Follow Tilt's [instructions](https://docs.tilt.dev/install.html) for installatio
### Installing catalogd
operator-controller requires
[catalogd](https://github.com/operator-framework/catalogd). Please make sure it's installed, either normally or via its own Tiltfile., before proceeding. If you want to use Tilt, make sure you specify a unique `--port` flag to each `tilt up` invocation.
[catalogd](https://github.com/operator-framework/operator-controller/tree/main/catalogd). Please make sure it's installed, either normally or via its own Tiltfile., before proceeding. If you want to use Tilt, make sure you specify a unique `--port` flag to each `tilt up` invocation.

### Starting Tilt

Expand Down
2 changes: 1 addition & 1 deletion docs/project/olmv1_architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide:
This document provides an overview of the architecture of OLM v1, which consists of two primary components:

1. [operator-controller](https://github.com/operator-framework/operator-controller)
2. [catalogD](https://github.com/operator-framework/catalogd)
2. [catalogD](https://github.com/operator-framework/operator-controller/tree/main/catalogd)

The diagram below visually represents the architecture of OLM v1, followed by descriptions of each component and its role within the system.

Expand Down
1 change: 0 additions & 1 deletion docs/tutorials/add-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ This catalog is distributed as an image [quay.io/operatorhubio/catalog](https://

* Access to a Kubernetes cluster, for example `kind`, using an account with `cluster-admin` permissions
* [Operator Controller installed](https://github.com/operator-framework/operator-controller/releases) on the cluster
* [Catalogd installed](https://github.com/operator-framework/catalogd/releases/) on the cluster
* Kubernetes CLI (`kubectl`) installed on your workstation

## Procedure
Expand Down

0 comments on commit 8ef9242

Please sign in to comment.