Skip to content

Commit 2df0dc7

Browse files
authored
skeleton of a decision reccord for #231
1 parent a033f24 commit 2df0dc7

1 file changed

Lines changed: 75 additions & 0 deletions

File tree

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Decision Record: [#231 AWS us-west-2 checking method](https://github.com/nsidc/earthaccess/issues/231)
2+
3+
- Status: draft <!-- optional -->
4+
- Deciders: @jhkennedy, @chuckwondo, @mfisher87, @Sherwin-14, @asteiker, @itcarroll
5+
- Date: 2025-05-13
6+
<!-- - Tags: [space and/or comma separated list of tags] optional -->
7+
8+
Technical Story: [#231 AWS us-west-2 checking method](https://github.com/nsidc/earthaccess/issues/231)
9+
10+
## Context and Problem Statement
11+
12+
There is a user-desire to know if they are working in the same region as the data, which is typically in `us-west-2` for NASA data (but not always), so that they can use `S3` aware tools and/or have more performant in-place access. However, there is no reliable way to do this in AWS. So, there's a question of how we should handle `S3` access on the UX side, and how we handle that technically.
13+
14+
15+
## Decision Drivers <!-- optional -->
16+
17+
- Earthaccess thus far has used `earthaccess.__store__.in_region: bool` to check if the user is in `us-west-2`, but this is NASA centric and not even uniform w/in NASA.
18+
- [driver 2, e.g., a force, facing concern, …]
19+
-<!-- numbers of drivers can vary -->
20+
21+
## Considered Options
22+
23+
1. Attempt to determine the region -- this is effectively a non-starter technically.
24+
2. Defult to S3 access and fall back to HTTPS
25+
3. Defult to HTTPS access and fall back to S3
26+
4. Allow users to select (2) or (3) and HTTP/S3 only
27+
28+
29+
## Decision Outcome
30+
31+
Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)].
32+
33+
### Positive Consequences <!-- optional -->
34+
35+
- [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]
36+
-
37+
38+
### Negative Consequences <!-- optional -->
39+
40+
- [e.g., compromising quality attribute, follow-up decisions required, …]
41+
-
42+
43+
## Pros and Cons of the Options <!-- optional -->
44+
45+
### [option 1]
46+
47+
[example | description | pointer to more information | …] <!-- optional -->
48+
49+
- Good, because [argument a]
50+
- Good, because [argument b]
51+
- Bad, because [argument c]
52+
-<!-- numbers of pros and cons can vary -->
53+
54+
### [option 2]
55+
56+
[example | description | pointer to more information | …] <!-- optional -->
57+
58+
- Good, because [argument a]
59+
- Good, because [argument b]
60+
- Bad, because [argument c]
61+
-<!-- numbers of pros and cons can vary -->
62+
63+
### [option 3]
64+
65+
[example | description | pointer to more information | …] <!-- optional -->
66+
67+
- Good, because [argument a]
68+
- Good, because [argument b]
69+
- Bad, because [argument c]
70+
-<!-- numbers of pros and cons can vary -->
71+
72+
## Links <!-- optional -->
73+
74+
- [Link type][link to adr] <!-- example: Refined by [xxx](yyyymmdd-xxx.md) -->
75+
-<!-- numbers of links can vary -->

0 commit comments

Comments
 (0)