Merge pull request #200 from jumpstarter-dev/update-operator

Update operator scripts for upstream repos

Author: mangelajo

.github/workflows/controller-bundle.yaml

@@ -41,6 +41,9 @@ type ClientStatus struct {
 
 // Client is the Schema for the identities API
 type Client struct {
+	// The Client in the Jumpstarter controller represents a user that can access the Jumpstarter Controller.
+	// Clients can be associated to external identity OIDC providers by providing Username, i.e.
+	// Spec.Username: "kc:user-name-in-keycloak"
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 

controller/api/v1alpha1/client_types.go

@@ -52,6 +52,13 @@ const (
 
 // Exporter is the Schema for the exporters API
 type Exporter struct {
+	// Exporters represent the services that connect to the physical or virtual
+	// devices. They are responsible for providing the access to the devices and
+	// for the communication with the devices. A jumpstarter exporter service
+	// should be run on a linux machine, or a pod, with the exporter credentials
+	// and the right configuration for this resource to become online. For
+	// more information see the Jumpstarter documentation:
+	// https://jumpstarter.dev/main/introduction/exporters.html#exporters
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 

controller/api/v1alpha1/exporter_types.go

@@ -50,6 +50,8 @@ type ExporterAccessPolicyStatus struct {
 
 // ExporterAccessPolicy is the Schema for the exporteraccesspolicies API.
 type ExporterAccessPolicy struct {
+	// ExporterAccessPolicies are used to define the access policies for the exporters.
+	// they help organize, prioritize and restrict access to the exporters by clients.
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 

controller/api/v1alpha1/exporteraccesspolicy_types.go

@@ -78,6 +78,14 @@ const (
 
 // Lease is the Schema for the exporters API
 type Lease struct {
+	// Lease is the schema for the Leases API. Leases represent a
+	// request for a specific exporter by a client. The lease is
+	// acquired by the client and the exporter is assigned to the lease.
+	// The lease is released by the client when the client is done with
+	// the exporter. For more information see the Jumpstarter documentation:
+	//
+	// https://jumpstarter.dev/main/reference/man-pages/jmp.html#jmp-create-lease
+	// https://jumpstarter.dev/main/reference/man-pages/jmp.html#jmp-shell
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 

controller/api/v1alpha1/lease_types.go

@@ -3,7 +3,19 @@
 # To re-generate a bundle for another specific version without changing the standard setup, you can:
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
-VERSION ?= 0.8.0
+VERSION ?= 0.8.1-rc.1
+
+# REPLACES defines the previous operator version this release replaces in the OLM upgrade graph.
+# Used to generate the release-config.yaml for FBC auto-release.
+# Set to empty for the first release in a channel.
+# See: https://redhat-openshift-ecosystem.github.io/operator-pipelines/users/fbc_autorelease/
+REPLACES ?= jumpstarter-operator.v0.8.0
+
+# FBC_CHANNELS defines the FBC catalog channels for this release.
+FBC_CHANNELS ?= alpha
+
+# OPENSHIFT_VERSIONS defines the Red Hat OpenShift version range injected into bundle metadata.
+OPENSHIFT_VERSIONS ?= v4.18-v4.21
 
 # CHANNELS define the bundle channels used in the bundle.
 # Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")
@@ -305,7 +317,27 @@ bundle: manifests kustomize operator-sdk ## Generate bundle manifests and metada
 	$(OPERATOR_SDK) generate kustomize manifests -q
 	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
 	$(KUSTOMIZE) build config/manifests | $(OPERATOR_SDK) generate bundle $(BUNDLE_GEN_FLAGS)
+	@# Inject Red Hat OpenShift version range into bundle metadata (not handled by operator-sdk)
+	@if ! grep -q 'com.redhat.openshift.versions' bundle/metadata/annotations.yaml; then \
+		echo '  com.redhat.openshift.versions: $(OPENSHIFT_VERSIONS)' >> bundle/metadata/annotations.yaml; \
+	fi
 	$(OPERATOR_SDK) bundle validate ./bundle
+	@# Generate release-config.yaml for FBC auto-release
+	@echo "---" > bundle/release-config.yaml
+	@echo "catalog_templates:" >> bundle/release-config.yaml
+	@echo "  - template_name: basic.yaml" >> bundle/release-config.yaml
+	@echo "    channels: [$(FBC_CHANNELS)]" >> bundle/release-config.yaml
+ifneq ($(REPLACES),)
+	@echo "    replaces: $(REPLACES)" >> bundle/release-config.yaml
+	@REPLACES_VER=$$(echo "$(REPLACES)" | sed 's/jumpstarter-operator\.v//'); \
+	echo "    skipRange: '>=$${REPLACES_VER} <$(VERSION)'" >> bundle/release-config.yaml
+endif
+	@echo "Generated bundle/release-config.yaml"
+
+.PHONY: contribute
+contribute: bundle ## Update community-operators repos with the current bundle.
+	cd contribute && \
+	./update-contributions.sh
 
 .PHONY: bundle-build
 bundle-build: ## Build the bundle image.