Skip to content

feat: update Function CRD to use packageRef instead of package field #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions operator/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,17 @@ is manually re-applied afterwards.

**NOTE:** Run `make help` for more information on all potential `make` targets

### CRD Updates

When CRD definitions are updated in `operator/config/crd/bases/`, you need to ensure the Helm chart CRD templates are also updated to match. The Helm chart CRD templates are located in `operator/deploy/chart/templates/crd/`.

To update the Helm chart CRD templates:

1. Update the CRD definitions in `operator/config/crd/bases/`
2. Manually update the corresponding files in `operator/deploy/chart/templates/crd/` to match the base definitions
3. Ensure any Helm-specific templating (like `{{- if .Values.crd.enable }}`) is preserved
4. Test the changes to ensure the CRDs work correctly

**Important:** The Helm chart CRD templates should always reflect the latest changes from the base CRD definitions to ensure consistency between direct CRD installation and Helm chart installation.

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,18 @@ spec:
module:
description: Module name
type: string
package:
description: Package name
type: string
packageRef:
description: Package reference
properties:
name:
description: Name of the Package resource
type: string
namespace:
description: Namespace of the Package resource
type: string
required:
- name
type: object
replicas:
default: 1
description: Number of replicas for the function deployment
Expand Down Expand Up @@ -113,7 +122,7 @@ spec:
type: string
required:
- module
- package
- packageRef
type: object
status:
description: FunctionStatus defines the observed state of Function
Expand Down
Loading