|
1 | 1 | # SearchAPI-v3 |
2 | 2 |
|
3 | | -This project contains source code and supporting files for a serverless application that you can deploy with the SAM CLI. It includes the following files and folders. |
4 | | - |
5 | | -- SearchAPI - Code for the application's Lambda function. |
6 | | -- events - Invocation events that you can use to invoke the function. |
7 | | -- tests - Unit tests for the application code. |
8 | | -- template.yaml - A template that defines the application's AWS resources. |
9 | | - |
10 | | -The application uses several AWS resources, including Lambda functions and an API Gateway API. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code. |
11 | | - |
12 | | -## Default Parameters |
13 | | - |
14 | | -I added the parameters for deploying to `samconfig.toml` to have sensible default params specific to this project. Thus SAM may not behave the same as on other projects! |
15 | | - |
16 | | -## Quick start: Develop the app locally |
17 | | - |
18 | | -To develop against anything inside the container itself (FastAPI), run these commands to build/start the server: |
19 | | - |
20 | | -```bash |
21 | | -sam build --template-file template-docker.yaml |
22 | | -sam local start-api --env-vars local-env-vars.conf |
23 | | -``` |
24 | | - |
25 | | -If you haven't done so, you'll have to pull the `asf_search` repo to the root of this project (and switch to the `cs.searchapi-v3-edits` branch if it's not merged yet). |
26 | | - |
27 | | -Once that branch is merged, we can remove the local install from the dockerfile and delete the local repo. This helps with developing against asf_search until then. |
28 | | - |
29 | | -## Deploy the sample application |
30 | | - |
31 | | -To use the SAM CLI, you need the following tools. |
32 | | - |
33 | | -- SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) |
34 | | -- [Python 3 installed](https://www.python.org/downloads/) |
35 | | -- Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community) |
36 | | - |
37 | | -To build and deploy your application for the first time, run the following in your shell: |
38 | | - |
39 | | -### For Python-based Lambda |
40 | | - |
41 | | -```bash |
42 | | -export AWS_PROFILE=<your-profile> |
43 | | -sam validate --template-file template-python.yaml |
44 | | -sam build --template-file template-python.yaml |
45 | | -sam package |
46 | | -sam deploy / |
47 | | - --stack-name SearchAPI-v3-SAM-python |
48 | | -``` |
49 | | - |
50 | | -### For Docker-based Lambda |
51 | | - |
52 | | -```bash |
53 | | -export AWS_PROFILE=<your-profile> |
54 | | -sam validate --template-file template-docker.yaml |
55 | | -sam build --template-file template-docker.yaml |
56 | | -sam package --image-repository "$(aws sts get-caller-identity --query Account --output text).dkr.ecr.us-east-1.amazonaws.com/searchapi-v3" |
57 | | -sam deploy \ |
58 | | - --stack-name SearchAPI-v3-SAM-docker \ |
59 | | - --image-repository "$(aws sts get-caller-identity --query Account --output text).dkr.ecr.us-east-1.amazonaws.com/searchapi-v3" |
60 | | -``` |
61 | | - |
62 | | -## Use the SAM CLI to build and test locally |
63 | | - |
64 | | -Build your application with the `sam build ...` command above. |
65 | | - |
66 | | -The SAM CLI installs dependencies defined in `SearchAPI/requirements.txt`, creates a deployment package, and saves it in the `.aws-sam/build` folder. |
67 | | - |
68 | | -Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project. |
69 | | - |
70 | | -Run functions locally and invoke them with the `sam local invoke` command. |
71 | | - |
72 | | -```bash |
73 | | -# THIS WON'T WORK until we add API Gateway events to events/* |
74 | | -# for now, use `sam local start-api` in the next part instead. |
75 | | -sam local invoke SearchApiFunction --event events/event.json |
76 | | -``` |
77 | | - |
78 | | -The SAM CLI can also emulate your application's API. Use the `sam local start-api` to run the API locally on port 3000. |
79 | | - |
80 | | -```bash |
81 | | -sam local start-api --env-vars local-env-vars.conf |
82 | | -curl http://localhost:3000/ |
83 | | -``` |
84 | | - |
85 | | -## Fetch, tail, and filter Lambda function logs |
86 | | - |
87 | | -To simplify troubleshooting, SAM CLI has a command called `sam logs`. `sam logs` lets you fetch logs generated by your deployed Lambda function from the command line. In addition to printing the logs on the terminal, this command has several nifty features to help you quickly find the bug. |
88 | | - |
89 | | -`NOTE`: This command works for all AWS Lambda functions; not just the ones you deploy using SAM. |
90 | | - |
91 | | -```bash |
92 | | -sam logs -n SearchApiFunction --stack-name SearchAPI-v3-SAM --tail |
93 | | -``` |
94 | | - |
95 | | -You can find more information and examples about filtering Lambda function logs in the [SAM CLI Documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-logging.html). |
96 | | - |
97 | | -## Tests |
98 | | - |
99 | | -Tests are defined in the `tests` folder in this project. Use PIP to install the test dependencies and run tests. |
100 | | - |
101 | | -```bash |
102 | | -pip install -r tests/requirements.txt --user |
103 | | -# unit test |
104 | | -python -m pytest tests/unit -v |
105 | | -# integration test, requiring deploying the stack first. |
106 | | -# Create the env variable AWS_SAM_STACK_NAME with the name of the stack we are testing |
107 | | -AWS_SAM_STACK_NAME=<stack-name> python -m pytest tests/integration -v |
108 | | -``` |
109 | | - |
110 | | -## Cleanup |
111 | | - |
112 | | -To delete the sample application that you created, use the AWS CLI. Assuming you used your project name for the stack name, you can run the following: |
113 | | - |
114 | | -```bash |
115 | | -sam delete --stack-name SearchAPI-v3-SAM |
116 | | -``` |
117 | | - |
118 | | -## Resources |
119 | | - |
120 | | -See the [AWS SAM developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) for an introduction to SAM specification, the SAM CLI, and serverless application concepts. |
121 | | - |
122 | | -Next, you can use AWS Serverless Application Repository to deploy ready to use Apps that go beyond hello world samples and learn how authors developed their applications: [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/) |
| 3 | +- Login to aws console using Kion |
| 4 | +- Find the region that has the VPC and note account number, vpc_id, subnet_ids and security_group. Subnet_ids should be a comma separated list |
| 5 | +- Get temp cli credentials from Kion and add them to your shell |
| 6 | +- Run CDK bootstrap in region with the VPC using cdk-bootstrap-example.sh and filling in the account number, vpc_id, subnet_ids and security_group |
| 7 | +- If not already created, make an OpenIdConnectProvider (some how...) |
| 8 | +- Create OIDC role using cloudformation template cdk/oidc/github-actions-oidc.yml. For 'ActionsRoleName' parameter put 'SearchAPIActionsOIDCRole' |
| 9 | +- Create a github environment with params using the same values from the CDK bootstrap. AWS_ACCOUNT_ID, SECURITY_GROUP, SUBNET_IDS, VPC_ID |
0 commit comments