Skip to content

Commit f75fb54

Browse files
jbw976jbw976
committed
v2.0 docs release
Signed-off-by: Jared Watts <[email protected]>
1 parent ad7f75a commit f75fb54

File tree

117 files changed

+12407
-18664
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+12407
-18664
lines changed

‎config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ security:
9090
# Global parameters accessible by any Page
9191
params:
9292
# The current "latest" version. Used in the version dropdown
93-
latest: "1.20"
93+
latest: "2.0"
9494
docs: true
9595
anchors:
9696
# Generate heading anchors for any heading between min and max

‎content/master/api/crds/apiextensions.crossplane.io_compositeresourcedefinitions.yaml

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
33
kind: CustomResourceDefinition
44
metadata:
55
annotations:
6-
controller-gen.kubebuilder.io/version: v0.16.5
6+
controller-gen.kubebuilder.io/version: v0.18.0
77
name: compositeresourcedefinitions.apiextensions.crossplane.io
88
spec:
99
group: apiextensions.crossplane.io
@@ -29,6 +29,9 @@ spec:
2929
- jsonPath: .metadata.creationTimestamp
3030
name: AGE
3131
type: date
32+
deprecated: true
33+
deprecationWarning: CompositeResourceDefinition v1 is deprecated and will be removed
34+
in a future release; consider migrating to v2
3235
name: v1
3336
schema:
3437
openAPIV3Schema:
@@ -122,9 +125,11 @@ spec:
122125
rule: '!has(self.singular) || self.singular == self.singular.lowerAscii()'
123126
connectionSecretKeys:
124127
description: |-
125-
ConnectionSecretKeys is the list of keys that will be exposed to the end
126-
user of the defined kind.
127-
If the list is empty, all keys will be published.
128+
ConnectionSecretKeys is the list of connection secret keys the
129+
defined XR can publish. If the list is empty, all keys will be
130+
published. If the list isn't empty, any connection secret keys that
131+
don't appear in the list will be filtered out. Only LegacyCluster XRs
132+
support connection secrets.
128133
items:
129134
type: string
130135
type: array
@@ -505,6 +510,8 @@ spec:
505510
x-kubernetes-validations:
506511
- message: Only LegacyCluster composite resources can offer claims
507512
rule: self.scope == 'LegacyCluster' || !has(self.claimNames)
513+
- message: Only LegacyCluster composite resources support connection secrets
514+
rule: self.scope == 'LegacyCluster' || !has(self.connectionSecretKeys)
508515
status:
509516
description: CompositeResourceDefinitionStatus shows the observed state
510517
of the definition.
@@ -600,8 +607,7 @@ spec:
600607
type: object
601608
type: object
602609
served: true
603-
# v1 is actually the storage version, its set to false only here in the docs so v2alpha1 will be displayed
604-
storage: false
610+
storage: true
605611
subresources:
606612
status: {}
607613
- additionalPrinterColumns:
@@ -614,7 +620,7 @@ spec:
614620
- jsonPath: .metadata.creationTimestamp
615621
name: AGE
616622
type: date
617-
name: v2alpha1
623+
name: v2
618624
schema:
619625
openAPIV3Schema:
620626
description: |-
@@ -702,9 +708,14 @@ spec:
702708
type: object
703709
connectionSecretKeys:
704710
description: |-
705-
ConnectionSecretKeys is the list of keys that will be exposed to the end
706-
user of the defined kind.
707-
If the list is empty, all keys will be published.
711+
ConnectionSecretKeys is the list of connection secret keys the
712+
defined XR can publish. If the list is empty, all keys will be
713+
published. If the list isn't empty, any connection secret keys that
714+
don't appear in the list will be filtered out. Only LegacyCluster XRs
715+
support connection secrets.
716+
717+
Deprecated: XR connection secrets aren't supported in
718+
apiextensions.crossplane.io/v2. Compose a secret instead.
708719
items:
709720
type: string
710721
type: array
@@ -1079,6 +1090,8 @@ spec:
10791090
x-kubernetes-validations:
10801091
- message: Claims aren't supported in apiextensions.crossplane.io/v2
10811092
rule: '!has(self.claimNames)'
1093+
- message: XR connection secrets aren't supported in apiextensions.crossplane.io/v2
1094+
rule: '!has(self.connectionSecretKeys)'
10821095
status:
10831096
description: CompositeResourceDefinitionStatus shows the observed state
10841097
of the definition.
@@ -1174,7 +1187,6 @@ spec:
11741187
type: object
11751188
type: object
11761189
served: true
1177-
# v2alpha1 is not actually the storage version, but its set to true here in the docs so v2alpha1 will be displayed
1178-
storage: true
1190+
storage: false
11791191
subresources:
11801192
status: {}

