docs snapshot for crossplane version `v1.8`

2022-10-11 14:32:36 +00:00 · 2022-10-11 14:32:36 +00:00 · f4f0f12932
parent 80a19ecdcf
commit f4f0f12932
12 changed files with 81 additions and 11 deletions
--- a/content/docs/v1.8/api-docs/crds/meta.pkg.crossplane.io_configurations.yaml
+++ b/content/docs/v1.8/api-docs/crds/meta.pkg.crossplane.io_configurations.yaml
@ -24,12 +24,12 @@ spec:
          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: {{<ref "https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions" >}}#resources'
+              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: {{<ref "https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions" >}}#types-kinds'
+              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
@ -83,12 +83,12 @@ spec:
          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: {{<ref "https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions" >}}#resources'
+              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: {{<ref "https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions" >}}#types-kinds'
+              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
--- a/content/docs/v1.8/api-docs/crds/meta.pkg.crossplane.io_providers.yaml
+++ b/content/docs/v1.8/api-docs/crds/meta.pkg.crossplane.io_providers.yaml
@ -23,12 +23,12 @@ spec:
          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: {{<ref "https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions" >}}#resources'
+              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: {{<ref "https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions" >}}#types-kinds'
+              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
@ -143,12 +143,12 @@ spec:
          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: {{<ref "https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions" >}}#resources'
+              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: {{<ref "https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions" >}}#types-kinds'
+              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
--- a/content/docs/v1.8/reference/install.md
+++ b/content/docs/v1.8/reference/install.md
@ -1,8 +1,10 @@
 ---
-title: Install
+title: Install Crossplane
 weight: 301
 ---

+
+
 # Install Crossplane

 Crossplane can be easily installed into any existing Kubernetes cluster using
@ -160,5 +162,5 @@ imagePullSecrets:
 <!-- Named Links -->

 [Kubernetes cluster]: https://kubernetes.io/docs/setup/
-[Minikube]: https://minikube.sigs.k8s.io/docs/start/
-[Helm]: https://helm.sh/docs/intro/using_helm/
+[Minikube]: https://kubernetes.io/docs/tasks/tools/install-minikube/
+[Helm]: https://docs.helm.sh/using_helm/
--- a/content/docs/v1.8/snippets/package/aws-with-vpc/crossplane.yaml
+++ b/content/docs/v1.8/snippets/package/aws-with-vpc/crossplane.yaml
@ -3,6 +3,21 @@ kind: Configuration
 metadata:
  name: getting-started-with-aws-with-vpc
  annotations:
+    meta.crossplane.io/maintainer: Crossplane Maintainers <info@crossplane.io>
+    meta.crossplane.io/source: github.com/crossplane/crossplane
+    meta.crossplane.io/license: Apache-2.0
+    meta.crossplane.io/description: |
+      An introductory example to Crossplane and Composition for AWS.
+    meta.crossplane.io/readme: |
+      An introductory example to Crossplane and Composition for AWS.
+      This will enable provisioning of an RDS database instance.
+      The example also illustrates how to specify a non-default VPC.
+
+      [Install & 
+      Configure](https://crossplane.io/docs/master/getting-started/install-configure.html)
+
+      [Provision a PostgreSQL RDS 
+      Database](https://crossplane.io/docs/master/getting-started/provision-infrastructure.html)
    guide: quickstart
    provider: aws
    vpc: new
--- a/content/docs/v1.8/snippets/package/aws-with-vpc/definition.yaml
+++ b/content/docs/v1.8/snippets/package/aws-with-vpc/definition.yaml
@ -26,12 +26,14 @@ spec:
        properties:
          spec:
            type: object
+            description: "The OpenAPIV3Schema of this Composite Resource Definition."
            properties:
              parameters:
                type: object
                properties:
                  storageGB:
                    type: integer
+                    description: "The desired storage capacity of the database, in GB."
                required:
                  - storageGB
            required:
--- a/content/docs/v1.8/snippets/package/aws/crossplane.yaml
+++ b/content/docs/v1.8/snippets/package/aws/crossplane.yaml
@ -3,6 +3,21 @@ kind: Configuration
 metadata:
  name: getting-started-with-aws
  annotations:
+    meta.crossplane.io/maintainer: Crossplane Maintainers <info@crossplane.io>
+    meta.crossplane.io/source: github.com/crossplane/crossplane
+    meta.crossplane.io/license: Apache-2.0
+    meta.crossplane.io/description: |
+      An introductory example to Crossplane and Composition for AWS.
+    meta.crossplane.io/readme: |
+      An introductory example to Crossplane and Composition for AWS.
+      This will enable provisioning of an RDS database instance.
+
+      [Install & 
+      Configure](https://crossplane.io/docs/master/getting-started/install-configure.html)
+
+      [Provision a PostgreSQL RDS 
+      Database](https://crossplane.io/docs/master/getting-started/provision-infrastructure.html)
+  labels:
    guide: quickstart
    provider: aws
    vpc: default
--- a/content/docs/v1.8/snippets/package/aws/definition.yaml
+++ b/content/docs/v1.8/snippets/package/aws/definition.yaml
@ -26,12 +26,14 @@ spec:
        properties:
          spec:
            type: object
+            description: "The OpenAPIV3Schema of this Composite Resource Definition."
            properties:
              parameters:
                type: object
                properties:
                  storageGB:
                    type: integer
+                    description: "The desired storage capacity of the database, in GB."
                required:
                  - storageGB
            required:
--- a/content/docs/v1.8/snippets/package/azure/composition.yaml
+++ b/content/docs/v1.8/snippets/package/azure/composition.yaml
@ -30,6 +30,8 @@ spec:
            location: West US 2
            sslEnforcement: Disabled
            version: "11"
+            storageProfile:
+              storageMB: 5120
            sku:
              tier: GeneralPurpose
              capacity: 2
--- a/content/docs/v1.8/snippets/package/azure/crossplane.yaml
+++ b/content/docs/v1.8/snippets/package/azure/crossplane.yaml
@ -3,6 +3,20 @@ kind: Configuration
 metadata:
  name: getting-started-with-azure
  annotations:
+    meta.crossplane.io/maintainer: Crossplane Maintainers <info@crossplane.io>
+    meta.crossplane.io/source: github.com/crossplane/crossplane
+    meta.crossplane.io/license: Apache-2.0
+    meta.crossplane.io/description: |
+      An introductory example to Crossplane and Composition for Azure.
+    meta.crossplane.io/readme: |
+      An introductory example to Crossplane and Composition for Azure.
+      This will enable provisioning of an Azure SQL database instance.
+
+      [Install & 
+      Configure](https://crossplane.io/docs/master/getting-started/install-configure.html)
+
+      [Provision a PostgreSQL Azure SQL 
+      Database](https://crossplane.io/docs/master/getting-started/provision-infrastructure.html)
    guide: quickstart
    provider: azure
 spec:
--- a/content/docs/v1.8/snippets/package/azure/definition.yaml
+++ b/content/docs/v1.8/snippets/package/azure/definition.yaml
@ -26,12 +26,14 @@ spec:
        properties:
          spec:
            type: object
+            description: "The OpenAPIV3Schema of this Composite Resource Definition."
            properties:
              parameters:
                type: object
                properties:
                  storageGB:
                    type: integer
+                    description: "The desired storage capacity of the database, in GB."
                required:
                  - storageGB
            required:
--- a/content/docs/v1.8/snippets/package/gcp/crossplane.yaml
+++ b/content/docs/v1.8/snippets/package/gcp/crossplane.yaml
@ -3,6 +3,20 @@ kind: Configuration
 metadata:
  name: getting-started-with-gcp
  annotations:
+    meta.crossplane.io/maintainer: Crossplane Maintainers <info@crossplane.io>
+    meta.crossplane.io/source: github.com/crossplane/crossplane
+    meta.crossplane.io/license: Apache-2.0
+    meta.crossplane.io/description: |
+      An introductory example to Crossplane and Composition for GCP.
+    meta.crossplane.io/readme: |
+      An introductory example to Crossplane and Composition for GCP.
+      This will enable provisioning of a Cloud SQL database instance.
+
+      [Install & 
+      Configure](https://crossplane.io/docs/master/getting-started/install-configure.html)
+
+      [Provision a PostgreSQL Cloud SQL 
+      Database](https://crossplane.io/docs/master/getting-started/provision-infrastructure.html)
    guide: quickstart
    provider: gcp
 spec:
--- a/content/docs/v1.8/snippets/package/gcp/definition.yaml
+++ b/content/docs/v1.8/snippets/package/gcp/definition.yaml
@ -26,12 +26,14 @@ spec:
        properties:
          spec:
            type: object
+            description: "The OpenAPIV3Schema of this Composite Resource Definition."
            properties:
              parameters:
                type: object
                properties:
                  storageGB:
                    type: integer
+                    description: "The desired storage capacity of the database, in GB."
                required:
                  - storageGB
            required: