9
0
Fork
You've already forked docs
1

refresh debugging enclave docs #11

Closed
xenushka wants to merge 0 commits from debugging-page-refresh into main
pull from: debugging-page-refresh
merge into: caution:main
caution:main
caution:xenushka/opengraph
caution:xenushka/diataxis-reorg
caution:docs/agentic-skills
caution:docs/hcl-sweep
caution:docs/caution-hcl-reference
caution:xenushka/byoc-rename
caution:ryansquared/add-eif-reproduction-notes
caution:add-docs-llms-txt
caution:what-is-caution
caution:security-assumptions-page
caution:containerize-application-guide
caution:custom-domains-howto
caution:verify-guide
caution:remove-disk-gb
caution:beta-updates
caution:cli-links
caution:key-services
caution:xen-mar-27
caution:managed-on-prem-doc
caution:ryansquared/keypair
caution:more-docs-edits
caution:jan13--kiki-edits

Summary

  • Refreshes the debugging guide and renames it to "Debug an enclave"
  • Reframes the page around the debugging flow: enable debug access, connect to the host, inspect startup, inspect services, and clean up
  • Clarifies the difference between debug: true and ssh_keys
  • Adds production cleanup guidance and safer warnings around debug mode and SSH access

Accuracy updates

  • Uses sudo for host-side Nitro, systemd, journal, and log commands
  • Updates the multiple ssh_keys example to match the Procfile parser
  • Uses vsock-proxy-<port>.service instead of hardcoding 8083
  • Keeps the guide focused on AWS Nitro Enclaves debugging commands
## Summary - Refreshes the debugging guide and renames it to "Debug an enclave" - Reframes the page around the debugging flow: enable debug access, connect to the host, inspect startup, inspect services, and clean up - Clarifies the difference between `debug: true` and `ssh_keys` - Adds production cleanup guidance and safer warnings around debug mode and SSH access ## Accuracy updates - Uses `sudo` for host-side Nitro, systemd, journal, and log commands - Updates the multiple `ssh_keys` example to match the Procfile parser - Uses `vsock-proxy-<port>.service` instead of hardcoding `8083` - Keeps the guide focused on AWS Nitro Enclaves debugging commands
@ -108,3 +120,3 @@
```
This lets you see boot output and application logs directly in your terminal without needing SSH, debug mode, or a full AWS deployment. Iterate on your Containerfile and Procfile locally, then deploy once things work.
Replace `<port>` with the application port from your `Procfile`.
Owner
Copy link

I think the default port we use is 8083

I think the default port we use is 8083
Author
Owner
Copy link

I checked the latest platform and cli code. The vsock proxy service is generated from the ports value in the app’s Procfile as vsock-proxy-${port}.service, and http_port defaults to the single configured port if only one is listed. I didn’t find a hardcoded app default of 8083; the current generated Procfile template comments ports: 8080 / http_port: 8080.

So I am updating the docs to use 8083 in the example command, but worded it as "These examples use port 8083. If your Procfile uses a different value in ports, replace 8083 with that port." That keeps the common/example value while staying accurate to the code behavior.

I checked the latest platform and cli code. The vsock proxy service is generated from the ports value in the app’s Procfile as vsock-proxy-${port}.service, and http_port defaults to the single configured port if only one is listed. I didn’t find a hardcoded app default of 8083; the current generated Procfile template comments ports: 8080 / http_port: 8080. So I am updating the docs to use 8083 in the example command, but worded it as "These examples use port 8083. If your Procfile uses a different value in ports, replace 8083 with that port." That keeps the common/example value while staying accurate to the code behavior.
Owner
Copy link

Merged via CLI

Merged via CLI
anton closed this pull request 2026年05月25日 16:13:09 +02:00

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
caution/docs!11
Reference in a new issue
caution/docs
No description provided.
Delete branch "debugging-page-refresh"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?