Update readme to include python E2E test instructions. (#55)

* Update readme to include python E2E test instructions.

* Reformate.

* Fix

Author: zzhlogin

.github/workflows/appsignals-python-e2e-ec2-canary-test.yml

@@ -5,7 +5,7 @@
 ## test the artifacts for Application Signals enablement. It will deploy a sample app and remote
 ## service on two EC2 instances, call the APIs, and validate the generated telemetry,
 ## including logs, metrics, and traces.
-name: App Signals Enablement - Tests Python E2E EC2 Canary Testing
+name: App Signals Enablement - Python E2E EC2 Canary Testing
 on:
   schedule:
     - cron: '*/15 * * * *' # run the workflow every 15 minutes

.github/workflows/appsignals-python-e2e-eks-canary-test.yml

@@ -5,7 +5,7 @@
 ## test the artifacts for Application Signals enablement. It will deploy a sample app and remote
 ## service onto an EKS cluster, call the APIs, and validate the generated telemetry,
 ## including logs, metrics, and traces.
-name: App Signals Enablement - Tests Python E2E EKS Canary Testing
+name: App Signals Enablement - Python E2E EKS Canary Testing
 on:
   schedule:
     - cron: '*/15 * * * *' # run the workflow every 15 minutes

README.md

@@ -1,5 +1,5 @@
 # How to Test E2E Resource Changes
-This guide will give a step by step instruction on how to test changes made to E2E testing resources before pushing a PR.
+This guide will give a step by step instruction on how to test changes made to Java/Python E2E testing resources before pushing a PR.
 The guide will include the following:
 - Setting up IAM roles and an EKS cluster
 - Setting up VPC settings and IAM role for EC2 instances
@@ -78,37 +78,47 @@ Note: If you do not want to test all 5 regions, you can create one for us-east-1
 
 ### 4. Building Sample App to ECR
 Create two ECR repositories: one for the sample app main service and another for the sample app remote service.
-Follow the instructions [here](../sample-apps/README.md) to build the sample app image and upload it to the ECR
+Follow the instructions to build the sample app image and upload it to the ECR:
+- [Java Sample App build instruction](https://github.com/aws-observability/aws-application-signals-test-framework/blob/main/sample-apps/README.md#eks-use-case-uploading-to-ecr)
+- [Python Sample App build instruction](https://github.com/aws-observability/aws-application-signals-test-framework/blob/main/sample-apps/python/README.md#eks-use-case-uploading-to-ecr)
 
 ### 5. Building Sample App to S3 Bucket
-Create an S3 Bucket to store the .jar files for the sample app main service and sample app remote service.
-Follow the instructions under [here](../sample-apps/README.md) to build the sample app .jar and upload it to the bucket
+Create an S3 Bucket to store the artifacts for the sample app main service and sample app remote service.
+Follow the instructions to build the sample app .jar and upload it to the bucket:
+- [Java .jar files build instruction](https://github.com/aws-observability/aws-application-signals-test-framework/blob/main/sample-apps/README.md#ec2-use-case-building-the-jar-files)
+- [Python .zip file build instruction](https://github.com/aws-observability/aws-application-signals-test-framework/blob/main/sample-apps/python/README.md#ec2-use-case-building-the-jar-files)
 
 ### 6. Setting up repository
-- Go to https://github.com/aws-observability/aws-otel-java-instrumentation and create a fork
+- Create a fork for the current repository.
 - Go to the forked repo and enable action on the Action tab
 - Add the following secrets to the repository
     - APP_SIGNALS_E2E_TEST_ACC: `<AccountID>`
+    - E2E_SECRET_TEST_ROLE_ARN: `arn:aws:iam::<SecretManagerAccountID>:role/<RoleName>`
     - E2E_TEST_ROLE_ARN: `arn:aws:iam::<AccountID>:role/<RoleName>`
-    - APP_SIGNALS_E2E_FE_SA_IMG: `<AccountID>.dkr.ecr.us-east-1.amazonaws.com/<Path to Sample App Image>`
-    - APP_SIGNALS_E2E_RE_SA_IMG: `<AccountID>.dkr.ecr.us-east-1.amazonaws.com/<Path to Remote Sample App Image>`
-    - APP_SIGNALS_E2E_FE_SA_JAR: s3://<BucketName>/<FileName.jar>
-    - APP_SIGNALS_E2E_RE_SA_JAR: s3://<BucketName>/<FileName.jar>
+    - ADOT_E2E_TEST_ROLE_ARN: `arn:aws:iam::<MainBuildAccountID>:role/<MainBuildClusterRoleName>`
+    - APP_SIGNALS_PYTHON_E2E_FE_SA_IMG: `<AccountID>.dkr.ecr.us-east-1.amazonaws.com/<Path to Python Sample App Image>`
+    - APP_SIGNALS_PYTHON_E2E_RE_SA_IMG: `<AccountID>.dkr.ecr.us-east-1.amazonaws.com/<Path to Python Remote Sample App Image>`
+    - APP_SIGNALS_E2E_FE_SA_IMG: `<AccountID>.dkr.ecr.us-east-1.amazonaws.com/<Path to Java Sample App Image>`
+    - APP_SIGNALS_E2E_RE_SA_IMG: `<AccountID>.dkr.ecr.us-east-1.amazonaws.com/<Path to Java Remote Sample App Image>`
+    - APP_SIGNALS_E2E_EC2_JAR: <JarBucketNamePrefix>
 
 
 ### 7. Running the tests
 Go to the Actions tab on the forked repository.
 
-- To run the EKS test, go to `App Signals Enablement - E2E EKS Canary Testing`, and click `Enable Workflow`, then `Run Workflow`.
-- To run the EC2 test, go to `App Signals Enablement - E2E EC2 Canary Testing`, and click `Enable Workflow`, then `Run Workflow`.
+- To run the Java EKS test, go to `App Signals Enablement - E2E EKS Canary Testing`, and click `Enable Workflow`, then `Run Workflow`.
+- To run the Java EC2 test, go to `App Signals Enablement - E2E EC2 Canary Testing`, and click `Enable Workflow`, then `Run Workflow`. 
+- To run the Python EKS test, go to `App Signals Enablement - Python E2E EKS Canary Testing`, and click `Enable Workflow`, then `Run Workflow`.
+- To run the Python EC2 test, go to `App Signals Enablement - Python E2E EC2 Canary Testing`, and click `Enable Workflow`, then `Run Workflow`.
 
 If you don't want the canaries to run every 15 minutes on the forked repository, click the `...` button on the top right and choose `Disable Workflow`
 
 ### E2E Testing Resources
-- `./.github/workflows/appsignals-e2e-*`: workflow files for running e2e tests
-- `./testing/sample-apps/*`: files for building the sample app
-- `./testing/validator/*`: files for validating logs/metrics/traces generated by sample app
-- `./testing/terraform/*`:  files for launching the sample app to EKS cluster or EC2 instances
+- `./.github/workflows/appsignals-e2e-*`: workflow files for running java e2e tests
+- `./.github/workflows/appsignals-python-e2e-*`: workflow files for running python e2e tests
+- `./sample-apps/*`: files for building the sample app
+- `./validator/*`: files for validating logs/metrics/traces generated by sample app
+- `./terraform/*`:  files for launching the sample app to EKS cluster or EC2 instances
 
 ## Security
 

sample-apps/python/README.md

@@ -22,7 +22,7 @@ docker push ${REPOSITORY_PREFIX}/pythonsampleapp/remote-service:latest
 ```
 
 
-## EC2 Use Case: Building the JAR Files:
+## EC2 Use Case: Building the ZIP File:
 1. Compress the folder with: `zip -r python-sample-app.zip .`
 2. Login to the testing account
 3. Create a new S3 bucket if there's no existing one.