Skip to content

Commit 3f70880

Browse files
bastjanbastjan
authored
Merge pull request #170 from vshn/renovate/github.com-elastic-crd-ref-docs-0.x
Update module github.com/elastic/crd-ref-docs to v0.3.0
2 parents b9e9bac + e5dbfdc commit 3f70880

3 files changed

Lines changed: 60 additions & 35 deletions

File tree

‎docs/api.adoc‎

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,11 @@ The namespace is configured at controller startup and normally points to the nam
9898
|===
9999
| Field | Description | Default | Validation
100100
| *`fieldManager`* __string__ | FieldManager is the field manager to use when applying the ManagedResource +
101-
If not set, the field manager is set to the name of the resource with `managed-resource` prefix + | |
101+
If not set, the field manager is set to the name of the resource with `managed-resource` prefix + | | Optional: \{} +
102+
102103
| *`force`* __boolean__ | Force is going to "force" Apply requests. It means user will +
103-
re-acquire conflicting fields owned by other people. + | false |
104+
re-acquire conflicting fields owned by other people. + | false | Optional: \{} +
105+
104106
| *`fieldValidation`* __string__ | fieldValidation instructs the managed resource on how to handle +
105107
objects containing unknown or duplicate fields. Valid values are: +
106108
- Ignore: This will ignore any unknown fields that are silently +
@@ -114,6 +116,7 @@ any unknown fields would be dropped from the object, or if any +
114116
duplicate fields are present. The error returned will contain +
115117
all unknown and duplicate fields encountered. +
116118
Defaults to "Strict". + | Strict | Enum: [Ignore Strict] +
119+
Optional: \{} +
117120

118121
|===
119122

@@ -213,7 +216,8 @@ The filtering is done on the controller side and might not be as efficient as th
213216
Filtered objects are dropped before any caching or processing. + | |
214217
| *`stripManagedFields`* __boolean__ | StripManagedFields removes the managedFields from the watched resource. +
215218
managedFields are not used in Espejote and if the template does not use them, they can be removed to significantly reduce the size of cached objects. +
216-
Defaults to true if not set. + | |
219+
Defaults to true if not set. + | | Optional: \{} +
220+
217221
|===
218222

219223

@@ -333,7 +337,8 @@ ManagedResourceSpec defines the desired state of ManagedResource
333337
| Field | Description | Default | Validation
334338
| *`triggers`* __xref:{anchor_prefix}-github-com-vshn-espejote-api-v1alpha1-managedresourcetrigger[$$ManagedResourceTrigger$$] array__ | Triggers define the resources that trigger the reconciliation of the ManagedResource +
335339
Trigger information will be injected when rendering the template. +
336-
This can be used to only partially render the template based on the trigger. + | |
340+
This can be used to only partially render the template based on the trigger. + | | Optional: \{} +
341+
337342
| *`context`* __xref:{anchor_prefix}-github-com-vshn-espejote-api-v1alpha1-managedresourcecontext[$$ManagedResourceContext$$] array__ | Context defines the context for the ManagedResource + | |
338343
| *`serviceAccountRef`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core[$$LocalObjectReference$$]__ | ServiceAccountRef is the service account this managed resource runs as. +
339344
The service account must have the necessary permissions to manage the resources referenced in the template. +
@@ -356,6 +361,7 @@ If the initial sync does not complete within this time, the ManagedResource is m
356361
This usually happens because of missing RBAC permissions. +
357362
After the initial sync, the ManagedResource is reconciled normally. +
358363
Defaults to 2 minutes. + | | Format: duration +
364+
Optional: \{} +
359365

360366
| *`applyOptions`* __xref:{anchor_prefix}-github-com-vshn-espejote-api-v1alpha1-applyoptions[$$ApplyOptions$$]__ | ApplyOptions defines the options for applying the ManagedResource + | |
361367
|===
@@ -406,7 +412,8 @@ More information can be found by inspecting the ManagedResource's events with ei
406412