‎content/master/api/crds/apiextensions.crossplane.io_compositionrevisions.yaml

Lines changed: 67 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
33
kind: CustomResourceDefinition
44
metadata:
55
annotations:
6-
controller-gen.kubebuilder.io/version: v0.16.5
6+
controller-gen.kubebuilder.io/version: v0.18.0
77
name: compositionrevisions.apiextensions.crossplane.io
88
spec:
99
group: apiextensions.crossplane.io
@@ -87,28 +87,27 @@ spec:
8787
Mode controls what type or "mode" of Composition will be used.
8888
8989
"Pipeline" indicates that a Composition specifies a pipeline of
90-
Composition Functions, each of which is responsible for producing
91-
composed resources that Crossplane should create or update.
90+
functions, each of which is responsible for producing composed
91+
resources that Crossplane should create or update.
9292
enum:
9393
- Pipeline
9494
type: string
9595
pipeline:
9696
description: |-
97-
Pipeline is a list of composition function steps that will be used when a
98-
composite resource referring to this composition is created. One of
99-
resources and pipeline must be specified - you cannot specify both.
97+
Pipeline is a list of function steps that will be used when a
98+
composite resource referring to this composition is created.
10099
101100
The Pipeline is only used by the "Pipeline" mode of Composition. It is
102101
ignored by other modes.
103102
items:
104-
description: A PipelineStep in a Composition Function pipeline.
103+
description: A PipelineStep in a function pipeline.
105104
properties:
106105
credentials:
107-
description: Credentials are optional credentials that the Composition
108-
Function needs.
106+
description: Credentials are optional credentials that the function
107+
needs.
109108
items:
110109
description: |-
111-
FunctionCredentials are optional credentials that a Composition Function
110+
FunctionCredentials are optional credentials that a function
112111
needs to run.
113112
properties:
114113
name:
@@ -148,7 +147,7 @@ spec:
148147
x-kubernetes-list-type: map
149148
functionRef:
150149
description: |-
151-
FunctionRef is a reference to the Composition Function this step should
150+
FunctionRef is a reference to the function this step should
152151
execute.
153152
properties:
154153
name:
@@ -160,11 +159,66 @@ spec:
160159
input:
161160
description: |-
162161
Input is an optional, arbitrary Kubernetes resource (i.e. a resource
163-
with an apiVersion and kind) that will be passed to the Composition
164-
Function as the 'input' of its RunFunctionRequest.
162+
with an apiVersion and kind) that will be passed to the function as
163+
the 'input' of its RunFunctionRequest.
165164
type: object
166165
x-kubernetes-embedded-resource: true
167166
x-kubernetes-preserve-unknown-fields: true
167+
requirements:
168+
description: |-
169+
Requirements are resource requirements that will be satisfied before
170+
this pipeline step is called for the first time. This allows
171+
pre-populating required resources without requiring a function to
172+
request them first.
173+
properties:
174+
requiredResources:
175+
description: |-
176+
RequiredResources is a list of resources that must be fetched before
177+
this function is called.
178+
items:
179+
description: RequiredResourceSelector selects a required
180+
resource.
181+
properties:
182+
apiVersion:
183+
description: APIVersion of the required resource.
184+
type: string
185+
kind:
186+
description: Kind of the required resource.
187+
type: string
188+
matchLabels:
189+
additionalProperties:
190+
type: string
191+
description: |-
192+
MatchLabels specifies the set of labels to match for finding the
193+
required resource. When specified, Name is ignored.
194+
type: object
195+
name:
196+
description: Name of the required resource.
197+
type: string
198+
namespace:
199+
description: Namespace of the required resource if
200+
it is namespaced.
201+
type: string
202+
requirementName:
203+
description: |-
204+
RequirementName is the unique name to identify this required resource
205+
in the Required Resources map in the function request.
206+
type: string
207+
required:
208+
- apiVersion
209+
- kind
210+
- requirementName
211+
type: object
212+
x-kubernetes-validations:
213+
- message: Either name or matchLabels must be specified,
214+
but not both
215+
rule: (has(self.name) && !has(self.matchLabels)) ||
216+
(!has(self.name) && has(self.matchLabels))
217+
type: array
218+
x-kubernetes-list-map-keys:
219+
- requirementName
220+
x-kubernetes-list-type: map
221+
type: object
168222
step:
169223
description: Step name. Must be unique within its Pipeline.
170224
type: string

