Add documentation for ImageConfig (#830)

crossplane · Nov 7, 2024 · 11ed92d · 11ed92d
1 parent f881158
commit 11ed92d
Show file tree

Hide file tree

Showing 25 changed files with 1,400 additions and 1,854 deletions.
diff --git a/content/master/api/crds/apiextensions.crossplane.io_compositeresourcedefinitions.yaml b/content/master/api/crds/apiextensions.crossplane.io_compositeresourcedefinitions.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.14.0
+    controller-gen.kubebuilder.io/version: v0.16.5
   name: compositeresourcedefinitions.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
@@ -36,7 +36,6 @@ spec:
           A CompositeResourceDefinition defines the schema for a new custom Kubernetes
           API.
 
-
           Read the Crossplane documentation for
           [more information about CustomResourceDefinitions](https://docs.crossplane.io/latest/concepts/composite-resource-definitions).
         properties:
@@ -155,7 +154,6 @@ spec:
                               service is a reference to the service for this webhook. Either
                               service or url must be specified.
 
-
                               If the webhook is running within the cluster, then you should use `service`.
                             properties:
                               name:
@@ -189,29 +187,24 @@ spec:
                               (`scheme://host:port/path`). Exactly one of `url` or `service`
                               must be specified.
 
-
                               The `host` should not refer to a service running in the cluster; use
                               the `service` field instead. The host might be resolved via external
                               DNS in some apiservers (e.g., `kube-apiserver` cannot resolve
                               in-cluster DNS as that would be a layering violation). `host` may
                               also be an IP address.
 
-
                               Please note that using `localhost` or `127.0.0.1` as a `host` is
                               risky unless you take great care to run this webhook on all hosts
                               which run an apiserver which might need to make calls to this
                               webhook. Such installs are likely to be non-portable, i.e., not easy
                               to turn up in a new cluster.
 
-
                               The scheme must be "https"; the URL must begin with "https://".
 
-
                               A path is optional, and if present may be any string permissible in
                               a URL. You may use the path to pass an arbitrary string to the
                               webhook, for example, a cluster identifier.
 
-
                               Attempting to use a user or basic auth e.g. "user:password@" is not
                               allowed. Fragments ("#...") and query parameters ("?...") are not
                               allowed, either.

diff --git a/content/master/api/crds/apiextensions.crossplane.io_compositionrevisions.yaml b/content/master/api/crds/apiextensions.crossplane.io_compositionrevisions.yaml
diff --git a/content/master/api/crds/apiextensions.crossplane.io_compositions.yaml b/content/master/api/crds/apiextensions.crossplane.io_compositions.yaml
diff --git a/content/master/api/crds/apiextensions.crossplane.io_environmentconfigs.yaml b/content/master/api/crds/apiextensions.crossplane.io_environmentconfigs.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.14.0
+    controller-gen.kubebuilder.io/version: v0.16.5
   name: environmentconfigs.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
@@ -29,6 +29,47 @@ spec:
           An EnvironmentConfig contains user-defined unstructured values for
           use in a Composition.
 
+          Read the Crossplane documentation for
+          [more information about EnvironmentConfigs](https://docs.crossplane.io/latest/concepts/environment-configs).
+        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
+          data:
+            additionalProperties:
+              x-kubernetes-preserve-unknown-fields: true
+            description: |-
+              The data of this EnvironmentConfig.
+              This may contain any kind of structure that can be serialized into JSON.
+            type: object
+          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
+        type: object
+    served: true
+    storage: false
+    subresources: {}
+  - additionalPrinterColumns:
+    - jsonPath: .metadata.creationTimestamp
+      name: AGE
+      type: date
+    name: v1beta1
+    schema:
+      openAPIV3Schema:
+        description: |-
+          An EnvironmentConfig contains user-defined unstructured values for
+          use in a Composition.
 
           Read the Crossplane documentation for
           [more information about EnvironmentConfigs](https://docs.crossplane.io/latest/concepts/environment-configs).

diff --git a/content/master/api/crds/apiextensions.crossplane.io_usages.yaml b/content/master/api/crds/apiextensions.crossplane.io_usages.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.14.0
+    controller-gen.kubebuilder.io/version: v0.16.5
   name: usages.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
@@ -32,11 +32,9 @@ spec:
         description: |-
           A Usage defines a deletion blocking relationship between two resources.
 
-
           Usages prevent accidental deletion of a single resource or deletion of
           resources with dependent resources.
 
-
           Read the Crossplane documentation for
           [more information about Compositions](https://docs.crossplane.io/latest/concepts/usages).
         properties:

diff --git a/content/master/api/crds/pkg.crossplane.io_configurationrevisions.yaml b/content/master/api/crds/pkg.crossplane.io_configurationrevisions.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.14.0
+    controller-gen.kubebuilder.io/version: v0.16.5
   name: configurationrevisions.pkg.crossplane.io
 spec:
   group: pkg.crossplane.io
@@ -46,7 +46,6 @@ spec:
           A ConfigurationRevision represents a revision of a Configuration. Crossplane
           creates new revisions when there are changes to a Configuration.
 
-
           Crossplane creates and manages ConfigurationRevision. Don't directly edit
           ConfigurationRevisions.
         properties:
@@ -113,10 +112,13 @@ spec:
                     referenced object inside the same namespace.
                   properties:
                     name:
+                      default: ""
                       description: |-
                         Name of the referent.
+                        This field is effectively required, but due to backwards compatibility is
+                        allowed to be empty. Instances of this type with an empty value here are
+                        almost certainly wrong.
                         More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-                        TODO: Add other useful fields. apiVersion, kind, uid?
                       type: string
                   type: object
                   x-kubernetes-map-type: atomic

diff --git a/content/master/api/crds/pkg.crossplane.io_configurations.yaml b/content/master/api/crds/pkg.crossplane.io_configurations.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.14.0
+    controller-gen.kubebuilder.io/version: v0.16.5
   name: configurations.pkg.crossplane.io
 spec:
   group: pkg.crossplane.io
@@ -38,7 +38,6 @@ spec:
           Crossplane with support for new kinds of CompositeResourceDefinitions and
           Compositions.
 
-
           Read the Crossplane documentation for
           [more information about Configuration packages](https://docs.crossplane.io/latest/concepts/packages).
         properties:
@@ -99,10 +98,13 @@ spec:
                     referenced object inside the same namespace.
                   properties:
                     name:
+                      default: ""
                       description: |-
                         Name of the referent.
+                        This field is effectively required, but due to backwards compatibility is
+                        allowed to be empty. Instances of this type with an empty value here are
+                        almost certainly wrong.
                         More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-                        TODO: Add other useful fields. apiVersion, kind, uid?
                       type: string
                   type: object
                   x-kubernetes-map-type: atomic