Skip to content

Conversation

@ZachHoppinen
Copy link
Contributor

Adding in ReadMe clarifications and edits from my first hyp3 deployment.

Changes include:

  • Added in overall motivation for setting up a hyp3 deployment
  • clarify access key creation (I ended up doing this twice to rename and know where I would need to use it again)
  • Clarify Warning about deploying ASF CI/CD stack
  • Clarify formatting of editing asf.alaska.edu.db for SSL cert
  • add example formats for all items in environment
  • Clarify naming of github environment
  • Add tip on deleting rolled back stack before re-running failed job
  • clarify adding DNS record for API
  • Add section on "Testing and adding user credits"
  • Other small changes to make the flow actually match what you see on AWS

@ZachHoppinen ZachHoppinen requested review from a team as code owners January 14, 2026 19:29
1. Go to AWS console -> IAM -> Users -> github-actions -> security credentials tab -> "create access key".
2. Store the access key ID and secret access key using your team's password manager.
2. Select "Other" for key usage
3. Add tag value to describe the key such as `hyp3-foobar-access`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. Add tag value to describe the key such as `hyp3-foobar-access`
3. (Optional)Add tag value to describe the key, such as "For GitHub Actions CI/CD pipelines"

Comment on lines +256 to +258
Then copy past the add the validation record to a row of
https://gitlab.asf.alaska.edu/operations/puppet/-/edit/production/modules/legacy_dns/files/asf.alaska.edu.db
(see previous records for examples).
in the format `<CNAME_name> in CNAME <CNAME_value>.` (see previous records for examples).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Then copy past the add the validation record to a row of
https://gitlab.asf.alaska.edu/operations/puppet/-/edit/production/modules/legacy_dns/files/asf.alaska.edu.db
(see previous records for examples).
in the format `<CNAME_name> in CNAME <CNAME_value>.` (see previous records for examples).
Then create a validation record in
https://gitlab.asf.alaska.edu/operations/puppet/-/edit/production/modules/legacy_dns/files/asf.alaska.edu.db
of the form `<CNAME_name> in CNAME <CNAME_value>`, stripping the `.asf.alaska.edu` from the CNAME name (see previous records for examples).

### Create the HyP3 deployment

You will need to add the deployment to the matrix in an existing GitHub Actions `deploy-*.yml` workflow or create
You will need to add the deployment to the matrix in an existing GitHub Actions `deploy-*.yml` workflow (.github/workflows/) or create
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You will need to add the deployment to the matrix in an existing GitHub Actions `deploy-*.yml` workflow (.github/workflows/) or create
You will need to add the deployment to the matrix in an existing GitHub Actions `deploy-*.yml` workflow located in the `.github/workflows/` directory, or create

You will need to add the deployment to the matrix in an existing GitHub Actions `deploy-*.yml` workflow (.github/workflows/) or create
a new one for the deployment. If you need to create a new one, we recommend copying one of the
existing workflows, and then updating all of the fields
existing workflows, and then updating all of the fields.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
existing workflows, and then updating all of the fields.
existing workflows, and then updating all of the fields

#### Testing and adding user credits to your hyp3 deployment
After successful deployment and DNS record merging you can test you deployment by accessing the Swagger UI and using the POST /user tab to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After successful deployment and DNS record merging you can test you deployment by accessing the Swagger UI and using the POST /user tab to
After successfully deploying HyP3 and your new DNS record has taken effect (or you've edited your local DNS name resolution), you can test your deployment by accessing the Swagger UI and using the POST `/user` tab to

2. Edit your user (only present after using the Swagger UI in some way)
3. Add credits if neccessary
You can then return the Swagger UI and use the POST /jobs to run a test job and confirm it completes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can then return the Swagger UI and use the POST /jobs to run a test job and confirm it completes.
You can then return the Swagger UI and use the POST `/jobs` to run a test job and confirm it completes.

Comment on lines +336 to +342
check if your user is approved and has credits for running jobs on the deployment. This should automatically add your user to the DynamoDB
table.
AWS console -> DynamoDB -> Explore items
1. Find the table with format like `hyp3-foobar-UsersTable-XXXXXXXXXXXXX`
2. Edit your user (only present after using the Swagger UI in some way)
3. Add credits if neccessary
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
check if your user is approved and has credits for running jobs on the deployment. This should automatically add your user to the DynamoDB
table.
AWS console -> DynamoDB -> Explore items
1. Find the table with format like `hyp3-foobar-UsersTable-XXXXXXXXXXXXX`
2. Edit your user (only present after using the Swagger UI in some way)
3. Add credits if neccessary
check if your user is approved and has credits for running jobs on the deployment. You will need to be authenticated by either providing an Earthdata Login Bearer Token using the "Authorize" button, or by having a valid `asf-urs` cookie, typically logging into [Vertex](https://search.asf.alaska.edu). Interacting with HyP3 should automatically add your user to the DynamoDB table with the default number of credits (typically 0).
To add credits to your (or any) user, log in to the AWS console and navigate to DynamoDB -> Explore items, then:
1. Find the table with a format like `hyp3-foobar-UsersTable-XXXXXXXXXXXXX`
2. Edit your user record (only present after using the Swagger UI in some way)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants