+kubebuilder:default={} does not use nested defaults #622

astoycos · 2021-09-21T21:19:39Z

So I believe I exposed a bug in kubebuilder...

when I define a +kubebuilder:default={} as a pointer to another type with +kubebuilder:default values I assume those values should propagate to the parent object.

For example

// policyAuditConfig is the configuration for network policy audit events. If unset,
// reported defaults are used.
// +kubebuilder:default={}
// +optional
PolicyAuditConfig *PolicyAuditConfig `json:"policyAuditConfig,omitempty"`

Where the PolicyAuditConfig is defined in the same package

type PolicyAuditConfig struct {
	// rateLimit is the approximate maximum number of messages to generate per-second per-node. If
	// unset the default of 20 msg/sec is used.
	// +kubebuilder:default=20
	// +kubebuilder:validation:Minimum=1
	// +optional
	RateLimit *uint32 `json:"rateLimit,omitempty"`

	// maxFilesSize is the max size an ACL_audit log file is allowed to reach before rotation occurs
	// Units are in MB and the Default is 50MB
	// +kubebuilder:default=50
	// +kubebuilder:validation:Minimum=1
	// +optional
	MaxFileSize *uint32 `json:"maxFileSize,omitempty"`

	// destination is the location for policy log messages.
	// Regardless of this config, persistent logs will always be dumped to the host
	// at /var/log/ovn/ however
	// Additionally syslog output may be configured as follows.
	// Valid values are:
	// - "libc" -> to use the libc syslog() function of the host node's journdald process
	// - "udp:host:port" -> for sending syslog over UDP
	// - "unix:file" -> for using the UNIX domain socket directly
	// - "null" -> to discard all messages logged to syslog
	// The default is "null"
	// +kubebuilder:default=null
	// +kubebuilder:pattern='^libc$|^null$|^udp:(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]):([0-9]){0,5}$|^unix:(\/[^\/ ]*)+([^\/\s])$'
	// +optional
	Destination string `json:"destination,omitempty"`

	// syslogFacility the RFC5424 facility for generated messages, e.g. "kern". Default is "local0"
	// +kubebuilder:default=local0
	// +kubebuilder:Enum=kern;user;mail;daemon;auth;syslog;lpr;news;uucp;clock;ftp;ntp;audit;alert;clock2;local0;local1;local2;local3;local4;local5;local6;local7
	// +optional
	SyslogFacility string `json:"syslogFacility,omitempty"`
}

However rather than rendering the default correctly I see the following in the generated yaml

policyAuditConfig:
  description: policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used.
  type: object
  default: null
  properties:
    destination:
      description: 'destination is the location for policy log messages. Regardless of this config, persistent logs will always be dumped to the host at /var/log/ovn/ however Additionally syslog output may be configured as follows. Valid values are: - "libc" -> to use the libc syslog() function of the host node''s journdald process - "udp:host:port" -> for sending syslog over UDP - "unix:file" -> for using the UNIX domain socket directly - "null" -> to discard all messages logged to syslog The default is "null"'
      type: string
      default: "null"
    maxFileSize:
      description: maxFilesSize is the max size an ACL_audit log file is allowed to reach before rotation occurs Units are in MB and the Default is 50MB
      type: integer
      format: int32
      default: 50
      minimum: 1
    rateLimit:
      description: rateLimit is the approximate maximum number of messages to generate per-second per-node. If unset the default of 20 msg/sec is used.
      type: integer
      format: int32
      default: 20
      minimum: 1
    syslogFacility:
      description: syslogFacility the RFC5424 facility for generated messages, e.g. "kern". Default is "local0"
      type: string
      default: local0

Specifically the default value is null where it should be populated automatically by the defined nested defaults.

I am happy to help propose a fix here, however after spending some time playing with the codebase I'm realizing I will probably need some assistance from someone more experienced with kubebuilder

I already reached out on slack and got no response, which prompted me to open this issue.

Thanks,
Andrew

