diff --git a/docs/master/api.md b/docs/master/api.md index e276473b..8b1e237d 100644 --- a/docs/master/api.md +++ b/docs/master/api.md @@ -84,14 +84,14 @@ following API groups: API Group | Status | Details -------- | ------ | ------- [`azure.crossplane.io/v1alpha3`] | Alpha | Core Azure resources. -[`cache.azure.crossplane.io/v1alpha3`] | Alpha | Azure Redis managed resources and classes. +[`cache.azure.crossplane.io/v1beta1`] | Beta | Azure Redis managed resources and classes. [`compute.azure.crossplane.io/v1alpha3`] | Alpha | AKS managed resources and classes. [`database.azure.crossplane.io/v1alpha3`] | Alpha | Azure Database managed resources and classes. [`network.azure.crossplane.io/v1alpha3`] | Alpha | Virtual network managed resources and classes. [`storage.azure.crossplane.io/v1alpha3`] | Alpha | Azure Blob Storage managed resources and classes. [`azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/azure-crossplane-io-v1alpha3.md -[`cache.azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1alpha3.md +[`cache.azure.crossplane.io/v1beta1`]: api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1beta1.md [`compute.azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/compute-azure-crossplane-io-v1alpha3.md [`database.azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/database-azure-crossplane-io-v1alpha3.md [`network.azure.crossplane.io/v1alpha3`]: api/crossplaneio/stack-azure/network-azure-crossplane-io-v1alpha3.md diff --git a/docs/master/api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1alpha3.md b/docs/master/api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1beta1.md similarity index 50% rename from docs/master/api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1alpha3.md rename to docs/master/api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1beta1.md index de965f35..41c504c7 100644 --- a/docs/master/api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1alpha3.md +++ b/docs/master/api/crossplaneio/stack-azure/cache-azure-crossplane-io-v1beta1.md @@ -1,6 +1,6 @@ -# cache.azure.crossplane.io/v1alpha3 API Reference +# cache.azure.crossplane.io/v1beta1 API Reference -Package v1alpha3 contains managed resources for Azure cache services such as Redis. +Package v1beta1 contains managed resources for Azure cache services such as Redis. This API group contains the following Crossplane resources: @@ -14,7 +14,7 @@ A Redis is a managed resource that represents an Azure Redis cluster. Name | Type | Description -----|------|------------ -`apiVersion` | string | `cache.azure.crossplane.io/v1alpha3` +`apiVersion` | string | `cache.azure.crossplane.io/v1beta1` `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. @@ -29,7 +29,7 @@ A RedisClass is a non-portable resource class. It defines the desired spec of re Name | Type | Description -----|------|------------ -`apiVersion` | string | `cache.azure.crossplane.io/v1alpha3` +`apiVersion` | string | `cache.azure.crossplane.io/v1beta1` `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. @@ -45,17 +45,41 @@ Appears in: * [RedisClass](#RedisClass) +Name | Type | Description +-----|------|------------ +`forProvider` | [RedisParameters](#RedisParameters) | RedisParameters define the desired state of an Azure Redis cluster. https://docs.microsoft.com/en-us/rest/api/redis/redis/create#redisresource RedisClassSpecTemplate supports all fields of: * [v1alpha1.ClassSpecTemplate](../crossplane-runtime/core-crossplane-io-v1alpha1.md#classspectemplate) -* [RedisParameters](#RedisParameters) + + +## RedisObservation + +RedisObservation represents the observed state of the Redis object in Azure. + +Appears in: + +* [RedisStatus](#RedisStatus) + + +Name | Type | Description +-----|------|------------ +`redisVersion` | string | RedisVersion - Redis version. +`provisioningState` | string | ProvisioningState - Redis instance provisioning status. Possible values include: 'Creating', 'Deleting', 'Disabled', 'Failed', 'Linking', 'Provisioning', 'RecoveringScaleFailure', 'Scaling', 'Succeeded', 'Unlinking', 'Unprovisioning', 'Updating' +`hostName` | string | HostName - Redis host name. +`port` | int | Port - Redis non-SSL port. +`sslPort` | int | SSLPort - Redis SSL port. +`linkedServers` | []string | LinkedServers - List of the linked servers associated with the cache +`id` | string | ID - Resource ID. +`name` | string | Name - Resource name. + ## 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 +RedisParameters define the desired state of an Azure Redis cluster. https://docs.microsoft.com/en-us/rest/api/redis/redis/create#redisresource Appears in: @@ -66,13 +90,18 @@ Appears in: Name | Type | Description -----|------|------------ `resourceGroupName` | string | ResourceGroupName in which to create this resource. +`resourceGroupNameRef` | [ResourceGroupNameReferencerForRedis](#ResourceGroupNameReferencerForRedis) | ResourceGroupNameRef to fetch resource group name. +`sku` | [SKU](#SKU) | Sku - The SKU of the Redis cache to deploy. `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. +`staticIp` | Optional string | StaticIP address. Required when deploying a Redis cache inside an existing Azure Virtual Network. +`redisConfiguration` | Optional map[string]string | RedisConfiguration - All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples, slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries, list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value, set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc. +`enableNonSslPort` | Optional bool | EnableNonSSLPort specifies whether the non-ssl Redis server port (6379) is enabled. +`tenantSettings` | Optional map[string]string | TenantSettings - A dictionary of tenant settings +`shardCount` | Optional int | ShardCount specifies the number of shards to be created on a Premium Cluster Cache. +`minimumTlsVersion` | Optional string | MinimumTLSVersion - Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2'). Possible values include: 'OneFullStopZero', 'OneFullStopOne', 'OneFullStopTwo' +`zones` | Optional []string | Zones - A list of availability zones denoting where the resource needs to come from. +`tags` | Optional map[string]string | Tags - Resource tags. @@ -85,12 +114,14 @@ Appears in: * [Redis](#Redis) +Name | Type | Description +-----|------|------------ +`forProvider` | [RedisParameters](#RedisParameters) | RedisParameters define the desired state of an Azure Redis cluster. https://docs.microsoft.com/en-us/rest/api/redis/redis/create#redisresource RedisSpec supports all fields of: * [v1alpha1.ResourceSpec](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcespec) -* [RedisParameters](#RedisParameters) ## RedisStatus @@ -104,13 +135,7 @@ Appears in: 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. +`atProvider` | [RedisObservation](#RedisObservation) | RedisObservation represents the observed state of the Redis object in Azure. RedisStatus supports all fields of: @@ -118,9 +143,25 @@ RedisStatus supports all fields of: * [v1alpha1.ResourceStatus](../crossplane-runtime/core-crossplane-io-v1alpha1.md#resourcestatus) -## SKUSpec +## ResourceGroupNameReferencerForRedis -An SKUSpec represents the performance and cost oriented properties of a Redis. +ResourceGroupNameReferencerForRedis is an attribute referencer that resolves the name of a the ResourceGroup. + +Appears in: + +* [RedisParameters](#RedisParameters) + + + + +ResourceGroupNameReferencerForRedis supports all fields of: + +* github.com/crossplaneio/stack-azure/apis/v1alpha3.ResourceGroupNameReferencer + + +## SKU + +An SKU represents the performance and cost oriented properties of a Redis. Appears in: