-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaws-development.html
More file actions
236 lines (211 loc) · 17.1 KB
/
aws-development.html
File metadata and controls
236 lines (211 loc) · 17.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AWS Development — 3.2.0+3.gb2780d4a</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="canonical" href="https://podpac.org/aws-development.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API Reference" href="api.html" />
<link rel="prev" title="NASA Earth Data Login" href="earthdata.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html">
<img src="_static/icon.svg" class="logo" alt="Logo"/>
</a>
<div class="version">
3.2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws.html">AWS Integration</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Topics</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="why-podpac.html">Why PODPAC?</a></li>
<li class="toctree-l1"><a class="reference internal" href="design.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="nodes.html">Nodes</a></li>
<li class="toctree-l1"><a class="reference internal" href="coordinates.html">Coordinates</a></li>
<li class="toctree-l1"><a class="reference internal" href="cache.html">Cache</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">Supported Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="interpolation.html">Interpolation</a></li>
<li class="toctree-l1"><a class="reference internal" href="earthdata.html">NASA Earth Data Login</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">AWS Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#aws-architecture">AWS Architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="#creating-podpac-resources-for-aws">Creating PODPAC resources for AWS</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="wrapping-datasets.html">Wrapping Datasets</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Support</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Development Roadmap</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PODPAC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">AWS Development</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/aws-development.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="aws-development">
<h1>AWS Development<a class="headerlink" href="#aws-development" title="Permalink to this heading"></a></h1>
<p>This document provides details on how PODPAC integrates with AWS services for serverless cloud processing.
See the <a class="reference internal" href="#aws.html"><span class="xref myst">AWS Quick Start Guide</span></a> for a quick guide to building and using AWS services with PODPAC.</p>
<section id="aws-architecture">
<h2>AWS Architecture<a class="headerlink" href="#aws-architecture" title="Permalink to this heading"></a></h2>
</section>
<section id="creating-podpac-resources-for-aws">
<h2>Creating PODPAC resources for AWS<a class="headerlink" href="#creating-podpac-resources-for-aws" title="Permalink to this heading"></a></h2>
<blockquote>
<div><p><a class="reference external" href="https://www.docker.com/">Docker</a> is required for creating PODPAC resources for AWS services.</p>
</div></blockquote>
<p>All files related to creating PODPAC resources for AWS live in <a class="reference external" href="https://github.com/creare-com/podpac/tree/master/dist/aws"><code class="docutils literal notranslate"><span class="pre">dist/aws</span></code></a>.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">handler.py</span></code>: <a class="reference external" href="https://docs.aws.amazon.com/lambda/latest/dg/python-programming-model-handler-types.html">AWS Lambda function handler</a>. Handles PODPAC Lambda trigger event, executes the pipeline, and returns the result back to the source of the trigger. Developers can override the default function handler for a <a class="reference internal" href="#api/podpac.managers.Lambda.html"><span class="xref myst"><code class="docutils literal notranslate"><span class="pre">Lambda</span></code></span></a> Node using the <a class="reference internal" href="#api/podpac.managers.Lambda.html#podpac.managers.Lambda.function_handler"><span class="xref myst"><code class="docutils literal notranslate"><span class="pre">function_handler</span></code></span></a> attribute.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DockerFile</span></code>: Docker instructions for creating PODPAC deployment package and dependencies using <a class="reference external" href="https://hub.docker.com/_/amazonlinux/">Amazon’s EC2 DockerHub</a> distribution.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">build_lambda.sh</span></code>: Bash script to build PODPAC deployment package and dependencies using <a class="reference external" href="https://www.docker.com/">Docker</a>. Outputs <code class="docutils literal notranslate"><span class="pre">podpac_dist.zip</span></code> and <code class="docutils literal notranslate"><span class="pre">podpac_deps.zip</span></code> in the <code class="docutils literal notranslate"><span class="pre">dist/aws</span></code> directory.</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">podpac_dist.zip</span></code>: PODPAC <a class="reference external" href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-features.html#gettingstarted-features-package">deployment package</a> ready to create a Lambda function.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">podpac_deps.zip</span></code>: PODPAC dependencies that are hosted on S3 and dynamically extracted during Lambda function execution. These files are seperate from <code class="docutils literal notranslate"><span class="pre">podpac_dist.zip</span></code> to circumvent the space limitations of AWS Lambda functions.</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">upload_lambda.sh</span></code>: Convience script to upload deployment package and dependencies to an S3 bucket.</p></li>
</ul>
<p>To create a custom deployment package or dependencies package:</p>
<ul class="simple">
<li><p>Edit the <code class="docutils literal notranslate"><span class="pre">Dockerfile</span></code> or <code class="docutils literal notranslate"><span class="pre">handler.py</span></code> with desired changes</p>
<ul>
<li><p>To build using the local copy of the PODPAC repository,see comment in <code class="docutils literal notranslate"><span class="pre">Dockerfile</span></code> at ~L36.</p></li>
</ul>
</li>
<li><p>Build the deployment package and dependencies</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ bash build_lambda.sh
Creating docker image from podpac version master
podpac:master
...
Built podpac deployment package: podpac_dist.zip
Built podpac dependencies: podpac_deps.zip
</pre></div>
</div>
<ul class="simple">
<li><p>You can now use PODPAC to create a function from these local resources:</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">podpac</span>
<span class="c1"># configure settings</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"AWS_ACCESS_KEY_ID"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"access key id"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"AWS_SECRET_ACCESS_KEY"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"secrect access key"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"AWS_REGION_NAME"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"region name"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"S3_BUCKET_NAME"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"bucket name"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"FUNCTION_NAME"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"function name"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"FUNCTION_ROLE_NAME"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"role name"</span>
<span class="c1"># define node</span>
<span class="n">node</span> <span class="o">=</span> <span class="n">podpac</span><span class="o">.</span><span class="n">managers</span><span class="o">.</span><span class="n">aws</span><span class="o">.</span><span class="n">Lambda</span><span class="p">(</span><span class="n">function_source_dist_zip</span><span class="o">=</span><span class="s2">"dist/aws/podpac_dist.zip"</span><span class="p">,</span>
<span class="n">function_source_dependencies_zip</span><span class="o">=</span><span class="s2">"dist/aws/podpac_deps.zip"</span>
<span class="p">)</span>
<span class="c1"># build AWS resources</span>
<span class="n">node</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>
</pre></div>
</div>
<ul class="simple">
<li><p>You can also upload <code class="docutils literal notranslate"><span class="pre">podpac_dist.zip</span></code> and <code class="docutils literal notranslate"><span class="pre">podpac_deps.zip</span></code> to a public or user-accessible S3 bucket and build PODPAC functions from the remote bucket. The bash script <code class="docutils literal notranslate"><span class="pre">upload_lambda.sh</span></code> can do this for you if the <code class="docutils literal notranslate"><span class="pre">BUCKET</span></code> variable is customized.
We’ll assume you copy the files to <code class="docutils literal notranslate"><span class="pre">s3://my-bucket/directory/podpac_dist.zip</span></code> and <code class="docutils literal notranslate"><span class="pre">s3://my-bucket/directory/podpac_deps.zip</span></code>:</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">podpac</span>
<span class="c1"># configure settings</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"AWS_ACCESS_KEY_ID"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"access key id"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"AWS_SECRET_ACCESS_KEY"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"secrect access key"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"AWS_REGION_NAME"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"region name"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"S3_BUCKET_NAME"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"bucket name"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"FUNCTION_NAME"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"function name"</span>
<span class="n">settings</span><span class="p">[</span><span class="s2">"FUNCTION_ROLE_NAME"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"role name"</span>
<span class="c1"># define node</span>
<span class="n">node</span> <span class="o">=</span> <span class="n">podpac</span><span class="o">.</span><span class="n">managers</span><span class="o">.</span><span class="n">aws</span><span class="o">.</span><span class="n">Lambda</span><span class="p">(</span><span class="n">function_source_bucket</span><span class="o">=</span><span class="s2">"my-bucket"</span><span class="p">,</span>
<span class="n">function_source_dist_key</span><span class="o">=</span><span class="s2">"directory/podpac_dist.zip"</span><span class="p">,</span>
<span class="n">function_source_dependencies_key</span><span class="o">=</span><span class="s2">"directory/podpac_deps.zip"</span>
<span class="p">)</span>
<span class="c1"># build AWS resources</span>
<span class="n">node</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="earthdata.html" class="btn btn-neutral float-left" title="NASA Earth Data Login" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="api.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2017-2023, Creare.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>