You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,15 @@
1
+
## Note
2
+
Starting from Airflow version 2.9, MWAA has open-sourced the original Docker image used in our production deployments. You can refer to our open-source image repository at https://github.com/aws/amazon-mwaa-docker-images to create a local environment identical to that of MWAA.
3
+
You can also continue to use the MWAA Local Runner for testing and packaging requirements for all Airflow versions supported on MWAA.
4
+
1
5
# About aws-mwaa-local-runner
2
6
3
7
This repository provides a command line interface (CLI) utility that replicates an Amazon Managed Workflows for Apache Airflow (MWAA) environment locally.
4
8
5
-
*Please note: MWAA/AWS/DAG/Plugin issues should be raised through AWS Support or the Airflow Slack #airflow-aws channel. Issues here should be focused on this local-runner repository.*
9
+
_Please note: MWAA/AWS/DAG/Plugin issues should be raised through AWS Support or the Airflow Slack #airflow-aws channel. Issues here should be focused on this local-runner repository._
6
10
11
+
_Please note: The dynamic configurations which are dependent on the class of an environment are
12
+
aligned with the Large environment class in this repository._
7
13
8
14
## About the CLI
9
15
@@ -14,7 +20,7 @@ The CLI builds a Docker container image locally that’s similar to a MWAA produ
14
20
```text
15
21
dags/
16
22
example_lambda.py
17
-
example_dag_with_taskflow_api.py
23
+
example_dag_with_taskflow_api.py
18
24
example_redshift_data_execute_sql.py
19
25
docker/
20
26
config/
@@ -34,7 +40,7 @@ docker/
34
40
Dockerfile
35
41
plugins/
36
42
README.md
37
-
requirements/
43
+
requirements/
38
44
requirements.txt
39
45
.gitignore
40
46
CODE_OF_CONDUCT.md
@@ -102,7 +108,7 @@ The following section describes where to add your DAG code and supporting files.
102
108
103
109
#### Requirements.txt
104
110
105
-
1. Add Python dependencies to `requirements/requirements.txt`.
111
+
1. Add Python dependencies to `requirements/requirements.txt`.
106
112
2. To test a requirements.txt without running Apache Airflow, use the following script:
@@ -136,7 +142,7 @@ For example usage see [Installing Python dependencies using PyPi.org Requirement
136
142
137
143
#### Custom plugins
138
144
139
-
- There is a directory at the root of this repository called plugins.
145
+
- There is a directory at the root of this repository called plugins.
140
146
- In this directory, create a file for your new custom plugin.
141
147
- Add any Python dependencies to `requirements/requirements.txt`.
142
148
@@ -165,7 +171,7 @@ The following section contains common questions and answers you may encounter wh
165
171
### Can I test execution role permissions using this repository?
166
172
167
173
- You can setup the local Airflow's boto with the intended execution role to test your DAGs with AWS operators before uploading to your Amazon S3 bucket. To setup aws connection for Airflow locally see [Airflow | AWS Connection](https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/connections/aws.html)
168
-
To learn more, see [Amazon MWAA Execution Role](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html).
174
+
To learn more, see [Amazon MWAA Execution Role](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html).
169
175
- You can set AWS credentials via environment variables set in the `docker/config/.env.localrunner` env file. To learn more about AWS environment variables, see [Environment variables to configure the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) and [Using temporary security credentials with the AWS CLI](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html#using-temp-creds-sdk-cli). Simply set the relevant environment variables in `.env.localrunner` and `./mwaa-local-env start`.
170
176
171
177
### How do I add libraries to requirements.txt and test install?
0 commit comments