Skip to content

📖 (docs/tutorials): ensure all fields follow Kubernetes API conventions #4942

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 31, 2025
Merged

📖 (docs/tutorials): ensure all fields follow Kubernetes API conventions #4942

merged 1 commit into from
Jul 31, 2025

Conversation

@camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Jul 20, 2025

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jul 20, 2025
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 20, 2025
@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Jul 20, 2025

@erikgb @JoelSpeed

This PR is the latest one to ensure that we follow all samples / scaffold and everything in the k8s API conventions and rules. If you have time to help with the reviews, it would be great!
Thank you a lot for the help 🙏

erikgb
erikgb reviewed Jul 20, 2025
View reviewed changes
Copy link
Member

@erikgb erikgb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would mind if this is merged as is, but I find it inconsistent to remove +kubebuilder:validation:MinLength=0 and at the same time add +kubebuilder:validation:MinItems=0. Both are pretty redundant, since this is the default.

@camilamacedo86 camilamacedo86 force-pushed the fix-tutorails-kal branch 2 times, most recently from 77f88f0 to d2ee38d Compare July 20, 2025 17:45
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 20, 2025
@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Jul 20, 2025

Hi @erikgb, I tried to address your review.
Please feel free to take a look at it.
Thank you so much for the time and help

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 22, 2025
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jul 23, 2025
@camilamacedo86 camilamacedo86 requested a review from erikgb July 24, 2025 02:40
@camilamacedo86 camilamacedo86 force-pushed the fix-tutorails-kal branch 2 times, most recently from 84b60f7 to a3078c8 Compare July 24, 2025 08:25
JoelSpeed
JoelSpeed reviewed Jul 24, 2025
View reviewed changes
@camilamacedo86 camilamacedo86 force-pushed the fix-tutorails-kal branch 3 times, most recently from bb98572 to c6e41ee Compare July 25, 2025 08:11
camilamacedo86
camilamacedo86 commented Jul 25, 2025
View reviewed changes
docs/book/src/cronjob-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook_test.go
obj = &batchv1.CronJob{
Spec: batchv1.CronJobSpec{
Schedule: schedule,
ConcurrencyPolicy: batchv1.AllowConcurrent,
Copy link
Member Author

@camilamacedo86 camilamacedo86 Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not a pointer?
See: kubernetes-sigs/kube-api-linter#128
We will need to configure the linter with WhenRequired option
@erikgb @JoelSpeed

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 25, 2025
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 25, 2025
@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Jul 25, 2025

Hi @JoelSpeed and @erikgb

Thank you a lot for your help and support.
Sorry, I forgot the context of the previous discussions about pointers or not in ConcurrencyPolicy, as mentioned in kubernetes-sigs/kube-api-linter#128, which caused us to waste a little more time here.

It's hard sometimes to keep all in mind when we are doing many things at the same time. :-P

But I really appreciate so much the help
I think it is good to get merged now !!!!

afzal442
afzal442 reviewed Jul 31, 2025
View reviewed changes
...onjob-tutorial/testdata/project/config/crd/bases/batch.tutorial.kubebuilder.io_cronjobs.yaml
spec:
properties:
concurrencyPolicy:
default: Allow
Copy link
Member

@afzal442 afzal442 Jul 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I missed the context. Why it's allowed as default?

Copy link
Member Author

@camilamacedo86 camilamacedo86 Jul 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because of the type: ConcurrencyPolicy
It can be:

                enum:
                - Allow
                - Forbid

By default, in the example, we want to allow.
So, if not set will be Allow

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Jul 31, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afzal442, camilamacedo86

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Jul 31, 2025

In this one, we addressed all comments made by @JoelSpeed and @erikgb
Really thank you for ALL help
And we have one approval so it seems good to fly
Anyway, we can always come back and do a follow-up if we need to.

@camilamacedo86 camilamacedo86 added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 31, 2025
@k8s-ci-robot k8s-ci-robot merged commit 3517a5b into kubernetes-sigs:master Jul 31, 2025
22 checks passed
@camilamacedo86 camilamacedo86 deleted the fix-tutorails-kal branch July 31, 2025 20:25
@camilamacedo86 camilamacedo86 mentioned this pull request Aug 25, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Kavinjsir Kavinjsir Awaiting requested review from Kavinjsir

@rashmigottipati rashmigottipati Awaiting requested review from rashmigottipati

@erikgb erikgb Awaiting requested review from erikgb

@JoelSpeed JoelSpeed Awaiting requested review from JoelSpeed

1 more reviewer

@afzal442 afzal442 afzal442 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@camilamacedo86 @k8s-ci-robot @erikgb @JoelSpeed @afzal442