-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathrootsync-crd.yaml
More file actions
2428 lines (2421 loc) · 126 KB
/
Copy pathrootsync-crd.yaml
File metadata and controls
2428 lines (2421 loc) · 126 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.18.0
labels:
configmanagement.gke.io/arch: csmr
configmanagement.gke.io/system: "true"
name: rootsyncs.configsync.gke.io
spec:
group: configsync.gke.io
names:
kind: RootSync
listKind: RootSyncList
plural: rootsyncs
singular: rootsync
preserveUnknownFields: false
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.rendering.commit
name: RenderingCommit
type: string
- jsonPath: .status.rendering.errorSummary.totalCount
name: RenderingErrorCount
type: integer
- jsonPath: .status.source.commit
name: SourceCommit
type: string
- jsonPath: .status.source.errorSummary.totalCount
name: SourceErrorCount
type: integer
- jsonPath: .status.sync.commit
name: SyncCommit
type: string
- jsonPath: .status.sync.errorSummary.totalCount
name: SyncErrorCount
type: integer
name: v1alpha1
schema:
openAPIV3Schema:
description: RootSync is the Schema for the rootsyncs API
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: RootSyncSpec defines the desired state of RootSync
properties:
git:
description: git contains configuration specific to importing resources
from a Git repo.
properties:
auth:
description: |-
auth is the type of secret configured for access to the Git repo.
Must be one of ssh, cookiefile, gcenode, token, or none.
The validation of this is case-sensitive. Required.
enum:
- ssh
- cookiefile
- gcenode
- gcpserviceaccount
- githubapp
- token
- none
type: string
branch:
description: |-
branch is the git branch to sync from.
Branch defaults to 'master', but if 'revision' is set and is not 'HEAD',
'revision' takes precedence over 'branch'.
type: string
caCertSecretRef:
description: |-
caCertSecretRef specifies the name of the secret where the CA certificate is stored.
The creation of the secret should be done out of band by the user and should store the
certificate in a key named "cert". For RepoSync resources, the secret must be
created in the same namespace as the RepoSync. For RootSync resource, the secret
must be created in the config-management-system namespace.
nullable: true
properties:
name:
description: name represents the secret name.
type: string
type: object
dir:
description: |-
dir is the absolute path of the directory that contains
the local resources. Default: the root directory of the repo.
type: string
gcpServiceAccountEmail:
description: |-
gcpServiceAccountEmail specifies the GCP service account used to annotate
the RootSync/RepoSync controller Kubernetes Service Account.
Note: The field is used when spec.git.auth: gcpserviceaccount.
type: string
noSSLVerify:
description: |-
noSSLVerify specifies whether to enable or disable the SSL certificate verification. Default: false.
If noSSLVerify is set to true, it tells Git to skip the SSL certificate verification.
This should either be false or unset when caCertSecretRef is provided.
type: boolean
period:
description: |-
period is the time duration between consecutive syncs. Default: 15s.
Note to developers that customers specify this value using
string (https://golang.org/pkg/time/#Duration.String) like "3s"
in their Custom Resource YAML. However, time.Duration is at a nanosecond
granularity, and it is easy to introduce a bug where it looks like the
code is dealing with seconds but its actually nanoseconds (or vice versa).
type: string
proxy:
description: |-
proxy specifies an HTTPS proxy for accessing the Git repo.
Only has an effect when secretType is one of ("cookiefile", "none", "token").
When secretType is "cookiefile" or "token", if your HTTPS proxy URL contains sensitive information
such as a username or password and you need to hide the sensitive information,
you can leave this field empty and add the URL for the HTTPS proxy into the same Secret
used for the Git credential via `kubectl create secret ... --from-literal=https_proxy=HTTPS_PROXY_URL`. Optional.
type: string
repo:
description: repo is the git repository URL to sync from. Required.
type: string
revision:
description: |-
revision is the git revision (branch, tag, ref or commit) to fetch.
If 'revision' is not specified, it defaults to the HEAD of the branch that
is specified in the 'branch' field.
If neither 'revision' nor 'branch' is specified, it defaults to the HEAD of
the 'master' branch.
type: string
secretRef:
description: secretRef is the secret used to connect to the Git
source of truth.
nullable: true
properties:
name:
description: name represents the secret name.
type: string
type: object
required:
- auth
- repo
type: object
helm:
description: helm contains configuration specific to importing resources
from a Helm repo.
properties:
auth:
description: |-
auth specifies the type to authenticate to the Helm repository.
Must be one of token, gcpserviceaccount, k8sserviceaccount, gcenode or none.
The validation of this is case-sensitive. Required.
enum:
- none
- gcpserviceaccount
- k8sserviceaccount
- token
- gcenode
type: string
caCertSecretRef:
description: |-
caCertSecretRef specifies the name of the secret where the CA certificate is stored.
The creation of the secret should be done out of band by the user and should store the
certificate in a key named "cert". For RepoSync resources, the secret must be
created in the same namespace as the RepoSync. For RootSync resource, the secret
must be created in the config-management-system namespace.
nullable: true
properties:
name:
description: name represents the secret name.
type: string
type: object
chart:
description: chart is a Helm chart name. Required.
type: string
deployNamespace:
description: |-
deployNamespace specifies the namespace in which to deploy the chart.
This is a mutually exclusive setting with "namespace".
If neither namespace nor deployNamespace are set, the chart will be
deployed into the default namespace.
type: string
gcpServiceAccountEmail:
description: |-
gcpServiceAccountEmail specifies the GCP service account used to annotate
the RootSync/RepoSync controller Kubernetes Service Account.
Note: The field is used when spec.helm.auth: gcpserviceaccount.
type: string
includeCRDs:
description: |-
includeCRDs specifies if Helm template should also generate CustomResourceDefinitions.
If IncludeCRDs is set to false, no CustomeResourceDefinition will be generated.
Default: false.
type: boolean
namespace:
description: |-
namespace sets the target namespace for a release.
Default: "default".
type: string
period:
description: |-
period is the time duration that Config Sync waits before refetching the chart.
Default: 1 hour.
Use string to specify this field value, like "30s", "5m".
More details about valid inputs: https://pkg.go.dev/time#ParseDuration.
If the chart version is a range, the literal tag "latest", or left empty to indicate that Config Sync
should fetch the latest version, the chart will be re-fetched according to spec.helm.period.
If the chart version is specified as a single static version, the chart will not be re-fetched.
type: string
releaseName:
description: releaseName is the name of the Helm release.
type: string
repo:
description: repo is the helm repository URL to sync from. Required.
type: string
secretRef:
description: |-
secretRef holds the authentication secret for accessing
the Helm repository.
nullable: true
properties:
name:
description: name represents the secret name.
type: string
type: object
values:
description: |-
values to use instead of default values that accompany the chart. Format
values the same as default values.yaml. If `valuesFileRefs` is also specified,
fields from `values` will override fields from `valuesFileRefs`.
x-kubernetes-preserve-unknown-fields: true
valuesFileRefs:
description: |-
valuesFileRefs holds references to objects in the cluster that represent
values to use instead of default values that accompany the chart. Currently,
only ConfigMaps are supported. The ConfigMaps must be immutable and in the same
namespace as the RootSync/RepoSync. When multiple values files are specified, duplicated
keys in later files will override the value from earlier files. This is equivalent
to passing in multiple values files to Helm CLI. If `values` is also specified,
fields from `values` will override fields from `valuesFileRefs`.
items:
description: |-
ValuesFileRef references a ConfigMap object that contains a values file to use for
helm rendering. The ConfigMap must be in the same namespace as the RootSync/RepoSync.
properties:
dataKey:
description: 'dataKey represents the object data key to
read the values from. Default: `values.yaml`'
type: string
name:
description: name represents the Object name. Required.
type: string
type: object
type: array
version:
description: |-
version is the chart version.
This can be specified as a static version, or as a range of values from which Config Sync
will fetch the latest. If left empty, Config Sync will fetch the latest version according to semver.
The supported version range syntax is identical to the version range syntax
supported by helm CLI, and is documented here: https://github.com/Masterminds/semver#hyphen-range-comparisons.
Versions specified as a range, the literal tag "latest", or left empty to indicate that Config Sync should
fetch the latest version, will be fetched every sync according to spec.helm.period.
type: string
required:
- auth
- chart
- repo
type: object
monitoring:
description: monitoring specifies the observability configuration
for the reconciler.
properties:
enabled:
default: true
description: |-
enabled controls whether the OpenTelemetry (otel-agent) sidecar is deployed
alongside the reconciler container. When enabled, the sidecar intercepts
and exports metrics.
Default: true.
type: boolean
type: object
oci:
description: oci contains configuration specific to importing resources
from an OCI package.
properties:
auth:
description: |-
auth is the type of secret configured for access to the OCI package.
Must be one of gcenode, gcpserviceaccount, k8sserviceaccount, token, or none.
The validation of this is case-sensitive. Required.
enum:
- gcenode
- gcpserviceaccount
- k8sserviceaccount
- token
- none
type: string
caCertSecretRef:
description: |-
caCertSecretRef specifies the name of the secret where the CA certificate is stored.
The creation of the secret should be done out of band by the user and should store the
certificate in a key named "cert". For RepoSync resources, the secret must be
created in the same namespace as the RepoSync. For RootSync resource, the secret
must be created in the config-management-system namespace.
nullable: true
properties:
name:
description: name represents the secret name.
type: string
type: object
dir:
description: |-
dir is the absolute path of the directory that contains
the local resources. Default: the root directory of the image.
type: string
gcpServiceAccountEmail:
description: |-
gcpServiceAccountEmail specifies the GCP service account used to annotate
the RootSync/RepoSync controller Kubernetes Service Account.
Note: The field is used when secretType: gcpServiceAccount.
type: string
image:
description: |-
image is the OCI image repository URL for the package to sync from.
e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
The image can be pulled by TAG or by DIGEST if it is specified in PACKAGE_NAME.
- Pull by tag: `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME:TAG`.
- Pull by digest: `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME@sha256:DIGEST`.
If neither TAG nor DIGEST is specified, it pulls with the `latest` tag by default.
Required
type: string
period:
description: |-
period is the time duration between consecutive syncs. Default: 15s.
Note to developers that customers specify this value using
string (https://golang.org/pkg/time/#Duration.String) like "3s"
in their Custom Resource YAML. However, time.Duration is at a nanosecond
granularity, and it is easy to introduce a bug where it looks like the
code is dealing with seconds but its actually nanoseconds (or vice versa).
type: string
secretRef:
description: |-
secretRef holds the authentication secret for accessing
the OCI repository.
nullable: true
properties:
name:
description: name represents the secret name.
type: string
type: object
required:
- auth
- image
type: object
override:
description: override allows to override the settings for a reconciler.
nullable: true
properties:
apiServerTimeout:
description: |-
apiServerTimeout allows one to override the client-side timeout for requests to the API server.
Default: 15s.
Use string to specify this field value, like "30s", "1m".
More details about valid inputs: https://pkg.go.dev/time#ParseDuration.
Recommended apiServerTimeout range is from "3s" to "1m".
type: string
enableShellInRendering:
description: |-
enableShellInRendering specifies whether to enable or disable the shell access in rendering process. Default: false.
Kustomize remote bases requires shell access. Setting this field to true will enable shell in the rendering process and
support pulling remote bases from public repositories.
type: boolean
gitSyncDepth:
description: |-
gitSyncDepth allows one to override the number of git commits to fetch.
Must be no less than 0.
Config Sync would do a full clone if this field is 0, and a shallow
clone if this field is greater than 0.
If this field is not provided, Config Sync would configure it automatically.
format: int64
minimum: 0
type: integer
logLevels:
description: |-
logLevels specify the container name and log level override value for the reconciler deployment container.
Each entry must contain the name of the reconciler deployment container and the desired log level.
items:
description: ContainerLogLevelOverride specifies the container
name and log level override value
properties:
containerName:
description: |-
containerName specifies the name of the reconciler deployment container for which log level will be overridden.
Must be one of the following: "reconciler", "git-sync", "hydration-controller", "oci-sync", or "helm-sync".
pattern: ^(reconciler|git-sync|hydration-controller|oci-sync|helm-sync|gcenode-askpass-sidecar|otel-agent)$
type: string
logLevel:
description: |-
logLevel specifies the verbosity level of the logging for a specific container.
The "git-sync" and "otel-agent" containers default to 5, while all other containers default to 0.
Increasing the value of logLevel increases the verbosity of the logs.
Lower severity messages are logged at higher verbosity.
Allowed values are from -10 to 10.
maximum: 10
minimum: -10
type: integer
required:
- containerName
- logLevel
type: object
type: array
x-kubernetes-list-map-keys:
- containerName
x-kubernetes-list-type: map
namespaceStrategy:
description: |-
namespaceStrategy controls how the reconciler handles Namespaces
which are used by resources in the source but not declared. Only applies
when using the unstructured sourceFormat.
Must be "implicit" or "explicit". Default: "implicit".
"implicit" means that the reconciler will implicitly create Namespaces
if they do not exist, even if they are not declared in the source.
"explicit" means that the reconciler will not create Namespaces which
are not declared in the source.
enum:
- implicit
- explicit
type: string
reconcileTimeout:
description: |-
reconcileTimeout allows one to override the threshold for how long to wait for
all resources to reconcile before giving up.
Default: 5m.
Use string to specify this field value, like "30s", "5m".
More details about valid inputs: https://pkg.go.dev/time#ParseDuration.
Recommended reconcileTimeout range is from "10s" to "1h".
type: string
resources:
description: resources allow one to override the resource requirements
for the containers in a reconciler pod.
items:
description: ContainerResourcesSpec allows to override the resource
requirements for a container
properties:
containerName:
description: |-
containerName specifies the name of a container whose resource requirements will be overridden.
Must be "reconciler", "git-sync", "hydration-controller", "oci-sync", or "helm-sync".
pattern: ^(reconciler|git-sync|hydration-controller|oci-sync|helm-sync|gcenode-askpass-sidecar|otel-agent)$
type: string
cpuLimit:
anyOf:
- type: integer
- type: string
description: cpuLimit allows one to override the CPU limit
of a container
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
cpuRequest:
anyOf:
- type: integer
- type: string
description: cpuRequest allows one to override the CPU request
of a container
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
memoryLimit:
anyOf:
- type: integer
- type: string
description: memoryLimit allows one to override the memory
limit of a container
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
memoryRequest:
anyOf:
- type: integer
- type: string
description: memoryRequest allows one to override the memory
request of a container
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
type: array
roleRefs:
description: |-
roleRefs is a list of Roles or ClusterRoles to create bindings.
If unset, a binding to cluster-admin will be created.
items:
description: |-
each item references a Role or ClusterRole to create
a binding to for this reconciler. It supports a namespace field that can be used
to create RoleBindings rather than ClusterRoleBindings.
properties:
kind:
description: |-
kind refers to the Kind of the RBAC resource.
Accepted values are Role and ClusterRole. Required.
enum:
- Role
- ClusterRole
type: string
name:
description: name is the name of the Role or ClusterRole
resource. Required.
type: string
namespace:
description: |-
namespace indicates the Namespace in which a RoleBinding should be created.
For ClusterRole objects, will determine whether a RoleBinding or ClusterRoleBinding
is created.
For Role objects, must be set to the same namespace as the Role.
type: string
required:
- kind
- name
type: object
type: array
statusMode:
description: |-
statusMode controls whether the actuation status
such as apply failed or not should be embedded into the ResourceGroup object.
Must be "enabled" or "disabled".
If set to "enabled", it increases the size of the ResourceGroup object.
pattern: ^(enabled|disabled|)$
type: string
type: object
sourceFormat:
description: |-
sourceFormat specifies how the repository is formatted.
See documentation for specifics of what these options do.
Must be one of hierarchy, unstructured. Optional. Set to
hierarchy if not specified.
The validation of this is case-sensitive.
pattern: ^(hierarchy|unstructured|)$
type: string
sourceType:
default: git
description: |-
sourceType specifies the type of the source of truth.
Must be one of git, oci, helm. Optional. Set to git if not specified.
pattern: ^(git|oci|helm)$
type: string
type: object
status:
description: RootSyncStatus defines the observed state of RootSync
properties:
conditions:
description: |-
conditions represents the latest available observations of the RootSync's
current state.
items:
description: RootSyncCondition describes the state of a RootSync
at a certain point.
properties:
commit:
description: hash of the source of truth. It can be a git commit
hash, or an OCI image digest.
type: string
errorSourceRefs:
description: errorSourceRefs track the origination(s) of errors
when the condition type is Syncing.
items:
description: ErrorSource indicates the origination of errors.
type: string
type: array
errorSummary:
description: |-
errorSummary summarizes the errors in the `errors` field when the condition type is Reconciling or Stalled,
and summarizes the errors referred in the `errorsSourceRefs` field when the condition type is Syncing.
properties:
errorCountAfterTruncation:
description: errorCountAfterTruncation tracks the number
of errors in the `Errors` field.
type: integer
totalCount:
description: totalCount tracks the total number of errors.
type: integer
truncated:
description: |-
truncated indicates whether the `Errors` field includes all the errors.
If `true`, the `Errors` field does not includes all the errors.
If `false`, the `Errors` field includes all the errors.
The size limit of a RootSync/RepoSync object is 2MiB. The status update would
fail with the `ResourceExhausted` rpc error if there are too many errors.
type: boolean
type: object
errors:
description: |-
errors is a list of errors that occurred in the process.
This field is used to track errors when the condition type is Reconciling or Stalled.
When the condition type is Syncing, the `errorSourceRefs` field is used instead to
avoid duplicating errors between `status.conditions` and `status.rendering|source|sync`.
items:
description: |-
ConfigSyncError represents an error that occurs while parsing, applying, or
remediating a resource.
properties:
code:
description: |-
code is the error code of this particular error. Error codes are numeric strings,
like "1012".
type: string
errorMessage:
description: errorMessage describes the error that occurred.
type: string
errorResources:
description: errorResources describes the resources associated
with this error, if any.
items:
description: ResourceRef contains the identification
bits of a single managed resource.
properties:
gvk:
description: |-
gvk is the GroupVersionKind of the affected K8S resource. This field may be
empty for errors that are not associated with a specific resource.
properties:
group:
type: string
kind:
type: string
version:
type: string
required:
- group
- kind
- version
type: object
name:
description: |-
name is the name of the affected K8S resource. This field may be empty for
errors that are not associated with a specific resource.
type: string
namespace:
description: |-
namespace is the namespace of the affected K8S resource. This field may be
empty for errors that are associated with a cluster-scoped resource or not
associated with a specific resource.
type: string
sourcePath:
description: |-
sourcePath is the repo-relative slash path to where the config is defined.
This field may be empty for errors that are not associated with a specific
config file.
type: string
type: object
type: array
required:
- code
- errorMessage
type: object
type: array
lastTransitionTime:
description: Last time the condition transitioned from one status
to another.
format: date-time
nullable: true
type: string
lastUpdateTime:
description: The last time this condition was updated.
format: date-time
nullable: true
type: string
message:
description: A human readable message indicating details about
the transition.
type: string
reason:
description: The reason for the condition's last transition.
type: string
status:
description: status of the condition, one of True, False, Unknown.
type: string
type:
description: type of RootSync condition.
type: string
required:
- status
- type
type: object
type: array
lastSyncedCommit:
description: |-
lastSyncedCommit describes the most recent hash that is successfully synced.
It can be a git commit hash, or an OCI image digest.
type: string
observedGeneration:
default: 0
description: |-
observedGeneration is the most recent generation observed for the sync resource.
It corresponds to the it's generation, which is updated on mutation by the API Server.
format: int64
type: integer
reconciler:
description: |-
reconciler is the name of the reconciler process which corresponds to the
sync resource.
type: string
rendering:
description: |-
rendering contains fields describing the status of rendering resources from
the source of truth.
properties:
commit:
description: |-
hash of the source of truth that is rendered.
It can be a git commit hash, or an OCI image digest.
type: string
errorSummary:
description: errorSummary summarizes the errors encountered during
the process of rendering the source of truth.
properties:
errorCountAfterTruncation:
description: errorCountAfterTruncation tracks the number of
errors in the `Errors` field.
type: integer
totalCount:
description: totalCount tracks the total number of errors.
type: integer
truncated:
description: |-
truncated indicates whether the `Errors` field includes all the errors.
If `true`, the `Errors` field does not includes all the errors.
If `false`, the `Errors` field includes all the errors.
The size limit of a RootSync/RepoSync object is 2MiB. The status update would
fail with the `ResourceExhausted` rpc error if there are too many errors.
type: boolean
type: object
errors:
description: errors is a list of any errors that occurred while
rendering the source of truth.
items:
description: |-
ConfigSyncError represents an error that occurs while parsing, applying, or
remediating a resource.
properties:
code:
description: |-
code is the error code of this particular error. Error codes are numeric strings,
like "1012".
type: string
errorMessage:
description: errorMessage describes the error that occurred.
type: string
errorResources:
description: errorResources describes the resources associated
with this error, if any.
items:
description: ResourceRef contains the identification bits
of a single managed resource.
properties:
gvk:
description: |-
gvk is the GroupVersionKind of the affected K8S resource. This field may be
empty for errors that are not associated with a specific resource.
properties:
group:
type: string
kind:
type: string
version:
type: string
required:
- group
- kind
- version
type: object
name:
description: |-
name is the name of the affected K8S resource. This field may be empty for
errors that are not associated with a specific resource.
type: string
namespace:
description: |-
namespace is the namespace of the affected K8S resource. This field may be
empty for errors that are associated with a cluster-scoped resource or not
associated with a specific resource.
type: string
sourcePath:
description: |-
sourcePath is the repo-relative slash path to where the config is defined.
This field may be empty for errors that are not associated with a specific
config file.
type: string
type: object
type: array
required:
- code
- errorMessage
type: object
type: array
gitStatus:
description: gitStatus contains fields describing the status of
a Git source of truth.
properties:
branch:
description: branch is the git branch being fetched
type: string
dir:
description: |-
dir is the path within the Git repository that represents the top level of the repo to sync.
Default: the root directory of the repository
type: string
repo:
description: repo is the git repository URL being synced from.
type: string
revision:
description: revision is the git revision (tag, ref, or commit)
being fetched.
type: string
required:
- branch
- dir
- repo
- revision
type: object
helmStatus:
description: helmStatus contains fields describing the status
of a Helm source of truth.
properties:
chart:
description: chart is the name of helm chart being fetched
type: string
repo:
description: repo is the helm repository URL being synced
from.
type: string
version:
description: version is the helm chart version being fetched.
type: string
required:
- chart
- repo
- version
type: object
lastUpdate:
description: |-
lastUpdate is the timestamp of when this status was last updated by a
reconciler.
format: date-time
nullable: true
type: string
message:
description: Human-readable message describes details about the
rendering status.
type: string
ociStatus:
description: ociStatus contains fields describing the status of
an OCI source of truth.
properties:
dir:
description: |-
dir is the absolute path of the directory that contains the local resources.
Default: the root directory of the repository
type: string
image:
description: image is the OCI image repository URL for the
package to sync from.
type: string
required:
- dir
- image
type: object
type: object
source:
description: |-
source contains fields describing the status of a *Sync's source of
truth.
properties:
commit:
description: |-
hash of the source of truth that is rendered.
It can be a git commit hash, or an OCI image digest.
type: string
errorSummary:
description: errorSummary summarizes the errors encountered during
the process of reading from the source of truth.
properties:
errorCountAfterTruncation:
description: errorCountAfterTruncation tracks the number of
errors in the `Errors` field.
type: integer
totalCount:
description: totalCount tracks the total number of errors.
type: integer
truncated:
description: |-
truncated indicates whether the `Errors` field includes all the errors.
If `true`, the `Errors` field does not includes all the errors.
If `false`, the `Errors` field includes all the errors.
The size limit of a RootSync/RepoSync object is 2MiB. The status update would
fail with the `ResourceExhausted` rpc error if there are too many errors.
type: boolean
type: object
errors:
description: errors is a list of any errors that occurred while
reading from the source of truth.
items:
description: |-
ConfigSyncError represents an error that occurs while parsing, applying, or
remediating a resource.
properties:
code:
description: |-
code is the error code of this particular error. Error codes are numeric strings,
like "1012".
type: string
errorMessage:
description: errorMessage describes the error that occurred.
type: string
errorResources:
description: errorResources describes the resources associated
with this error, if any.
items:
description: ResourceRef contains the identification bits
of a single managed resource.
properties:
gvk:
description: |-
gvk is the GroupVersionKind of the affected K8S resource. This field may be
empty for errors that are not associated with a specific resource.
properties:
group:
type: string
kind:
type: string
version:
type: string
required:
- group
- kind
- version
type: object
name:
description: |-
name is the name of the affected K8S resource. This field may be empty for
errors that are not associated with a specific resource.
type: string
namespace:
description: |-
namespace is the namespace of the affected K8S resource. This field may be
empty for errors that are associated with a cluster-scoped resource or not
associated with a specific resource.
type: string
sourcePath:
description: |-
sourcePath is the repo-relative slash path to where the config is defined.
This field may be empty for errors that are not associated with a specific
config file.
type: string
type: object
type: array
required:
- code
- errorMessage
type: object
type: array
gitStatus:
description: gitStatus contains fields describing the status of
a Git source of truth.
properties:
branch:
description: branch is the git branch being fetched
type: string
dir: