frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated Debugging using with ssh for Github Actions (markdown)

clee2000
2023-07-10 14:15:44 -07:00
parent 3a5a3138a3
commit 3564210359
1 changed files with 6 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Debugging-using-with-ssh-for-Github-Actions.md

@ -1,8 +1,4 @@
# Debug using `with-ssh` for Github Actions
## Context
`with-ssh` is a feature for Github Actions that was created to replicate the features set of CircleCI’s [*Re-run with SSH*](https://circleci.com/docs/2.0/ssh-access-jobs/) feature that a lot of the development team is used to.
# SSH for Github Actions
## Platform availability:
@ -20,7 +16,6 @@
### Differences
* Only works for users who are connected to the Meta VPN
* Only works for `pull_request` events and will not work on *main branch* `push` events
## Known limitations
@ -29,12 +24,12 @@
## Workflow for users
1. Push a new commit / re-run completed workflows, see below for re-running jobs through the Github UI
1. ![image (1)](https://user-images.githubusercontent.com/1700823/130687616-eb899bd4-d5e3-441c-9134-6637c1b0857c.png)
1. Push a new commit / re-run completed workflows, see below for re-running jobs through the Github UI <br>
<img height="100" alt="image" src="https://github.com/pytorch/pytorch/assets/44682903/f6b3a114-ae25-4466-b9c9-ac9aa0f7db9b"> or <img height="100" alt="image" src="https://github.com/pytorch/pytorch/assets/44682903/6addb042-93a3-4462-a3bb-858196938bfa"> <br> Unfortunately, jobs can only be rerun after all jobs in the workflow are finished.
2. Traverse to logs for a `build` or `test` job that runs the `add-github-ssh-key` step added (currently all of our linux workflows have this enabled)
1. <img width="1254" alt="Screen Shot 2021-08-04 at 11 47 56 AM" src="https://user-images.githubusercontent.com/1700823/130687634-973fc0ac-558c-44eb-8568-eed10027062b.png">
<br> <img width="622" alt="image" src="https://github.com/pytorch/pytorch/assets/44682903/8cfbe3fe-305b-4676-a6bb-a2d5e57ead71">
3. Use the SSH command provided to log into the node (do this immediately, as the job will start cleaning up if it reaches the end without any active SSH session):
1. <img width="948" alt="Screen Shot 2021-08-04 at 11 49 25 AM" src="https://user-images.githubusercontent.com/1700823/130687653-b74ce62e-0e7b-40b0-9957-5d157a6b0c62.png">
<br> <img width="948" alt="Screen Shot 2021-08-04 at 11 49 25 AM" src="https://user-images.githubusercontent.com/1700823/130687653-b74ce62e-0e7b-40b0-9957-5d157a6b0c62.png">
## Notes for users
@ -111,4 +106,4 @@ aws ssm start-session --target i-0099d5a07d34e8904 --region us-east-1
### Caveats
* Nodes will still be reaped on their regular schedule
* Jobs will not wait for your session to finish before concluding
* There is no extra hold on the machine and the 2 hour timeout does not apply here, sessions will most likely end immediately at the next reap cycle
* There is no extra hold on the machine and the 2 hour timeout does not apply here, sessions will most likely end immediately at the next reap cycle