Skip to content

Commit 8ef9242

Browse files
[Monorepo] Update documentation for old catalogd repository references
- Replaced references to https://github.com/operator-framework/catalogd/ across the documentation. - Ensures that all mentions of the old catalogd repository are correctly updated.
1 parent 7a6fa07 commit 8ef9242

File tree

6 files changed

+7
-9
lines changed

6 files changed

+7
-9
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ As you may or may not know, the Operator-Controller project aims to deliver the
1818
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:
1919

2020
- [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.
21-
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.
21+
- [The Catalogd project](https://github.com/operator-framework/operator-controller/tree/main/catalogd), which hosts operator content and helps users discover installable content.
2222

2323
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.
2424

@@ -120,7 +120,6 @@ As discussed earlier, the operator-controller adheres to a microservice architec
120120
Unsure where to submit an issue?
121121
122122
- [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.
123-
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.
124123

125124
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.
126125

catalogd/docs/fetching-catalog-contents.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,11 +133,11 @@ This section outlines a way of exposing the `Catalogd` Service's endpoints outsi
133133

134134
- [Install kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
135135
- 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/)
136-
- 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.
136+
- Install OLMV1, see the [Getting Started](https://operator-framework.github.io/operator-controller/getting-started/olmv1_getting_started/) documentation.
137137
- Install the `Ingress NGINX` Controller by running the below command:
138138

139139
```sh
140-
$ kubectl apply -k https://github.com/operator-framework/catalogd/tree/main/config/nginx-ingress
140+
$ kubectl apply -k https://github.com/operator-framework/operator-controller/tree/main/catalogd/config/base/nginx-ingress
141141
```
142142
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.
143143

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

204-
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.
204+
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.

docs/api-reference/catalogd-webserver.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Catalogd web server
22

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

66
The endpoint to retrieve this information can be composed from the `.status.urls.base` of a `ClusterCatalog` resource with the selected access API path.

docs/contribute/developer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Follow Tilt's [instructions](https://docs.tilt.dev/install.html) for installatio
8989
### Installing catalogd
9090
9191
operator-controller requires
92-
[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.
92+
[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.
9393

9494
### Starting Tilt
9595

docs/project/olmv1_architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ hide:
88
This document provides an overview of the architecture of OLM v1, which consists of two primary components:
99

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

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

docs/tutorials/add-catalog.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ This catalog is distributed as an image [quay.io/operatorhubio/catalog](https://
1818

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

2423
## Procedure

0 commit comments

Comments
 (0)