Skip to content

Commit 2792cf9

Browse files
Update docs for new release
1 parent 3afc55e commit 2792cf9

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -640,6 +640,17 @@ Once configured, from the Launcher choose the environment, puck up the lifecycle
640640
sm-local-configure
641641
```
642642
643+
4. Set your SageMaker Studio domain ID and user profile name:
644+
645+
```bash
646+
sm-local-ssh-ide set-domain-id <<domain_id>>
647+
sm-local-ssh-ide set-user-profile-name <<user_profile_name>>
648+
```
649+
650+
Since SageMaker Studio app names are not unique across domains and user profiles, it will help to find the correct instance in a multi-user environment.
651+
652+
For your convenience, the domain ID and the user profile name are printed by the `sm-ssh-ide get-metadata` command when you run the notebook (check the cell output).
653+
643654
4. Start SSH tunnel and port forwarding from a terminal session as follows:
644655
645656
```shell
@@ -650,6 +661,8 @@ The parameter <<kernel_gateway_app_name>> is either taken from SageMaker Studio
650661
or from the image terminal as a `hostname` output, or you can find it in the list of running apps in AWS Console under Amazon SageMaker -> Control Panel -> User Details.
651662
It looks like this: `sagemaker-data-science-ml-m5-large-1234567890abcdef0`.
652663
664+
For your convenience, the app name is printed by the `sm-ssh-ide get-metadata` command when you run the notebook (check the cell output).
665+
653666
The local port `10022` will be connected to the remote SSH server port, to let you connect with SSH from IDE.
654667
In addition, the local port `8889` will be connected to remote Jupyter notebook port, the port `5901` to the remote VNC server
655668
and optionally the remote port `443` will be connected to your local PyCharm license server address.

images/Flow_IDE.png

455 Bytes
Loading

uml/Flow_IDE.puml

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ ssm_agent -> ssm: Go online
122122

123123

124124
note right dev
125-
sm-local-ssh-ide set-domain d-egm0dexample
126-
sm-local-ssh-ide set-user terry-whitlock
125+
sm-local-ssh-ide set-domain-id d-egm0dexample
126+
sm-local-ssh-ide set-user-profile-nam terry-whitlock
127127
end note
128128

129129
note right dev

0 commit comments

Comments
 (0)