407413
| *`watchResource`* __xref:{anchor_prefix}-github-com-vshn-espejote-api-v1alpha1-triggerwatchresource[$$TriggerWatchResource$$]__ | WatchResource defines one or multiple resources that trigger the reconciliation of the ManagedResource. +
408414
Resource information is injected when rendering the template and can be retrieved using `(import "espejote.libsonnet").getTrigger()`. +
409-
`local esp = import "espejote.libsonnet"; esp.triggerType() == esp.TriggerTypeWatchResource` will be true if the render was triggered by a definition in this block. + | |
415+
`local esp = import "espejote.libsonnet"; esp.triggerType() == esp.TriggerTypeWatchResource` will be true if the render was triggered by a definition in this block. + | | Optional: \{} +
416+
410417
| *`watchContextResource`* __xref:{anchor_prefix}-github-com-vshn-espejote-api-v1alpha1-watchcontextresource[$$WatchContextResource$$]__ | WatchContextResource works the same as WatchResource, but it uses and already existing context resource. +
411418
This is useful when you require both full (when the template changes) and partial (a context resource changes) reconciliation of the same resource. +
412419
Check the example below. Both a context resource and a trigger are defined. If the trigger is not known in the template all network policies are reconciled. +
@@ -486,7 +493,8 @@ The filtering is done on the controller side and might not be as efficient as th
486493
Filtered objects are dropped before any caching or processing. + | |
487494
| *`stripManagedFields`* __boolean__ | StripManagedFields removes the managedFields from the watched resource. +
488495
managedFields are not used in Espejote and if the template does not use them, they can be removed to significantly reduce the size of cached objects. +
489-
Defaults to true if not set. + | |
496+
Defaults to true if not set. + | | Optional: \{} +
497+
490498
|===
491499

492500

@@ -536,7 +544,8 @@ from putting the cluster in a state which cannot be recovered from without compl
536544
disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called +
537545
on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + | |
538546
| *`failurePolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#failurepolicytype-v1-admissionregistration[$$FailurePolicyType$$]__ | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - +
539-
allowed values are Ignore or Fail. Defaults to Fail. + | |
547+
allowed values are Ignore or Fail. Defaults to Fail. + | | Optional: \{} +
548+
540549
| *`matchPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#matchpolicytype-v1-admissionregistration[$$MatchPolicyType$$]__ | matchPolicy defines how the "rules" list is used to match incoming requests. +
541550
Allowed values are "Exact" or "Equivalent". +
542551

@@ -550,7 +559,8 @@ For example, if deployments can be modified via apps/v1, apps/v1beta1, and exten
550559
and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, +
551560
a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. +
552561

553-
Defaults to "Equivalent" + | |
562+
Defaults to "Equivalent" + | | Optional: \{} +
563+
554564
| *`objectSelector`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#labelselector-v1-meta[$$LabelSelector$$]__ | ObjectSelector decides whether to run the webhook based on if the +
555565
object has matching labels. objectSelector is evaluated against both +
556566
the oldObject and newObject that would be sent to the webhook, and +
@@ -561,7 +571,8 @@ DeploymentRollback or a PodProxyOptions object) is not considered to +
561571
match. +
562572
Use the object selector only if the webhook is opt-in, because end +
563573
users may skip the admission webhook by setting the labels. +
564-
Default to the empty LabelSelector, which matches everything. + | |
574+
Default to the empty LabelSelector, which matches everything. + | | Optional: \{} +
575+
565576
| *`reinvocationPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#reinvocationpolicytype-v1-admissionregistration[$$ReinvocationPolicyType$$]__ | reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. +
566577
Allowed values are "Never" and "IfNeeded". +
567578

@@ -576,7 +587,8 @@ Note: +
576587
* webhooks that use this option may be reordered to minimize the number of additional invocations. +
577588
* to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. +
578589

579-
Defaults to "Never". + | |
590+
Defaults to "Never". + | | Optional: \{} +
591+
580592
| *`matchConditions`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#matchcondition-v1-admissionregistration[$$MatchCondition$$] array__ | MatchConditions is a list of conditions that must be met for a request to be sent to this +
581593
webhook. Match conditions filter requests that have already been matched by the rules, +
582594
namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. +
@@ -587,7 +599,8 @@ The exact matching logic is (in order): +
587599
2. If ALL matchConditions evaluate to TRUE, the webhook is called. +
588600
3. If any matchCondition evaluates to an error (but none are FALSE): +
589601
- If failurePolicy=Fail, reject the request +
590-
- If failurePolicy=Ignore, the error is ignored and the webhook is skipped + | |
602+
- If failurePolicy=Ignore, the error is ignored and the webhook is skipped + | | Optional: \{} +
603+
591604
|===
592605

593606

@@ -650,15 +663,17 @@ See +
650663
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +
651664
for more examples of label selectors. +
652665

653-
Default to the empty LabelSelector, which matches everything. + | |
666+
Default to the empty LabelSelector, which matches everything. + | | Optional: \{} +
667+
654668
| *`rules`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#rulewithoperations-v1-admissionregistration[$$RuleWithOperations$$] array__ | Rules describes what operations on what resources/subresources the webhook cares about. +
655669
The webhook cares about an operation if it matches _any_ Rule. +
656670
However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks +
657671
from putting the cluster in a state which cannot be recovered from without completely +
658672
disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called +
659673
on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + | |
660674
| *`failurePolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#failurepolicytype-v1-admissionregistration[$$FailurePolicyType$$]__ | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - +
661-
allowed values are Ignore or Fail. Defaults to Fail. + | |
675+
allowed values are Ignore or Fail. Defaults to Fail. + | | Optional: \{} +
676+
662677
| *`matchPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#matchpolicytype-v1-admissionregistration[$$MatchPolicyType$$]__ | matchPolicy defines how the "rules" list is used to match incoming requests. +
663678
Allowed values are "Exact" or "Equivalent". +
664679

@@ -672,7 +687,8 @@ For example, if deployments can be modified via apps/v1, apps/v1beta1, and exten
672687
and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, +
673688
a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. +
674689

675-
Defaults to "Equivalent" + | |
690+
Defaults to "Equivalent" + | | Optional: \{} +
691+
676692
| *`objectSelector`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#labelselector-v1-meta[$$LabelSelector$$]__ | ObjectSelector decides whether to run the webhook based on if the +
677693
object has matching labels. objectSelector is evaluated against both +
678694
the oldObject and newObject that would be sent to the webhook, and +
@@ -683,7 +699,8 @@ DeploymentRollback or a PodProxyOptions object) is not considered to +
683699
match. +
684700
Use the object selector only if the webhook is opt-in, because end +
685701
users may skip the admission webhook by setting the labels. +
686-
Default to the empty LabelSelector, which matches everything. + | |
702+
Default to the empty LabelSelector, which matches everything. + | | Optional: \{} +
703+
687704
| *`reinvocationPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#reinvocationpolicytype-v1-admissionregistration[$$ReinvocationPolicyType$$]__ | reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. +
688705
Allowed values are "Never" and "IfNeeded". +
689706

@@ -698,7 +715,8 @@ Note: +
698715
* webhooks that use this option may be reordered to minimize the number of additional invocations. +
699716
* to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. +
700717

701-
Defaults to "Never". + | |
718+
Defaults to "Never". + | | Optional: \{} +
719+
702720
| *`matchConditions`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#matchcondition-v1-admissionregistration[$$MatchCondition$$] array__ | MatchConditions is a list of conditions that must be met for a request to be sent to this +
703721
webhook. Match conditions filter requests that have already been matched by the rules, +
704722
namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. +
@@ -709,7 +727,8 @@ The exact matching logic is (in order): +
709727
2. If ALL matchConditions evaluate to TRUE, the webhook is called. +
710728
3. If any matchCondition evaluates to an error (but none are FALSE): +
711729
- If failurePolicy=Fail, reject the request +
712-
- If failurePolicy=Ignore, the error is ignored and the webhook is skipped + | |
730+
- If failurePolicy=Ignore, the error is ignored and the webhook is skipped + | | Optional: \{} +
731+
713732
|===
714733

715734

