Skip to content

Commit

Permalink
update readme with how to build and deploy catalog
Browse files Browse the repository at this point in the history
Signed-off-by: Mohamed Mahmoud <[email protected]>
  • Loading branch information
msherif1234 committed Jul 12, 2024
1 parent 5f99b07 commit 4f16278
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 5 deletions.
5 changes: 2 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ IMAGE_TAG ?= latest
BPFMAN_IMG ?= quay.io/bpfman/bpfman:$(IMAGE_TAG)
BPFMAN_AGENT_IMG ?= quay.io/bpfman/bpfman-agent:$(IMAGE_TAG)
BPFMAN_OPERATOR_IMG ?= quay.io/bpfman/bpfman-operator:$(IMAGE_TAG)
BPFMAN_OPERATOR_BUNDLE_IMG ?= quay.io/bpfman/bpfman-operator-bundle:$(IMAGE_TAG)
KIND_CLUSTER_NAME ?= bpfman-deployment

# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
Expand Down Expand Up @@ -344,11 +343,11 @@ load-images-kind: ## Load bpfman-agent, and bpfman-operator images into the runn

.PHONY: bundle-build
bundle-build: ## Build the bundle image.
docker build -f Containerfile.bundle -t $(BPFMAN_OPERATOR_BUNDLE_IMG) .
docker build -f Containerfile.bundle -t $(BUNDLE_IMG) .

.PHONY: bundle-push
bundle-push: ## Push the bundle image.
docker push $(BPFMAN_OPERATOR_BUNDLE_IMG)
docker push $(BUNDLE_IMG)

# A comma-separated list of bundle images (e.g. make catalog-build BUNDLE_IMGS=example.com/operator-bundle:v0.1.0,example.com/operator-bundle:v0.2.0).
# These images MUST exist in a registry and be pull-able.
Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,16 @@ object to find references to the bpfMap pinpoints (`spec.maps`) to configure the
## Developer

For more architecture details about `bpfman-operator`, refer to
[Developing the bpfman-operator](https://bpfman.io/v0.5.0-rc1/developer-guide/develop-operator)
[Developing the bpfman-operator](https://bpfman.io/v0.5.0-rc1/developer-guide/develop-operator)

### Deploy as a bundle from the Console's OperatorHub page

This mode is recommended when you want to test the customer experience of navigating through the operators'
catalog and installing/configuring it manually through the UI.

```sh
export BUNDLE_IMG=quay.io/$USER/bpfman-operator-bundle:v$VERSION
make bundle bundle-build bundle-push
export CATALOG_IMG=quay.io/$USER/bpfman-operator-catalog:v$VERSION
make catalog-build catalog-push catalog-deploy
```
21 changes: 20 additions & 1 deletion bundle/manifests/bpfman-operator.clusterserviceversion.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,18 @@ metadata:
capabilities: Basic Install
categories: OpenShift Optional
containerImage: quay.io/bpfman/bpfman-operator:v0.0.0
createdAt: "2024-07-10T22:28:17Z"
createdAt: "2024-07-12T16:12:00Z"
features.operators.openshift.io/cnf: "false"
features.operators.openshift.io/cni: "false"
features.operators.openshift.io/csi: "true"
features.operators.openshift.io/disconnected: "true"
features.operators.openshift.io/fips-compliant: "true"
features.operators.openshift.io/proxy-aware: "false"
features.operators.openshift.io/tls-profiles: "false"
features.operators.openshift.io/token-auth-aws: "false"
features.operators.openshift.io/token-auth-azure: "false"
features.operators.openshift.io/token-auth-gcp: "false"
operatorframework.io/suggested-namespace: bpfman
operatorframework.io/suggested-namespace-template: |-
{
"apiVersion": "v1",
Expand All @@ -313,9 +324,17 @@ metadata:
},
}
}
operators.openshift.io/infrastructure-features: '["csi", "disconnected"]'
operators.openshift.io/valid-subscription: '["OpenShift Kubernetes Engine", "OpenShift
Container Platform", "OpenShift Platform Plus"]'
operators.operatorframework.io/builder: operator-sdk-v1.27.0
operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
repository: https://github.com/bpfman/bpfman
labels:
operatorframework.io/arch.amd64: supported
operatorframework.io/arch.arm64: supported
operatorframework.io/arch.ppc64le: supported
operatorframework.io/arch.s390x: supported
name: bpfman-operator.v0.5.0-rc1
namespace: placeholder
spec:
Expand Down
18 changes: 18 additions & 0 deletions config/manifests/bases/bpfman-operator.clusterserviceversion.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ metadata:
capabilities: Basic Install
containerImage: quay.io/bpfman/bpfman-operator:v0.0.0
repository: https://github.com/bpfman/bpfman
operatorframework.io/suggested-namespace: bpfman
operatorframework.io/suggested-namespace-template: |-
{
"apiVersion": "v1",
Expand All @@ -23,6 +24,23 @@ metadata:
},
}
}
features.operators.openshift.io/disconnected: "true"
features.operators.openshift.io/fips-compliant: "true"
features.operators.openshift.io/proxy-aware: "false"
features.operators.openshift.io/cnf: "false"
features.operators.openshift.io/cni: "false"
features.operators.openshift.io/csi: "true"
features.operators.openshift.io/tls-profiles: "false"
features.operators.openshift.io/token-auth-aws: "false"
features.operators.openshift.io/token-auth-azure: "false"
features.operators.openshift.io/token-auth-gcp: "false"
operators.openshift.io/infrastructure-features: '["csi", "disconnected"]'
operators.openshift.io/valid-subscription: '["OpenShift Kubernetes Engine", "OpenShift Container Platform", "OpenShift Platform Plus"]'
labels:
operatorframework.io/arch.amd64: supported
operatorframework.io/arch.arm64: supported
operatorframework.io/arch.ppc64le: supported
operatorframework.io/arch.s390x: supported
name: bpfman-operator.v0.0.0
namespace: placeholder
spec:
Expand Down

0 comments on commit 4f16278

Please sign in to comment.