Skip to content

Commit abcd49d

Browse files
camilamacedo86camilamacedo86
committed
(docs/tutorials): ensure all fields follow Kubernetes API conventions
1 parent cf5dbb3 commit abcd49d

File tree

18 files changed

+101
-29
lines changed

18 files changed

+101
-29
lines changed

‎docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_types.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ import (
6565
// CronJobSpec defines the desired state of CronJob
6666
type CronJobSpec struct {
6767
// schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
68-
// +kubebuilder:validation:MinLength=0
6968
// +required
7069
Schedule string `json:"schedule"`
7170

@@ -81,6 +80,7 @@ type CronJobSpec struct {
8180
// - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
8281
// - "Replace": cancels currently running job and replaces it with a new one
8382
// +optional
83+
// +kubebuilder:default:=Allow
8484
ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`
8585

8686
// suspend tells the controller to suspend subsequent executions, it does
@@ -89,6 +89,7 @@ type CronJobSpec struct {
8989
Suspend *bool `json:"suspend,omitempty"`
9090

9191
// jobTemplate defines the job that will be created when executing a CronJob.
92+
// +required
9293
JobTemplate batchv1.JobTemplateSpec `json:"jobTemplate"`
9394

9495
// successfulJobsHistoryLimit defines the number of successful finished jobs to retain.
@@ -146,6 +147,9 @@ type CronJobStatus struct {
146147

147148
// active defines a list of pointers to currently running jobs.
148149
// +optional
150+
// +listType=atomic
151+
// +kubebuilder:validation:MaxItems=10
152+
// +kubebuilder:validation:MinItems=0
149153
Active []corev1.ObjectReference `json:"active,omitempty"`
150154

151155
// lastScheduleTime defines when was the last time the job was successfully scheduled.

‎docs/book/src/cronjob-tutorial/testdata/project/config/crd/bases/batch.tutorial.kubebuilder.io_cronjobs.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ spec:
2727
spec:
2828
properties:
2929
concurrencyPolicy:
30+
default: Allow
3031
enum:
3132
- Allow
3233
- Forbid
@@ -3798,7 +3799,6 @@ spec:
37983799
type: object
37993800
type: object
38003801
schedule:
3801-
minLength: 0
38023802
type: string
38033803
startingDeadlineSeconds:
38043804
format: int64
@@ -3835,7 +3835,10 @@ spec:
38353835
type: string
38363836
type: object
38373837
x-kubernetes-map-type: atomic
3838+
maxItems: 10
3839+
minItems: 0
38383840
type: array
3841+
x-kubernetes-list-type: atomic
38393842
lastScheduleTime:
38403843
format: date-time
38413844
type: string

‎docs/book/src/cronjob-tutorial/testdata/project/dist/chart/templates/crd/batch.tutorial.kubebuilder.io_cronjobs.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ spec:
3333
spec:
3434
properties:
3535
concurrencyPolicy:
36+
default: Allow
3637
enum:
3738
- Allow
3839
- Forbid
@@ -3804,7 +3805,6 @@ spec:
38043805
type: object
38053806
type: object
38063807
schedule:
3807-
minLength: 0
38083808
type: string
38093809
startingDeadlineSeconds:
38103810
format: int64
@@ -3841,7 +3841,10 @@ spec:
38413841
type: string
38423842
type: object
38433843
x-kubernetes-map-type: atomic
3844+
maxItems: 10
3845+
minItems: 0
38443846
type: array
3847+
x-kubernetes-list-type: atomic
38453848
lastScheduleTime:
38463849
format: date-time
38473850
type: string

‎docs/book/src/cronjob-tutorial/testdata/project/dist/install.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ spec:
3535
spec:
3636
properties:
3737
concurrencyPolicy:
38+
default: Allow
3839
enum:
3940
- Allow
4041
- Forbid
@@ -3806,7 +3807,6 @@ spec:
38063807
type: object
38073808
type: object
38083809
schedule:
3809-
minLength: 0
38103810
type: string
38113811
startingDeadlineSeconds:
38123812
format: int64
@@ -3843,7 +3843,10 @@ spec:
38433843
type: string
38443844
type: object
38453845
x-kubernetes-map-type: atomic
3846+
maxItems: 10
3847+
minItems: 0
38463848
type: array
3849+
x-kubernetes-list-type: atomic
38473850
lastScheduleTime:
38483851
format: date-time
38493852
type: string

‎docs/book/src/cronjob-tutorial/testdata/project/go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ require (
99
k8s.io/api v0.33.0
1010
k8s.io/apimachinery v0.33.0
1111
k8s.io/client-go v0.33.0
12+
k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738
1213
sigs.k8s.io/controller-runtime v0.21.0
1314
)
1415

@@ -89,7 +90,6 @@ require (
8990
k8s.io/component-base v0.33.0 // indirect
9091
k8s.io/klog/v2 v2.130.1 // indirect
9192
k8s.io/kube-openapi v0.0.0-20250318190949-c8a335a9a2ff // indirect
92-
k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738 // indirect
9393
sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.31.2 // indirect
9494
sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 // indirect
9595
sigs.k8s.io/randfill v1.0.0 // indirect

‎docs/book/src/cronjob-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook_test.go‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222

2323
batchv1 "tutorial.kubebuilder.io/project/api/v1"
2424
// TODO (user): Add any additional imports if needed
25+
"k8s.io/utils/ptr"
2526
)
2627

2728
var _ = Describe("CronJob Webhook", func() {
@@ -40,8 +41,8 @@ var _ = Describe("CronJob Webhook", func() {
4041
Spec: batchv1.CronJobSpec{
4142
Schedule: schedule,
4243
ConcurrencyPolicy: batchv1.AllowConcurrent,
43-
SuccessfulJobsHistoryLimit: new(int32),
44-
FailedJobsHistoryLimit: new(int32),
44+
SuccessfulJobsHistoryLimit: ptr.To(int32(3)),
45+
FailedJobsHistoryLimit: ptr.To(int32(1)),
4546
},
4647
}
4748
*obj.Spec.SuccessfulJobsHistoryLimit = 3
@@ -51,8 +52,8 @@ var _ = Describe("CronJob Webhook", func() {
5152
Spec: batchv1.CronJobSpec{
5253
Schedule: schedule,
5354
ConcurrencyPolicy: batchv1.AllowConcurrent,
54-
SuccessfulJobsHistoryLimit: new(int32),
55-
FailedJobsHistoryLimit: new(int32),
55+
SuccessfulJobsHistoryLimit: ptr.To(int32(3)),
56+
FailedJobsHistoryLimit: ptr.To(int32(1)),
5657
},
5758
}
5859
*oldObj.Spec.SuccessfulJobsHistoryLimit = 3

‎docs/book/src/getting-started.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ we will allow configuring the number of instances with the following:
8383
```go
8484
type MemcachedSpec struct {
8585
...
86+
// +kubebuilder:validation:Minimum=0
87+
// +required
8688
Size int32 `json:"size,omitempty"`
8789
}
8890
```

‎docs/book/src/multiversion-tutorial/testdata/project/api/v1/cronjob_types.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ import (
3737
// CronJobSpec defines the desired state of CronJob
3838
type CronJobSpec struct {
3939
// schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
40-
// +kubebuilder:validation:MinLength=0
4140
// +required
4241
Schedule string `json:"schedule"`
4342

@@ -53,6 +52,7 @@ type CronJobSpec struct {
5352
// - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
5453
// - "Replace": cancels currently running job and replaces it with a new one
5554
// +optional
55+
// +kubebuilder:default:=Allow
5656
ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`
5757

5858
// suspend tells the controller to suspend subsequent executions, it does
@@ -61,6 +61,7 @@ type CronJobSpec struct {
6161
Suspend *bool `json:"suspend,omitempty"`
6262

6363
// jobTemplate defines the job that will be created when executing a CronJob.
64+
// +required
6465
JobTemplate batchv1.JobTemplateSpec `json:"jobTemplate"`
6566

6667
// successfulJobsHistoryLimit defines the number of successful finished jobs to retain.
@@ -102,6 +103,9 @@ type CronJobStatus struct {
102103

103104
// active defines a list of pointers to currently running jobs.
104105
// +optional
106+
// +listType=atomic
107+
// +kubebuilder:validation:MaxItems=10
108+
// +kubebuilder:validation:MinItems=0
105109
Active []corev1.ObjectReference `json:"active,omitempty"`
106110

107111
// lastScheduleTime defines when was the last time the job was successfully scheduled.

‎docs/book/src/multiversion-tutorial/testdata/project/api/v2/cronjob_types.go‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ We'll leave our spec largely unchanged, except to change the schedule field to a
4141
*/
4242
// CronJobSpec defines the desired state of CronJob
4343
type CronJobSpec struct {
44-
// The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
44+
// schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
45+
// +required
4546
Schedule CronSchedule `json:"schedule"`
4647

4748
/*
@@ -59,6 +60,7 @@ type CronJobSpec struct {
5960
// - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
6061
// - "Replace": cancels currently running job and replaces it with a new one
6162
// +optional
63+
// +kubebuilder:default:=Allow
6264
ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`
6365

6466
// suspend tells the controller to suspend subsequent executions, it does
@@ -67,6 +69,7 @@ type CronJobSpec struct {
6769
Suspend *bool `json:"suspend,omitempty"`
6870

6971
// jobTemplate defines the job that will be created when executing a CronJob.
72+
// +required
7073
JobTemplate batchv1.JobTemplateSpec `json:"jobTemplate"`
7174

7275
// successfulJobsHistoryLimit defines the number of successful finished jobs to retain.
@@ -149,6 +152,9 @@ type CronJobStatus struct {
149152

150153
// active defines a list of pointers to currently running jobs.
151154
// +optional
155+
// +listType=atomic
156+
// +kubebuilder:validation:MaxItems=10
157+
// +kubebuilder:validation:MinItems=0
152158
Active []corev1.ObjectReference `json:"active,omitempty"`
153159

154160
// lastScheduleTime defines the information when was the last time the job was successfully scheduled.

‎docs/book/src/multiversion-tutorial/testdata/project/config/crd/bases/batch.tutorial.kubebuilder.io_cronjobs.yaml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ spec:
2727
spec:
2828
properties:
2929
concurrencyPolicy:
30+
default: Allow
3031
enum:
3132
- Allow
3233
- Forbid
@@ -3798,7 +3799,6 @@ spec:
37983799
type: object
37993800
type: object
38003801
schedule:
3801-
minLength: 0
38023802
type: string
38033803
startingDeadlineSeconds:
38043804
format: int64
@@ -3835,7 +3835,10 @@ spec:
38353835
type: string
38363836
type: object
38373837
x-kubernetes-map-type: atomic
3838+
maxItems: 10
3839+
minItems: 0
38383840
type: array
3841+
x-kubernetes-list-type: atomic
38393842
lastScheduleTime:
38403843
format: date-time
38413844
type: string
@@ -3860,6 +3863,7 @@ spec:
38603863
spec:
38613864
properties:
38623865
concurrencyPolicy:
3866+
default: Allow
38633867
enum:
38643868
- Allow
38653869
- Forbid
@@ -7678,7 +7682,10 @@ spec:
76787682
type: string
76797683
type: object
76807684
x-kubernetes-map-type: atomic
7685+
maxItems: 10
7686+
minItems: 0
76817687
type: array
7688+
x-kubernetes-list-type: atomic
76827689
lastScheduleTime:
76837690
format: date-time
76847691
type: string

0 commit comments

Comments
 (0)