‎go.mod‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,19 @@ require (
2929
require (
3030
al.essio.dev/pkg/shellescape v1.5.1 // indirect
3131
cel.dev/expr v0.25.1 // indirect
32+
dario.cat/mergo v1.0.2 // indirect
3233
github.com/BurntSushi/toml v1.4.0 // indirect
3334
github.com/Masterminds/goutils v1.1.1 // indirect
34-
github.com/Masterminds/semver v1.5.0 // indirect
35-
github.com/Masterminds/sprig v2.22.0+incompatible // indirect
35+
github.com/Masterminds/semver/v3 v3.4.0 // indirect
36+
github.com/Masterminds/sprig/v3 v3.3.0 // indirect
3637
github.com/antlr4-go/antlr/v4 v4.13.1 // indirect
3738
github.com/beorn7/perks v1.0.1 // indirect
3839
github.com/blang/semver/v4 v4.0.0 // indirect
3940
github.com/cenkalti/backoff/v5 v5.0.3 // indirect
4041
github.com/cespare/xxhash/v2 v2.3.0 // indirect
4142
github.com/cpuguy83/go-md2man/v2 v2.0.7 // indirect
4243
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
43-
github.com/elastic/crd-ref-docs v0.2.0 // indirect
44+
github.com/elastic/crd-ref-docs v0.3.0 // indirect
4445
github.com/emicklei/go-restful/v3 v3.13.0 // indirect
4546
github.com/evanphx/json-patch v5.9.0+incompatible // indirect
4647
github.com/felixge/httpsnoop v1.0.4 // indirect
@@ -66,7 +67,7 @@ require (
6667
github.com/go-openapi/swag/yamlutils v0.25.4 // indirect
6768
github.com/gobuffalo/flect v1.0.3 // indirect
6869
github.com/gobuffalo/here v0.6.7 // indirect
69-
github.com/goccy/go-yaml v1.18.0 // indirect
70+
github.com/goccy/go-yaml v1.19.2 // indirect
7071
github.com/google/btree v1.1.3 // indirect
7172
github.com/google/cel-go v0.26.1 // indirect
7273
github.com/google/gnostic-models v0.7.1 // indirect
@@ -77,7 +78,6 @@ require (
7778
github.com/hashicorp/errwrap v1.1.0 // indirect
7879
github.com/hashicorp/go-multierror v1.1.1 // indirect
7980
github.com/huandu/xstrings v1.5.0 // indirect
80-
github.com/imdario/mergo v0.3.16 // indirect
8181
github.com/inconshreveable/mousetrap v1.1.0 // indirect
8282
github.com/json-iterator/go v1.1.12 // indirect
8383
github.com/jsonnet-libs/docsonnet v0.0.7-0.20231214125531-6ac6c69685b8 // indirect
@@ -98,7 +98,9 @@ require (
9898
github.com/prometheus/procfs v0.19.2 // indirect
9999
github.com/russross/blackfriday/v2 v2.1.0 // indirect
100100
github.com/sergi/go-diff v1.4.0 // indirect
101+
github.com/shopspring/decimal v1.4.0 // indirect
101102
github.com/spf13/afero v1.12.0 // indirect
103+
github.com/spf13/cast v1.10.0 // indirect
102104
github.com/spf13/pflag v1.0.10 // indirect
103105
github.com/stoewer/go-strcase v1.3.1 // indirect
104106
github.com/x448/float16 v0.8.4 // indirect
@@ -140,7 +142,7 @@ require (
140142
k8s.io/component-base v0.35.0 // indirect
141143
k8s.io/gengo/v2 v2.0.0-20250922181213-ec3ebc5fd46b // indirect
142144
k8s.io/klog/v2 v2.130.1 // indirect
143-
k8s.io/kube-openapi v0.0.0-20251125145642-4e65d59e963e // indirect
145+
k8s.io/kube-openapi v0.0.0-20260127142750-a19766b6e2d4 // indirect
144146
sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.34.0 // indirect
145147
sigs.k8s.io/controller-runtime/tools/setup-envtest v0.0.0-20250211091558-894df3a7e664 // indirect
146148
sigs.k8s.io/controller-tools v0.20.0 // indirect

0 commit comments

Comments
 (0)