update s3 how-to with dynamodb

Signed-off-by: Reshma Abdul Rahim <[email protected]>

docs/content/guides/author-apps/aws/howto-aws-resources/index.md

@@ -10,10 +10,8 @@ weight: 200
 
 This how-to guide will show you:
 
-- How to model an AWS S3 resource in Bicep
-- How to use a sample application to interact with AWS S3 bucket
-
-   <img src="./s3appdiagram.png" alt="Screenshot of the sample application to interact with s3 bucket " width=400>
+- How to model an AWS Dynamo DB table in Bicep
+- How to deploy an AWS resource in Radius
 
 ## Prerequisites
 
@@ -52,53 +50,55 @@ Follow the prompts to install the [control plane services]({{< ref architecture-
 - **Add AWS provider** - An [AWS cloud provider]({{< ref "/guides/operations/providers/howto-aws-provider" >}}) allows you to deploy and manage AWS resources as part of your application. Enter 'y' and follow the instructions. Provide a valid AWS region and the values obtained for IAM Access Key ID and IAM Secret Access Keys.
 - **Environment name** - The name of the environment to create. You can specify any name with lowercase letters, such as `myawsenv`.
 
-## Step 3: Create a Bicep file to model AWS Simple Storage Service (S3)
+## Step 3: Create a Bicep file to model AWS Dynamo DB table
 
-Create a new file called `app.bicep` and add the following bicep code to model an AWS S3 Bucket:
+Create a new file called `dynamodb.bicep` and add the following bicep code to model a Dynamodb Table
 
-{{< rad file="snippets/s3.bicep" embed=true >}}
+{{< rad file="snippets/dynamodb.bicep" embed=true >}}
 
 Radius uses the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html) to interact with AWS resources. This means that you can model your AWS resources in Bicep and Radius will be able to deploy and manage them. You can find the list of supported AWS resources in the [AWS resource library]({{< ref "guides/author-apps/aws/overview#resource-library" >}}).
 
-## Step 4: Add a Radius container to interact with the AWS S3 Bucket
-
-Open the `app.bicep` and append the following Radius resources:
+## Step 5: Deploy the db to your environment
 
-{{< rad file="snippets/s3app.bicep" embed=true marker="//S3APP" >}}
+1. Deploy the db to your environment using the below command:
 
-Your final `app.bicep` file should look like this
+   ```bash
+   rad deploy ./dynamodb.bicep
+   ```
+    This will deploy the AWS Dynamo DB table to your environment. 
 
-{{< rad file="snippets/app.bicep" embed=true >}}
+    ```
+    Building dynamodb.bicep...
+    Deploying template 'dynamodb.bicep' into environment 'aws' from workspace 'default'...
 
-This creates a container that will be deployed to your Kubernetes cluster. This container will interact with the AWS S3 Bucket you created in the previous step.
+    Deployment In Progress...
 
-## Step 5: Deploy the application
+    .                    demotable       AWS.DynamoDB/GlobalTable
 
-1. Deploy your application to your environment:
+    Deployment Complete
 
-   ```bash
-   rad deploy ./app.bicep -p aws_access_key_id=<AWS_ACCESS_KEY_ID> -p aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
-   ```
-   > Replace `<AWS_ACCESS_KEY_ID>` and `<AWS_SECRET_ACCESS_KEY>` with the values obtained from the previous step.
+    Resources:
+        demotable       AWS.DynamoDB/GlobalTable
+    ```
 
-   {{% alert title="Warning" color="warning" %}}It is always recommended to have separate IAM credentials for your container to communicate with S3 or any other data store. 
-   Radius is currently working on supporting direct connections to AWS resources so that your container can automatically communicate with the data store securely without having to manage separate credentials for data plane operations{{% /alert %}}
+2. Verify that the AWS Dynamo DB table has been created via AWS Console / CLI
 
-1. Port-forward the container to your machine with [`rad resource expose`]({{< ref rad_resource_expose >}}):
+## Step 6: Cleanup
 
-    ```bash
-    rad resource expose containers frontend -a s3app --port 5234
-    ```
+1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster.
 
-1. Visit [localhost:5234](http://localhost:5234/swagger/index.html) in your browser. This is a swagger doc for the sample application. You can use this to interact with the AWS S3 Bucket you created. For example, you can try to upload a file to the bucket via the `/upload` endpoint.
+2. Cleanup AWS Resources - AWS resources are not deleted when deleting a Radius Environment, so make sure to delete all resources created in this reference app to prevent additional charges. You can delete these resources in the AWS Console or via the AWS CLI. 
 
-    <img src="./s3app.png" alt="Screenshot of the sample application to interact with s3 bucket " width=900>
+   ```bash
+   aws dynamodb delete-table --table-name demotable
+   ```
 
-## Step 6: Cleanup
+## Further Reading
 
-1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster.
+For further reference to examples of a sample Radius application that uses AWS resources, refer to the following tutorials:
 
-2. Cleanup AWS Resources - AWS resources are not deleted when deleting a Radius Environment, so make sure to delete all resources created in this reference app to prevent additional charges. You can delete these resources in the AWS Console or via the AWS CLI. Instructions to delete an AWS S3 Bucket are available [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html).
+1. [Deploy Recipes in your Radius Application]({{< ref "/tutorials/tutorial-recipe" >}})
+2. [eShop on containers]({{< ref "/tutorials/eshop" >}})
 
 ## Troubleshooting
 
@@ -118,12 +118,6 @@ If you have issues with the sample application, where the container doesn't conn
 1. Use the below command to inspect logs from container:
 
     ```bash
-    rad resource logs containers frontend -a s3app
+    rad resource logs containers frontend -a <appname>
     ```
 Also make sure to [open an Issue](https://github.com/radius-project/radius/issues/new/choose) if you encounter a generic `Internal server error` message or an error message that is not self-serviceable, so we can address the root error not being forwarded to the user.
-
-## Further Reading
-
-{{< categorizeby category="Overview" tag="AWS" >}}
-
-{{< categorizeby category="How-To" tag="AWS" >}}

docs/content/guides/author-apps/aws/howto-aws-resources/snippets/dynamodb.bicep

@@ -0,0 +1,34 @@
+import aws as aws
+
+resource dynamodb 'AWS.DynamoDB/GlobalTable@default'={
+  properties: {
+    TableName:'demotable'
+    BillingMode: 'PAY_PER_REQUEST'
+    AttributeDefinitions: [
+      {
+        AttributeName: 'order_id'
+        AttributeType: 'S'
+      }
+      {
+        AttributeName: 'quantity'
+        AttributeType: 'N'
+      }
+    ]
+    KeySchema: [
+      {
+        AttributeName: 'order_id'
+        KeyType: 'HASH'
+      }
+      {
+        AttributeName: 'quantity'
+        KeyType: 'RANGE'
+      }
+    ]
+    Replicas: [
+     {
+      Region: 'us-west-2'
+     } 
+    ]
+  }
+  alias: 'dynamodb'
+}

holding-pen/howto-aws-s3/index.md

@@ -0,0 +1,129 @@
+---
+type: docs
+title: "How-To: Deploy AWS resources"
+linkTitle: "Deploy AWS resources"
+description: "Learn about how to add AWS resources to your application and deploy them with Radius"
+categories: "How-To"
+tags: ["AWS"]
+weight: 200
+---
+
+This how-to guide will show you:
+
+- How to model an AWS S3 resource in Bicep
+- How to use a sample application to interact with AWS S3 bucket
+
+   {{< image src="s3appdiagram.png" alt="Screenshot of the sample application to interact with s3 bucket " width=400 >}}
+
+## Prerequisites
+
+- Make sure you have an [AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account) and an [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html)
+    - [Create an IAM AWS access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) and copy the AWS Access Key ID and the AWS Secret Access Key to a secure location for use later. If you have already created an Access Key pair, you can use that instead.
+- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
+    - Configure your CLI with [`aws configure`](https://docs.aws.amazon.com/cli/latest/reference/configure/index.html), specifying your configuration values
+- [eksctl CLI](https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html)
+- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) 
+- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
+- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-radius-bicep-extension" >}})
+
+## Step 1: Create an EKS Cluster
+
+Create an EKS cluster by using the `eksctl` CLI. 
+
+```bash
+eksctl create cluster --name <my-cluster> --region=<my-region> 
+```
+
+## Step 2: Create a Radius Environment with the AWS cloud provider
+
+Create a [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) where you will deploy your application.
+
+Run [`rad init --full`]({{< ref rad_init >}}) to initialize a new environment into your current kubectl context:
+
+```bash
+rad init --full
+```
+
+Follow the prompts to install the [control plane services]({{< ref architecture-concept >}}), create an [environment resource]({{< ref "/guides/deploy-apps/environments" >}}), and create a [local workspace]({{< ref workspaces >}}). You will be asked for:
+
+- **Namespace** - When an application is deployed, this is the namespace where your containers and other Kubernetes resources will be run. By default, this will be in the `default` namespace.
+{{% alert title="💡 About namespaces" color="success" %}} When you initialize a Radius Kubernetes environment, Radius installs the control plane resources within    the `radius-system` namespace in your cluster, separate from your applications. The namespace specified in this step will be used for your application deployments.
+{{% /alert %}}
+- **Add AWS provider** - An [AWS cloud provider]({{< ref "/guides/operations/providers/howto-aws-provider" >}}) allows you to deploy and manage AWS resources as part of your application. Enter 'y' and follow the instructions. Provide a valid AWS region and the values obtained for IAM Access Key ID and IAM Secret Access Keys.
+- **Environment name** - The name of the environment to create. You can specify any name with lowercase letters, such as `myawsenv`.
+
+## Step 3: Create a Bicep file to model AWS Simple Storage Service (S3)
+
+Create a new file called `app.bicep` and add the following bicep code to model an AWS S3 Bucket:
+
+{{< rad file="snippets/s3.bicep" embed=true >}}
+
+Radius uses the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html) to interact with AWS resources. This means that you can model your AWS resources in Bicep and Radius will be able to deploy and manage them. You can find the list of supported AWS resources in the [AWS resource library]({{< ref "guides/author-apps/aws/overview#resource-library" >}}).
+
+## Step 4: Add a Radius container to interact with the AWS S3 Bucket
+
+Open the `app.bicep` and append the following Radius resources:
+
+{{< rad file="snippets/s3app.bicep" embed=true marker="//S3APP" >}}
+
+Your final `app.bicep` file should look like this
+
+{{< rad file="snippets/app.bicep" embed=true >}}
+
+This creates a container that will be deployed to your Kubernetes cluster. This container will interact with the AWS S3 Bucket you created in the previous step.
+
+## Step 5: Deploy the application
+
+1. Deploy your application to your environment:
+
+   ```bash
+   rad deploy ./app.bicep -p aws_access_key_id=<AWS_ACCESS_KEY_ID> -p aws_secret_access_key=<AWS_SECRET_ACCESS_KEY>
+   ```
+   > Replace `<AWS_ACCESS_KEY_ID>` and `<AWS_SECRET_ACCESS_KEY>` with the values obtained from the previous step.
+
+   {{% alert title="Warning" color="warning" %}}It is always recommended to have separate IAM credentials for your container to communicate with S3 or any other data store. 
+   Radius is currently working on supporting direct connections to AWS resources so that your container can automatically communicate with the data store securely without having to manage separate credentials for data plane operations{{% /alert %}}
+
+1. Port-forward the container to your machine with [`rad resource expose`]({{< ref rad_resource_expose >}}):
+
+    ```bash
+    rad resource expose containers frontend -a s3app --port 5234
+    ```
+
+1. Visit [localhost:5234](http://localhost:5234/swagger/index.html) in your browser. This is a swagger doc for the sample application. You can use this to interact with the AWS S3 Bucket you created. For example, you can try to upload a file to the bucket via the `/upload` endpoint.
+
+    {{< image src="s3app.png" alt="Screenshot of the sample application to interact with s3 bucket " width=900 >}}
+
+## Step 6: Cleanup
+
+1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster.
+
+2. Cleanup AWS Resources - AWS resources are not deleted when deleting a Radius Environment, so make sure to delete all resources created in this reference app to prevent additional charges. You can delete these resources in the AWS Console or via the AWS CLI. Instructions to delete an AWS S3 Bucket are available [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html).
+
+## Troubleshooting
+
+If you hit errors while deploying the application, please follow the steps below to troubleshoot:
+
+1. Check if the AWS credentials are valid. Login to the AWS console and check if the IAM access key and secret access key are valid and not expired.
+
+2. Look at the control plane logs to see if there are any errors. You can use the following command to view the logs:
+
+     ```bash
+     rad debug-logs
+     ```
+    Inspect the UCP logs to see if there are any errors  
+
+If you have issues with the sample application, where the container doesn't connect with the S3 bucket, please follow the steps below to troubleshoot:
+
+1. Use the below command to inspect logs from container:
+
+    ```bash
+    rad resource logs containers frontend -a s3app
+    ```
+Also make sure to [open an Issue](https://github.com/radius-project/radius/issues/new/choose) if you encounter a generic `Internal server error` message or an error message that is not self-serviceable, so we can address the root error not being forwarded to the user.
+
+## Further Reading
+
+{{< categorizeby category="Overview" tag="AWS" >}}
+
+{{< categorizeby category="How-To" tag="AWS" >}}

docs/content/guides/author-apps/aws/howto-aws-resources/snippets/app.bicep → holding-pen/howto-aws-s3/snippets/app.bicep

@@ -45,7 +45,7 @@ resource frontend 'Applications.Core/containers@2023-10-01-preview' = {
         AWS_SECRET_ACCESS_KEY: aws_secret_access_key
         AWS_DEFAULT_REGION: aws_region
       }
-      image: 'radius.azurecr.io/samples/aws:latest'
+      image: 'ghcr.io/radius-project/samples/aws:latest'
     }
   }
 }

docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3app.bicep → holding-pen/howto-aws-s3/snippets/s3app.bicep

@@ -46,7 +46,7 @@ resource frontend 'Applications.Core/containers@2023-10-01-preview' = {
         AWS_SECRET_ACCESS_KEY: aws_secret_access_key
         AWS_DEFAULT_REGION: aws_region
       }
-      image: 'radius.azurecr.io/samples/aws:latest'
+      image: 'ghcr.io/radius-project/samples/aws:latest'
     }
   }
 }