Skip to content

Commit 9464455

Browse files
authored
Remove install references to rukpak (#805)
Signed-off-by: Todd Short <[email protected]>
1 parent 8a00374 commit 9464455

File tree

8 files changed

+9
-511
lines changed

8 files changed

+9
-511
lines changed

.github/workflows/tilt.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@ jobs:
2222
- uses: actions/checkout@v4
2323
with:
2424
path: operator-controller
25-
- uses: actions/checkout@v4
26-
with:
27-
repository: operator-framework/rukpak
28-
path: rukpak
2925
- uses: actions/checkout@v4
3026
with:
3127
repository: operator-framework/catalogd

CONTRIBUTING.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,8 @@ The user experience captured in the OLM V1 PRD introduces many requirements that
1919
- [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.
2020
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.
2121
- [The Deppy project](https://github.com/operator-framework/deppy/), which enables the operator-controller to identify valid installs and upgrades from the list of installable content provided via the Catalogd project.
22-
- [The RukPak project](https://github.com/operator-framework/rukpak/), which facilitates the installation of operators.
2322

24-
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 introduces dependencies on RukPak, Deppy, and the Catalogd projects.
23+
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 introduces dependencies on Deppy and the Catalogd projects.
2524

2625
## How do we collaborate
2726

@@ -62,7 +61,7 @@ Ongoing or previous Operator-Controller milestones can always be found in the [m
6261

6362
### How are Subproject Issues Tracked?
6463

65-
As discussed earlier, the operator-controller adheres to a microservice architecture, where multiple projects contribute to the overall experience. As such, when designing an operator-controller milestone, the community may need to file an issue against RukPak, Deppy, or Catalogd. Unfortunately, the operator-controller milestone cannot contain issues from one of its subprojects. As such, we've introduced the concept of a "Dependency Issue", described below:
64+
As discussed earlier, the operator-controller adheres to a microservice architecture, where multiple projects contribute to the overall experience. As such, when designing an operator-controller milestone, the community may need to file an issue against Deppy or Catalogd. Unfortunately, the operator-controller milestone cannot contain issues from one of its subprojects. As such, we've introduced the concept of a "Dependency Issue", described below:
6665

6766
> Dependency Issues: An issue tracked in a milestone that "points" to an issue in another project with a URL.
6867
@@ -72,7 +71,6 @@ Unsure where to submit an issue?
7271
- [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.
7372
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.
7473
- [The Deppy project](https://github.com/operator-framework/deppy/), which enables the operator-controller to identify valid installs and upgrades from the list of installable content provided via the Catalogd project.
75-
- [The RukPak project](https://github.com/operator-framework/rukpak/), which facilitates the installation of operators.
7674

7775
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.
7876

Makefile

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ export IMAGE_TAG ?= devel
77
export CERT_MGR_VERSION ?= v1.9.0
88
export CATALOGD_VERSION ?= $(shell go list -mod=mod -m -f "{{.Version}}" github.com/operator-framework/catalogd)
99
export KAPP_VERSION ?= $(shell go list -mod=mod -m -f "{{.Version}}" github.com/vmware-tanzu/carvel-kapp-controller)
10-
export RUKPAK_VERSION=$(shell go list -mod=mod -m -f "{{.Version}}" github.com/operator-framework/rukpak)
1110
export WAIT_TIMEOUT ?= 60s
1211
IMG?=$(IMAGE_REPO):$(IMAGE_TAG)
1312
TESTDATA_DIR := testdata
@@ -167,7 +166,7 @@ endif
167166
kind-deploy: export MANIFEST="./operator-controller.yaml"
168167
kind-deploy: manifests $(KUSTOMIZE) #EXHELP Install controller and dependencies onto the kind cluster.
169168
$(KUSTOMIZE) build $(KUSTOMIZE_BUILD_DIR) > operator-controller.yaml
170-
envsubst '$$CATALOGD_VERSION,$$CERT_MGR_VERSION,$$KAPP_VERSION,$$RUKPAK_VERSION,$$MANIFEST' < scripts/install.tpl.sh | bash -s
169+
envsubst '$$CATALOGD_VERSION,$$CERT_MGR_VERSION,$$KAPP_VERSION,$$MANIFEST' < scripts/install.tpl.sh | bash -s
171170

172171
.PHONY: kind-cluster
173172
kind-cluster: $(KIND) #EXHELP Standup a kind cluster.
@@ -241,7 +240,7 @@ release: $(GORELEASER) #EXHELP Runs goreleaser for the operator-controller. By d
241240
quickstart: export MANIFEST="https://github.com/operator-framework/operator-controller/releases/download/$(VERSION)/operator-controller.yaml"
242241
quickstart: $(KUSTOMIZE) manifests #EXHELP Generate the installation release manifests and scripts.
243242
$(KUSTOMIZE) build $(KUSTOMIZE_BUILD_DIR) | sed "s/:devel/:$(VERSION)/g" > operator-controller.yaml
244-
envsubst '$$CATALOGD_VERSION,$$CERT_MGR_VERSION,$$KAPP_VERSION,$$RUKPAK_VERSION,$$MANIFEST' < scripts/install.tpl.sh > install.sh
243+
envsubst '$$CATALOGD_VERSION,$$CERT_MGR_VERSION,$$KAPP_VERSION,$$MANIFEST' < scripts/install.tpl.sh > install.sh
245244

246245
##@ Docs
247246

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ OLM v1 is the follow-up to OLM v0, located [here](https://github.com/operator-fr
1717
OLM v1 consists of four different components:
1818
* operator-controller (this repository)
1919
* [deppy](https://github.com/operator-framework/deppy)
20-
* [rukpak](https://github.com/operator-framework/rukpak)
2120
* [catalogd](https://github.com/operator-framework/catalogd)
2221

2322
For a more complete overview of OLM v1 and how it differs from OLM v0, see our [overview](./docs/olmv1_overview.md).
@@ -76,7 +75,7 @@ Install the CRDs and the operator-controller into a new [KIND cluster](https://k
7675
make run
7776
```
7877
This will build a local container image of the operator-controller, create a new KIND cluster and then deploy onto that cluster.
79-
This will also deploy the catalogd, rukpak and cert-manager dependencies.
78+
This will also deploy the catalogd and cert-manager dependencies.
8079

8180
### Modifying the API definitions
8281
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

docs/components.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,6 @@ OLM v1 is composed of various component projects:
22

33
* [operator-controller](https://github.com/operator-framework/operator-controller): operator-controller is the central component of OLM v1, that consumes all of the components below to extend Kubernetes to allows users to install, and manage the lifecycle of other extensions
44

5-
* [rukpak](https://github.com/operator-framework/rukpak): RukPak is a pluggable solution for the packaging and distribution of cloud-native content and supports advanced strategies for installation, updates, and policy. The project provides a content ecosystem for installing a variety of artifacts, such as Git repositories, Helm charts, OLM bundles, and more onto a Kubernetes cluster. These artifacts can then be managed, scaled, and upgraded in a safe way to enable powerful cluster extensions.
6-
At its core, RukPak is a small set of APIs, packaged as Kubernetes CustomResourceDefinitions, and controllers that watch for those APIs. These APIs express what content is being installed on-cluster and how to create a running deployment of the content.
7-
8-
95
* [deppy](https://github.com/operator-framework/deppy): Deppy is a Kubernetes API that runs on- or off-cluster for resolving constraints over catalogs of RukPak bundles. Deppy is part of the next iteration of OLM and was first introduced here. The initial goal of the project is to remove the dependency manager from the Operator Lifecycle Manager (OLM) and make it its own generic component.
106

11-
127
* [catalogD](https://github.com/operator-framework/catalogd): Catalogd is a Kubernetes extension that unpacks [file-based catalog (FBC)](https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs) content that is packaged and shipped in container images, for consumption by clients on-clusters (unpacking from other sources, like git repos, OCI artifacts etc, are in the roadmap for catalogD). As component of the Operator Lifecycle Manager (OLM) v1 microservices architecture, catalogD hosts metadata for Kubernetes extensions packaged by the authors of the extensions, as a result helping customers discover installable content.

scripts/install.tpl.sh

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,16 @@ fi
1111

1212
catalogd_version=$CATALOGD_VERSION
1313
cert_mgr_version=$CERT_MGR_VERSION
14-
rukpak_version=$RUKPAK_VERSION
1514
kapp_version=$KAPP_VERSION
1615

17-
if [[ -z "$catalogd_version" || -z "$cert_mgr_version" || -z "$rukpak_version" || -z "$kapp_version" ]]; then
16+
if [[ -z "$catalogd_version" || -z "$cert_mgr_version" || -z "$kapp_version" ]]; then
1817
err="Error: Missing component version(s) for: "
1918
if [[ -z "$catalogd_version" ]]; then
2019
err+="catalogd "
2120
fi
2221
if [[ -z "$cert_mgr_version" ]]; then
2322
err+="cert-manager "
2423
fi
25-
if [[ -z "$rukpak_version" ]]; then
26-
err+="rukpak "
27-
fi
2824
if [[ -z "$kapp_version" ]]; then
2925
err+="kapp "
3026
fi
@@ -46,11 +42,6 @@ kubectl_wait "cert-manager" "deployment/cert-manager-webhook" "60s"
4642
kubectl apply -f "https://github.com/carvel-dev/kapp-controller/releases/download/${kapp_version}/release.yml"
4743
kubectl_wait "kapp-controller" "deployment.apps/kapp-controller" 60s
4844

49-
kubectl apply -f "https://github.com/operator-framework/rukpak/releases/download/${rukpak_version}/rukpak.yaml"
50-
kubectl_wait "rukpak-system" "deployment/core" "60s"
51-
kubectl_wait "rukpak-system" "deployment/helm-provisioner" "60s"
52-
kubectl_wait "rukpak-system" "deployment/rukpak-webhooks" "60s"
53-
5445
kubectl apply -f "https://github.com/operator-framework/catalogd/releases/download/${catalogd_version}/catalogd.yaml"
5546
kubectl_wait "catalogd-system" "deployment/catalogd-controller-manager" "60s"
5647

0 commit comments

Comments
 (0)