From c0748104963a168eb7d2d5e34fc08ea3e9559900 Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Wed, 8 Apr 2020 16:09:05 -0700 Subject: [PATCH 01/11] added redis docs --- docs/rediscache/rediscache.md | 43 +++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index e69de29bb2d..7d1ac32cc0b 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -0,0 +1,43 @@ +# Redis Cache Operator + +This operator will deploy an Azure Cache for Redis into a resource group and location. + +Learn more about Azure Cache for Redis [here](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/cache-overview). + +A Redis Cache is comprised of the following fields: +* Location +* ResourceGroupName +* Properties + * SKU + * RedisCacheSku + * RedisCacheSkuFamily + * Capacity + * EnableNonSslPort + * SubnetID + * StaticIP + * Configuration +* SecretName +* KeyVaultToStoreSecrets + +### Required Fields + +A Redis Cache needs the following fields to deploy, along with a location and resource group. + +`Properties.SKU.RedisCacheSku` Select a SKU, where the options are: _Basic_, _Standard_, and _Premium_. +`Properties.SKU.RedisCacheSkuFamily` Select a SKU Family, where the options are: _C_, _P_. If you selected a _Premium_ SKU, then the corresponding SKU Family is _P_. +`Properties.SKU.Capacity` Set the desired capacity +`EnableNonSslPort` defaults to True + +### Optional Fields + +`SecretName` specify the name of the secret. If none is given, it will fall back to a default name. +`KeyVaultToStoreSecrets` specify a Key Vault to store primary and secondary credentials in. If none is given, it will default to storing credentials as a Kube Secret. +`Properties.SubnetID` specify a subnet ID to place the Redis Cache in +`Properties.StaticIP` specify a statis IP for the Redis Cache +`Properties.Configuration` provide a configuration to the Redis Cache + +## Deploy + +Follow the steps [here](/docs/development.md) or [here](/docs/deploy.md) to either run the operator locally or in a real Kubernetes cluster. + +You can find a sample Redis Cache YAML [here](/config/samples/azure_v1alpha1_rediscache.yaml). \ No newline at end of file From c7f00a3c47c56dc6d7dd6424a756ed32023b746a Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Wed, 8 Apr 2020 16:11:55 -0700 Subject: [PATCH 02/11] formatting --- docs/rediscache/rediscache.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index 7d1ac32cc0b..6960315afc5 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -5,19 +5,19 @@ This operator will deploy an Azure Cache for Redis into a resource group and loc Learn more about Azure Cache for Redis [here](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/cache-overview). A Redis Cache is comprised of the following fields: -* Location -* ResourceGroupName -* Properties - * SKU - * RedisCacheSku - * RedisCacheSkuFamily - * Capacity - * EnableNonSslPort - * SubnetID - * StaticIP - * Configuration -* SecretName -* KeyVaultToStoreSecrets +- Location +- ResourceGroupName +- Properties + - SKU + - RedisCacheSku + - RedisCacheSkuFamily + - Capacity + - EnableNonSslPort + - SubnetID + - StaticIP + - Configuration +- SecretName +- KeyVaultToStoreSecrets ### Required Fields From e1541cfd4865a6dd6a161b16811985c60ead3392 Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Wed, 8 Apr 2020 16:13:10 -0700 Subject: [PATCH 03/11] formatting --- docs/rediscache/rediscache.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index 6960315afc5..91ccca4128c 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -24,16 +24,23 @@ A Redis Cache is comprised of the following fields: A Redis Cache needs the following fields to deploy, along with a location and resource group. `Properties.SKU.RedisCacheSku` Select a SKU, where the options are: _Basic_, _Standard_, and _Premium_. + `Properties.SKU.RedisCacheSkuFamily` Select a SKU Family, where the options are: _C_, _P_. If you selected a _Premium_ SKU, then the corresponding SKU Family is _P_. + `Properties.SKU.Capacity` Set the desired capacity + `EnableNonSslPort` defaults to True ### Optional Fields `SecretName` specify the name of the secret. If none is given, it will fall back to a default name. + `KeyVaultToStoreSecrets` specify a Key Vault to store primary and secondary credentials in. If none is given, it will default to storing credentials as a Kube Secret. + `Properties.SubnetID` specify a subnet ID to place the Redis Cache in + `Properties.StaticIP` specify a statis IP for the Redis Cache + `Properties.Configuration` provide a configuration to the Redis Cache ## Deploy From 88adca393200c2255fc32ce4ac50e55ed76a15c7 Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Wed, 8 Apr 2020 16:14:28 -0700 Subject: [PATCH 04/11] formatting --- docs/rediscache/rediscache.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index 91ccca4128c..5d21da51a51 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -23,25 +23,25 @@ A Redis Cache is comprised of the following fields: A Redis Cache needs the following fields to deploy, along with a location and resource group. -`Properties.SKU.RedisCacheSku` Select a SKU, where the options are: _Basic_, _Standard_, and _Premium_. +* `Properties.SKU.RedisCacheSku` Select a SKU, where the options are: _Basic_, _Standard_, and _Premium_. -`Properties.SKU.RedisCacheSkuFamily` Select a SKU Family, where the options are: _C_, _P_. If you selected a _Premium_ SKU, then the corresponding SKU Family is _P_. +* `Properties.SKU.RedisCacheSkuFamily` Select a SKU Family, where the options are: _C_, _P_. If you selected a _Premium_ SKU, then the corresponding SKU Family is _P_. -`Properties.SKU.Capacity` Set the desired capacity +* `Properties.SKU.Capacity` Set the desired capacity -`EnableNonSslPort` defaults to True +* `EnableNonSslPort` defaults to True ### Optional Fields -`SecretName` specify the name of the secret. If none is given, it will fall back to a default name. +* `SecretName` specify the name of the secret. If none is given, it will fall back to a default name. -`KeyVaultToStoreSecrets` specify a Key Vault to store primary and secondary credentials in. If none is given, it will default to storing credentials as a Kube Secret. +* `KeyVaultToStoreSecrets` specify a Key Vault to store primary and secondary credentials in. If none is given, it will default to storing credentials as a Kube Secret. -`Properties.SubnetID` specify a subnet ID to place the Redis Cache in +* `Properties.SubnetID` specify a subnet ID to place the Redis Cache in -`Properties.StaticIP` specify a statis IP for the Redis Cache +* `Properties.StaticIP` specify a statis IP for the Redis Cache -`Properties.Configuration` provide a configuration to the Redis Cache +* `Properties.Configuration` provide a configuration to the Redis Cache ## Deploy From 64ce8155ba5135e177aaa3f84a5aadc1ee01d68b Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Wed, 8 Apr 2020 16:15:45 -0700 Subject: [PATCH 05/11] formatting --- docs/rediscache/rediscache.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index 5d21da51a51..9acc0e76562 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -24,23 +24,16 @@ A Redis Cache is comprised of the following fields: A Redis Cache needs the following fields to deploy, along with a location and resource group. * `Properties.SKU.RedisCacheSku` Select a SKU, where the options are: _Basic_, _Standard_, and _Premium_. - * `Properties.SKU.RedisCacheSkuFamily` Select a SKU Family, where the options are: _C_, _P_. If you selected a _Premium_ SKU, then the corresponding SKU Family is _P_. - * `Properties.SKU.Capacity` Set the desired capacity - * `EnableNonSslPort` defaults to True ### Optional Fields * `SecretName` specify the name of the secret. If none is given, it will fall back to a default name. - * `KeyVaultToStoreSecrets` specify a Key Vault to store primary and secondary credentials in. If none is given, it will default to storing credentials as a Kube Secret. - * `Properties.SubnetID` specify a subnet ID to place the Redis Cache in - * `Properties.StaticIP` specify a statis IP for the Redis Cache - * `Properties.Configuration` provide a configuration to the Redis Cache ## Deploy From b31f854ebee7f8004a417e23ae27c54ff7d21dc4 Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Wed, 8 Apr 2020 16:17:08 -0700 Subject: [PATCH 06/11] updated naming --- docs/rediscache/rediscache.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index 9acc0e76562..cc49517f780 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -9,8 +9,8 @@ A Redis Cache is comprised of the following fields: - ResourceGroupName - Properties - SKU - - RedisCacheSku - - RedisCacheSkuFamily + - Name + - Family - Capacity - EnableNonSslPort - SubnetID @@ -23,8 +23,8 @@ A Redis Cache is comprised of the following fields: A Redis Cache needs the following fields to deploy, along with a location and resource group. -* `Properties.SKU.RedisCacheSku` Select a SKU, where the options are: _Basic_, _Standard_, and _Premium_. -* `Properties.SKU.RedisCacheSkuFamily` Select a SKU Family, where the options are: _C_, _P_. If you selected a _Premium_ SKU, then the corresponding SKU Family is _P_. +* `Properties.SKU.Name` Select a SKU, where the options are: _Basic_, _Standard_, and _Premium_. +* `Properties.SKU.Family` Select a SKU Family, where the options are: _C_, _P_. If you selected a _Premium_ SKU, then the corresponding SKU Family is _P_. * `Properties.SKU.Capacity` Set the desired capacity * `EnableNonSslPort` defaults to True From 718f38aa9a1650b8bd27ff3111869e18183923ab Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Thu, 9 Apr 2020 07:45:16 -0700 Subject: [PATCH 07/11] Update docs/rediscache/rediscache.md Co-Authored-By: Janani Vasudevan <49576785+jananivMS@users.noreply.github.com> --- docs/rediscache/rediscache.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index cc49517f780..90f7b5282e2 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -1,6 +1,6 @@ # Redis Cache Operator -This operator will deploy an Azure Cache for Redis into a resource group and location. +This operator deploys an Azure Cache for Redis into a specified resource group at the specified location. Learn more about Azure Cache for Redis [here](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/cache-overview). @@ -40,4 +40,4 @@ A Redis Cache needs the following fields to deploy, along with a location and re Follow the steps [here](/docs/development.md) or [here](/docs/deploy.md) to either run the operator locally or in a real Kubernetes cluster. -You can find a sample Redis Cache YAML [here](/config/samples/azure_v1alpha1_rediscache.yaml). \ No newline at end of file +You can find a sample Redis Cache YAML [here](/config/samples/azure_v1alpha1_rediscache.yaml). From 2aac50494cdc105611dffd4584eaf7f802069e6d Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Thu, 9 Apr 2020 07:45:30 -0700 Subject: [PATCH 08/11] Update docs/rediscache/rediscache.md Co-Authored-By: Janani Vasudevan <49576785+jananivMS@users.noreply.github.com> --- docs/rediscache/rediscache.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index 90f7b5282e2..e2eaef67a6b 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -4,7 +4,7 @@ This operator deploys an Azure Cache for Redis into a specified resource group a Learn more about Azure Cache for Redis [here](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/cache-overview). -A Redis Cache is comprised of the following fields: +The spec is comprised of the following fields: - Location - ResourceGroupName - Properties From 2ec754f71deff638035994dda4d46d98b6f7e147 Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Thu, 9 Apr 2020 07:45:46 -0700 Subject: [PATCH 09/11] Update docs/rediscache/rediscache.md Co-Authored-By: Janani Vasudevan <49576785+jananivMS@users.noreply.github.com> --- docs/rediscache/rediscache.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index e2eaef67a6b..9d3a9c080bc 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -30,7 +30,7 @@ A Redis Cache needs the following fields to deploy, along with a location and re ### Optional Fields -* `SecretName` specify the name of the secret. If none is given, it will fall back to a default name. +* `SecretName` specify the name of the secret. If none is given, it will fall back to the name of the redis cache. * `KeyVaultToStoreSecrets` specify a Key Vault to store primary and secondary credentials in. If none is given, it will default to storing credentials as a Kube Secret. * `Properties.SubnetID` specify a subnet ID to place the Redis Cache in * `Properties.StaticIP` specify a statis IP for the Redis Cache From c4ecdf218e546f46aa46f2221f382eac9435d633 Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Thu, 9 Apr 2020 08:09:05 -0700 Subject: [PATCH 10/11] Update docs/rediscache/rediscache.md Co-Authored-By: Janani Vasudevan <49576785+jananivMS@users.noreply.github.com> --- docs/rediscache/rediscache.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index 9d3a9c080bc..44287ba07f5 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -34,7 +34,7 @@ A Redis Cache needs the following fields to deploy, along with a location and re * `KeyVaultToStoreSecrets` specify a Key Vault to store primary and secondary credentials in. If none is given, it will default to storing credentials as a Kube Secret. * `Properties.SubnetID` specify a subnet ID to place the Redis Cache in * `Properties.StaticIP` specify a statis IP for the Redis Cache -* `Properties.Configuration` provide a configuration to the Redis Cache +* `Properties.Configuration` specify configuration values as key value pairs for the Redis Cache ## Deploy From b996cc549f3d8da1684792332a8538a7d54ef2bb Mon Sep 17 00:00:00 2001 From: Claudia Nadolny Date: Thu, 9 Apr 2020 09:40:02 -0700 Subject: [PATCH 11/11] cr changes --- docs/rediscache/rediscache.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/rediscache/rediscache.md b/docs/rediscache/rediscache.md index 9d3a9c080bc..4a8a81c9ebf 100644 --- a/docs/rediscache/rediscache.md +++ b/docs/rediscache/rediscache.md @@ -4,6 +4,8 @@ This operator deploys an Azure Cache for Redis into a specified resource group a Learn more about Azure Cache for Redis [here](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/cache-overview). +Here is a [sample YAML](/config/samples/azure_v1alpha1_rediscache.yaml) to provision an Azure Cache for Redis. + The spec is comprised of the following fields: - Location - ResourceGroupName @@ -36,8 +38,13 @@ A Redis Cache needs the following fields to deploy, along with a location and re * `Properties.StaticIP` specify a statis IP for the Redis Cache * `Properties.Configuration` provide a configuration to the Redis Cache -## Deploy +### Secrets + +After creating an Azure Cache for Redis instance, the operator stores a JSON formatted secret with the following fields. For more details on where the secrets are stored, look [here](/docs/secrets.md). + +* `primaryKey` +* `secondaryKey` -Follow the steps [here](/docs/development.md) or [here](/docs/deploy.md) to either run the operator locally or in a real Kubernetes cluster. +## Deploy, view and delete resources -You can find a sample Redis Cache YAML [here](/config/samples/azure_v1alpha1_rediscache.yaml). +You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.