Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #698

Merged
merged 2 commits into from
Feb 17, 2023
Merged

Update docs #698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd6fd81
Remove notices about S3 direct access being experimental
reweeden Feb 13, 2023
267c3c1
Clarify that version 1 of the AWS CLI is needed
reweeden Feb 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,6 @@ PRIVATE_BUCKETS:

#### S3 Direct Access

*NOTE: S3 direct access is currently experimental*

TEA can be deployed with an `/s3credentials` endpoint (See
[Enabling S3 direct access](deploying.md#enabling-s3-direct-access)) for
facilitating S3 direct access. Credentials handed out over this endpoint will
Expand Down
11 changes: 5 additions & 6 deletions docs/deploying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
You can either download [`deploy.sh`](https://github.com/asfadmin/thin-egress-app/blob/devel/build/deploy.sh)
and run it, or, as show below, curl the output directly into bash.

This bash script requires `curl`,
[`awscli`](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html),
[`Session Manager Plugin`](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html),
and [`jq`](https://github.com/stedolan/jq/wiki/Installation) to be
installed.
This bash script requires the following executables to be installed and
available on your PATH:
* `curl`
* [`awscli`](https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-install.html) version 1 with [`Session Manager Plugin`](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html). *NOTE: Only version 1 of the AWS CLI is supported for this script!*
* [`jq`](https://github.com/stedolan/jq/wiki/Installation)

Run `deploy.sh` by replacing all `<VARIABLES>` with the appropriate
values. `STACK-NAME` should be less than 20 characters, lower-case
Expand Down Expand Up @@ -241,7 +241,6 @@ Please see the
for current TEA deployment and configuration procedures.

### Enabling S3 direct access
*NOTE: Support for S3 direct access is currently experimental*

TEA supports handing out s3 direct access credentials over the optional
`/s3credentials` endpoint. This endpoint can be deployed by setting the
Expand Down
2 changes: 0 additions & 2 deletions docs/s3access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# S3 Direct Access

*NOTE: Support for S3 direct access is currently experimental*

You can retrieve temporary S3 credentials at the `/s3credentials` endpoint when
authenticated via Earthdata Login. These credentials will only be valid for
**1 hour** due to
Expand Down