crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs snapshot for crossplane version `master`

This commit is contained in:
Crossplane 2019-09-17 19:27:39 +00:00
parent dfcb6e932f
commit 3b1cd60a86
28 changed files with 4996 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/master/README.md
View File

@ -24,5 +24,6 @@ The full architecture and vision of the Crossplane project is described in depth
* [Running Resources](running-resources.md)
* [Troubleshooting](troubleshoot.md)
* [Concepts](concepts.md)
* [API Reference](api.md)
* [FAQs](faqs.md)
* [Contributing](contributing.md)

121
docs/master/api.md Normal file
View File

@ -0,0 +1,121 @@
---
title: API Reference
toc: true
weight: 460
---
# API Reference
Crossplane is configured using a variety of Kubernetes resources. These
resources are separated into API groups. Core API groups are provided by
Crossplane, while cloud provider specific API groups are provided by each cloud
provider's stack.
Each API Group supported by Crossplane is assigned its own individual status to
reflect the varying maturity and stability. More details about API versioning
and status in Kubernetes can be found on the Kubernetes [API versioning] page,
but the key difference between the statuses are summarized below:
* **Alpha:** The API may change in incompatible ways in a later software release
without notice, recommended for use only in short-lived testing clusters, due
to increased risk of bugs and lack of long-term support.
* **Beta:** Support for the overall features will not be dropped, though details
may change. Support for upgrading or migrating between versions will be
provided, either through automation or manual steps.
* **Stable:** Features will appear in released software for many subsequent
versions and support for upgrading between versions will be provided with
software automation in the vast majority of scenarios.
## Crossplane
Crossplane is reponsible for all portable resources, including resource claims
(for example `MySQLInstance`) and portable resource classes (for example
`MySQLInstanceClass). Crossplane currently supports the following API groups:
API Group | Status | Details
-------- | ------ | -------
[`cache.crossplane.io/v1alpha1`] | Alpha | Cache service claims and classes.
[`compute.crossplane.io/v1alpha1`] | Alpha | Compute service resource claims and classes.
[`database.crossplane.io/v1alpha1`] | Alpha | Database service resource claims and classes.
[`storage.crossplane.io/v1alpha1`] | Alpha | Blob storage service resource claims and classes.
[`stacks.crossplane.io/v1alpha1`] | Alpha | Resources for managing Crossplane Stacks.
[`workload.crossplane.io/v1alpha1`] | Alpha | Resources for managing Crossplane Workloads.
[`cache.crossplane.io/v1alpha1`]: api/crossplaneio/crossplane/cache-crossplane-io-v1alpha1.md
[`compute.crossplane.io/v1alpha1`]: api/crossplaneio/crossplane/compute-crossplane-io-v1alpha1.md
[`database.crossplane.io/v1alpha1`]: api/crossplaneio/crossplane/database-crossplane-io-v1alpha1.md
[`storage.crossplane.io/v1alpha1`]: api/crossplaneio/crossplane/storage-crossplane-io-v1alpha1.md
[`stacks.crossplane.io/v1alpha1`]: api/crossplaneio/crossplane/stacks-crossplane-io-v1alpha1.md
[`workload.crossplane.io/v1alpha1`]: api/crossplaneio/crossplane/workload-crossplane-io-v1alpha1.md
## AWS Stack
The AWS Stack is reponsible for all AWS specific resources, including managed
resources (for example `EKSCluster`), and cloud specific resource classes (for
example `EKSClusterClass`) The AWS Stack currently supports the following API
groups:
API Group | Status | Details
-------- | ------ | -------
[`aws.crossplane.io/v1alpha2`] | Alpha | Core AWS resources.
[`cache.aws.crossplane.io/v1alpha2`] | Alpha | ElastiCache managed resources and classes.
[`compute.aws.crossplane.io/v1alpha2`] | Alpha | EKS managed resources and classes.
[`database.aws.crossplane.io/v1alpha2`] | Alpha | RDS managed resources and classes.
[`identity.aws.crossplane.io/v1alpha2`] | Alpha | IAM managed resources and classes.
[`network.aws.crossplane.io/v1alpha2`] | Alpha | VPC managed resources and classes.
[`storage.aws.crossplane.io/v1alpha2`] | Alpha | S3 managed resources and classes.
[`aws.crossplane.io/v1alpha2`]: api/crossplaneio/stack-aws/aws-crossplane-io-v1alpha2.md
[`cache.aws.crossplane.io/v1alpha2`]: api/crossplaneio/stack-aws/cache-aws-crossplane-io-v1alpha2.md
[`compute.aws.crossplane.io/v1alpha2`]: api/crossplaneio/stack-aws/compute-aws-crossplane-io-v1alpha2.md
[`database.aws.crossplane.io/v1alpha2`]: api/crossplaneio/stack-aws/database-aws-crossplane-io-v1alpha2.md
[`identity.aws.crossplane.io/v1alpha2`]: api/crossplaneio/stack-aws/identity-aws-crossplane-io-v1alpha2.md
[`network.aws.crossplane.io/v1alpha2`]: api/crossplaneio/stack-aws/network-aws-crossplane-io-v1alpha2.md
[`storage.aws.crossplane.io/v1alpha2`]: api/crossplaneio/stack-aws/storage-aws-crossplane-io-v1alpha2.md
## Azure Stack
The Azure Stack is reponsible for all Azure specific resources, including
managed resources (for example `AKSCluster`), and cloud specific resource
classes (for example `AKSClusterClass`) The Azure Stack currently supports the
following API groups:
API Group | Status | Details
-------- | ------ | -------
[`azure.crossplane.io/v1alpha2`] | Alpha | Core Azure resources.
[`cache.azure.crossplane.io/v1alpha2`] | Alpha | Azure Redis managed resources and classes.
[`compute.azure.crossplane.io/v1alpha2`] | Alpha | AKS managed resources and classes.
[`database.azure.crossplane.io/v1alpha2`] | Alpha | Azure Database managed resources and classes.
[`network.azure.crossplane.io/v1alpha2`] | Alpha | Virtual network managed resources and classes.
[`storage.azure.crossplane.io/v1alpha2`] | Alpha | Azure Blob Storage managed resources and classes.
[`azure.crossplane.io/v1alpha2`]: api/crossplaneio/stack-azure/azure-crossplane-io-v1alpha2.md
[`cache.azure.crossplane.io/v1alpha2`]: api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1alpha2.md
[`compute.azure.crossplane.io/v1alpha2`]: api/crossplaneio/stack-azure/compute-azure-crossplane-io-v1alpha2.md
[`database.azure.crossplane.io/v1alpha2`]: api/crossplaneio/stack-azure/database-azure-crossplane-io-v1alpha2.md
[`network.azure.crossplane.io/v1alpha2`]: api/crossplaneio/stack-azure/network-azure-crossplane-io-v1alpha2.md
[`storage.azure.crossplane.io/v1alpha2`]: api/crossplaneio/stack-azure/storage-azure-crossplane-io-v1alpha2.md
## GCP Stack
The GCP Stack is reponsible for all GCP specific resources, including managed
resources (for example `GKECluster`), and cloud specific resource classes (for
example `GKEClusterClass`) The GCP Stack currently supports the following API
groups:
API Group | Status | Details
-------- | ------ | -------
[`gcp.crossplane.io/v1alpha2`] | Alpha | Core GCP resources.
[`cache.gcp.crossplane.io/v1alpha2`] | Alpha | CloudMemorystore managed resources and classes.
[`compute.gcp.crossplane.io/v1alpha2`] | Alpha | Compute and Kubernetes Engine managed resources and classes.
[`database.gcp.crossplane.io/v1alpha2`] | Alpha | CloudSQL managed resources and classes.
[`servicenetworking.gcp.crossplane.io/v1alpha2`] | Alpha | Service Networking managed resources and classes.
[`storage.gcp.crossplane.io/v1alpha2`] | Alpha | Cloud Storage managed resources and classes.
[`gcp.crossplane.io/v1alpha2`]: api/crossplaneio/stack-gcp/gcp-crossplane-io-v1alpha2.md
[`cache.gcp.crossplane.io/v1alpha2`]: api/crossplaneio/stack-gcp/cache-gcp-crossplane-io-v1alpha2.md
[`compute.gcp.crossplane.io/v1alpha2`]: api/crossplaneio/stack-gcp/compute-gcp-crossplane-io-v1alpha2.md
[`database.gcp.crossplane.io/v1alpha2`]: api/crossplaneio/stack-gcp/database-gcp-crossplane-io-v1alpha2.md
[`servicenetworking.gcp.crossplane.io/v1alpha2`]: api/crossplaneio/stack-gcp/servicenetworking-gcp-crossplane-io-v1alpha2.md
[`storage.gcp.crossplane.io/v1alpha2`]: api/crossplaneio/stack-gcp/storage-gcp-crossplane-io-v1alpha2.md
[API Versioning]: https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-versioning

173
docs/master/api/crossplaneio/crossplane-runtime/core-crossplane-io-v1alpha1.md Normal file
View File

@ -0,0 +1,173 @@
# core.crossplane.io/v1alpha1 API Reference
Package v1alpha1 contains core API types used by most Crossplane resources.
This API group contains the following Crossplane resources:
## BindingPhase
BindingPhase represents the current binding phase of a resource or claim. Alias of string.
Appears in:
* [BindingStatus](#BindingStatus)
## BindingStatus
A BindingStatus represents the bindability and binding status of a resource.
Appears in:
* [ResourceClaimStatus](#ResourceClaimStatus)
* [ResourceStatus](#ResourceStatus)
Name | Type | Description
-----|------|------------
`bindingPhase` | Optional [BindingPhase](#BindingPhase) | Phase represents the binding phase of a managed resource or claim. Unbindable resources cannot be bound, typically because they are currently unavailable, or still being created. Unbound resource are available for binding, and Bound resources have successfully bound to another resource.
## Condition
A Condition that may apply to a managed resource.
Appears in:
* [ConditionedStatus](#ConditionedStatus)
Name | Type | Description
-----|------|------------
`type` | [ConditionType](#ConditionType) | Type of this condition. At most one of each condition type may apply to a resource at any point in time.
`status` | [core/v1.ConditionStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#conditionstatus-v1-core) | Status of this condition; is it currently True, False, or Unknown?
`lastTransitionTime` | [meta/v1.Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#time-v1-meta) | LastTransitionTime is the last time this condition transitioned from one status to another.
`reason` | [ConditionReason](#ConditionReason) | A Reason for this condition's last transition from one status to another.
`message` | Optional string | A Message containing details about this condition's last transition from one status to another, if any.
## ConditionReason
A ConditionReason represents the reason a resource is in a condition. Alias of string.
Appears in:
* [Condition](#Condition)
## ConditionType
A ConditionType represents a condition a resource could be in. Alias of string.
Appears in:
* [Condition](#Condition)
## ConditionedStatus
A ConditionedStatus reflects the observed status of a managed resource. Only one condition of each type may exist.
Appears in:
* [ResourceClaimStatus](#ResourceClaimStatus)
* [ResourceStatus](#ResourceStatus)
Name | Type | Description
-----|------|------------
`conditions` | Optional [[]Condition](#Condition) | Conditions of the resource.
## NonPortableClassSpecTemplate
NonPortableClassSpecTemplate defines a template that will be used to create the specifications of managed resources dynamically provisioned using a resource class.
Name | Type | Description
-----|------|------------
`providerRef` | [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | ProviderReference specifies the provider that will be used to create, observe, update, and delete managed resources that are dynamically provisioned using this resource class.
`reclaimPolicy` | Optional [ReclaimPolicy](#ReclaimPolicy) | ReclaimPolicy specifies what will happen to external resources when managed resources dynamically provisioned using this resource class are deleted. "Delete" deletes the external resource, while "Retain" (the default) does not. Note this behaviour is subtly different from other uses of the ReclaimPolicy concept within the Kubernetes ecosystem per https://github.com/crossplaneio/crossplane-runtime/issues/21
## PortableClass
A PortableClass connects a portable resource claim to a non-portable resource class used for dynamic provisioning.
Name | Type | Description
-----|------|------------
`classRef` | [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | NonPortableClassReference is a reference to a resource class kind that is not portable across cloud providers, such as an RDSInstanceClass.
## ReclaimPolicy
A ReclaimPolicy determines what should happen to managed resources when their bound resource claims are deleted. Alias of string.
Appears in:
* [NonPortableClassSpecTemplate](#NonPortableClassSpecTemplate)
* [ResourceSpec](#ResourceSpec)
## ResourceClaimSpec
A ResourceClaimSpec defines the desired state of a resource claim.
Name | Type | Description
-----|------|------------
`writeConnectionSecretToRef` | Optional [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core) | WriteConnectionSecretToReference specifies the name of a Secret, in the same namespace as this resource claim, to which any connection details for this resource claim should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource bound to this resource claim.
`classRef` | Optional [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core) | A PortableClassReference specifies the name of a portable resource class, in the same namespace as this resource claim, that will be used to dynamically provision a managed resource when the resource claim is created. The specified class kind must be aligned with the resource claim; e.g. a MySQLInstance kind resource claim always refers to a MySQLInstanceClass kind portable resource class. Omit the portable class reference if you wish to bind to a specific managed resource (known as static binding), or to use the default portable class for the resource claim's namespace (if any).
`resourceRef` | Optional [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | A ResourceReference specifies an existing managed resource, in any namespace, to which this resource claim should attempt to bind. Omit the resource reference to enable dynamic provisioning using a portable resource class; the resource reference will be automatically populated by Crossplane.
## ResourceClaimStatus
A ResourceClaimStatus represents the observed status of a resource claim.
ResourceClaimStatus supports all fields of:
* [ConditionedStatus](#ConditionedStatus)
* [BindingStatus](#BindingStatus)
## ResourceSpec
A ResourceSpec defines the desired state of a managed resource.
Name | Type | Description
-----|------|------------
`writeConnectionSecretToRef` | Optional [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core) | WriteConnectionSecretToReference specifies the name of a Secret, in the same namespace as this managed resource, to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
`claimRef` | Optional [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | ClaimReference specifies the resource claim to which this managed resource will be bound. ClaimReference is set automatically during dynamic provisioning. Crossplane does not currently support setting this field manually, per https://github.com/crossplaneio/crossplane-runtime/issues/19
`classRef` | Optional [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | NonPortableClassReference specifies the non-portable resource class that was used to dynamically provision this managed resource, if any. Crossplane does not currently support setting this field manually, per https://github.com/crossplaneio/crossplane-runtime/issues/20
`providerRef` | [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource.
`reclaimPolicy` | Optional [ReclaimPolicy](#ReclaimPolicy) | ReclaimPolicy specifies what will happen to the external resource this managed resource manages when the managed resource is deleted. "Delete" deletes the external resource, while "Retain" (the default) does not. Note this behaviour is subtly different from other uses of the ReclaimPolicy concept within the Kubernetes ecosystem per https://github.com/crossplaneio/crossplane-runtime/issues/21
## ResourceStatus
ResourceStatus represents the observed state of a managed resource.
ResourceStatus supports all fields of:
* [ConditionedStatus](#ConditionedStatus)
* [BindingStatus](#BindingStatus)
This API documentation was generated by `crossdocs`.

61
docs/master/api/crossplaneio/crossplane/cache-crossplane-io-v1alpha1.md Normal file
View File

@ -0,0 +1,61 @@
# cache.crossplane.io/v1alpha1 API Reference
Package v1alpha1 contains portable resource claims for caching services such as Redis clusters.
This API group contains the following Crossplane resources:
* [RedisCluster](#RedisCluster)
* [RedisClusterClass](#RedisClusterClass)
## RedisCluster
A RedisCluster is a portable resource claim that may be satisfied by binding to a Redis managed resource such as a GCP CloudMemorystore instance or an AWS ReplicationGroup. Despite the name RedisCluster claims may bind to Redis managed resources that are a single node, or not in cluster mode.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `cache.crossplane.io/v1alpha1`
`kind` | string | `RedisCluster`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [RedisClusterSpec](#RedisClusterSpec) | RedisClusterSpec specifies the desired state of a RedisCluster.
`status` | [v1alpha1.ResourceClaimStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimstatus) |
## RedisClusterClass
RedisClusterClass contains a namespace-scoped portable class for RedisCluster
Name | Type | Description
-----|------|------------
`apiVersion` | string | `cache.crossplane.io/v1alpha1`
`kind` | string | `RedisClusterClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
RedisClusterClass supports all fields of:
* [v1alpha1.PortableClass](../crossplane-runtime/core-crossplane-io-v1alpha1.md#portableclass)
## RedisClusterSpec
RedisClusterSpec specifies the desired state of a RedisCluster.
Appears in:
* [RedisCluster](#RedisCluster)
Name | Type | Description
-----|------|------------
`engineVersion` | string | EngineVersion specifies the desired Redis version.
RedisClusterSpec supports all fields of:
* [v1alpha1.ResourceClaimSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimspec)
This API documentation was generated by `crossdocs`.

61
docs/master/api/crossplaneio/crossplane/compute-crossplane-io-v1alpha1.md Normal file
View File

@ -0,0 +1,61 @@
# compute.crossplane.io/v1alpha1 API Reference
Package v1alpha1 contains portable resource claims for compute services such as Kubernetes clusters.
This API group contains the following Crossplane resources:
* [KubernetesCluster](#KubernetesCluster)
* [KubernetesClusterClass](#KubernetesClusterClass)
## KubernetesCluster
A KubernetesCluster is a portable resource claim that may be satisfied by binding to a Kubernetes cluster managed resource such as an AWS EKS cluster or an Azure AKS cluster.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.crossplane.io/v1alpha1`
`kind` | string | `KubernetesCluster`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [KubernetesClusterSpec](#KubernetesClusterSpec) | KubernetesClusterSpec specifies the desired state of a KubernetesCluster.
`status` | [v1alpha1.ResourceClaimStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimstatus) |
## KubernetesClusterClass
KubernetesClusterClass contains a namespace-scoped Class for KubernetesCluster
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.crossplane.io/v1alpha1`
`kind` | string | `KubernetesClusterClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
KubernetesClusterClass supports all fields of:
* [v1alpha1.PortableClass](../crossplane-runtime/core-crossplane-io-v1alpha1.md#portableclass)
## KubernetesClusterSpec
KubernetesClusterSpec specifies the desired state of a KubernetesCluster.
Appears in:
* [KubernetesCluster](#KubernetesCluster)
Name | Type | Description
-----|------|------------
`clusterVersion` | string | ClusterVersion specifies the desired Kubernetes version, e.g. 1.15.
KubernetesClusterSpec supports all fields of:
* [v1alpha1.ResourceClaimSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimspec)
This API documentation was generated by `crossdocs`.

114
docs/master/api/crossplaneio/crossplane/database-crossplane-io-v1alpha1.md Normal file
View File

@ -0,0 +1,114 @@
# database.crossplane.io/v1alpha1 API Reference
Package v1alpha1 contains portable resource claims for database services such as MySQL or PostgreSQL.
This API group contains the following Crossplane resources:
* [MySQLInstance](#MySQLInstance)
* [MySQLInstanceClass](#MySQLInstanceClass)
* [PostgreSQLInstance](#PostgreSQLInstance)
* [PostgreSQLInstanceClass](#PostgreSQLInstanceClass)
## MySQLInstance
A MySQLInstance is a portable resource claim that may be satisfied by binding to a MySQL managed resource such as an AWS RDS instance or a GCP CloudSQL instance.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.crossplane.io/v1alpha1`
`kind` | string | `MySQLInstance`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [MySQLInstanceSpec](#MySQLInstanceSpec) | MySQLInstanceSpec specifies the desired state of a MySQLInstance.
`status` | [v1alpha1.ResourceClaimStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimstatus) |
## MySQLInstanceClass
MySQLInstanceClass contains a namespace-scoped portable class for MySQLInstance
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.crossplane.io/v1alpha1`
`kind` | string | `MySQLInstanceClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
MySQLInstanceClass supports all fields of:
* [v1alpha1.PortableClass](../crossplane-runtime/core-crossplane-io-v1alpha1.md#portableclass)
## PostgreSQLInstance
A PostgreSQLInstance is a portable resource claim that may be satisfied by binding to a PostgreSQL managed resource such as an AWS RDS instance or a GCP CloudSQL instance. PostgreSQLInstance is the CRD type for abstract PostgreSQL database instances
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.crossplane.io/v1alpha1`
`kind` | string | `PostgreSQLInstance`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [PostgreSQLInstanceSpec](#PostgreSQLInstanceSpec) | PostgreSQLInstanceSpec specifies the desired state of a PostgreSQLInstance. PostgreSQLInstance.
`status` | [v1alpha1.ResourceClaimStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimstatus) |
## PostgreSQLInstanceClass
PostgreSQLInstanceClass contains a namespace-scoped portable class for PostgreSQLInstance
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.crossplane.io/v1alpha1`
`kind` | string | `PostgreSQLInstanceClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
PostgreSQLInstanceClass supports all fields of:
* [v1alpha1.PortableClass](../crossplane-runtime/core-crossplane-io-v1alpha1.md#portableclass)
## MySQLInstanceSpec
MySQLInstanceSpec specifies the desired state of a MySQLInstance.
Appears in:
* [MySQLInstance](#MySQLInstance)
Name | Type | Description
-----|------|------------
`engineVersion` | string | EngineVersion specifies the desired MySQL engine version, e.g. 5.7.
MySQLInstanceSpec supports all fields of:
* [v1alpha1.ResourceClaimSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimspec)
## PostgreSQLInstanceSpec
PostgreSQLInstanceSpec specifies the desired state of a PostgreSQLInstance. PostgreSQLInstance.
Appears in:
* [PostgreSQLInstance](#PostgreSQLInstance)
Name | Type | Description
-----|------|------------
`engineVersion` | string | EngineVersion specifies the desired PostgreSQL engine version, e.g. 9.6.
PostgreSQLInstanceSpec supports all fields of:
* [v1alpha1.ResourceClaimSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimspec)
This API documentation was generated by `crossdocs`.

260
docs/master/api/crossplaneio/crossplane/stacks-crossplane-io-v1alpha1.md Normal file
View File

@ -0,0 +1,260 @@
# stacks.crossplane.io/v1alpha1 API Reference
Package v1alpha1 contains resources relating to Crossplane Stacks.
This API group contains the following Crossplane resources:
* [ClusterStackInstall](#ClusterStackInstall)
* [Stack](#Stack)
* [StackInstall](#StackInstall)
## ClusterStackInstall
ClusterStackInstall is the CRD type for a request to add a stack to Crossplane.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `stacks.crossplane.io/v1alpha1`
`kind` | string | `ClusterStackInstall`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [StackInstallSpec](#StackInstallSpec) | StackInstallSpec specifies details about a request to install a stack to Crossplane.
`status` | [StackInstallStatus](#StackInstallStatus) | StackInstallStatus represents the observed state of a StackInstall.
## Stack
A Stack that has been added to Crossplane.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `stacks.crossplane.io/v1alpha1`
`kind` | string | `Stack`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [StackSpec](#StackSpec) | StackSpec specifies the desired state of a Stack.
`status` | [StackStatus](#StackStatus) | StackStatus represents the observed state of a Stack.
## StackInstall
A StackInstall requests a stack be installed to Crossplane.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `stacks.crossplane.io/v1alpha1`
`kind` | string | `StackInstall`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [StackInstallSpec](#StackInstallSpec) | StackInstallSpec specifies details about a request to install a stack to Crossplane.
`status` | [StackInstallStatus](#StackInstallStatus) | StackInstallStatus represents the observed state of a StackInstall.
## AppMetadataSpec
AppMetadataSpec defines metadata about the stack application
Appears in:
* [StackSpec](#StackSpec)
Name | Type | Description
-----|------|------------
`title` | string |
`overviewShort` | string |
`overview` | string |
`readme` | string |
`version` | string |
`icons` | [[]IconSpec](#IconSpec) |
`maintainers` | [[]ContributorSpec](#ContributorSpec) |
`owners` | [[]ContributorSpec](#ContributorSpec) |
`company` | string |
`category` | string |
`keywords` | []string |
`website` | string |
`source` | string |
`license` | string |
`dependsOn` | [[]StackInstallSpec](#StackInstallSpec) | DependsOn is the list of CRDs that this stack depends on. This data drives the dependency resolution process.
`permissionScope` | string |
## ContributorSpec
ContributorSpec defines a contributor for a stack (e.g., maintainer, owner, etc.)
Appears in:
* [AppMetadataSpec](#AppMetadataSpec)
Name | Type | Description
-----|------|------------
`name` | string |
`email` | string |
## ControllerDeployment
ControllerDeployment defines a controller for a stack that is managed by a Deployment.
Appears in:
* [ControllerSpec](#ControllerSpec)
Name | Type | Description
-----|------|------------
`name` | string |
`spec` | [apps/v1.DeploymentSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#deploymentspec-v1-apps) |
## ControllerJob
ControllerJob defines a controller for a stack that is installed by a Job.
Appears in:
* [ControllerSpec](#ControllerSpec)
Name | Type | Description
-----|------|------------
`name` | string |
`spec` | [batch/v1.JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#jobspec-v1-batch) |
## ControllerSpec
ControllerSpec defines the controller that implements the logic for a stack, which can come in different flavors. A golang code (controller-runtime) controller with a managing Deployment is all that is supported currently, but more types will come in the future (e.g., templates, functions/hooks, templates, a new DSL, etc.
Appears in:
* [StackSpec](#StackSpec)
Name | Type | Description
-----|------|------------
`deployment` | [ControllerDeployment](#ControllerDeployment) |
`job` | [ControllerJob](#ControllerJob) |
## IconSpec
IconSpec defines the icon for a stack
Appears in:
* [AppMetadataSpec](#AppMetadataSpec)
Name | Type | Description
-----|------|------------
`base64Data` | string |
`mediatype` | string |
## PermissionsSpec
PermissionsSpec defines the permissions that a stack will require to operate.
Appears in:
* [StackSpec](#StackSpec)
Name | Type | Description
-----|------|------------
`rules` | [[]rbac/v1.PolicyRule](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#policyrule-v1-rbac) |
## StackInstallSpec
StackInstallSpec specifies details about a request to install a stack to Crossplane.
Appears in:
* [ClusterStackInstall](#ClusterStackInstall)
* [StackInstall](#StackInstall)
* [AppMetadataSpec](#AppMetadataSpec)
Name | Type | Description
-----|------|------------
`source` | string | Source is the domain name for the stack registry hosting the stack being requested, e.g., registry.crossplane.io
`package` | string | Package is the name of the stack package that is being requested, e.g., myapp. Either Package or CustomResourceDefinition can be specified.
`crd` | string | CustomResourceDefinition is the full name of a CRD that is owned by the stack being requested. This can be a convenient way of installing a stack when the desired CRD is known, but the package name that contains it is not known. Either Package or CustomResourceDefinition can be specified.
## StackInstallStatus
StackInstallStatus represents the observed state of a StackInstall.
Appears in:
* [ClusterStackInstall](#ClusterStackInstall)
* [StackInstall](#StackInstall)
Name | Type | Description
-----|------|------------
`conditionedStatus` | [v1alpha1.ConditionedStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#conditionedstatus) |
`installJob` | [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) |
`stackRecord` | [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) |
## StackInstaller
StackInstaller provides a common interface for StackInstall and ClusterStackInstall to share controller and reconciler logic
## StackSpec
StackSpec specifies the desired state of a Stack.
Appears in:
* [Stack](#Stack)
Name | Type | Description
-----|------|------------
`customresourcedefinitions` | [CRDList](#CRDList) | CRDList is the full list of CRDs that this stack owns and depends on
`controller` | [ControllerSpec](#ControllerSpec) | ControllerSpec defines the controller that implements the logic for a stack, which can come in different flavors. A golang code (controller-runtime) controller with a managing Deployment is all that is supported currently, but more types will come in the future (e.g., templates, functions/hooks, templates, a new DSL, etc.
`permissions` | [PermissionsSpec](#PermissionsSpec) | PermissionsSpec defines the permissions that a stack will require to operate.
StackSpec supports all fields of:
* [AppMetadataSpec](#AppMetadataSpec)
## StackStatus
StackStatus represents the observed state of a Stack.
Appears in:
* [Stack](#Stack)
Name | Type | Description
-----|------|------------
`conditionedStatus` | [v1alpha1.ConditionedStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#conditionedstatus) |
`controllerRef` | [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) |
This API documentation was generated by `crossdocs`.

81
docs/master/api/crossplaneio/crossplane/storage-crossplane-io-v1alpha1.md Normal file
View File

@ -0,0 +1,81 @@
# storage.crossplane.io/v1alpha1 API Reference
Package v1alpha1 contains portable resource claims for storage services such as buckets.
This API group contains the following Crossplane resources:
* [Bucket](#Bucket)
* [BucketClass](#BucketClass)
## Bucket
A Bucket is a portable resource claim that may be satisfied by binding to a storage bucket PostgreSQL managed resource such as an AWS S3 bucket or Azure storage container.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.crossplane.io/v1alpha1`
`kind` | string | `Bucket`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [BucketSpec](#BucketSpec) | BucketSpec specifies the desired state of a Bucket.
`status` | [v1alpha1.ResourceClaimStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimstatus) |
## BucketClass
BucketClass contains a namespace-scoped portable class for Bucket
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.crossplane.io/v1alpha1`
`kind` | string | `BucketClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
BucketClass supports all fields of:
* [v1alpha1.PortableClass](../crossplane-runtime/core-crossplane-io-v1alpha1.md#portableclass)
## BucketSpec
BucketSpec specifies the desired state of a Bucket.
Appears in:
* [Bucket](#Bucket)
Name | Type | Description
-----|------|------------
`name` | string | Name specifies the desired name of the bucket.
`predefinedACL` | [PredefinedACL](#PredefinedACL) | PredefinedACL specifies a predefined ACL (e.g. Private, ReadWrite, etc) to be applied to the bucket.
`localPermission` | [LocalPermissionType](#LocalPermissionType) | LocalPermission specifies permissions granted to a provider specific service account for this bucket, e.g. Read, ReadWrite, or Write.
BucketSpec supports all fields of:
* [v1alpha1.ResourceClaimSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourceclaimspec)
## LocalPermissionType
A LocalPermissionType is a type of permission that may be granted to a Bucket. Alias of string.
Appears in:
* [BucketSpec](#BucketSpec)
## PredefinedACL
A PredefinedACL is a predefined ACL that may be applied to a Bucket. Alias of string.
Appears in:
* [BucketSpec](#BucketSpec)
This API documentation was generated by `crossdocs`.

160
docs/master/api/crossplaneio/crossplane/workload-crossplane-io-v1alpha1.md Normal file
View File

@ -0,0 +1,160 @@
# workload.crossplane.io/v1alpha1 API Reference
Package v1alpha1 contains resources relating to Crossplane Workloads.
This API group contains the following Crossplane resources:
* [KubernetesApplication](#KubernetesApplication)
* [KubernetesApplicationResource](#KubernetesApplicationResource)
## KubernetesApplication
A KubernetesApplication defines an application deployed by Crossplane to a Kubernetes cluster, i.e. a portable KubernetesCluster resource claim.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `workload.crossplane.io/v1alpha1`
`kind` | string | `KubernetesApplication`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [KubernetesApplicationSpec](#KubernetesApplicationSpec) | A KubernetesApplicationSpec specifies the resources of a Kubernetes application.
`status` | [KubernetesApplicationStatus](#KubernetesApplicationStatus) | KubernetesApplicationStatus represents the observed state of a KubernetesApplication.
## KubernetesApplicationResource
A KubernetesApplicationResource is a resource of a Kubernetes application. Each resource templates a single Kubernetes resource to be deployed to its scheduled KubernetesCluster.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `workload.crossplane.io/v1alpha1`
`kind` | string | `KubernetesApplicationResource`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [KubernetesApplicationResourceSpec](#KubernetesApplicationResourceSpec) | KubernetesApplicationResourceSpec specifies the desired state of a KubernetesApplicationResource.
`status` | [KubernetesApplicationResourceStatus](#KubernetesApplicationResourceStatus) | KubernetesApplicationResourceStatus represents the observed state of a KubernetesApplicationResource.
## KubernetesApplicationResourceSpec
KubernetesApplicationResourceSpec specifies the desired state of a KubernetesApplicationResource.
Appears in:
* [KubernetesApplicationResource](#KubernetesApplicationResource)
* [KubernetesApplicationResourceTemplate](#KubernetesApplicationResourceTemplate)
Name | Type | Description
-----|------|------------
`template` | [meta/v1/unstructured.Unstructured](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#unstructured-unstructured-v1) | A Template for a Kubernetes resource to be submitted to the KubernetesCluster to which this application resource is scheduled. The resource must be understood by the KubernetesCluster. Crossplane requires only that the resource contains standard Kubernetes type and object metadata.
`secrets` | [[]core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core) | Secrets upon which this application resource depends. These secrets will be propagated to the Kubernetes cluster to which this application is scheduled.
## KubernetesApplicationResourceState
KubernetesApplicationResourceState represents the state of a KubernetesApplicationResource. Alias of string.
Appears in:
* [KubernetesApplicationResourceStatus](#KubernetesApplicationResourceStatus)
## KubernetesApplicationResourceStatus
KubernetesApplicationResourceStatus represents the observed state of a KubernetesApplicationResource.
Appears in:
* [KubernetesApplicationResource](#KubernetesApplicationResource)
Name | Type | Description
-----|------|------------
`conditionedStatus` | [v1alpha1.ConditionedStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#conditionedstatus) |
`state` | [KubernetesApplicationResourceState](#KubernetesApplicationResourceState) | State of the application.
`clusterRef` | [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | Cluster to which this application has been scheduled.
`remote` | [RemoteStatus](#RemoteStatus) | Remote status of the resource templated by this application resource.
## KubernetesApplicationResourceTemplate
A KubernetesApplicationResourceTemplate is used to instantiate new KubernetesApplicationResources.
Appears in:
* [KubernetesApplicationSpec](#KubernetesApplicationSpec)
Name | Type | Description
-----|------|------------
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [KubernetesApplicationResourceSpec](#KubernetesApplicationResourceSpec) | KubernetesApplicationResourceSpec specifies the desired state of a KubernetesApplicationResource.
## KubernetesApplicationSpec
A KubernetesApplicationSpec specifies the resources of a Kubernetes application.
Appears in:
* [KubernetesApplication](#KubernetesApplication)
Name | Type | Description
-----|------|------------
`resourceSelector` | [meta/v1.LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#labelselector-v1-meta) | ResourceSelector selects the KubernetesApplicationResources that are managed by this KubernetesApplication. Note that a KubernetesApplication will never adopt orphaned KubernetesApplicationResources, and thus this selector serves only to help match a KubernetesApplication to its KubernetesApplicationResources.
`clusterSelector` | [meta/v1.LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#labelselector-v1-meta) | ClusterSelector selects the clusters to which this application may be scheduled. Leave both match labels and expressions empty to match any cluster.
`resourceTemplates` | [[]KubernetesApplicationResourceTemplate](#KubernetesApplicationResourceTemplate) | ResourceTemplates specifies a set of Kubernetes application resources managed by this application.
## KubernetesApplicationState
KubernetesApplicationState represents the state of a Kubernetes application. Alias of string.
Appears in:
* [KubernetesApplicationStatus](#KubernetesApplicationStatus)
## KubernetesApplicationStatus
KubernetesApplicationStatus represents the observed state of a KubernetesApplication.
Appears in:
* [KubernetesApplication](#KubernetesApplication)
Name | Type | Description
-----|------|------------
`conditionedStatus` | [v1alpha1.ConditionedStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#conditionedstatus) |
`state` | [KubernetesApplicationState](#KubernetesApplicationState) | State of the application.
`clusterRef` | [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | Cluster to which this application has been scheduled.
`desiredResources` | int | Desired resources of this application, i.e. the number of resources that match this application's resource selector.
`submittedResources` | int | Submitted resources of this workload, i.e. the subset of desired resources that have been successfully submitted to their scheduled Kubernetes cluster.
## RemoteStatus
RemoteStatus represents the observed state of a remote cluster.
Appears in:
* [KubernetesApplicationResourceStatus](#KubernetesApplicationResourceStatus)
Name | Type | Description
-----|------|------------
`raw` | [encoding/json.RawMessage](https://golang.org/pkg/encoding/json#RawMessage) | Raw JSON representation of the remote status as a byte array.
This API documentation was generated by `crossdocs`.

39
docs/master/api/crossplaneio/stack-aws/aws-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,39 @@
# aws.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains core AWS resources.
This API group contains the following Crossplane resources:
* [Provider](#Provider)
## Provider
A Provider configures an AWS 'provider', i.e. a connection to a particular AWS account using a particular AWS IAM role.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `aws.crossplane.io/v1alpha2`
`kind` | string | `Provider`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [ProviderSpec](#ProviderSpec) | A ProviderSpec defines the desired state of a Provider.
## ProviderSpec
A ProviderSpec defines the desired state of a Provider.
Appears in:
* [Provider](#Provider)
Name | Type | Description
-----|------|------------
`region` | string | Region for managed resources created using this AWS provider.
`credentialsSecretRef` | [core/v1.SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#secretkeyselector-v1-core) | A Secret containing INI encoded credentials for an AWS IAM role that will be used to authenticate to this AWS account.
This API documentation was generated by `crossdocs`.

163
docs/master/api/crossplaneio/stack-aws/cache-aws-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,163 @@
# cache.aws.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for AWS caching services such as ElastiCache.
This API group contains the following Crossplane resources:
* [ReplicationGroup](#ReplicationGroup)
* [ReplicationGroupClass](#ReplicationGroupClass)
## ReplicationGroup
A ReplicationGroup is a managed resource that represents an AWS ElastiCache Replication Group.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `cache.aws.crossplane.io/v1alpha2`
`kind` | string | `ReplicationGroup`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [ReplicationGroupSpec](#ReplicationGroupSpec) | A ReplicationGroupSpec defines the desired state of a ReplicationGroup.
`status` | [ReplicationGroupStatus](#ReplicationGroupStatus) | A ReplicationGroupStatus defines the observed state of a ReplicationGroup.
## ReplicationGroupClass
A ReplicationGroupClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `cache.aws.crossplane.io/v1alpha2`
`kind` | string | `ReplicationGroupClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [ReplicationGroupClassSpecTemplate](#ReplicationGroupClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned ReplicationGroup.
## MinorVersion
MinorVersion represents a supported minor version of Redis. Alias of string.
## NodeGroupConfigurationSpec
A NodeGroupConfigurationSpec specifies the desired state of a node group.
Appears in:
* [ReplicationGroupParameters](#ReplicationGroupParameters)
Name | Type | Description
-----|------|------------
`primaryAvailabilityZone` | Optional string | PrimaryAvailabilityZone specifies the Availability Zone where the primary node of this node group (shard) is launched.
`replicaAvailabilityZones` | Optional []string | ReplicaAvailabilityZones specifies a list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
`replicaCount` | Optional int | ReplicaCount specifies the number of read replica nodes in this node group (shard).
`slots` | Optional string | Slots specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey. Example: "0-3999"
## PatchVersion
PatchVersion represents a supported patch version of Redis. Alias of string.
## ReplicationGroupClassSpecTemplate
A ReplicationGroupClassSpecTemplate is a template for the spec of a dynamically provisioned ReplicationGroup.
Appears in:
* [ReplicationGroupClass](#ReplicationGroupClass)
ReplicationGroupClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [ReplicationGroupParameters](#ReplicationGroupParameters)
## ReplicationGroupParameters
ReplicationGroupParameters define the desired state of an AWS ElastiCache Replication Group. Most fields map directly to an AWS ReplicationGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html#API_CreateReplicationGroup_RequestParameters
Appears in:
* [ReplicationGroupClassSpecTemplate](#ReplicationGroupClassSpecTemplate)
* [ReplicationGroupSpec](#ReplicationGroupSpec)
Name | Type | Description
-----|------|------------
`atRestEncryptionEnabled` | Optional bool | AtRestEncryptionEnabled enables encryption at rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
`authEnabled` | Optional bool | AuthEnabled enables mandatory authentication when connecting to the managed replication group. AuthEnabled requires TransitEncryptionEnabled to be true. While ReplicationGroupSpec mirrors the fields of the upstream replication group object as closely as possible, we expose a boolean here rather than requiring the operator pass in a string authentication token. Crossplane will generate a token automatically and expose it via a Secret.
`automaticFailoverEnabled` | Optional bool | AutomaticFailoverEnabled specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
`cacheNodeType` | string | CacheNodeType specifies the compute and memory capacity of the nodes in the node group (shard).
`cacheParameterGroupName` | Optional string | CacheParameterGroupName specifies the name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
`cacheSecurityGroupNames` | Optional []string | CacheSecurityGroupNames specifies a list of cache security group names to associate with this replication group.
`cacheSubnetGroupName` | Optional string | CacheSubnetGroupName specifies the name of the cache subnet group to be used for the replication group. If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster.
`engineVersion` | Optional string | EngineVersion specifies the version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
`nodeGroupConfiguration` | Optional [[]NodeGroupConfigurationSpec](#NodeGroupConfigurationSpec) | NodeGroupConfiguration specifies a list of node group (shard) configuration options.
`notificationTopicArn` | Optional string | NotificationTopicARN specifies the Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
`numCacheClusters` | Optional int | NumCacheClusters specifies the number of clusters this replication group initially has. This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.
`numNodeGroups` | Optional int | NumNodeGroups specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.
`port` | Optional int | Port number on which each member of the replication group accepts connections.
`preferredCacheClusterAzs` | Optional []string | PreferredCacheClusterAZs specifies a list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. The number of Availability Zones listed must equal the value of NumCacheClusters.
`preferredMaintenanceWindow` | Optional string | PreferredMaintenanceWindow specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30
`replicasPerNodeGroup` | Optional int | ReplicasPerNodeGroup specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
`securityGroupIds` | Optional []string | SecurityGroupIDs specifies one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon VPC.
`snapshotArns` | Optional []string | SnapshotARNs specifies a list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
`snapshotName` | Optional string | SnapshotName specifies the name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
`snapshotRetentionLimit` | Optional int | SnapshotRetentionLimit specifies the number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
`snapshotWindow` | Optional string | SnapshotWindow specifies the daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
`transitEncryptionEnabled` | Optional bool | TransitEncryptionEnabled enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must TransitEncryptionEnabled to true when you create a cluster.
## ReplicationGroupSpec
A ReplicationGroupSpec defines the desired state of a ReplicationGroup.
Appears in:
* [ReplicationGroup](#ReplicationGroup)
ReplicationGroupSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [ReplicationGroupParameters](#ReplicationGroupParameters)
## ReplicationGroupStatus
A ReplicationGroupStatus defines the observed state of a ReplicationGroup.
Appears in:
* [ReplicationGroup](#ReplicationGroup)
Name | Type | Description
-----|------|------------
`state` | string | State of the Replication Group.
`providerID` | string | ProviderID is the external ID to identify this resource in the cloud provider
`endpoint` | string | Endpoint of the Replication Group used in connection strings.
`port` | int | Port at which the Replication Group endpoint is listening.
`clusterEnabled` | bool | ClusterEnabled indicates whether cluster mode is enabled, i.e. whether this replication group's data can be partitioned across multiple shards.
`memberClusters` | []string | MemberClusters that are part of this replication group.
`groupName` | string | Groupname of the Replication Group.
ReplicationGroupStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

186
docs/master/api/crossplaneio/stack-aws/compute-aws-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,186 @@
# compute.aws.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for AWS compute services such as EKS.
This API group contains the following Crossplane resources:
* [EKSCluster](#EKSCluster)
* [EKSClusterClass](#EKSClusterClass)
## EKSCluster
An EKSCluster is a managed resource that represents an AWS Elastic Kubernetes Service cluster.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.aws.crossplane.io/v1alpha2`
`kind` | string | `EKSCluster`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [EKSClusterSpec](#EKSClusterSpec) | An EKSClusterSpec defines the desired state of an EKSCluster.
`status` | [EKSClusterStatus](#EKSClusterStatus) | An EKSClusterStatus represents the observed state of an EKSCluster.
## EKSClusterClass
An EKSClusterClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.aws.crossplane.io/v1alpha2`
`kind` | string | `EKSClusterClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [EKSClusterClassSpecTemplate](#EKSClusterClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned EKSCluster.
## EKSClusterClassSpecTemplate
An EKSClusterClassSpecTemplate is a template for the spec of a dynamically provisioned EKSCluster.
Appears in:
* [EKSClusterClass](#EKSClusterClass)
EKSClusterClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [EKSClusterParameters](#EKSClusterParameters)
## EKSClusterParameters
EKSClusterParameters define the desired state of an AWS Elastic Kubernetes Service cluster.
Appears in:
* [EKSClusterClassSpecTemplate](#EKSClusterClassSpecTemplate)
* [EKSClusterSpec](#EKSClusterSpec)
Name | Type | Description
-----|------|------------
`region` | [EKSRegion](#EKSRegion) | Region for this EKS Cluster.
`roleARN` | string | RoleARN: The Amazon Resource Name (ARN) of the IAM role that provides permis sions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see 'Amazon EKS Service IAM Role' in the Amazon EKS User Guide.
`vpcId` | string | VpcID of this EKS cluster.
`subnetIds` | []string | SubnetIds of this EKS cluster.
`securityGroupIds` | []string | SecurityGroupIds of this EKS cluster.
`clusterVersion` | Optional string | ClusterVersion: The desired Kubernetes version of this EKS Cluster. If you do not specify a value here, the latest version available is used.
`workerNodes` | [WorkerNodesSpec](#WorkerNodesSpec) | WorkerNodes configuration for cloudformation
`mapRoles` | Optional [[]MapRole](#MapRole) | MapRoles map AWS roles to one or more Kubernetes groups. A Default role that allows nodes access to communicate with master is autogenerated when a node pool comes online.
`mapUsers` | Optional [[]MapUser](#MapUser) | MapUsers map AWS users to one or more Kubernetes groups.
## EKSClusterSpec
An EKSClusterSpec defines the desired state of an EKSCluster.
Appears in:
* [EKSCluster](#EKSCluster)
EKSClusterSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [EKSClusterParameters](#EKSClusterParameters)
## EKSClusterStatus
An EKSClusterStatus represents the observed state of an EKSCluster.
Appears in:
* [EKSCluster](#EKSCluster)
Name | Type | Description
-----|------|------------
`state` | string | State of the cluster.
`resourceName` | string | ClusterName of the cluster.
`resourceVersion` | string | ClusterVersion of the cluster.
`endpoint` | string | Endpoint for connecting to the cluster.
`cloudformationStackId` | string | CloudFormationStackID of the Stack used to create node groups.
EKSClusterStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## EKSRegion
EKSRegion represents an EKS enabled AWS region. Alias of string.
Appears in:
* [EKSClusterParameters](#EKSClusterParameters)
## MapRole
MapRole maps an AWS IAM role to one or more Kubernetes groups. See https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html and https://github.com/kubernetes-sigs/aws-iam-authenticator/blob/master/README.md
Appears in:
* [EKSClusterParameters](#EKSClusterParameters)
Name | Type | Description
-----|------|------------
`rolearn` | string | RoleARN to match, e.g. 'arn:aws:iam::000000000000:role/KubernetesNode'.
`username` | string | Username (in Kubernetes) the RoleARN should map to.
`groups` | []string | Groups (in Kubernetes) the RoleARN should map to.
## MapUser
MapUser maps an AWS IAM user to one or more Kubernetes groups. See https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html and https://github.com/kubernetes-sigs/aws-iam-authenticator/blob/master/README.md
Appears in:
* [EKSClusterParameters](#EKSClusterParameters)
Name | Type | Description
-----|------|------------
`userarn` | string | UserARN to match, e.g. 'arn:aws:iam::000000000000:user/Alice'
`username` | string | Username (in Kubernetes) the UserARN should map to.
`groups` | []string | Groups (in Kubernetes) the UserARN should map to.
## WorkerNodesSpec
WorkerNodesSpec - Worker node spec used to define cloudformation template that provisions workers for cluster
Appears in:
* [EKSClusterParameters](#EKSClusterParameters)
Name | Type | Description
-----|------|------------
`keyName` | Optional string | KeyName of the EC2 Key Pair to allow SSH access to the EC2 instances.
`nodeImageId` | Optional string | NodeImageId that the EC2 instances should run. Defaults to the region's standard AMI.
`nodeInstanceType` | string | NodeInstanceType of the EC2 instances.
`nodeAutoScalingGroupMinSize` | Optional int | NodeAutoScalingGroupMinSize configures the minimum size of this node group's Autoscaling Group. Defaults to 1.
`nodeAutoScalingGroupMaxSize` | Optional int | NodeAutoScalingGroupMaxSize configures the maximum size of this node group's Autoscaling Group. Defaults to 3.
`nodeVolumeSize` | Optional int | NodeVolumeSize configures the volume size in GB. Defaults to 20.
`bootstrapArguments` | Optional string | BootstrapArguments to pass to the bootstrap script. See files/bootstrap.sh in https://github.com/awslabs/amazon-eks-ami
`nodeGroupName` | Optional string | NodeGroupName is a unique identifier for the Node Group.
`clusterControlPlaneSecurityGroup` | Optional string | ClusterControlPlaneSecurityGroup configures the security group of the cluster control plane in order to allow communication to this node group.
This API documentation was generated by `crossdocs`.

122
docs/master/api/crossplaneio/stack-aws/database-aws-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,122 @@
# database.aws.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for AWS database services such as RDS.
This API group contains the following Crossplane resources:
* [RDSInstance](#RDSInstance)
* [RDSInstanceClass](#RDSInstanceClass)
## RDSInstance
An RDSInstance is a managed resource that represents an AWS Relational Database Service instance.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.aws.crossplane.io/v1alpha2`
`kind` | string | `RDSInstance`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [RDSInstanceSpec](#RDSInstanceSpec) | An RDSInstanceSpec defines the desired state of an RDSInstance.
`status` | [RDSInstanceStatus](#RDSInstanceStatus) | An RDSInstanceStatus represents the observed state of an RDSInstance.
## RDSInstanceClass
An RDSInstanceClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.aws.crossplane.io/v1alpha2`
`kind` | string | `RDSInstanceClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [RDSInstanceClassSpecTemplate](#RDSInstanceClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned RDSInstance.
## RDSInstanceClassSpecTemplate
An RDSInstanceClassSpecTemplate is a template for the spec of a dynamically provisioned RDSInstance.
Appears in:
* [RDSInstanceClass](#RDSInstanceClass)
RDSInstanceClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [RDSInstanceParameters](#RDSInstanceParameters)
## RDSInstanceParameters
RDSInstanceParameters define the desired state of an AWS Relational Database Service instance.
Appears in:
* [RDSInstanceClassSpecTemplate](#RDSInstanceClassSpecTemplate)
* [RDSInstanceSpec](#RDSInstanceSpec)
Name | Type | Description
-----|------|------------
`masterUsername` | string | MasterUsername for this RDSInstance.
`engine` | string | Engine for this RDSInstance - either mysql or postgres.
`engineVersion` | Optional string | EngineVersion for this RDS instance, for example "5.6".
`class` | string | Class of this RDS instance, for example "db.t2.micro".
`size` | int64 | Size in GB of this RDS instance.
`subnetGroupName` | Optional string | SubnetGroupName specifies a database subnet group for the RDS instance. The new instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the instance is not created in a VPC.
`securityGroups` | Optional []string | SecurityGroups that will allow the RDS instance to be accessed over the network.
## RDSInstanceSpec
An RDSInstanceSpec defines the desired state of an RDSInstance.
Appears in:
* [RDSInstance](#RDSInstance)
RDSInstanceSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [RDSInstanceParameters](#RDSInstanceParameters)
## RDSInstanceState
RDSInstanceState represents the state of an RDS instance. Alias of string.
## RDSInstanceStatus
An RDSInstanceStatus represents the observed state of an RDSInstance.
Appears in:
* [RDSInstance](#RDSInstance)
Name | Type | Description
-----|------|------------
`state` | string | State of this RDS instance.
`providerID` | string | ProviderID is the AWS identifier for this RDS instance.
`instanceName` | string | InstanceName of this RDS instance.
`endpoint` | string | Endpoint of this RDS instance.
RDSInstanceStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

172
docs/master/api/crossplaneio/stack-aws/identity-aws-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,172 @@
# identity.aws.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for AWS identity services such as IAM.
This API group contains the following Crossplane resources:
* [IAMRole](#IAMRole)
* [IAMRolePolicyAttachment](#IAMRolePolicyAttachment)
## IAMRole
An IAMRole is a managed resource that represents an AWS IAM Role.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `identity.aws.crossplane.io/v1alpha2`
`kind` | string | `IAMRole`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [IAMRoleSpec](#IAMRoleSpec) | An IAMRoleSpec defines the desired state of an IAMRole.
`status` | [IAMRoleStatus](#IAMRoleStatus) | An IAMRoleStatus represents the observed state of an IAMRole.
## IAMRolePolicyAttachment
An IAMRolePolicyAttachment is a managed resource that represents an AWS IAM Role policy attachment.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `identity.aws.crossplane.io/v1alpha2`
`kind` | string | `IAMRolePolicyAttachment`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [IAMRolePolicyAttachmentSpec](#IAMRolePolicyAttachmentSpec) | An IAMRolePolicyAttachmentSpec defines the desired state of an IAMRolePolicyAttachment.
`status` | [IAMRolePolicyAttachmentStatus](#IAMRolePolicyAttachmentStatus) | An IAMRolePolicyAttachmentStatus represents the observed state of an IAMRolePolicyAttachment.
## IAMRoleExternalStatus
IAMRoleExternalStatus keeps the state for the external resource
Appears in:
* [IAMRoleStatus](#IAMRoleStatus)
Name | Type | Description
-----|------|------------
`arn` | string | ARN is the Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the IAM User Guide guide.
`roleID` | string | RoleID is the stable and unique string identifying the role. For more information about IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the Using IAM guide.
## IAMRoleParameters
IAMRoleParameters define the desired state of an AWS IAM Role.
Appears in:
* [IAMRoleSpec](#IAMRoleSpec)
Name | Type | Description
-----|------|------------
`assumeRolePolicyDocument` | string | AssumeRolePolicyDocument is the the trust relationship policy document that grants an entity permission to assume the role.
`description` | Optional string | Description is a description of the role.
`roleName` | string | RoleName presents the name of the IAM role.
## IAMRolePolicyAttachmentExternalStatus
IAMRolePolicyAttachmentExternalStatus keeps the state for the external resource
Appears in:
* [IAMRolePolicyAttachmentStatus](#IAMRolePolicyAttachmentStatus)
Name | Type | Description
-----|------|------------
`attachedPolicyArn` | string | AttachedPolicyARN is the arn for the attached policy. If nil, the policy is not yet attached
## IAMRolePolicyAttachmentParameters
IAMRolePolicyAttachmentParameters define the desired state of an AWS IAM Role policy attachment.
Appears in:
* [IAMRolePolicyAttachmentSpec](#IAMRolePolicyAttachmentSpec)
Name | Type | Description
-----|------|------------
`policyArn` | string | PolicyARN is the Amazon Resource Name (ARN) of the IAM policy you want to attach.
`roleName` | string | RoleName presents the name of the IAM role.
## IAMRolePolicyAttachmentSpec
An IAMRolePolicyAttachmentSpec defines the desired state of an IAMRolePolicyAttachment.
Appears in:
* [IAMRolePolicyAttachment](#IAMRolePolicyAttachment)
IAMRolePolicyAttachmentSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [IAMRolePolicyAttachmentParameters](#IAMRolePolicyAttachmentParameters)
## IAMRolePolicyAttachmentStatus
An IAMRolePolicyAttachmentStatus represents the observed state of an IAMRolePolicyAttachment.
Appears in:
* [IAMRolePolicyAttachment](#IAMRolePolicyAttachment)
IAMRolePolicyAttachmentStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [IAMRolePolicyAttachmentExternalStatus](#IAMRolePolicyAttachmentExternalStatus)
## IAMRoleSpec
An IAMRoleSpec defines the desired state of an IAMRole.
Appears in:
* [IAMRole](#IAMRole)
IAMRoleSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [IAMRoleParameters](#IAMRoleParameters)
## IAMRoleStatus
An IAMRoleStatus represents the observed state of an IAMRole.
Appears in:
* [IAMRole](#IAMRole)
IAMRoleStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [IAMRoleExternalStatus](#IAMRoleExternalStatus)
This API documentation was generated by `crossdocs`.

568
docs/master/api/crossplaneio/stack-aws/network-aws-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,568 @@
# network.aws.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for AWS network services such as VPC and Subnet.
This API group contains the following Crossplane resources:
* [InternetGateway](#InternetGateway)
* [RouteTable](#RouteTable)
* [SecurityGroup](#SecurityGroup)
* [Subnet](#Subnet)
* [VPC](#VPC)
## InternetGateway
An InternetGateway is a managed resource that represents an AWS VPC Internet Gateway.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `network.aws.crossplane.io/v1alpha2`
`kind` | string | `InternetGateway`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [InternetGatewaySpec](#InternetGatewaySpec) | An InternetGatewaySpec defines the desired state of an InternetGateway.
`status` | [InternetGatewayStatus](#InternetGatewayStatus) | An InternetGatewayStatus represents the observed state of an InternetGateway.
## RouteTable
A RouteTable is a managed resource that represents an AWS VPC Route Table.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `network.aws.crossplane.io/v1alpha2`
`kind` | string | `RouteTable`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [RouteTableSpec](#RouteTableSpec) | A RouteTableSpec defines the desired state of a RouteTable.
`status` | [RouteTableStatus](#RouteTableStatus) | A RouteTableStatus represents the observed state of a RouteTable.
## SecurityGroup
A SecurityGroup is a managed resource that represents an AWS VPC Security Group.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `network.aws.crossplane.io/v1alpha2`
`kind` | string | `SecurityGroup`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [SecurityGroupSpec](#SecurityGroupSpec) | A SecurityGroupSpec defines the desired state of a SecurityGroup.
`status` | [SecurityGroupStatus](#SecurityGroupStatus) | A SecurityGroupStatus represents the observed state of a SecurityGroup.
## Subnet
A Subnet is a managed resource that represents an AWS VPC Subnet.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `network.aws.crossplane.io/v1alpha2`
`kind` | string | `Subnet`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [SubnetSpec](#SubnetSpec) | A SubnetSpec defines the desired state of a Subnet.
`status` | [SubnetStatus](#SubnetStatus) | A SubnetStatus represents the observed state of a Subnet.
## VPC
A VPC is a managed resource that represents an AWS Virtual Private Cloud.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `network.aws.crossplane.io/v1alpha2`
`kind` | string | `VPC`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [VPCSpec](#VPCSpec) | A VPCSpec defines the desired state of a VPC.
`status` | [VPCStatus](#VPCStatus) | A VPCStatus represents the observed state of a VPC.
## Association
Association describes an association between a route table and a subnet.
Appears in:
* [AssociationState](#AssociationState)
* [RouteTableParameters](#RouteTableParameters)
Name | Type | Description
-----|------|------------
`subnetId` | string | The ID of the subnet. A subnet ID is not returned for an implicit association.
## AssociationState
AssociationState describes an association state in the route table.
Appears in:
* [RouteTableExternalStatus](#RouteTableExternalStatus)
Name | Type | Description
-----|------|------------
`main` | bool | Indicates whether this is the main route table.
`associationId` | string | The ID of the association between a route table and a subnet.
AssociationState supports all fields of:
* [Association](#Association)
## IPPermission
IPPermission Describes a set of permissions for a security group rule.
Appears in:
* [SecurityGroupParameters](#SecurityGroupParameters)
Name | Type | Description
-----|------|------------
`fromPort` | int64 | The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
`toPort` | int64 | The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.
`protocol` | string | The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). [EC2-VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6) allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed when authorizing rules.
`cidrBlocks` | [[]IPRange](#IPRange) | One or more IPv4 ranges.
## IPRange
IPRange describes an IPv4 range.
Appears in:
* [IPPermission](#IPPermission)
Name | Type | Description
-----|------|------------
`cidrIp` | string | The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
`description` | string | A description for the ip range
## InternetGatewayAttachment
InternetGatewayAttachment describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
Appears in:
* [InternetGatewayExternalStatus](#InternetGatewayExternalStatus)
Name | Type | Description
-----|------|------------
`attachmentStatus` | string | The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
`vpcId` | string | VPCID is the ID of the attached VPC.
## InternetGatewayExternalStatus
InternetGatewayExternalStatus keeps the state for the external resource
Appears in:
* [InternetGatewayStatus](#InternetGatewayStatus)
Name | Type | Description
-----|------|------------
`attachments` | [[]InternetGatewayAttachment](#InternetGatewayAttachment) | Any VPCs attached to the internet gateway.
`internetGatewayId` | string | The ID of the internet gateway.
`tags` | [[]Tag](#Tag) | Tags represents to current ec2 tags.
## InternetGatewayParameters
InternetGatewayParameters define the desired state of an AWS VPC Internet Gateway.
Appears in:
* [InternetGatewaySpec](#InternetGatewaySpec)
Name | Type | Description
-----|------|------------
`vpcId` | string | the VPC to attach the gateway to.
## InternetGatewaySpec
An InternetGatewaySpec defines the desired state of an InternetGateway.
Appears in:
* [InternetGateway](#InternetGateway)
InternetGatewaySpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [InternetGatewayParameters](#InternetGatewayParameters)
## InternetGatewayStatus
An InternetGatewayStatus represents the observed state of an InternetGateway.
Appears in:
* [InternetGateway](#InternetGateway)
InternetGatewayStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [InternetGatewayExternalStatus](#InternetGatewayExternalStatus)
## Route
Route describes a route in a route table.
Appears in:
* [RouteState](#RouteState)
* [RouteTableParameters](#RouteTableParameters)
Name | Type | Description
-----|------|------------
`destinationCidrBlock` | string | The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.
`gatewayId` | string | The ID of an internet gateway or virtual private gateway attached to your VPC.
## RouteState
RouteState describes a route state in the route table.
Appears in:
* [RouteTableExternalStatus](#RouteTableExternalStatus)
Name | Type | Description
-----|------|------------
`routeState` | string | The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
RouteState supports all fields of:
* [Route](#Route)
## RouteTableExternalStatus
RouteTableExternalStatus keeps the state for the external resource
Appears in:
* [RouteTableStatus](#RouteTableStatus)
Name | Type | Description
-----|------|------------
`routeTableId` | string | RouteTableID is the ID of the RouteTable.
`routes` | [[]RouteState](#RouteState) | The actual routes created for the route table.
`associations` | [[]AssociationState](#AssociationState) | The actual associations created for the route table.
## RouteTableParameters
RouteTableParameters define the desired state of an AWS VPC Route Table.
Appears in:
* [RouteTableSpec](#RouteTableSpec)
Name | Type | Description
-----|------|------------
`vpcId` | string | VPCID is the ID of the VPC.
`routes` | [[]Route](#Route) | the routes in the route table
`associations` | [[]Association](#Association) | The associations between the route table and one or more subnets.
## RouteTableSpec
A RouteTableSpec defines the desired state of a RouteTable.
Appears in:
* [RouteTable](#RouteTable)
RouteTableSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [RouteTableParameters](#RouteTableParameters)
## RouteTableStatus
A RouteTableStatus represents the observed state of a RouteTable.
Appears in:
* [RouteTable](#RouteTable)
RouteTableStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [RouteTableExternalStatus](#RouteTableExternalStatus)
## SecurityGroupExternalStatus
SecurityGroupExternalStatus keeps the state for the external resource
Appears in:
* [SecurityGroupStatus](#SecurityGroupStatus)
Name | Type | Description
-----|------|------------
`securityGroupID` | string | SecurityGroupID is the ID of the SecurityGroup.
`tags` | [[]Tag](#Tag) | Tags represents to current ec2 tags.
## SecurityGroupParameters
SecurityGroupParameters define the desired state of an AWS VPC Security Group.
Appears in:
* [SecurityGroupSpec](#SecurityGroupSpec)
Name | Type | Description
-----|------|------------
`vpcId` | string | VPCID is the ID of the VPC.
`description` | string | A description of the security group.
`groupName` | string | The name of the security group.
`ingress` | [[]IPPermission](#IPPermission) | One or more inbound rules associated with the security group.
`egress` | [[]IPPermission](#IPPermission) | [EC2-VPC] One or more outbound rules associated with the security group.
## SecurityGroupSpec
A SecurityGroupSpec defines the desired state of a SecurityGroup.
Appears in:
* [SecurityGroup](#SecurityGroup)
SecurityGroupSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [SecurityGroupParameters](#SecurityGroupParameters)
## SecurityGroupStatus
A SecurityGroupStatus represents the observed state of a SecurityGroup.
Appears in:
* [SecurityGroup](#SecurityGroup)
SecurityGroupStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [SecurityGroupExternalStatus](#SecurityGroupExternalStatus)
## SubnetExternalStatus
SubnetExternalStatus keeps the state for the external resource
Appears in:
* [SubnetStatus](#SubnetStatus)
Name | Type | Description
-----|------|------------
`subnetState` | string | SubnetState is the current state of the Subnet.
`tags` | [[]Tag](#Tag) | Tags represents to current ec2 tags.
`subnetId` | string | SubnetID is the ID of the Subnet.
## SubnetParameters
SubnetParameters define the desired state of an AWS VPC Subnet.
Appears in:
* [SubnetSpec](#SubnetSpec)
Name | Type | Description
-----|------|------------
`cidrBlock` | string | CIDRBlock is the IPv4 network range for the Subnet, in CIDR notation. For example, 10.0.0.0/18.
`availabilityZone` | string | The Availability Zone for the subnet. Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.
`vpcId` | string | VPCID is the ID of the VPC.
## SubnetSpec
A SubnetSpec defines the desired state of a Subnet.
Appears in:
* [Subnet](#Subnet)
SubnetSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [SubnetParameters](#SubnetParameters)
## SubnetStatus
A SubnetStatus represents the observed state of a Subnet.
Appears in:
* [Subnet](#Subnet)
SubnetStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [SubnetExternalStatus](#SubnetExternalStatus)
## Tag
Tag defines a tag
Appears in:
* [InternetGatewayExternalStatus](#InternetGatewayExternalStatus)
* [SecurityGroupExternalStatus](#SecurityGroupExternalStatus)
* [SubnetExternalStatus](#SubnetExternalStatus)
* [VPCExternalStatus](#VPCExternalStatus)
Name | Type | Description
-----|------|------------
`key` | string | Key is the name of the tag.
`value` | string | Value is the value of the tag.
## VPCExternalStatus
VPCExternalStatus keeps the state for the external resource
Appears in:
* [VPCStatus](#VPCStatus)
Name | Type | Description
-----|------|------------
`vpcState` | string | VPCState is the current state of the VPC.
`tags` | [[]Tag](#Tag) | Tags represents to current ec2 tags.
`vpcId` | string | VPCID is the ID of the VPC.
## VPCParameters
VPCParameters define the desired state of an AWS Virtual Private Cloud.
Appears in:
* [VPCSpec](#VPCSpec)
Name | Type | Description
-----|------|------------
`cidrBlock` | string | CIDRBlock is the IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.
`enableDnsSupport` | bool | A boolean flag to enable/disable DNS support in the VPC
`enableDnsHostNames` | bool | A boolean flag to enable/disable DNS hostnames in the VPC
## VPCSpec
A VPCSpec defines the desired state of a VPC.
Appears in:
* [VPC](#VPC)
VPCSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [VPCParameters](#VPCParameters)
## VPCStatus
A VPCStatus represents the observed state of a VPC.
Appears in:
* [VPC](#VPC)
VPCStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [VPCExternalStatus](#VPCExternalStatus)
This API documentation was generated by `crossdocs`.

233
docs/master/api/crossplaneio/stack-aws/storage-aws-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,233 @@
# storage.aws.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for AWS storage services such as S3.
This API group contains the following Crossplane resources:
* [DBSubnetGroup](#DBSubnetGroup)
* [S3Bucket](#S3Bucket)
* [S3BucketClass](#S3BucketClass)
## DBSubnetGroup
A DBSubnetGroup is a managed resource that represents an AWS VPC Database Subnet Group.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.aws.crossplane.io/v1alpha2`
`kind` | string | `DBSubnetGroup`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [DBSubnetGroupSpec](#DBSubnetGroupSpec) | A DBSubnetGroupSpec defines the desired state of a DBSubnetGroup.
`status` | [DBSubnetGroupStatus](#DBSubnetGroupStatus) | A DBSubnetGroupStatus represents the observed state of a DBSubnetGroup.
## S3Bucket
An S3Bucket is a managed resource that represents an AWS S3 Bucket.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.aws.crossplane.io/v1alpha2`
`kind` | string | `S3Bucket`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [S3BucketSpec](#S3BucketSpec) | S3BucketSpec defines the desired state of S3Bucket
`status` | [S3BucketStatus](#S3BucketStatus) | S3BucketStatus defines the observed state of S3Bucket
## S3BucketClass
An S3BucketClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.aws.crossplane.io/v1alpha2`
`kind` | string | `S3BucketClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [S3BucketClassSpecTemplate](#S3BucketClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned S3Bucket.
## DBSubnetGroupExternalStatus
DBSubnetGroupExternalStatus keeps the state for the external resource
Appears in:
* [DBSubnetGroupStatus](#DBSubnetGroupStatus)
Name | Type | Description
-----|------|------------
`groupArn` | string | The Amazon Resource Name (ARN) for the DB subnet group.
`groupStatus` | string | Provides the status of the DB subnet group.
`subnets` | [[]Subnet](#Subnet) | Contains a list of Subnet elements.
`vpcId` | string | Provides the VpcId of the DB subnet group.
## DBSubnetGroupParameters
DBSubnetGroupParameters define the desired state of an AWS VPC Database Subnet Group.
Appears in:
* [DBSubnetGroupSpec](#DBSubnetGroupSpec)
Name | Type | Description
-----|------|------------
`description` | string | The description for the DB subnet group.
`groupName` | string | The name for the DB subnet group. This value is stored as a lowercase string.
`subnetIds` | []string | The EC2 Subnet IDs for the DB subnet group.
`tags` | [[]Tag](#Tag) | A list of tags. For more information, see Tagging Amazon RDS Resources (http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the Amazon RDS User Guide.
## DBSubnetGroupSpec
A DBSubnetGroupSpec defines the desired state of a DBSubnetGroup.
Appears in:
* [DBSubnetGroup](#DBSubnetGroup)
DBSubnetGroupSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [DBSubnetGroupParameters](#DBSubnetGroupParameters)
## DBSubnetGroupStatus
A DBSubnetGroupStatus represents the observed state of a DBSubnetGroup.
Appears in:
* [DBSubnetGroup](#DBSubnetGroup)
DBSubnetGroupStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [DBSubnetGroupExternalStatus](#DBSubnetGroupExternalStatus)
## S3BucketClassSpecTemplate
An S3BucketClassSpecTemplate is a template for the spec of a dynamically provisioned S3Bucket.
Appears in:
* [S3BucketClass](#S3BucketClass)
S3BucketClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [S3BucketParameters](#S3BucketParameters)
## S3BucketParameters
S3BucketParameters define the desired state of an AWS S3 Bucket.
Appears in:
* [S3BucketClassSpecTemplate](#S3BucketClassSpecTemplate)
* [S3BucketSpec](#S3BucketSpec)
Name | Type | Description
-----|------|------------
`nameFormat` | Optional string | NameFormat specifies the name of the external S3Bucket instance. The first instance of the string '%s' will be replaced with the Kubernetes UID of this S3Bucket. Omit this field to use the UID alone as the name.
`region` | string | Region of the bucket.
`cannedACL` | Optional [s3.BucketCannedACL](https://godoc.org/github.com/aws/aws-sdk-go-v2/service/s3#BucketCannedACL) | CannedACL applies a standard AWS built-in ACL for common bucket use cases.
`versioning` | Optional bool | Versioning enables versioning of objects stored in this bucket.
`localPermission` | [storage/v1alpha1.LocalPermissionType](../crossplane/storage-crossplane-io-v1alpha1.md#localpermissiontype) | LocalPermission is the permissions granted on the bucket for the provider specific bucket service account that is available in a secret after provisioning.
## S3BucketSpec
S3BucketSpec defines the desired state of S3Bucket
Appears in:
* [S3Bucket](#S3Bucket)
S3BucketSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [S3BucketParameters](#S3BucketParameters)
## S3BucketStatus
S3BucketStatus defines the observed state of S3Bucket
Appears in:
* [S3Bucket](#S3Bucket)
Name | Type | Description
-----|------|------------
`providerID` | string | ProviderID is the AWS identifier for this bucket.
`iamUsername` | string | IAMUsername is the name of an IAM user that is automatically created and granted access to this bucket by Crossplane at bucket creation time.
`lastUserPolicyVersion` | int | LastUserPolicyVersion is the most recent version of the policy associated with this bucket's IAMUser.
`lastLocalPermission` | [storage/v1alpha1.LocalPermissionType](../crossplane/storage-crossplane-io-v1alpha1.md#localpermissiontype) | LastLocalPermission is the most recent local permission that was set for this bucket.
S3BucketStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## Subnet
Subnet represents a aws subnet
Appears in:
* [DBSubnetGroupExternalStatus](#DBSubnetGroupExternalStatus)
Name | Type | Description
-----|------|------------
`subnetID` | string | Specifies the identifier of the subnet.
`subnetStatus` | string | Specifies the status of the subnet.
## Tag
Tag defines a tag
Appears in:
* [DBSubnetGroupParameters](#DBSubnetGroupParameters)
Name | Type | Description
-----|------|------------
`key` | string | Key is the name of the tag.
`value` | string | Value is the value of the tag.
This API documentation was generated by `crossdocs`.

93
docs/master/api/crossplaneio/stack-azure/azure-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,93 @@
# azure.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains core resources for Microsoft Azure.
This API group contains the following Crossplane resources:
* [Provider](#Provider)
* [ResourceGroup](#ResourceGroup)
## Provider
A Provider configures an Azure 'provider', i.e. a connection to a particular Azure account using a particular Azure Service Principal.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `azure.crossplane.io/v1alpha2`
`kind` | string | `Provider`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [ProviderSpec](#ProviderSpec) | A ProviderSpec defines the desired state of a Provider.
## ResourceGroup
A ResourceGroup is a managed resource that represents an Azure Resource Group.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `azure.crossplane.io/v1alpha2`
`kind` | string | `ResourceGroup`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [ResourceGroupSpec](#ResourceGroupSpec) | A ResourceGroupSpec defines the desired state of a ResourceGroup.
`status` | [ResourceGroupStatus](#ResourceGroupStatus) | A ResourceGroupStatus represents the observed status of a ResourceGroup.
## ProviderSpec
A ProviderSpec defines the desired state of a Provider.
Appears in:
* [Provider](#Provider)
Name | Type | Description
-----|------|------------
`credentialsSecretRef` | [core/v1.SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#secretkeyselector-v1-core) | Azure service principal credentials json secret key reference A Secret containing JSON encoded credentials for an Azure Service Principal that will be used to authenticate to this Azure Provider.
## ResourceGroupSpec
A ResourceGroupSpec defines the desired state of a ResourceGroup.
Appears in:
* [ResourceGroup](#ResourceGroup)
Name | Type | Description
-----|------|------------
`name` | string | Name of the resource group.
`location` | string | Location of the resource group. See the official list of valid regions - https://azure.microsoft.com/en-us/global-infrastructure/regions/
ResourceGroupSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
## ResourceGroupStatus
A ResourceGroupStatus represents the observed status of a ResourceGroup.
Appears in:
* [ResourceGroup](#ResourceGroup)
Name | Type | Description
-----|------|------------
`name` | string | Name of the resource group.
ResourceGroupStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

138
docs/master/api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,138 @@
# cache.azure.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for Azure cache services such as Redis.
This API group contains the following Crossplane resources:
* [Redis](#Redis)
* [RedisClass](#RedisClass)
## Redis
A Redis is a managed resource that represents an Azure Redis cluster.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `cache.azure.crossplane.io/v1alpha2`
`kind` | string | `Redis`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [RedisSpec](#RedisSpec) | A RedisSpec defines the desired state of a Redis.
`status` | [RedisStatus](#RedisStatus) | A RedisStatus represents the observed state of a Redis.
## RedisClass
A RedisClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `cache.azure.crossplane.io/v1alpha2`
`kind` | string | `RedisClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [RedisClassSpecTemplate](#RedisClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned Redis.
## RedisClassSpecTemplate
A RedisClassSpecTemplate is a template for the spec of a dynamically provisioned Redis.
Appears in:
* [RedisClass](#RedisClass)
RedisClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [RedisParameters](#RedisParameters)
## RedisParameters
RedisParameters define the desired state of an Azure Redis cluster. Most fields map directly to an Azure Redis resource: https://docs.microsoft.com/en-us/rest/api/redis/redis/create#redisresource
Appears in:
* [RedisClassSpecTemplate](#RedisClassSpecTemplate)
* [RedisSpec](#RedisSpec)
Name | Type | Description
-----|------|------------
`resourceGroupName` | string | ResourceGroupName in which to create this resource.
`location` | string | Location in which to create this resource.
`sku` | [SKUSpec](#SKUSpec) | SKU of the Redis cache to deploy.
`enableNonSslPort` | Optional bool | EnableNonSSLPort specifies whether the non-ssl Redis server port (6379) is enabled.
`shardCount` | Optional int | ShardCount specifies the number of shards to be created on a Premium Cluster Cache.
`staticIP` | Optional string | StaticIP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
`subnetId` | Optional string | SubnetID specifies the full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
`redisConfiguration` | Optional map[string]string | RedisConfiguration specifies Redis Settings.
## RedisSpec
A RedisSpec defines the desired state of a Redis.
Appears in:
* [Redis](#Redis)
RedisSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [RedisParameters](#RedisParameters)
## RedisStatus
A RedisStatus represents the observed state of a Redis.
Appears in:
* [Redis](#Redis)
Name | Type | Description
-----|------|------------
`state` | string | State represents the state of an Azure Redis.
`providerID` | string | ProviderID is the external ID to identify this resource in the cloud provider.
`endpoint` | string | Endpoint of the Redis resource used in connection strings.
`port` | int | Port at which the Redis endpoint is listening.
`sslPort` | int | SSLPort at which the Redis endpoint is listening.
`redisVersion` | string | RedisVersion the Redis endpoint is running.
`resourceName` | string | ResourceName of the Redis cache resource.
RedisStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## SKUSpec
An SKUSpec represents the performance and cost oriented properties of a Redis.
Appears in:
* [RedisParameters](#RedisParameters)
Name | Type | Description
-----|------|------------
`name` | string | Name specifies what type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). Possible values include: 'Basic', 'Standard', 'Premium'
`family` | string | Family specifies which family to use. Valid values: (C, P). Possible values include: 'C', 'P'
`capacity` | int | Capacity specifies the size of Redis cache to deploy. Valid values: for C family (0, 1, 2, 3, 4, 5, 6), for P family (1, 2, 3, 4).
This API documentation was generated by `crossdocs`.

122
docs/master/api/crossplaneio/stack-azure/compute-azure-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,122 @@
# compute.azure.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for Azure compute services such as AKS.
This API group contains the following Crossplane resources:
* [AKSCluster](#AKSCluster)
* [AKSClusterClass](#AKSClusterClass)
## AKSCluster
An AKSCluster is a managed resource that represents an Azure Kubernetes Engine cluster.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.azure.crossplane.io/v1alpha2`
`kind` | string | `AKSCluster`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [AKSClusterSpec](#AKSClusterSpec) | An AKSClusterSpec defines the desired state of a AKSCluster.
`status` | [AKSClusterStatus](#AKSClusterStatus) | An AKSClusterStatus represents the observed state of an AKSCluster.
## AKSClusterClass
An AKSClusterClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.azure.crossplane.io/v1alpha2`
`kind` | string | `AKSClusterClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [AKSClusterClassSpecTemplate](#AKSClusterClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned AKSCluster.
## AKSClusterClassSpecTemplate
An AKSClusterClassSpecTemplate is a template for the spec of a dynamically provisioned AKSCluster.
Appears in:
* [AKSClusterClass](#AKSClusterClass)
AKSClusterClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [AKSClusterParameters](#AKSClusterParameters)
## AKSClusterParameters
AKSClusterParameters define the desired state of an Azure Kubernetes Engine cluster.
Appears in:
* [AKSClusterClassSpecTemplate](#AKSClusterClassSpecTemplate)
* [AKSClusterSpec](#AKSClusterSpec)
Name | Type | Description
-----|------|------------
`resourceGroupName` | string | ResourceGroupName is the name of the resource group that the cluster will be created in
`location` | string | Location is the Azure location that the cluster will be created in
`version` | string | Version is the Kubernetes version that will be deployed to the cluster
`vnetSubnetID` | Optional string | VnetSubnetID is the subnet to which the cluster will be deployed.
`nodeCount` | Optional int | NodeCount is the number of nodes that the cluster will initially be created with. This can be scaled over time and defaults to 1.
`nodeVMSize` | Optional string | NodeVMSize is the name of the worker node VM size, e.g., Standard_B2s, Standard_F2s_v2, etc.
`dnsNamePrefix` | Optional string | DNSNamePrefix is the DNS name prefix to use with the hosted Kubernetes API server FQDN. You will use this to connect to the Kubernetes API when managing containers after creating the cluster.
`disableRBAC` | Optional bool | DisableRBAC determines whether RBAC will be disabled or enabled in the cluster.
`writeServicePrincipalTo` | [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core) | WriteServicePrincipalSecretTo the specified Secret. The service principal is automatically generated and used by the AKS cluster to interact with other Azure resources.
## AKSClusterSpec
An AKSClusterSpec defines the desired state of a AKSCluster.
Appears in:
* [AKSCluster](#AKSCluster)
AKSClusterSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [AKSClusterParameters](#AKSClusterParameters)
## AKSClusterStatus
An AKSClusterStatus represents the observed state of an AKSCluster.
Appears in:
* [AKSCluster](#AKSCluster)
Name | Type | Description
-----|------|------------
`clusterName` | string | ClusterName is the name of the cluster as registered with the cloud provider.
`state` | string | State is the current state of the cluster.
`providerID` | string | ProviderID is the external ID to identify this resource in the cloud provider.
`endpoint` | string | Endpoint is the endpoint where the cluster can be reached
`appObjectID` | string | ApplicationObjectID is the object ID of the AD application the cluster uses for Azure APIs.
`servicePrincipalID` | string | ServicePrincipalID is the ID of the service principal the AD application uses.
`runningOperation` | string | RunningOperation stores any current long running operation for this instance across reconciliation attempts.
AKSClusterStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

270
docs/master/api/crossplaneio/stack-azure/database-azure-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,270 @@
# database.azure.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for Azure database services such as SQL server.
This API group contains the following Crossplane resources:
* [MysqlServer](#MysqlServer)
* [MysqlServerVirtualNetworkRule](#MysqlServerVirtualNetworkRule)
* [PostgresqlServer](#PostgresqlServer)
* [PostgresqlServerVirtualNetworkRule](#PostgresqlServerVirtualNetworkRule)
* [SQLServerClass](#SQLServerClass)
## MysqlServer
A MysqlServer is a managed resource that represents an Azure MySQL Database Server.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.azure.crossplane.io/v1alpha2`
`kind` | string | `MysqlServer`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [SQLServerSpec](#SQLServerSpec) | A SQLServerSpec defines the desired state of a SQLServer.
`status` | [SQLServerStatus](#SQLServerStatus) | A SQLServerStatus represents the observed state of a SQLServer.
## MysqlServerVirtualNetworkRule
A MysqlServerVirtualNetworkRule is a managed resource that represents an Azure MySQL Database virtual network rule.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.azure.crossplane.io/v1alpha2`
`kind` | string | `MysqlServerVirtualNetworkRule`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [VirtualNetworkRuleSpec](#VirtualNetworkRuleSpec) | A VirtualNetworkRuleSpec defines the desired state of a VirtualNetworkRule.
`status` | [VirtualNetworkRuleStatus](#VirtualNetworkRuleStatus) | A VirtualNetworkRuleStatus represents the observed state of a VirtualNetworkRule.
## PostgresqlServer
A PostgresqlServer is a managed resource that represents an Azure PostgreSQL Database Server.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.azure.crossplane.io/v1alpha2`
`kind` | string | `PostgresqlServer`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [SQLServerSpec](#SQLServerSpec) | A SQLServerSpec defines the desired state of a SQLServer.
`status` | [SQLServerStatus](#SQLServerStatus) | A SQLServerStatus represents the observed state of a SQLServer.
## PostgresqlServerVirtualNetworkRule
A PostgresqlServerVirtualNetworkRule is a managed resource that represents an Azure PostgreSQL Database virtual network rule.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.azure.crossplane.io/v1alpha2`
`kind` | string | `PostgresqlServerVirtualNetworkRule`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [VirtualNetworkRuleSpec](#VirtualNetworkRuleSpec) | A VirtualNetworkRuleSpec defines the desired state of a VirtualNetworkRule.
`status` | [VirtualNetworkRuleStatus](#VirtualNetworkRuleStatus) | A VirtualNetworkRuleStatus represents the observed state of a VirtualNetworkRule.
## SQLServerClass
A SQLServerClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.azure.crossplane.io/v1alpha2`
`kind` | string | `SQLServerClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [SQLServerClassSpecTemplate](#SQLServerClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned SQLServer.
## PricingTierSpec
PricingTierSpec represents the performance and cost oriented properties of a SQLServer.
Appears in:
* [SQLServerParameters](#SQLServerParameters)
Name | Type | Description
-----|------|------------
`tier` | string | Tier of the particular SKU, e.g. Basic. Possible values include: 'Basic', 'GeneralPurpose', 'MemoryOptimized'
`vcores` | int | VCores (aka Capacity) specifies how many virtual cores this SQLServer requires.
`family` | string | Family of hardware.
## SQLServer
SQLServer represents a generic Azure SQL server.
## SQLServerClassSpecTemplate
A SQLServerClassSpecTemplate is a template for the spec of a dynamically provisioned MysqlServer or PostgresqlServer.
Appears in:
* [SQLServerClass](#SQLServerClass)
SQLServerClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [SQLServerParameters](#SQLServerParameters)
## SQLServerParameters
SQLServerParameters define the desired state of an Azure SQL Database, either PostgreSQL or MySQL.
Appears in:
* [SQLServerClassSpecTemplate](#SQLServerClassSpecTemplate)
* [SQLServerSpec](#SQLServerSpec)
Name | Type | Description
-----|------|------------
`resourceGroupName` | string | ResourceGroupName specifies the name of the resource group that should contain this SQLServer.
`location` | string | Location specifies the location of this SQLServer.
`pricingTier` | [PricingTierSpec](#PricingTierSpec) | PricingTier specifies the pricing tier (aka SKU) for this SQLServer.
`storageProfile` | [StorageProfileSpec](#StorageProfileSpec) | StorageProfile configures the storage profile of this SQLServer.
`adminLoginName` | string | AdminLoginName specifies the administrator login name for this SQLServer.
`version` | string | Version specifies the version of this server, for example "5.6", or "9.6".
`sslEnforced` | Optional bool | SSLEnforced specifies whether SSL is required to connect to this SQLServer.
## SQLServerSpec
A SQLServerSpec defines the desired state of a SQLServer.
Appears in:
* [MysqlServer](#MysqlServer)
* [PostgresqlServer](#PostgresqlServer)
SQLServerSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [SQLServerParameters](#SQLServerParameters)
## SQLServerStatus
A SQLServerStatus represents the observed state of a SQLServer.
Appears in:
* [MysqlServer](#MysqlServer)
* [PostgresqlServer](#PostgresqlServer)
Name | Type | Description
-----|------|------------
`state` | string | State of this SQLServer.
`message` | string | A Message containing detail on the state of this SQLServer, if any.
`providerID` | string | ProviderID is the external ID to identify this resource in the cloud provider.
`endpoint` | string | Endpoint of the MySQL Server instance used in connection strings.
`runningOperation` | string | RunningOperation stores any current long running operation for this instance across reconciliation attempts.
`runningOperationType` | string | RunningOperationType is the type of the currently running operation.
SQLServerStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## StorageProfileSpec
A StorageProfileSpec represents storage related properties of a SQLServer.
Appears in:
* [SQLServerParameters](#SQLServerParameters)
Name | Type | Description
-----|------|------------
`storageGB` | int | StorageGB configures the maximum storage allowed.
`backupRetentionDays` | int | BackupRetentionDays configures how many days backups will be retained.
`geoRedundantBackup` | bool | GeoRedundantBackup enables geo-redunndant backups.
## VirtualNetworkRuleProperties
VirtualNetworkRuleProperties defines the properties of a VirtualNetworkRule.
Appears in:
* [VirtualNetworkRuleSpec](#VirtualNetworkRuleSpec)
Name | Type | Description
-----|------|------------
`virtualNetworkSubnetId` | string | VirtualNetworkSubnetID - The ARM resource id of the virtual network subnet.
`ignoreMissingVnetServiceEndpoint` | bool | IgnoreMissingVnetServiceEndpoint - Create firewall rule before the virtual network has vnet service endpoint enabled.
## VirtualNetworkRuleSpec
A VirtualNetworkRuleSpec defines the desired state of a VirtualNetworkRule.
Appears in:
* [MysqlServerVirtualNetworkRule](#MysqlServerVirtualNetworkRule)
* [PostgresqlServerVirtualNetworkRule](#PostgresqlServerVirtualNetworkRule)
Name | Type | Description
-----|------|------------
`name` | string | Name - Name of the Virtual Network Rule.
`serverName` | string | ServerName - Name of the Virtual Network Rule's server.
`resourceGroupName` | string | ResourceGroupName - Name of the Virtual Network Rule's resource group.
`properties` | [VirtualNetworkRuleProperties](#VirtualNetworkRuleProperties) | VirtualNetworkRuleProperties - Resource properties.
VirtualNetworkRuleSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
## VirtualNetworkRuleStatus
A VirtualNetworkRuleStatus represents the observed state of a VirtualNetworkRule.
Appears in:
* [MysqlServerVirtualNetworkRule](#MysqlServerVirtualNetworkRule)
* [PostgresqlServerVirtualNetworkRule](#PostgresqlServerVirtualNetworkRule)
Name | Type | Description
-----|------|------------
`state` | string | State of this virtual network rule.
`message` | string | A Message containing details about the state of this virtual network rule, if any.
`id` | string | ID - Resource ID
`type` | string | Type - Resource type.
VirtualNetworkRuleStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

197
docs/master/api/crossplaneio/stack-azure/network-azure-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,197 @@
# network.azure.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for Azure network services such as virtual networks.
This API group contains the following Crossplane resources:
* [Subnet](#Subnet)
* [VirtualNetwork](#VirtualNetwork)
## Subnet
A Subnet is a managed resource that represents an Azure Subnet.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `network.azure.crossplane.io/v1alpha2`
`kind` | string | `Subnet`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [SubnetSpec](#SubnetSpec) | A SubnetSpec defines the desired state of a Subnet.
`status` | [SubnetStatus](#SubnetStatus) | A SubnetStatus represents the observed state of a Subnet.
## VirtualNetwork
A VirtualNetwork is a managed resource that represents an Azure Virtual Network.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `network.azure.crossplane.io/v1alpha2`
`kind` | string | `VirtualNetwork`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [VirtualNetworkSpec](#VirtualNetworkSpec) | A VirtualNetworkSpec defines the desired state of a VirtualNetwork.
`status` | [VirtualNetworkStatus](#VirtualNetworkStatus) | A VirtualNetworkStatus represents the observed state of a VirtualNetwork.
## AddressSpace
AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
Appears in:
* [VirtualNetworkPropertiesFormat](#VirtualNetworkPropertiesFormat)
Name | Type | Description
-----|------|------------
`addressPrefixes` | []string | AddressPrefixes - A list of address blocks reserved for this virtual network in CIDR notation.
## ServiceEndpointPropertiesFormat
ServiceEndpointPropertiesFormat defines properties of a service endpoint.
Appears in:
* [SubnetPropertiesFormat](#SubnetPropertiesFormat)
Name | Type | Description
-----|------|------------
`service` | Optional string | Service - The type of the endpoint service.
`locations` | Optional []string | Locations - A list of locations.
`provisioningState` | Optional string | ProvisioningState - The provisioning state of the resource.
## SubnetPropertiesFormat
SubnetPropertiesFormat defines properties of a Subnet.
Appears in:
* [SubnetSpec](#SubnetSpec)
Name | Type | Description
-----|------|------------
`addressPrefix` | string | AddressPrefix - The address prefix for the subnet.
`serviceEndpoints` | [[]ServiceEndpointPropertiesFormat](#ServiceEndpointPropertiesFormat) | ServiceEndpoints - An array of service endpoints.
## SubnetSpec
A SubnetSpec defines the desired state of a Subnet.
Appears in:
* [Subnet](#Subnet)
Name | Type | Description
-----|------|------------
`name` | string | Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
`virtualNetworkName` | string | VirtualNetworkName - Name of the Subnet's virtual network.
`resourceGroupName` | string | ResourceGroupName - Name of the Subnet's resource group.
`properties` | [SubnetPropertiesFormat](#SubnetPropertiesFormat) | SubnetPropertiesFormat - Properties of the subnet.
SubnetSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
## SubnetStatus
A SubnetStatus represents the observed state of a Subnet.
Appears in:
* [Subnet](#Subnet)
Name | Type | Description
-----|------|------------
`state` | string | State of this Subnet.
`message` | string | A Message providing detail about the state of this Subnet, if any.
`etag` | string | Etag - A unique string that changes whenever the resource is updated.
`id` | string | ID of this Subnet.
`purpose` | string | Purpose - A string identifying the intention of use for this subnet based on delegations and other user-defined properties.
SubnetStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## VirtualNetworkPropertiesFormat
VirtualNetworkPropertiesFormat defines properties of a VirtualNetwork.
Appears in:
* [VirtualNetworkSpec](#VirtualNetworkSpec)
Name | Type | Description
-----|------|------------
`addressSpace` | Optional [AddressSpace](#AddressSpace) | AddressSpace - The AddressSpace that contains an array of IP address ranges that can be used by subnets.
`enableDdosProtection` | Optional bool | EnableDDOSProtection - Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.
`enableVmProtection` | Optional bool | EnableVMProtection - Indicates if VM protection is enabled for all the subnets in the virtual network.
## VirtualNetworkSpec
A VirtualNetworkSpec defines the desired state of a VirtualNetwork.
Appears in:
* [VirtualNetwork](#VirtualNetwork)
Name | Type | Description
-----|------|------------
`name` | string | Name - Name of the Virtual Network.
`resourceGroupName` | string | ResourceGroupName - Name of the Virtual Network's resource group.
`properties` | [VirtualNetworkPropertiesFormat](#VirtualNetworkPropertiesFormat) | VirtualNetworkPropertiesFormat - Properties of the virtual network.
`location` | string | Location - Resource location.
`tags` | Optional map[string]string | Tags - Resource tags.
VirtualNetworkSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
## VirtualNetworkStatus
A VirtualNetworkStatus represents the observed state of a VirtualNetwork.
Appears in:
* [VirtualNetwork](#VirtualNetwork)
Name | Type | Description
-----|------|------------
`state` | string | State of this VirtualNetwork.
`message` | string | A Message providing detail about the state of this VirtualNetwork, if any.
`id` | string | ID of this VirtualNetwork.
`etag` | string | Etag - A unique read-only string that changes whenever the resource is updated.
`resourceGuid` | string | ResourceGUID - The GUID of this VirtualNetwork.
`type` | string | Type of this VirtualNetwork.
VirtualNetworkStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

469
docs/master/api/crossplaneio/stack-azure/storage-azure-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,469 @@
# storage.azure.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for Azure storage services such as containers and accounts.
This API group contains the following Crossplane resources:
* [Account](#Account)
* [AccountClass](#AccountClass)
* [Container](#Container)
* [ContainerClass](#ContainerClass)
## Account
An Account is a managed resource that represents an Azure Blob Service Account.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.azure.crossplane.io/v1alpha2`
`kind` | string | `Account`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [AccountSpec](#AccountSpec) | An AccountSpec defines the desired state of an Account.
`status` | [AccountStatus](#AccountStatus) | An AccountStatus represents the observed state of an Account.
## AccountClass
An AccountClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.azure.crossplane.io/v1alpha2`
`kind` | string | `AccountClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [AccountClassSpecTemplate](#AccountClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned Account.
## Container
A Container is a managed resource that represents an Azure Blob Storage Container.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.azure.crossplane.io/v1alpha2`
`kind` | string | `Container`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [ContainerSpec](#ContainerSpec) | A ContainerSpec defines the desired state of a Container.
`status` | [ContainerStatus](#ContainerStatus) | A ContainerStatus represents the observed status of a Container.
## ContainerClass
A ContainerClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.azure.crossplane.io/v1alpha2`
`kind` | string | `ContainerClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [ContainerClassSpecTemplate](#ContainerClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned Container.
## AccountClassSpecTemplate
An AccountClassSpecTemplate is a template for the spec of a dynamically provisioned Account.
Appears in:
* [AccountClass](#AccountClass)
AccountClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [AccountParameters](#AccountParameters)
## AccountParameters
AccountParameters define the desired state of an Azure Blob Storage Account.
Appears in:
* [AccountClassSpecTemplate](#AccountClassSpecTemplate)
* [AccountSpec](#AccountSpec)
Name | Type | Description
-----|------|------------
`resourceGroupName` | string | ResourceGroupName specifies the resource group for this Account.
`storageAccountName` | string | StorageAccountName specifies the name for this Account.
`storageAccountSpec` | [StorageAccountSpec](#StorageAccountSpec) | StorageAccountSpec specifies the desired state of this Account.
## AccountSpec
An AccountSpec defines the desired state of an Account.
Appears in:
* [Account](#Account)
AccountSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [AccountParameters](#AccountParameters)
## AccountStatus
An AccountStatus represents the observed state of an Account.
Appears in:
* [Account](#Account)
AccountStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [StorageAccountStatus](#StorageAccountStatus)
## ContainerClassSpecTemplate
A ContainerClassSpecTemplate is a template for the spec of a dynamically provisioned Container.
Appears in:
* [ContainerClass](#ContainerClass)
ContainerClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [ContainerParameters](#ContainerParameters)
## ContainerParameters
ContainerParameters define the desired state of an Azure Blob Storage Container.
Appears in:
* [ContainerClassSpecTemplate](#ContainerClassSpecTemplate)
* [ContainerSpec](#ContainerSpec)
Name | Type | Description
-----|------|------------
`nameFormat` | string | NameFormat specifies the name of the external Container. The first instance of the string '%s' will be replaced with the Kubernetes UID of this Container.
`metadata` | Optional [azblob.Metadata](https://godoc.org/github.com/Azure/azure-storage-blob-go/azblob#Metadata) | Metadata for this Container.
`publicAccessType` | Optional [azblob.PublicAccessType](https://godoc.org/github.com/Azure/azure-storage-blob-go/azblob#PublicAccessType) | PublicAccessType for this container; either "blob" or "container".
`accountReference` | [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core) | AccountReference to the Azure Blob Storage Account this Container will reside within.
## ContainerSpec
A ContainerSpec defines the desired state of a Container.
Appears in:
* [Container](#Container)
Name | Type | Description
-----|------|------------
`writeConnectionSecretToRef` | Optional [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core) | WriteConnectionSecretToReference specifies the name of a Secret, in the same namespace as this managed resource, to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
`claimRef` | Optional [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | ClaimReference specifies the resource claim to which this managed resource will be bound. ClaimReference is set automatically during dynamic provisioning. Crossplane does not currently support setting this field manually, per https://github.com/crossplaneio/crossplane-runtime/issues/19
`classRef` | Optional [core/v1.ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectreference-v1-core) | NonPortableClassReference specifies the non-portable resource class that was used to dynamically provision this managed resource, if any. Crossplane does not currently support setting this field manually, per https://github.com/crossplaneio/crossplane-runtime/issues/20
`reclaimPolicy` | Optional [v1alpha1.ReclaimPolicy](../crossplane-runtime/core-crossplane-io-v1alpha1.md#reclaimpolicy) | ReclaimPolicy specifies what will happen to the external resource this managed resource manages when the managed resource is deleted. "Delete" deletes the external resource, while "Retain" (the default) does not. Note this behaviour is subtly different from other uses of the ReclaimPolicy concept within the Kubernetes ecosystem per https://github.com/crossplaneio/crossplane-runtime/issues/21
ContainerSpec supports all fields of:
* [ContainerParameters](#ContainerParameters)
## ContainerStatus
A ContainerStatus represents the observed status of a Container.
Appears in:
* [Container](#Container)
Name | Type | Description
-----|------|------------
`name` | string | Name of this Container.
ContainerStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## CustomDomain
CustomDomain specifies the custom domain assigned to this storage account.
Appears in:
* [StorageAccountSpecProperties](#StorageAccountSpecProperties)
Name | Type | Description
-----|------|------------
`name` | Optional string | Name - custom domain name assigned to the storage account. Name is the CNAME source.
`useSubDomainName` | Optional bool | UseSubDomainName - Indicates whether indirect CNAME validation is enabled.
## EnabledEncryptionServices
EnabledEncryptionServices a list of services that support encryption.
Appears in:
* [Encryption](#Encryption)
Name | Type | Description
-----|------|------------
`blob` | bool | Blob - The encryption function of the blob storage service.
`file` | bool | File - The encryption function of the file storage service.
`table` | bool | Table - The encryption function of the table storage service.
`queue` | bool | Queue - The encryption function of the queue storage service.
## Encryption
Encryption the encryption settings on the storage account.
Appears in:
* [StorageAccountSpecProperties](#StorageAccountSpecProperties)
Name | Type | Description
-----|------|------------
`services` | [EnabledEncryptionServices](#EnabledEncryptionServices) | Services - List of services which support encryption.
`keySource` | [storage.KeySource](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#KeySource) | KeySource - The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault
`keyvaultproperties` | [KeyVaultProperties](#KeyVaultProperties) | KeyVaultProperties - Properties provided by key vault.
## Endpoints
Endpoints the URIs that are used to perform a retrieval of a public blob, queue, or table object.
Appears in:
* [StorageAccountStatusProperties](#StorageAccountStatusProperties)
Name | Type | Description
-----|------|------------
`blob` | string | Blob - the blob endpoint.
`queue` | string | Queue - the queue endpoint.
`table` | string | Table - the table endpoint.
`file` | string | File - the file endpoint.
## IPRule
IPRule IP rule with specific IP or IP range in CIDR format.
Appears in:
* [NetworkRuleSet](#NetworkRuleSet)
Name | Type | Description
-----|------|------------
`value` | string | IPAddressOrRange - Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
`action` | [storage.Action](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#Action) | Action - The action of IP ACL rule. Possible values include: 'Allow'
## Identity
Identity identity for the resource.
Appears in:
* [StorageAccountSpec](#StorageAccountSpec)
Name | Type | Description
-----|------|------------
`principalId` | string | PrincipalID - The principal ID of resource identity.
`tenantId` | string | TenantID - The tenant ID of resource.
`type` | string | Type - The identity type.
## KeyVaultProperties
KeyVaultProperties properties of key vault.
Appears in:
* [Encryption](#Encryption)
Name | Type | Description
-----|------|------------
`keyname` | string | KeyName - The name of KeyVault key.
`keyversion` | string | KeyVersion - The version of KeyVault key.
`keyvaulturi` | string | KeyVaultURI - The Uri of KeyVault.
## NetworkRuleSet
NetworkRuleSet network rule set
Appears in:
* [StorageAccountSpecProperties](#StorageAccountSpecProperties)
Name | Type | Description
-----|------|------------
`bypass` | [storage.Bypass](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#Bypass) | Bypass - Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics. Possible values include: 'None', 'Logging', 'Metrics', 'AzureServices'
`virtualNetworkRules` | [[]VirtualNetworkRule](#VirtualNetworkRule) | VirtualNetworkRules - Sets the virtual network rules
`ipRules` | [[]IPRule](#IPRule) | IPRules - Sets the IP ACL rules
`defaultAction` | [storage.DefaultAction](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#DefaultAction) | DefaultAction - Specifies the default action of allow or deny when no other rules match. Possible values include: 'Allow', 'Deny'
## Sku
Sku of an Azure Blob Storage Account.
Appears in:
* [StorageAccountSpec](#StorageAccountSpec)
Name | Type | Description
-----|------|------------
`capabilities` | [[]skuCapability](#skuCapability) | Capabilities - The capability information in the specified sku, including file encryption, network acls, change notification, etc.
`kind` | [storage.Kind](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#Kind) | Kind - Indicates the type of storage account. Possible values include: 'Storage', 'BlobStorage'
`locations` | []string | Locations - The set of locations that the Sku is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.).
`name` | [storage.SkuName](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#SkuName) | Name - Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'
`resourceType` | string | ResourceType - The type of the resource, usually it is 'storageAccounts'.
`tier` | [storage.SkuTier](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#SkuTier) | Tier - Gets the sku tier. This is based on the Sku name. Possible values include: 'Standard', 'Premium'
## StorageAccountSpec
A StorageAccountSpec defines the desired state of an Azure Blob Storage account.
Appears in:
* [AccountParameters](#AccountParameters)
Name | Type | Description
-----|------|------------
`identity` | Optional [Identity](#Identity) | Identity - The identity of the resource.
`kind` | [storage.Kind](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#Kind) | Kind - Indicates the type of storage account. Possible values include: 'Storage', 'BlobStorage'
`location` | string | Location - The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.).
`sku` | [Sku](#Sku) | Sku of the storage account.
`properties` | Optional [StorageAccountSpecProperties](#StorageAccountSpecProperties) | StorageAccountSpecProperties - The parameters used to create the storage account.
`tags` | Optional map[string]string | Tags - A list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
## StorageAccountSpecProperties
StorageAccountSpecProperties the parameters used to create the storage account.
Appears in:
* [StorageAccountSpec](#StorageAccountSpec)
Name | Type | Description
-----|------|------------
`accessTier` | [storage.AccessTier](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#AccessTier) | AccessTier - Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool'
`customDomain` | [CustomDomain](#CustomDomain) | CustomDomain - User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. to clear the existing custom domain, use an empty string for the custom domain name property.
`supportsHttpsTrafficOnly` | bool | EnableHTTPSTrafficOnly - Allows https traffic only to storage service if sets to true.
`encryption` | [Encryption](#Encryption) | Encryption - Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted.
`networkAcls` | [NetworkRuleSet](#NetworkRuleSet) | NetworkRuleSet - Network rule set
## StorageAccountStatus
A StorageAccountStatus represents the observed status of an Account.
Appears in:
* [AccountStatus](#AccountStatus)
Name | Type | Description
-----|------|------------
`id` | string | ID of this Account.
`name` | string | Name of this Account.
`type` | string | Type of this Account.
`properties` | [StorageAccountStatusProperties](#StorageAccountStatusProperties) | Properties of this Account.
## StorageAccountStatusProperties
StorageAccountStatusProperties represent the observed state of an Account.
Appears in:
* [StorageAccountStatus](#StorageAccountStatus)
Name | Type | Description
-----|------|------------
`creationTime` | [meta/v1.Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#time-v1-meta) | CreationTime - the creation date and time of the storage account in UTC.
`lastGeoFailoverTime` | [meta/v1.Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#time-v1-meta) | LastGeoFailoverTime - the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.
`primaryEndpoints` | [Endpoints](#Endpoints) | PrimaryEndpoints - the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.
`primaryLocation` | string | PrimaryLocation - the location of the primary data center for the storage account.
`provisioningState` | [storage.ProvisioningState](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#ProvisioningState) | ProvisioningState - the status of the storage account at the time the operation was called. Possible values include: 'Creating', 'ResolvingDNS', 'Succeeded'
`secondaryEndpoints` | [Endpoints](#Endpoints) | SecondaryEndpoints - the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the Sku name is Standard_RAGRS.
`secondaryLocation` | string | SecondaryLocation - the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.
`statusOfPrimary` | [storage.AccountStatus](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#AccountStatus) | StatusOfPrimary - the status indicating whether the primary location of the storage account is available or unavailable. Possible values include: 'Available', 'Unavailable'
`statusOfSecondary` | [storage.AccountStatus](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#AccountStatus) | StatusOfSecondary - the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the Sku name is Standard_GRS or Standard_RAGRS. Possible values include: 'Available', 'Unavailable'
## VirtualNetworkRule
VirtualNetworkRule virtual Network rule.
Appears in:
* [NetworkRuleSet](#NetworkRuleSet)
Name | Type | Description
-----|------|------------
`id` | string | VirtualNetworkResourceID - Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.
`action` | [storage.Action](https://godoc.org/github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2017-06-01/storage#Action) | Action - The action of virtual network rule. Possible values include: 'Allow'
This API documentation was generated by `crossdocs`.

121
docs/master/api/crossplaneio/stack-gcp/cache-gcp-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,121 @@
# cache.gcp.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for GCP cache services such as CloudMemorystore.
This API group contains the following Crossplane resources:
* [CloudMemorystoreInstance](#CloudMemorystoreInstance)
* [CloudMemorystoreInstanceClass](#CloudMemorystoreInstanceClass)
## CloudMemorystoreInstance
A CloudMemorystoreInstance is a managed resource that represents a Google Cloud Memorystore instance.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `cache.gcp.crossplane.io/v1alpha2`
`kind` | string | `CloudMemorystoreInstance`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [CloudMemorystoreInstanceSpec](#CloudMemorystoreInstanceSpec) | A CloudMemorystoreInstanceSpec defines the desired state of a CloudMemorystoreInstance.
`status` | [CloudMemorystoreInstanceStatus](#CloudMemorystoreInstanceStatus) | A CloudMemorystoreInstanceStatus represents the observed state of a CloudMemorystoreInstance.
## CloudMemorystoreInstanceClass
A CloudMemorystoreInstanceClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `cache.gcp.crossplane.io/v1alpha2`
`kind` | string | `CloudMemorystoreInstanceClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [CloudMemorystoreInstanceClassSpecTemplate](#CloudMemorystoreInstanceClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned CloudMemorystoreInstance.
## CloudMemorystoreInstanceClassSpecTemplate
A CloudMemorystoreInstanceClassSpecTemplate is a template for the spec of a dynamically provisioned CloudMemorystoreInstance.
Appears in:
* [CloudMemorystoreInstanceClass](#CloudMemorystoreInstanceClass)
CloudMemorystoreInstanceClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [CloudMemorystoreInstanceParameters](#CloudMemorystoreInstanceParameters)
## CloudMemorystoreInstanceParameters
CloudMemorystoreInstanceParameters define the desired state of an Google Cloud Memorystore instance. Most fields map directly to an Instance: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance
Appears in:
* [CloudMemorystoreInstanceClassSpecTemplate](#CloudMemorystoreInstanceClassSpecTemplate)
* [CloudMemorystoreInstanceSpec](#CloudMemorystoreInstanceSpec)
Name | Type | Description
-----|------|------------
`region` | string | Region in which to create this Cloud Memorystore cluster.
`tier` | string | Tier specifies the replication level of the Redis cluster. BASIC provides a single Redis instance with no high availability. STANDARD_HA provides a cluster of two Redis instances in distinct availability zones. https://cloud.google.com/memorystore/docs/redis/redis-tiers
`locationId` | Optional string | LocationID specifies the zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures.
`alternativeLocationId` | Optional string | AlternativeLocationID is only applicable to STANDARD_HA tier, which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in locationId.
`memorySizeGb` | int | MemorySizeGB specifies the Redis memory size in GiB.
`reservedIpRange` | Optional string | ReservedIPRange specifies the CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
`authorizedNetwork` | Optional string | AuthorizedNetwork specifies the full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
`redisVersion` | Optional string | RedisVersion specifies the version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are REDIS_3_2 for Redis 3.2, and REDIS_4_0 for Redis 4.0 (the default).
`redisConfigs` | Optional map[string]string | RedisConfigs specifies Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: * maxmemory-policy * notify-keyspace-events
## CloudMemorystoreInstanceSpec
A CloudMemorystoreInstanceSpec defines the desired state of a CloudMemorystoreInstance.
Appears in:
* [CloudMemorystoreInstance](#CloudMemorystoreInstance)
CloudMemorystoreInstanceSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [CloudMemorystoreInstanceParameters](#CloudMemorystoreInstanceParameters)
## CloudMemorystoreInstanceStatus
A CloudMemorystoreInstanceStatus represents the observed state of a CloudMemorystoreInstance.
Appears in:
* [CloudMemorystoreInstance](#CloudMemorystoreInstance)
Name | Type | Description
-----|------|------------
`state` | string | State of this instance.
`message` | string | Additional information about the current status of this instance, if available.
`providerID` | string | ProviderID is the external ID to identify this resource in the cloud provider, e.g. 'projects/fooproj/locations/us-foo1/instances/foo'
`currentLocationId` | string | CurrentLocationID is the current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the locationId provided by the user at creation time. For Standard Tier instances, this can be either locationId or alternativeLocationId and can change after a failover event.
`endpoint` | string | Endpoint of the Cloud Memorystore instance used in connection strings.
`port` | int | Port at which the Cloud Memorystore instance endpoint is listening.
CloudMemorystoreInstanceStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

440
docs/master/api/crossplaneio/stack-gcp/compute-gcp-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,440 @@
# compute.gcp.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for GCP compute services such as GKE.
This API group contains the following Crossplane resources:
* [GKECluster](#GKECluster)
* [GKEClusterClass](#GKEClusterClass)
* [GlobalAddress](#GlobalAddress)
* [Network](#Network)
* [Subnetwork](#Subnetwork)
## GKECluster
A GKECluster is a managed resource that represents a Google Kubernetes Engine cluster.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.gcp.crossplane.io/v1alpha2`
`kind` | string | `GKECluster`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [GKEClusterSpec](#GKEClusterSpec) | A GKEClusterSpec defines the desired state of a GKECluster.
`status` | [GKEClusterStatus](#GKEClusterStatus) | A GKEClusterStatus represents the observed state of a GKECluster.
## GKEClusterClass
A GKEClusterClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.gcp.crossplane.io/v1alpha2`
`kind` | string | `GKEClusterClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [GKEClusterClassSpecTemplate](#GKEClusterClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned GKECluster.
## GlobalAddress
A GlobalAddress is a managed resource that represents a Google Compute Engine Global Address.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.gcp.crossplane.io/v1alpha2`
`kind` | string | `GlobalAddress`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [GlobalAddressSpec](#GlobalAddressSpec) | A GlobalAddressSpec defines the desired state of a GlobalAddress.
`status` | [GlobalAddressStatus](#GlobalAddressStatus) | A GlobalAddressStatus reflects the observed state of a GlobalAddress.
## Network
A Network is a managed resource that represents a Google Compute Engine VPC Network.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.gcp.crossplane.io/v1alpha2`
`kind` | string | `Network`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [NetworkSpec](#NetworkSpec) | A NetworkSpec defines the desired state of a Network.
`status` | [NetworkStatus](#NetworkStatus) | A NetworkStatus represents the observed state of a Network.
## Subnetwork
A Subnetwork is a managed resource that represents a Google Compute Engine VPC Subnetwork.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `compute.gcp.crossplane.io/v1alpha2`
`kind` | string | `Subnetwork`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [SubnetworkSpec](#SubnetworkSpec) | A SubnetworkSpec defines the desired state of a Subnetwork.
`status` | [SubnetworkStatus](#SubnetworkStatus) | A SubnetworkStatus represents the observed state of a Subnetwork.
## GCPNetworkPeering
A GCPNetworkPeering represents the observed state of a Google Compute Engine VPC Network Peering.
Name | Type | Description
-----|------|------------
`autoCreateRoutes` | bool | AutoCreateRoutes: This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.
`exchangeSubnetRoutes` | bool | ExchangeSubnetRoutes: Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.
`name` | string | Name: Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
`network` | string | Network: The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.
`state` | string | State: State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. Possible values: "ACTIVE" "INACTIVE"
`stateDetails` | string | StateDetails: Details about the current state of the peering.
## GCPNetworkRoutingConfig
A GCPNetworkRoutingConfig specifies the desired state of a Google Compute Engine VPC Network Routing configuration.
Appears in:
* [GCPNetworkStatus](#GCPNetworkStatus)
* [NetworkParameters](#NetworkParameters)
Name | Type | Description
-----|------|------------
`routingMode` | string | RoutingMode: The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. Possible values: "GLOBAL" "REGIONAL"
## GCPNetworkStatus
A GCPNetworkStatus represents the observed state of a Google Compute Engine VPC Network.
Appears in:
* [NetworkStatus](#NetworkStatus)
Name | Type | Description
-----|------|------------
`IPv4Range` | string | IPv4Range: Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
`autoCreateSubnetworks` | bool | AutoCreateSubnetworks: When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges.
`creationTimestamp` | string | CreationTimestamp: Creation timestamp in RFC3339 text format.
`description` | string | Description: An optional description of this resource. Provide this field when you create the resource.
`gatewayIPv4` | string | GatewayIPv4: The gateway address for default routing out of the network, selected by GCP.
`id` | uint64 | Id: The unique identifier for the resource. This identifier is defined by the server.
`peerings` | [[]*github.com/crossplaneio/stack-gcp/gcp/apis/compute/v1alpha2.GCPNetworkPeering](#*github.com/crossplaneio/stack-gcp/gcp/apis/compute/v1alpha2.GCPNetworkPeering) | Peerings: A list of network peerings for the resource.
`routingConfig` | [GCPNetworkRoutingConfig](#GCPNetworkRoutingConfig) | RoutingConfig: The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.
`selfLink` | string | SelfLink: Server-defined URL for the resource.
`subnetworks` | []string | Subnetworks: Server-defined fully-qualified URLs for all subnetworks in this VPC network.
## GCPSubnetworkSecondaryRange
A GCPSubnetworkSecondaryRange defines the state of a Google Compute Engine VPC Subnetwork secondary range.
Name | Type | Description
-----|------|------------
`ipCidrRange` | string | IPCIDRRange: The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported.
`rangeName` | string | RangeName: The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
## GCPSubnetworkStatus
A GCPSubnetworkStatus represents the observed state of a Google Compute Engine VPC Subnetwork.
Appears in:
* [SubnetworkStatus](#SubnetworkStatus)
Name | Type | Description
-----|------|------------
`creationTimestamp` | string | CreationTimestamp: Creation timestamp in RFC3339 text format.
`description` | string | Description: An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
`enableFlowLogs` | bool | EnableFlowLogs: Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging.
`fingerprint` | string | Fingerprint: Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.
`gatewayAddress` | string | GatewayAddress: The gateway address for default routes to reach destination addresses outside this subnetwork.
`id` | uint64 | Id: The unique identifier for the resource. This identifier is defined by the server.
`ipCidrRange` | string | IPCIDRRange: The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time.
`kind` | string | Kind: Type of the resource. Always compute#subnetwork for Subnetwork resources.
`name` | string | Name: The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
`network` | string | Network: The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time.
`privateIpGoogleAccess` | bool | PrivateIPGoogleAccess: Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIPGoogleAccess.
`region` | string | Region: URL of the region where the Subnetwork resides. This field can be set only at resource creation time.
`secondaryIpRanges` | [[]*github.com/crossplaneio/stack-gcp/gcp/apis/compute/v1alpha2.GCPSubnetworkSecondaryRange](#*github.com/crossplaneio/stack-gcp/gcp/apis/compute/v1alpha2.GCPSubnetworkSecondaryRange) | SecondaryIPRanges: An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.
`selfLink` | string | SelfLink: Server-defined URL for the resource.
## GKEClusterClassSpecTemplate
A GKEClusterClassSpecTemplate is a template for the spec of a dynamically provisioned GKECluster.
Appears in:
* [GKEClusterClass](#GKEClusterClass)
GKEClusterClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [GKEClusterParameters](#GKEClusterParameters)
## GKEClusterParameters
GKEClusterParameters define the desired state of a Google Kubernetes Engine cluster.
Appears in:
* [GKEClusterClassSpecTemplate](#GKEClusterClassSpecTemplate)
* [GKEClusterSpec](#GKEClusterSpec)
Name | Type | Description
-----|------|------------
`clusterVersion` | Optional string | ClusterVersion is the initial Kubernetes version for this cluster. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, for example "latest", "1.X", or "1.X.Y". Leave unset to use the default version.
`labels` | Optional map[string]string | Labels for the cluster to use to annotate any related Google Compute Engine resources.
`machineType` | Optional string | MachineType is the name of a Google Compute Engine machine type (e.g. n1-standard-1). If unspecified the default machine type is n1-standard-1.
`numNodes` | int64 | NumNodes is the number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
`zone` | Optional string | Zone specifies the name of the Google Compute Engine zone in which this cluster resides.
`scopes` | Optional []string | Scopes are the set of Google API scopes to be made available on all of the node VMs under the "default" service account.
`network` | Optional string | Network is the name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.
`subnetwork` | Optional string | Subnetwork is the name of the Google Compute Engine subnetwork to which the cluster is connected.
`enableIPAlias` | Optional bool | EnableIPAlias determines whether Alias IPs will be used for pod IPs in the cluster.
`createSubnetwork` | Optional bool | CreateSubnetwork determines whether a new subnetwork will be created automatically for the cluster. Only applicable when EnableIPAlias is true.
`nodeIPV4CIDR` | Optional string | NodeIPV4CIDR specifies the IP address range of the instance IPs in this cluster. This is applicable only if CreateSubnetwork is true. Omit this field to have a range chosen with the default size. Set it to a netmask (e.g. /24) to have a range chosen with a specific netmask.
`clusterIPV4CIDR` | Optional string | ClusterIPV4CIDR specifies the IP address range of the pod IPs in this cluster. This is applicable only if EnableIPAlias is true. Omit this field to have a range chosen with the default size. Set it to a netmask (e.g. /24) to have a range chosen with a specific netmask.
`clusterSecondaryRangeName` | Optional string | ClusterSecondaryRangeName specifies the name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork.
`serviceIPV4CIDR` | Optional string | ServiceIPV4CIDR specifies the IP address range of service IPs in this cluster. This is applicable only if EnableIPAlias is true. Omit this field to have a range chosen with the default size. Set it to a netmask (e.g. /24) to have a range chosen with a specific netmask.
`servicesSecondaryRangeName` | string | ServicesSecondaryRangeName specifies the name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork.
## GKEClusterSpec
A GKEClusterSpec defines the desired state of a GKECluster.
Appears in:
* [GKECluster](#GKECluster)
GKEClusterSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [GKEClusterParameters](#GKEClusterParameters)
## GKEClusterStatus
A GKEClusterStatus represents the observed state of a GKECluster.
Appears in:
* [GKECluster](#GKECluster)
Name | Type | Description
-----|------|------------
`clusterName` | string | ClusterName is the name of this GKE cluster. The name is automatically generated by Crossplane.
`endpoint` | string | Endpoint of the GKE cluster used in connection strings.
`state` | string | State of this GKE cluster.
GKEClusterStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## GlobalAddressParameters
GlobalAddressParameters define the desired state of a Google Compute Engine Global Address. Most fields map directly to an Address: https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses
Appears in:
* [GlobalAddressSpec](#GlobalAddressSpec)
Name | Type | Description
-----|------|------------
`address` | Optional string | Address: The static IP address represented by this resource.
`addressType` | Optional string | AddressType: The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Possible values: "EXTERNAL" "INTERNAL" "UNSPECIFIED_TYPE"
`description` | Optional string | Description: An optional description of this resource.
`ipVersion` | Optional string | IPVersion: The IP version that will be used by this address. Valid options are IPV4 or IPV6. Possible values: "IPV4" "IPV6" "UNSPECIFIED_VERSION"
`name` | string | Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
`network` | Optional string | Network: The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
`prefixLength` | Optional int64 | PrefixLength: The prefix length if the resource represents an IP range.
`purpose` | Optional string | Purpose: The purpose of this resource, which can be one of the following values: - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. - `DNS_RESOLVER` for a DNS resolver address in a subnetwork - `VPC_PEERING` for addresses that are reserved for VPC peer networks. - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. Possible values: "DNS_RESOLVER" "GCE_ENDPOINT" "NAT_AUTO" "VPC_PEERING"
`subnetwork` | Optional string | Subnetwork: The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
## GlobalAddressSpec
A GlobalAddressSpec defines the desired state of a GlobalAddress.
Appears in:
* [GlobalAddress](#GlobalAddress)
GlobalAddressSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [GlobalAddressParameters](#GlobalAddressParameters)
## GlobalAddressStatus
A GlobalAddressStatus reflects the observed state of a GlobalAddress.
Appears in:
* [GlobalAddress](#GlobalAddress)
Name | Type | Description
-----|------|------------
`creationTimestamp` | string | CreationTimestamp in RFC3339 text format.
`id` | uint64 | ID for the resource. This identifier is defined by the server.
`selfLink` | string | SelfLink: Server-defined URL for the resource.
`status` | string | Status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. Possible values: "IN_USE" "RESERVED" "RESERVING"
`users` | []string | Users that are using this address.
GlobalAddressStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## NetworkParameters
NetworkParameters define the desired state of a Google Compute Engine VPC Network. Most fields map directly to a Network: https://cloud.google.com/compute/docs/reference/rest/v1/networks
Appears in:
* [NetworkSpec](#NetworkSpec)
Name | Type | Description
-----|------|------------
`IPv4Range` | string | IPv4Range: Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
`autoCreateSubnetworks` | bool | AutoCreateSubnetworks: When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. When set to nil, the VPC network is created in "legacy" mode which will be deprecated by GCP soon. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges.
`description` | string | Description: An optional description of this resource. Provide this field when you create the resource.
`name` | string | Name: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
`routingConfig` | [GCPNetworkRoutingConfig](#GCPNetworkRoutingConfig) | RoutingConfig: The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.
## NetworkSpec
A NetworkSpec defines the desired state of a Network.
Appears in:
* [Network](#Network)
NetworkSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [NetworkParameters](#NetworkParameters)
## NetworkStatus
A NetworkStatus represents the observed state of a Network.
Appears in:
* [Network](#Network)
NetworkStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [GCPNetworkStatus](#GCPNetworkStatus)
## SubnetworkParameters
SubnetworkParameters define the desired state of a Google Compute Engine VPC Subnetwork. Most fields map directly to a Subnetwork: https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks
Appears in:
* [SubnetworkSpec](#SubnetworkSpec)
Name | Type | Description
-----|------|------------
`description` | Optional string | Description: An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
`enableFlowLogs` | Optional bool | EnableFlowLogs: Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging.
`ipCidrRange` | string | IPCIDRRange: The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time.
`name` | string | Name: The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
`network` | string | Network: The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time.
`privateIpGoogleAccess` | Optional bool | PrivateIPGoogleAccess: Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIPGoogleAccess.
`region` | Optional string | Region: URL of the region where the Subnetwork resides. This field can be set only at resource creation time.
`secondaryIpRanges` | Optional [[]*github.com/crossplaneio/stack-gcp/gcp/apis/compute/v1alpha2.GCPSubnetworkSecondaryRange](#*github.com/crossplaneio/stack-gcp/gcp/apis/compute/v1alpha2.GCPSubnetworkSecondaryRange) | SecondaryIPRanges: An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.
## SubnetworkSpec
A SubnetworkSpec defines the desired state of a Subnetwork.
Appears in:
* [Subnetwork](#Subnetwork)
SubnetworkSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [SubnetworkParameters](#SubnetworkParameters)
## SubnetworkStatus
A SubnetworkStatus represents the observed state of a Subnetwork.
Appears in:
* [Subnetwork](#Subnetwork)
SubnetworkStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
* [GCPSubnetworkStatus](#GCPSubnetworkStatus)
This API documentation was generated by `crossdocs`.

119
docs/master/api/crossplaneio/stack-gcp/database-gcp-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,119 @@
# database.gcp.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for GCP database services such as CloudSQL.
This API group contains the following Crossplane resources:
* [CloudsqlInstance](#CloudsqlInstance)
* [CloudsqlInstanceClass](#CloudsqlInstanceClass)
## CloudsqlInstance
A CloudsqlInstance is a managed resource that represents a Google CloudSQL instance.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.gcp.crossplane.io/v1alpha2`
`kind` | string | `CloudsqlInstance`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [CloudsqlInstanceSpec](#CloudsqlInstanceSpec) | A CloudsqlInstanceSpec defines the desired state of a CloudsqlInstance.
`status` | [CloudsqlInstanceStatus](#CloudsqlInstanceStatus) | A CloudsqlInstanceStatus represents the observed state of a CloudsqlInstance.
## CloudsqlInstanceClass
A CloudsqlInstanceClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `database.gcp.crossplane.io/v1alpha2`
`kind` | string | `CloudsqlInstanceClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [CloudsqlInstanceClassSpecTemplate](#CloudsqlInstanceClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned CloudsqlInstance.
## CloudsqlInstanceClassSpecTemplate
A CloudsqlInstanceClassSpecTemplate is a template for the spec of a dynamically provisioned CloudsqlInstance.
Appears in:
* [CloudsqlInstanceClass](#CloudsqlInstanceClass)
CloudsqlInstanceClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [CloudsqlInstanceParameters](#CloudsqlInstanceParameters)
## CloudsqlInstanceParameters
CloudsqlInstanceParameters define the desired state of a Google CloudSQL instance.
Appears in:
* [CloudsqlInstanceClassSpecTemplate](#CloudsqlInstanceClassSpecTemplate)
* [CloudsqlInstanceSpec](#CloudsqlInstanceSpec)
Name | Type | Description
-----|------|------------
`authorizedNetworks` | Optional []string | AuthorizedNetworks is the list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
`privateNetwork` | Optional string | PrivateNetwork is the resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
`ipv4Enabled` | Optional bool | Ipv4Enabled specifies whether the instance should be assigned an IP address or not.
`databaseVersion` | string | DatabaseVersion specifies he database engine type and version. MySQL Second Generation instances use MYSQL_5_7 (default) or MYSQL_5_6. MySQL First Generation instances use MYSQL_5_6 (default) or MYSQL_5_5 PostgreSQL instances uses POSTGRES_9_6 (default) or POSTGRES_11.
`labels` | Optional map[string]string | Labels to apply to this CloudSQL instance.
`region` | string | Region specifies the geographical region of this CloudSQL instance.
`storageType` | string | StorageType specifies the type of the data disk, either PD_SSD or PD_HDD.
`storageGB` | int64 | StorageGB specifies the size of the data disk. The minimum is 10GB.
`tier` | string | Tier (or machine type) for this instance, for example db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see https://cloud.google.com/sql/docs/mysql/instance-settings
`nameFormat` | string | NameFormat specifies the name of the extenral CloudSQL instance. The first instance of the string '%s' will be replaced with the Kubernetes UID of this CloudsqlInstance.
## CloudsqlInstanceSpec
A CloudsqlInstanceSpec defines the desired state of a CloudsqlInstance.
Appears in:
* [CloudsqlInstance](#CloudsqlInstance)
CloudsqlInstanceSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [CloudsqlInstanceParameters](#CloudsqlInstanceParameters)
## CloudsqlInstanceStatus
A CloudsqlInstanceStatus represents the observed state of a CloudsqlInstance.
Appears in:
* [CloudsqlInstance](#CloudsqlInstance)
Name | Type | Description
-----|------|------------
`state` | string | State of this CloudsqlInstance.
`publicIp` | string | PublicIP is used to connect to this resource from other authorized networks.
`privateIp` | string | PrivateIP is used to connect to this instance from the same Network.
CloudsqlInstanceStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

39
docs/master/api/crossplaneio/stack-gcp/gcp-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,39 @@
# gcp.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains the core resources of the Google Cloud Platform.
This API group contains the following Crossplane resources:
* [Provider](#Provider)
## Provider
A Provider configures a GCP 'provider', i.e. a connection to a particular GCP project using a particular GCP service account
Name | Type | Description
-----|------|------------
`apiVersion` | string | `gcp.crossplane.io/v1alpha2`
`kind` | string | `Provider`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [ProviderSpec](#ProviderSpec) | A ProviderSpec defines the desired state of a Provider.
## ProviderSpec
A ProviderSpec defines the desired state of a Provider.
Appears in:
* [Provider](#Provider)
Name | Type | Description
-----|------|------------
`credentialsSecretRef` | [core/v1.SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#secretkeyselector-v1-core) | A Secret containing JSON encoded credentials for a Google Service Account that will be used to authenticate to this GCP Provider.
`projectID` | string | ProjectID is the project name (not numerical ID) of this GCP Provider.
This API documentation was generated by `crossdocs`.

78
docs/master/api/crossplaneio/stack-gcp/servicenetworking-gcp-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,78 @@
# servicenetworking.gcp.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for GCP service networking services such as connections.
This API group contains the following Crossplane resources:
* [Connection](#Connection)
## Connection
A Connection is a managed resource that represents a Google Cloud Service Networking Connection.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `servicenetworking.gcp.crossplane.io/v1alpha2`
`kind` | string | `Connection`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [ConnectionSpec](#ConnectionSpec) | A ConnectionSpec defines the desired state of a Connection.
`status` | [ConnectionStatus](#ConnectionStatus) | A ConnectionStatus represents the observed state of a Connection.
## ConnectionParameters
ConnectionParameters define the desired state of a Google Cloud Service Networking Connection. Most fields map direct to a Connection: https://cloud.google.com/service-infrastructure/docs/service-networking/reference/rest/v1/services.connections#Connection
Appears in:
* [ConnectionSpec](#ConnectionSpec)
Name | Type | Description
-----|------|------------
`parent` | string | Parent: The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
`network` | string | Network: The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network}` is the name of the service consumer's VPC network.
`reservedPeeringRanges` | Optional []string | ReservedPeeringRanges: The name of one or more allocated IP address ranges for this service producer of type `PEERING`.
## ConnectionSpec
A ConnectionSpec defines the desired state of a Connection.
Appears in:
* [Connection](#Connection)
ConnectionSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [ConnectionParameters](#ConnectionParameters)
## ConnectionStatus
A ConnectionStatus represents the observed state of a Connection.
Appears in:
* [Connection](#Connection)
Name | Type | Description
-----|------|------------
`peering` | string | Peering: The name of the VPC Network Peering connection that was created by the service producer.
`service` | string | Service: The name of the peering service that's associated with this connection, in the following format: `services/{service name}`.
ConnectionStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
This API documentation was generated by `crossdocs`.

395
docs/master/api/crossplaneio/stack-gcp/storage-gcp-crossplane-io-v1alpha2.md Normal file
View File

@ -0,0 +1,395 @@
# storage.gcp.crossplane.io/v1alpha2 API Reference
Package v1alpha2 contains managed resources for GCP storage services such as GCS buckets.
This API group contains the following Crossplane resources:
* [Bucket](#Bucket)
* [BucketClass](#BucketClass)
## Bucket
A Bucket is a managed resource that represents a Google Cloud Storage bucket.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.gcp.crossplane.io/v1alpha2`
`kind` | string | `Bucket`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`spec` | [BucketSpec](#BucketSpec) | A BucketSpec defines the desired state of a Bucket.
`status` | [BucketStatus](#BucketStatus) | A BucketStatus represents the observed state of a Bucket.
## BucketClass
A BucketClass is a non-portable resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
Name | Type | Description
-----|------|------------
`apiVersion` | string | `storage.gcp.crossplane.io/v1alpha2`
`kind` | string | `BucketClass`
`metadata` | [meta/v1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#objectmeta-v1-meta) | Kubernetes object metadata.
`specTemplate` | [BucketClassSpecTemplate](#BucketClassSpecTemplate) | SpecTemplate is a template for the spec of a dynamically provisioned Bucket.
## ACLRule
ACLRule represents a grant for a role to an entity (user, group or team) for a Google Cloud Storage object or bucket.
Appears in:
* [BucketSpecAttrs](#BucketSpecAttrs)
Name | Type | Description
-----|------|------------
`entity` | string |
`entityId` | string |
`role` | string |
`domain` | string |
`email` | string |
`projectTeam` | [ProjectTeam](#ProjectTeam) |
## BucketClassSpecTemplate
A BucketClassSpecTemplate is a template for the spec of a dynamically provisioned Bucket.
Appears in:
* [BucketClass](#BucketClass)
BucketClassSpecTemplate supports all fields of:
* [v1alpha1.NonPortableClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#nonportableclassspectemplate)
* [BucketParameters](#BucketParameters)
## BucketEncryption
BucketEncryption is a bucket's encryption configuration.
Appears in:
* [BucketUpdatableAttrs](#BucketUpdatableAttrs)
Name | Type | Description
-----|------|------------
`defaultKmsKeyName` | string | A Cloud KMS key name, in the form projects/P/locations/L/keyRings/R/cryptoKeys/K, that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. The key's location must be the same as the bucket's.
## BucketLogging
BucketLogging holds the bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
Appears in:
* [BucketUpdatableAttrs](#BucketUpdatableAttrs)
Name | Type | Description
-----|------|------------
`logBucket` | string | The destination bucket where the current bucket's logs should be placed.
`logObjectPrefix` | string | A prefix for log object names.
## BucketOutputAttrs
BucketOutputAttrs represent the subset of metadata for a Google Cloud Storage bucket limited to output (read-only) fields.
Appears in:
* [BucketStatus](#BucketStatus)
Name | Type | Description
-----|------|------------
`bucketPolicyOnly` | [BucketPolicyOnly](#BucketPolicyOnly) | BucketPolicyOnly configures access checks to use only bucket-level IAM policies.
`created` | [meta/v1.Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#time-v1-meta) | Created is the creation time of the bucket.
`name` | string | Name is the name of the bucket.
`retentionPolicy` | [RetentionPolicyStatus](#RetentionPolicyStatus) | Retention policy enforces a minimum retention time for all objects contained in the bucket. A RetentionPolicy of nil implies the bucket has no minimum data retention. This feature is in private alpha release. It is not currently available to most customers. It might be changed in backwards-incompatible ways and is not subject to any SLA or deprecation policy.
## BucketParameters
BucketParameters define the desired state of a Google Cloud Storage Bucket. Most fields map directly to a bucket resource: https://cloud.google.com/storage/docs/json_api/v1/buckets#resource
Appears in:
* [BucketClassSpecTemplate](#BucketClassSpecTemplate)
* [BucketSpec](#BucketSpec)
Name | Type | Description
-----|------|------------
`nameFormat` | string | NameFormat specifies the name of the external Bucket. The first instance of the string '%s' will be replaced with the Kubernetes UID of this Bucket.
`serviceAccountSecretRef` | [core/v1.LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#localobjectreference-v1-core) | ServiceAccountSecretRef contains GCP ServiceAccount secret that will be used for bucket connection secret credentials
BucketParameters supports all fields of:
* [BucketSpecAttrs](#BucketSpecAttrs)
## BucketPolicyOnly
BucketPolicyOnly configures access checks to use only bucket-level IAM policies.
Appears in:
* [BucketOutputAttrs](#BucketOutputAttrs)
* [BucketUpdatableAttrs](#BucketUpdatableAttrs)
Name | Type | Description
-----|------|------------
`enabled` | bool | Enabled specifies whether access checks use only bucket-level IAM policies. Enabled may be disabled until the locked time.
`lockedTime` | [meta/v1.Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#time-v1-meta) | LockedTime specifies the deadline for changing Enabled from true to false.
## BucketSpec
A BucketSpec defines the desired state of a Bucket.
Appears in:
* [Bucket](#Bucket)
BucketSpec supports all fields of:
* [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec)
* [BucketParameters](#BucketParameters)
## BucketSpecAttrs
BucketSpecAttrs represents the full set of metadata for a Google Cloud Storage bucket limited to all input attributes
Appears in:
* [BucketParameters](#BucketParameters)
Name | Type | Description
-----|------|------------
`acl` | [[]ACLRule](#ACLRule) | ACL is the list of access control rules on the bucket.
`defaultObjectAcl` | [[]ACLRule](#ACLRule) | DefaultObjectACL is the list of access controls to apply to new objects when no object ACL is provided.
`location` | string | Location is the location of the bucket. It defaults to "US".
`storageClass` | string | StorageClass is the default storage class of the bucket. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are "MULTI_REGIONAL", "REGIONAL", "NEARLINE", "COLDLINE", "STANDARD" and "DURABLE_REDUCED_AVAILABILITY". Defaults to "STANDARD", which is equivalent to "MULTI_REGIONAL" or "REGIONAL" depending on the bucket's location settings.
BucketSpecAttrs supports all fields of:
* [BucketUpdatableAttrs](#BucketUpdatableAttrs)
## BucketStatus
A BucketStatus represents the observed state of a Bucket.
Appears in:
* [Bucket](#Bucket)
Name | Type | Description
-----|------|------------
`attributes` | [BucketOutputAttrs](#BucketOutputAttrs) | BucketOutputAttrs represent the subset of metadata for a Google Cloud Storage bucket limited to output (read-only) fields.
BucketStatus supports all fields of:
* [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus)
## BucketUpdatableAttrs
BucketUpdatableAttrs represents the subset of parameters of a Google Cloud Storage bucket that may be updated.
Appears in:
* [BucketSpecAttrs](#BucketSpecAttrs)
Name | Type | Description
-----|------|------------
`bucketPolicyOnly` | [BucketPolicyOnly](#BucketPolicyOnly) | BucketPolicyOnly configures access checks to use only bucket-level IAM policies.
`cors` | [[]CORS](#CORS) | The bucket's Cross-Origin Resource Sharing (CORS) configuration.
`defaultEventBasedHold` | bool | DefaultEventBasedHold is the default value for event-based hold on newly created objects in this bucket. It defaults to false.
`encryption` | [BucketEncryption](#BucketEncryption) | The encryption configuration used by default for newly inserted objects.
`labels` | map[string]string | Labels are the bucket's labels.
`lifecycle` | [Lifecycle](#Lifecycle) | Lifecycle is the lifecycle configuration for objects in the bucket.
`logging` | [BucketLogging](#BucketLogging) | The logging configuration.
`predefinedAcl` | string | If not empty, applies a predefined set of access controls. It should be set only when creating a bucket. It is always empty for BucketAttrs returned from the service. See https://cloud.google.com/storage/docs/json_api/v1/buckets/insert for valid values.
`predefinedCefaultObjectAcl` | string | If not empty, applies a predefined set of default object access controls. It should be set only when creating a bucket. It is always empty for BucketAttrs returned from the service. See https://cloud.google.com/storage/docs/json_api/v1/buckets/insert for valid values.
`requesterPays` | bool | RequesterPays reports whether the bucket is a Requester Pays bucket. Clients performing operations on Requester Pays buckets must provide a user project (see BucketHandle.UserProject), which will be billed for the operations.
`retentionPolicy` | [RetentionPolicy](#RetentionPolicy) | Retention policy enforces a minimum retention time for all objects contained in the bucket. A RetentionPolicy of nil implies the bucket has no minimum data retention. This feature is in private alpha release. It is not currently available to most customers. It might be changed in backwards-incompatible ways and is not subject to any SLA or deprecation policy.
`versioningEnabled` | bool | VersioningEnabled reports whether this bucket has versioning enabled.
`website` | [BucketWebsite](#BucketWebsite) | The website configuration.
## BucketWebsite
BucketWebsite holds the bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See https://cloud.google.com/storage/docs/static-website for more information.
Appears in:
* [BucketUpdatableAttrs](#BucketUpdatableAttrs)
Name | Type | Description
-----|------|------------
`mainPageSuffix` | string | If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
`notFundPage` | string | If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
## CORS
CORS is the bucket's Cross-Origin Resource Sharing (CORS) configuration.
Appears in:
* [BucketUpdatableAttrs](#BucketUpdatableAttrs)
Name | Type | Description
-----|------|------------
`maxAge` | [meta/v1.Duration](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration) | MaxAge is the value to return in the Access-Control-Max-Age header used in preflight responses.
`methods` | []string | Methods is the list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
`origins` | []string | Origins is the list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
`responseHeaders` | []string | ResponseHeaders is the list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
## Lifecycle
Lifecycle is the lifecycle configuration for objects in the bucket.
Appears in:
* [BucketUpdatableAttrs](#BucketUpdatableAttrs)
Name | Type | Description
-----|------|------------
`rules` | [[]LifecycleRule](#LifecycleRule) |
## LifecycleAction
LifecycleAction is a lifecycle configuration action.
Appears in:
* [LifecycleRule](#LifecycleRule)
Name | Type | Description
-----|------|------------
`storageClass` | string | StorageClass is the storage class to set on matching objects if the Action is "SetStorageClass".
`type` | string | Type is the type of action to take on matching objects. Acceptable values are "Delete" to delete matching objects and "SetStorageClass" to set the storage class defined in StorageClass on matching objects.
## LifecycleCondition
LifecycleCondition is a set of conditions used to match objects and take an action automatically. All configured conditions must be met for the associated action to be taken.
Appears in:
* [LifecycleRule](#LifecycleRule)
Name | Type | Description
-----|------|------------
`ageInDays` | int64 | AgeInDays is the age of the object in days.
`createdBefore` | [meta/v1.Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#time-v1-meta) | CreatedBefore is the time the object was created. This condition is satisfied when an object is created before midnight of the specified date in UTC.
`liveness` | [storage.Liveness](https://godoc.org/cloud.google.com/go/storage#Liveness) | Liveness specifies the object's liveness. Relevant only for versioned objects
`matchesStorageClasses` | []string | MatchesStorageClasses is the condition matching the object's storage class. Values include "MULTI_REGIONAL", "REGIONAL", "NEARLINE", "COLDLINE", "STANDARD", and "DURABLE_REDUCED_AVAILABILITY".
`numNewerVersions` | int64 | NumNewerVersions is the condition matching objects with a number of newer versions. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
## LifecycleRule
LifecycleRule is a lifecycle configuration rule. When all the configured conditions are met by an object in the bucket, the configured action will automatically be taken on that object.
Appears in:
* [Lifecycle](#Lifecycle)
Name | Type | Description
-----|------|------------
`action` | [LifecycleAction](#LifecycleAction) | Action is the action to take when all of the associated conditions are met.
`condition` | [LifecycleCondition](#LifecycleCondition) | Condition is the set of conditions that must be met for the associated action to be taken.
## ProjectTeam
ProjectTeam is the project team associated with the entity, if any.
Appears in:
* [ACLRule](#ACLRule)
Name | Type | Description
-----|------|------------
`projectNumber` | string |
`team` | string |
## RetentionPolicy
RetentionPolicy enforces a minimum retention time for all objects contained in the bucket. Any attempt to overwrite or delete objects younger than the retention period will result in an error. An unlocked retention policy can be modified or removed from the bucket via the Update method. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. This feature is in private alpha release. It is not currently available to most customers. It might be changed in backwards-incompatible ways and is not subject to any SLA or deprecation policy.
Appears in:
* [BucketUpdatableAttrs](#BucketUpdatableAttrs)
Name | Type | Description
-----|------|------------
`retentionPeriodSeconds` | int | RetentionPeriod specifies the duration value in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.
## RetentionPolicyStatus
RetentionPolicyStatus output component of storage.RetentionPolicy
Appears in:
* [BucketOutputAttrs](#BucketOutputAttrs)
Name | Type | Description
-----|------|------------
`effectiveTime` | [meta/v1.Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#time-v1-meta) | EffectiveTime is the time from which the policy was enforced and effective.
`isLocked` | bool | IsLocked describes whether the bucket is locked. Once locked, an object retention policy cannot be modified.
This API documentation was generated by `crossdocs`.