Skip to content

Commit b6e670b

Browse files
Apply suggestions from code review
Updates to readme as per review. Co-authored-by: Bevan Arps <[email protected]>
1 parent 6362ee9 commit b6e670b

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

azure-votes-redis/README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To deploy this demo application you'll need the following:
2020
## Set up Azure Service Operator
2121

2222
ASO lets you manage Azure resources using Kubernetes tools.
23-
The operator is installed in your cluster and propagates changes to resources there to the Azure Resource Manager.
23+
The operator is installed in your cluster, and propagates changes from cluster resources to Azure, using the Azure Resource Manager.
2424
[Read more about how ASO works](https://github.com/azure/azure-service-operator#what-is-it)
2525

2626
Follow [these
@@ -29,17 +29,22 @@ Part of this installs
2929
the [custom resource definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) for some of the Azure Resources.
3030

3131
### Note:
32-
Only a few Custom Resource Definitions will be installed in your cluster when you follow the Azure Service Operator set up instructions. The CRDs required specifically to run this sample will be installed along with the sample.
32+
As you follow the installation instructions for Azure Service Operator, add `cache.azure.com/*` to the configuration of CRD Patterns. (ASO doesn't automatically install all available Custom Resource Definitions, as most users only want a small subset.)
3333

3434

3535
## Deploy the application and Azure resources
3636

37-
The YAML documents in [azure-vote-managed-redis.yaml](azure-vote-managed-redis.yaml) create a number of things:
37+
The YAML documents in [azure-vote-managed-redis.yaml](azure-vote-managed-redis.yaml) create:
3838

3939
* A Kubernetes namespace named `azure-vote`,
4040
* An Azure resource group named `aso-redis-demo`,
41-
* An Azure Cache for Redis instance. Note that the container spec for redis.cache.azure.com instance is configured to retrieve two secrets that are produced by the Azure Cache for Redis instance - hostname and primaryKey. As described [here](https://azure.github.io/azure-service-operator/guide/secrets/#how-to-retrieve-secrets-created-by-azure), these secrets need to be mapped to our sample application and the container for our sample application will be blocked until these two secrets are created.
42-
* A deployment and service for the popular [AKS voting sample app](https://github.com/Azure-Samples/azure-voting-app-redis). We have updated the original container spec to introduce environment variables for the managed Redis hostname and access key.
41+
* An Azure Cache for Redis instance.
42+
* A deployment and service for the popular [AKS voting sample app](https://github.com/Azure-Samples/azure-voting-app-redis).
43+
44+
The redis.cache.azure.com instance is configured to retrieve two secrets that are produced by the Azure Cache for Redis instance - hostname and primaryKey. As described [here](https://azure.github.io/azure-service-operator/guide/secrets/#how-to-retrieve-secrets-created-by-azure), these secrets need to be mapped to our sample application and the container for our sample application will be blocked until these two secrets are created.
45+
46+
The Voting Sample is configured with environment variables that read the secretes for the managed Redis hostname and access key, allowing the sample to use the cache.
47+
4348

4449
Create them all by applying the file:
4550
```sh
@@ -54,9 +59,9 @@ watch kubectl get -n azure-vote resourcegroup,redis
5459
You can also find the resource group in the [Azure portal](https://portal.azure.com) and watch the Azure Cache for Redis instance being created there.
5560

5661
### Note
57-
It could take a few minutes for the Azure Cache for Redis to be provisioned. In that time you might see some `ResourceNotFound` errors, or messages indicating that the secret, Azure Cache for Redis or the application deployment are not ready.
62+
It may take a few minutes for the Azure Cache for Redis to be provisioned. In that time, you may see some `ResourceNotFound` messages in the logsindicating that the secret, the Azure Cache for Redis or the application deployment are not ready.
5863
*This is OK!*
59-
Once the Redis instance is created, secrets will be created and will unblock the sample application container creation. All errors should eventually resolve once the Redis instance is provisioned.
64+
Once the Redis instance is created, secrets will be created and will unblock the sample application container creation. All errors will eventually resolve once the Redis instance is provisioned. These errors are ASO monitoring the creation of each resource, allowing it to take the next step as soon as the resource is available.
6065

6166
## Test the application
6267
When the application runs, a Kubernetes service exposes the application front end to the internet. This process can take a few minutes to complete.

0 commit comments

Comments
 (0)