‎content/master/api/crds/apiextensions.crossplane.io_compositions.yaml

Lines changed: 65 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
33
kind: CustomResourceDefinition
44
metadata:
55
annotations:
6-
controller-gen.kubebuilder.io/version: v0.16.5
6+
controller-gen.kubebuilder.io/version: v0.18.0
77
name: compositions.apiextensions.crossplane.io
88
spec:
99
group: apiextensions.crossplane.io
@@ -82,8 +82,8 @@ spec:
8282
Mode controls what type or "mode" of Composition will be used.
8383
8484
"Pipeline" indicates that a Composition specifies a pipeline of
85-
Composition Functions, each of which is responsible for producing
86-
composed resources that Crossplane should create or update.
85+
functions, each of which is responsible for producing composed
86+
resources that Crossplane should create or update.
8787
enum:
8888
- Pipeline
8989
type: string
@@ -96,14 +96,14 @@ spec:
9696
The Pipeline is only used by the "Pipeline" mode of Composition. It is
9797
ignored by other modes.
9898
items:
99-
description: A PipelineStep in a Composition Function pipeline.
99+
description: A PipelineStep in a function pipeline.
100100
properties:
101101
credentials:
102-
description: Credentials are optional credentials that the Composition
103-
Function needs.
102+
description: Credentials are optional credentials that the function
103+
needs.
104104
items:
105105
description: |-
106-
FunctionCredentials are optional credentials that a Composition Function
106+
FunctionCredentials are optional credentials that a function
107107
needs to run.
108108
properties:
109109
name:
@@ -143,7 +143,7 @@ spec:
143143
x-kubernetes-list-type: map
144144
functionRef:
145145
description: |-
146-
FunctionRef is a reference to the Composition Function this step should
146+
FunctionRef is a reference to the function this step should
147147
execute.
148148
properties:
149149
name:
@@ -155,11 +155,66 @@ spec:
155155
input:
156156
description: |-
157157
Input is an optional, arbitrary Kubernetes resource (i.e. a resource
158-
with an apiVersion and kind) that will be passed to the Composition
159-
Function as the 'input' of its RunFunctionRequest.
158+
with an apiVersion and kind) that will be passed to the function as
159+
the 'input' of its RunFunctionRequest.
160160
type: object
161161
x-kubernetes-embedded-resource: true
162162
x-kubernetes-preserve-unknown-fields: true
163+
requirements:
164+
description: |-
165+
Requirements are resource requirements that will be satisfied before
166+
this pipeline step is called for the first time. This allows
167+
pre-populating required resources without requiring a function to
168+
request them first.
169+
properties:
170+
requiredResources:
171+
description: |-
172+
RequiredResources is a list of resources that must be fetched before
173+
this function is called.
174+
items:
175+
description: RequiredResourceSelector selects a required
176+
resource.
177+
properties:
178+
apiVersion:
179+
description: APIVersion of the required resource.
180+
type: string
181+
kind:
182+
description: Kind of the required resource.
183+
type: string
184+
matchLabels:
185+
additionalProperties:
186+
type: string
187+
description: |-
188+
MatchLabels specifies the set of labels to match for finding the
189+
required resource. When specified, Name is ignored.
190+
type: object
191+
name:
192+
description: Name of the required resource.
193+
type: string
194+
namespace:
195+
description: Namespace of the required resource if
196+
it is namespaced.
197+
type: string
198+
requirementName:
199+
description: |-
200+
RequirementName is the unique name to identify this required resource
201+
in the Required Resources map in the function request.
202+
type: string
203+
required:
204+
- apiVersion
205+
- kind
206+
- requirementName
207+
type: object
208+
x-kubernetes-validations:
209+
- message: Either name or matchLabels must be specified,
210+
but not both
211+
rule: (has(self.name) && !has(self.matchLabels)) ||
212+
(!has(self.name) && has(self.matchLabels))
213+
type: array
214+
x-kubernetes-list-map-keys:
215+
- requirementName
216+
x-kubernetes-list-type: map
217+
type: object
163218
step:
164219
description: Step name. Must be unique within its Pipeline.
165220
type: string

0 commit comments

Comments
 (0)