Skip to content

Improve suspend documentation to include -u none #276

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

Closed
youngm wants to merge 1 commit into from
Closed

Improve suspend documentation to include -u none #276

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion docs/framework-debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The framework can be configured by creating or modifying the [`config/debug.yml`
| ---- | -----------
| `enabled` | Whether to enable Java debugging
| `port` | The port that the debug agent will listen on. Defaults to `8000`.
| `suspend` | Whether to suspend execution until a debugger has attached. Note, enabling this may cause application start to timeout and be restarted.
| `suspend` | Whether to suspend execution until a debugger has attached. Note, you cannot ssh to a container until the container has decided the application is running. Therefore when enabling this setting you must also push the application using the parameter `-u none` which disables container health checking.

## Creating SSH Tunnel
After starting an application with debugging enabled, an SSH tunnel must be created to the container. To create that SSH container, execute the following command:
Expand Down