Skip to content

Commit 11ed92d

Browse files
authored
Add documentation for ImageConfig (#830)
1 parent f881158 commit 11ed92d

25 files changed

+1400
-1854
lines changed

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

Lines changed: 1 addition & 8 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.14.0
6+
controller-gen.kubebuilder.io/version: v0.16.5
77
name: compositeresourcedefinitions.apiextensions.crossplane.io
88
spec:
99
group: apiextensions.crossplane.io
@@ -36,7 +36,6 @@ spec:
3636
A CompositeResourceDefinition defines the schema for a new custom Kubernetes
3737
API.
3838
39-
4039
Read the Crossplane documentation for
4140
[more information about CustomResourceDefinitions](https://docs.crossplane.io/latest/concepts/composite-resource-definitions).
4241
properties:
@@ -155,7 +154,6 @@ spec:
155154
service is a reference to the service for this webhook. Either
156155
service or url must be specified.
157156
158-
159157
If the webhook is running within the cluster, then you should use `service`.
160158
properties:
161159
name:
@@ -189,29 +187,24 @@ spec:
189187
(`scheme://host:port/path`). Exactly one of `url` or `service`
190188
must be specified.
191189
192-
193190
The `host` should not refer to a service running in the cluster; use
194191
the `service` field instead. The host might be resolved via external
195192
DNS in some apiservers (e.g., `kube-apiserver` cannot resolve
196193
in-cluster DNS as that would be a layering violation). `host` may
197194
also be an IP address.
198195
199-
200196
Please note that using `localhost` or `127.0.0.1` as a `host` is
201197
risky unless you take great care to run this webhook on all hosts
202198
which run an apiserver which might need to make calls to this
203199
webhook. Such installs are likely to be non-portable, i.e., not easy
204200
to turn up in a new cluster.
205201
206-
207202
The scheme must be "https"; the URL must begin with "https://".
208203
209-
210204
A path is optional, and if present may be any string permissible in
211205
a URL. You may use the path to pass an arbitrary string to the
212206
webhook, for example, a cluster identifier.
213207
214-
215208
Attempting to use a user or basic auth e.g. "user:password@" is not
216209
allowed. Fragments ("#...") and query parameters ("?...") are not
217210
allowed, either.

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

Lines changed: 31 additions & 1077 deletions
Large diffs are not rendered by default.

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

Lines changed: 9 additions & 535 deletions
Large diffs are not rendered by default.

content/master/api/crds/apiextensions.crossplane.io_environmentconfigs.yaml

Lines changed: 42 additions & 1 deletion
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.14.0
6+
controller-gen.kubebuilder.io/version: v0.16.5
77
name: environmentconfigs.apiextensions.crossplane.io
88
spec:
99
group: apiextensions.crossplane.io
@@ -29,6 +29,47 @@ spec:
2929
An EnvironmentConfig contains user-defined unstructured values for
3030
use in a Composition.
3131
32+
Read the Crossplane documentation for
33+
[more information about EnvironmentConfigs](https://docs.crossplane.io/latest/concepts/environment-configs).
34+
properties:
35+
apiVersion:
36+
description: |-
37+
APIVersion defines the versioned schema of this representation of an object.
38+
Servers should convert recognized schemas to the latest internal value, and
39+
may reject unrecognized values.
40+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
41+
type: string
42+
data:
43+
additionalProperties:
44+
x-kubernetes-preserve-unknown-fields: true
45+
description: |-
46+
The data of this EnvironmentConfig.
47+
This may contain any kind of structure that can be serialized into JSON.
48+
type: object
49+
kind:
50+
description: |-
51+
Kind is a string value representing the REST resource this object represents.
52+
Servers may infer this from the endpoint the client submits requests to.
53+
Cannot be updated.
54+
In CamelCase.
55+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
56+
type: string
57+
metadata:
58+
type: object
59+
type: object
60+
served: true
61+
storage: false
62+
subresources: {}
63+
- additionalPrinterColumns:
64+
- jsonPath: .metadata.creationTimestamp
65+
name: AGE
66+
type: date
67+
name: v1beta1
68+
schema:
69+
openAPIV3Schema:
70+
description: |-
71+
An EnvironmentConfig contains user-defined unstructured values for
72+
use in a Composition.
3273
3374
Read the Crossplane documentation for
3475
[more information about EnvironmentConfigs](https://docs.crossplane.io/latest/concepts/environment-configs).

content/master/api/crds/apiextensions.crossplane.io_usages.yaml

Lines changed: 1 addition & 3 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.14.0
6+
controller-gen.kubebuilder.io/version: v0.16.5
77
name: usages.apiextensions.crossplane.io
88
spec:
99
group: apiextensions.crossplane.io
@@ -32,11 +32,9 @@ spec:
3232
description: |-
3333
A Usage defines a deletion blocking relationship between two resources.
3434
35-
3635
Usages prevent accidental deletion of a single resource or deletion of
3736
resources with dependent resources.
3837
39-
4038
Read the Crossplane documentation for
4139
[more information about Compositions](https://docs.crossplane.io/latest/concepts/usages).
4240
properties:

content/master/api/crds/pkg.crossplane.io_configurationrevisions.yaml

Lines changed: 5 additions & 3 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.14.0
6+
controller-gen.kubebuilder.io/version: v0.16.5
77
name: configurationrevisions.pkg.crossplane.io
88
spec:
99
group: pkg.crossplane.io
@@ -46,7 +46,6 @@ spec:
4646
A ConfigurationRevision represents a revision of a Configuration. Crossplane
4747
creates new revisions when there are changes to a Configuration.
4848
49-
5049
Crossplane creates and manages ConfigurationRevision. Don't directly edit
5150
ConfigurationRevisions.
5251
properties:
@@ -113,10 +112,13 @@ spec:
113112
referenced object inside the same namespace.
114113
properties:
115114
name:
115+
default: ""
116116
description: |-
117117
Name of the referent.
118+
This field is effectively required, but due to backwards compatibility is
119+
allowed to be empty. Instances of this type with an empty value here are
120+
almost certainly wrong.
118121
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
119-
TODO: Add other useful fields. apiVersion, kind, uid?
120122
type: string
121123
type: object
122124
x-kubernetes-map-type: atomic

content/master/api/crds/pkg.crossplane.io_configurations.yaml

Lines changed: 5 additions & 3 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.14.0
6+
controller-gen.kubebuilder.io/version: v0.16.5
77
name: configurations.pkg.crossplane.io
88
spec:
99
group: pkg.crossplane.io
@@ -38,7 +38,6 @@ spec:
3838
Crossplane with support for new kinds of CompositeResourceDefinitions and
3939
Compositions.
4040
41-
4241
Read the Crossplane documentation for
4342
[more information about Configuration packages](https://docs.crossplane.io/latest/concepts/packages).
4443
properties:
@@ -99,10 +98,13 @@ spec:
9998
referenced object inside the same namespace.
10099
properties:
101100
name:
101+
default: ""
102102
description: |-
103103
Name of the referent.
104+
This field is effectively required, but due to backwards compatibility is
105+
allowed to be empty. Instances of this type with an empty value here are
106+
almost certainly wrong.
104107
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
105-
TODO: Add other useful fields. apiVersion, kind, uid?
106108
type: string
107109
type: object
108110
x-kubernetes-map-type: atomic

0 commit comments

Comments
 (0)