Skip to content

Commit b650a4b

Browse files
Update ACK MemoryDB controller tutorial (#1763)
Issue #, if available: Update ACK MemoryDB controller tutorial Description of changes: Updated ACK MemoryDB controller tutorial By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent b8ee309 commit b650a4b

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/content/docs/tutorials/memorydb-example.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In this tutorial we will install ACK service controller for Amazon MemoryDB for
1717

1818
## Setup
1919

20-
Although it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see [Amazon EKS Setup](https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html). For automated cluster creation using `eksctl`, see [Getting started with Amazon EKS - `eksctl`](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html) and create your cluster with Amazon EC2 Linux managed nodes.
20+
Although it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see [Amazon EKS Setup](https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html). For automated cluster creation using `eksctl`, see [Getting started with Amazon EKS - `eksctl`](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html) and create your cluster with Amazon EC2 Linux managed nodes. If you follow this document, install AWS CLI first. Use `aws configure` to access IAM permissions before creating EKS cluster.
2121

2222
### Prerequisites
2323

@@ -46,14 +46,16 @@ You can install the Helm chart to deploy the ACK service controller for Amazon M
4646
For example, to specify that the Amazon MemoryDB API calls go to the `us-east-1` region, you can deploy the service controller with the following command:
4747

4848
```bash
49-
helm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/memorydb-chart --version=v0.0.1 --generate-name --set=aws.region=us-east-1
49+
helm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/memorydb-chart --version=v1.0.0 --generate-name --set=aws.region=us-east-1
5050
```
51+
You can find the latest version of ACK MemoryDB controller on GitHub [release page](https://github.com/aws-controllers-k8s/memorydb-controller/releases).
52+
Replace value for `--version` to the desired version.
5153

5254
For a full list of available values to the Helm chart, please [review the values.yaml file](https://github.com/aws-controllers-k8s/memorydb-controller/blob/main/helm/values.yaml).
5355

5456
### Configure IAM permissions
5557

56-
Once the service controller is deployed, you will need to [configure the IAM permissions][irsa-permissions] for the controller to query the Amazon MemoryDB API. For full details, please review the AWS Controllers for Kubernetes documentation for [how to configure the IAM permissions][irsa-permissions]. If you follow the examples in the documentation, use the value of `memorydb` for `SERVICE`.
58+
Once the service controller is deployed, you will need to [configure the IAM permissions][irsa-permissions] for the controller to query the Amazon MemoryDB API. For full details, please review the AWS Controllers for Kubernetes documentation for [how to configure the IAM permissions][irsa-permissions]. If you follow the examples in the documentation, use the value of `memorydb` for `SERVICE`. Install wget, [oc](https://docs.openshift.com/container-platform/4.8/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli), [jq](https://github.com/stedolan/jq/wiki/Installation), sed first. Skip Next Steps in the documentation.
5759

5860
## Create Amazon MemoryDB Cluster Instances
5961

@@ -64,7 +66,7 @@ You can create Amazon MemoryDB Clusters using the `Cluster` custom resource. The
6466
To create a Amazon MemoryDB Cluster, create a `Cluster` custom resource. The examples below shows how to provision a Amazon MemoryDB Cluster :
6567
* The first example creates a Amazon MemoryDB Cluster in default VPC
6668
* The second example creates a Amazon MemoryDB Cluster in specific VPC subnets and security groups.
67-
You may choose any option from these examples.
69+
You may choose any option from these examples. You can check more [yaml examples](https://github.com/aws-controllers-k8s/examples/tree/main/resources/memorydb/v1alpha1) of all MemoryDB resources.
6870

6971
#### Create Amazon MemoryDB Cluster in default VPC
7072
The following YAML creates a MemoryDB Cluster using the default VPC subnets and security group.
@@ -90,6 +92,7 @@ To create a Amazon MemoryDB Cluster using specific subnets from a VPC, create a
9092

9193
##### Create Amazon MemoryDB subnet group
9294
The following example uses the VPC ID of the EKS Cluster. You may specify any other VPC ID by updating the `VPC_ID` variable in the following example.
95+
Replace `EKS_CLUSTER_NAME` to the eks cluster name you created under 'Prerequisites' section.
9396
```bash
9497
EKS_CLUSTER_NAME="example-eks-cluster"
9598
AWS_REGION="us-east-1"

0 commit comments

Comments
 (0)