The text was updated successfully, but these errors were encountered:

We need to initialize `ovnKubernetesConfig.policyAuditConfig` so that the proper defaults are populated when a CNO config object is created It would be better to do this using the `+kubebuilder:default` flag however it is broken for this case as described in this [upstream issue](kubernetes-sigs/controller-tools#622) Signed-off-by: astoycos <astoycos@redhat.com> TMP

We need to initialize `ovnKubernetesConfig.policyAuditConfig` so that the proper defaults are populated when a CNO config object is created It would be better to do this using the `+kubebuilder:default` flag however it is broken for this case as described in this [upstream issue](kubernetes-sigs/controller-tools#622) Signed-off-by: astoycos <astoycos@redhat.com>

k8s-triage-robot · 2021-12-20T22:11:21Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2022-01-19T22:14:53Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2022-02-18T22:27:44Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue or PR with /reopen
Mark this issue or PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2022-02-18T22:27:55Z

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue or PR with /reopen

Mark this issue or PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

astoycos · 2022-02-23T00:40:02Z

/reopen

k8s-ci-robot · 2022-02-23T00:40:13Z

@astoycos: Reopened this issue.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

astoycos · 2022-02-23T00:40:27Z

/bug

k8s-triage-robot · 2022-03-25T00:42:44Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue or PR with /reopen
Mark this issue or PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2022-03-25T00:42:55Z

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue or PR with /reopen

Mark this issue or PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

therealak12 · 2022-04-30T16:31:18Z

/reopen

k8s-ci-robot · 2022-04-30T16:31:26Z

@therealak12: You can't reopen an issue/PR unless you authored it or you are a collaborator.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

astoycos · 2022-05-01T16:02:06Z

/reopen

k8s-ci-robot · 2022-05-01T16:02:14Z

@astoycos: Reopened this issue.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-triage-robot · 2022-08-07T20:40:07Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue or PR with /reopen
Mark this issue or PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2022-08-07T20:40:16Z

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue or PR with /reopen

Mark this issue or PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

liubog2008 · 2022-12-06T09:08:14Z

This issue seems not fixed?

- Unify pointer and omitempty JSON tag usage - Add all default fields for struct with default values. With the exception of HZ anc MC spec. The change is done due to the issue in kubernetes-sigs/controller-tools#622 - WanReplication Queue , Batch and Acknowledgment fields did not have struct default values but they were not pointers so those fields acted like they had default values. Added explicit struct default values. - Add enum kubebuilder tags - Add optional comment for forgotten fields - Add explicit required comment for required field

k8s-triage-robot · 2023-01-05T10:15:22Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue with /reopen
Mark this issue as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

k8s-ci-robot · 2023-01-05T10:15:26Z

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue with /reopen

Mark this issue as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

pmalek · 2023-08-23T15:02:20Z

This is still an issue. What "works" as a sort of workaround is specifying the default verbatim in every +kubebuilder:default marker, for instance:

type XStrategy struct {
	// +kubebuilder:validation:Optional
	// +kubebuilder:default={"plan":{"deployment":"ScaleDownOnPromotionScaleUpOnRollout"}}
	Resources RolloutResources `json:"resources,omitempty"`
}

type RolloutResources struct {
	// +kubebuilder:validation:Optional
	// +kubebuilder:default={"deployment":"ScaleDownOnPromotionScaleUpOnRollout"}
	Plan RolloutResourcePlans `json:"plan,omitempty"`
}


type RolloutResourcePlans struct {
	// +kubebuilder:validation:Enum=ScaleDownOnPromotionScaleUpOnRollout;DeleteOnPromotionRecreateOnRollout
	// +kubebuilder:default=ScaleDownOnPromotionScaleUpOnRollout
	Deployment RolloutResourcePlanDeployment `json:"deployment,omitempty"`
}

which is error prone and counterproductive. Field based defaults should be enough.

/reopen

k8s-ci-robot · 2023-08-23T15:02:24Z

@pmalek: You can't reopen an issue/PR unless you authored it or you are a collaborator.

In response to this:

This is still an issue. What "works" as a sort of workaround is specifying the default verbatim in every +kubebuilder:default marker, for instance:

type XStrategy struct {
  // +kubebuilder:validation:Optional
  // +kubebuilder:default={"plan":{"deployment":"ScaleDownOnPromotionScaleUpOnRollout"}}
  Resources RolloutResources `json:"resources,omitempty"`
}

type RolloutResources struct {
  // +kubebuilder:validation:Optional
  // +kubebuilder:default={"deployment":"ScaleDownOnPromotionScaleUpOnRollout"}
  Plan RolloutResourcePlans `json:"plan,omitempty"`
}


type RolloutResourcePlans struct {
  // +kubebuilder:validation:Enum=ScaleDownOnPromotionScaleUpOnRollout;DeleteOnPromotionRecreateOnRollout
  // +kubebuilder:default=ScaleDownOnPromotionScaleUpOnRollout
  Deployment RolloutResourcePlanDeployment `json:"deployment,omitempty"`
}

which is error prone and counterproductive. Field based defaults should be enough.

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

astoycos · 2023-08-23T15:03:15Z

/reopen

k8s-ci-robot · 2023-08-23T15:03:19Z

@astoycos: Reopened this issue.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

astoycos · 2023-08-23T15:06:59Z

/remove-lifecycle rotten

franpog859 · 2023-10-04T12:28:02Z

This issue has been here for over two years now 😵 Does anyone plan to work on it?

morucci · 2023-12-18T10:48:20Z

I just experienced the same behavior. I've used #622 (comment) as a workaround.

This change adds: - a test to validate that the sf-operator can reconsile a SF CR with the minimal set of settings. - a fix to provide default value for the logserver if the main field is not set. - a fix for the system-config pipeline generator where the zuul connection name for the config repo is never recomputed. See: kubernetes-sigs/controller-tools#622 Change-Id: Ibce761d80a9d90eeef29c09105b569890f1b4d8e

ahmetb · 2024-01-12T18:47:43Z

/lifecycle frozen
/kind bug

sbueringer · 2024-04-10T09:22:51Z

Specifically the default value is null where it should be populated automatically by the defined nested defaults.

Not sure if I got this correctly. I think in your example the default of policyAuditConfig should be an empty object.

Here another example:

	// +kubebuilder:default={}
	// +optional
	ControlPlaneCertificateRotation *ControlPlaneCertificateRotation `json:"controlPlaneCertificateRotation,omitempty"`


type ControlPlaneCertificateRotation struct {
	// +kubebuilder:default=true
	// +optional
	Activate bool `json:"activate"`

	// +kubebuilder:default=90
	// +kubebuilder:validation:Minimum=7
	// +optional
	DaysBefore int32 `json:"daysBefore"`
}

This results in:

      default: {}
      properties:
        activate:
          default: true
          type: boolean
        daysBefore:
          default: 90
          format: int32
          minimum: 7
          type: integer
      type: object

The result is at runtime that Kubernetes will first default the controlPlaneCertificateRotation field to an empty object and then default each individual field (defaulting happens top-down and nested defaults are only applied if the parent exists)

astoycos mentioned this issue Sep 21, 2021

Bug 1978798: Update ovnKubernetesConfig.policyAuditConfig Default openshift/api#993

Merged

viccuad mentioned this issue Dec 15, 2021

Minor bug: policyserver controller errors as watch enters twice per ClusterAdmissionPolicies deletion kubewarden/kubewarden-controller#136

Closed

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 20, 2021

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jan 19, 2022

k8s-ci-robot closed this as completed Feb 18, 2022

k8s-ci-robot reopened this Feb 23, 2022

k8s-ci-robot closed this as completed Mar 25, 2022

k8s-ci-robot reopened this May 1, 2022

k8s-ci-robot closed this as completed Aug 7, 2022

glrf mentioned this issue Dec 2, 2022

Add Composite and Composition for Kafka vshn/component-appcat#49

Merged

3 tasks

camilamacedo86 reopened this Dec 6, 2022

mtyazici mentioned this issue Dec 12, 2022

[CN-612] Unify the approach for exposing API fields hazelcast/hazelcast-platform-operator#498

Merged

k8s-ci-robot closed this as not planned Won't fix, can't repro, duplicate, stale Jan 5, 2023

cornBuddy mentioned this issue Mar 9, 2023

How to reflect CR definition to its spec in the code operator-framework/operator-sdk#6346

Closed

karelyatin mentioned this issue Jun 2, 2023

Fix the defaulting logic for OVNController.spec.external-ids openstack-k8s-operators/ovn-operator#64

Merged

k8s-ci-robot reopened this Aug 23, 2023

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Aug 23, 2023

k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. kind/bug Categorizes issue or PR as related to a bug. labels Jan 12, 2024

jjyao mentioned this issue Apr 30, 2024

Make k8s job backoff limit configurable for RayJob ray-project/kuberay#2091

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

+kubebuilder:default={} does not use nested defaults #622

+kubebuilder:default={} does not use nested defaults #622

astoycos commented Sep 21, 2021

k8s-triage-robot commented Dec 20, 2021

k8s-triage-robot commented Jan 19, 2022

k8s-triage-robot commented Feb 18, 2022

k8s-ci-robot commented Feb 18, 2022

astoycos commented Feb 23, 2022

k8s-ci-robot commented Feb 23, 2022

astoycos commented Feb 23, 2022

k8s-triage-robot commented Mar 25, 2022

k8s-ci-robot commented Mar 25, 2022

therealak12 commented Apr 30, 2022

k8s-ci-robot commented Apr 30, 2022

astoycos commented May 1, 2022

k8s-ci-robot commented May 1, 2022

k8s-triage-robot commented Aug 7, 2022

k8s-ci-robot commented Aug 7, 2022

liubog2008 commented Dec 6, 2022

k8s-triage-robot commented Jan 5, 2023

k8s-ci-robot commented Jan 5, 2023

pmalek commented Aug 23, 2023

k8s-ci-robot commented Aug 23, 2023

astoycos commented Aug 23, 2023

k8s-ci-robot commented Aug 23, 2023

astoycos commented Aug 23, 2023

franpog859 commented Oct 4, 2023

morucci commented Dec 18, 2023

ahmetb commented Jan 12, 2024

sbueringer commented Apr 10, 2024

+kubebuilder:default={} does not use nested defaults #622

+kubebuilder:default={} does not use nested defaults #622

Comments

astoycos commented Sep 21, 2021

k8s-triage-robot commented Dec 20, 2021

k8s-triage-robot commented Jan 19, 2022

k8s-triage-robot commented Feb 18, 2022

k8s-ci-robot commented Feb 18, 2022

astoycos commented Feb 23, 2022

k8s-ci-robot commented Feb 23, 2022

astoycos commented Feb 23, 2022

k8s-triage-robot commented Mar 25, 2022

k8s-ci-robot commented Mar 25, 2022

therealak12 commented Apr 30, 2022

k8s-ci-robot commented Apr 30, 2022

astoycos commented May 1, 2022

k8s-ci-robot commented May 1, 2022

k8s-triage-robot commented Aug 7, 2022

k8s-ci-robot commented Aug 7, 2022

liubog2008 commented Dec 6, 2022

k8s-triage-robot commented Jan 5, 2023

k8s-ci-robot commented Jan 5, 2023

pmalek commented Aug 23, 2023

k8s-ci-robot commented Aug 23, 2023

astoycos commented Aug 23, 2023

k8s-ci-robot commented Aug 23, 2023

astoycos commented Aug 23, 2023

franpog859 commented Oct 4, 2023

morucci commented Dec 18, 2023

ahmetb commented Jan 12, 2024

sbueringer commented Apr 10, 2024