-
Notifications
You must be signed in to change notification settings - Fork 12
Hyp3 Deployment ReadMe Edits #2999
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.
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
base: develop
Are you sure you want to change the base?
Conversation
| 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` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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" |
| 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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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) |
Adding in ReadMe clarifications and edits from my first hyp3 deployment.
Changes include: