Sagemaker-ssh-helper

21 - don't update the pre-installed pip in SageMaker Studio that can cause issues with PyYAML

The `sm-local-ssh-ide` script now supports extra SSH args for forwarding additional ports:

sm-local-ssh-ide connect <kernel_gateway_name> [--ssh-only] [<extra_ssh_args>]


The new method `is_last_session_timeout()` to prevent unused resources for the placeholder job if there's were no SSM or SSH sessions for the specified period of time.

Documentation updates

New `train_placeholder.py` script that ends when sessions timeout.

Added section on [Forwarding TCP ports over SSH tunnel](https://github.com/aws-samples/sagemaker-ssh-helper#port-forwarding) - useful to access remote apps like Dask or Streamlit

20 - fixing location of SSH authorized keys to prevent `sm-local-ssh-ide` script from asking root password

Simplified CDK app deployment step in [IAM_SSM_Setup.md](IAM_SSM_Setup.md) (no need to clone the source code repo anymore)

Documentation updates

Simplified procedure with instructions for `~/.ssh/config`

FAQ - [I'm running SageMaker in a VPC. Do I need to make extra configuration?](FAQ.mdim-running-sagemaker-in-a-vpc-do-i-need-to-make-extra-configuration)

FAQ - [I'm using boto3 Python SDK instead of SageMaker Python SDK, how can I use SageMaker SSH Helper?](FAQ.mdim-using-boto3-python-sdk-instead-of-sagemaker-python-sdk-how-can-i-use-sagemaker-ssh-helper)

CDK deployment automation in [IAM_SSM_Setup.md](IAM_SSM_Setup.mdautomated-setup-with-cdk-and-cloud9)

Demonstrated the least privilege principle

12 - Removed EC2 instance from SSM setup

Speed up instance ID resolution with [SSMManager](sagemaker_ssh_helper/manager.py) (not using CloudWatch logs and [SSHLog](sagemaker_ssh_helper/log.py) anymore, except for endpoints)

Speed up instance ID resolution (not using CloudWatch logs anymore, except for endpoints)

4 - Notebook instances support

The command `sm-local-ssh-ide <<kernel_gateway_name>>` is becoming `sm-local-ssh-ide connect <<kernel_gateway_name>>` (added `connect` for consitency with other scripts)

New command: `sm-local-configure` to run on the local machine to install AWS CLI v2 and Sessions Manager plugin

17 - An option to start only SSH server inside SageMaker Studio: `sm-ssh-ide start --ssh-only`

Deregistering instances with timestamp: new parameter `--delete-older-than-n-days <N>`

New tags attached to an SSM instance, in addition to `SSHOwner`: `SSHCreator`, `SSHTimestamp`, `SSHResourceName` and `SSHResourceArn`.

Env variables passed to SSH helper change: instead of `SSH_SSM_TAGS` it now accepts only `SSH_OWNER_TAG`, other tags are calculated automatically. `SSH_LOG_TO_STDOUT` parameter is needed for notebook instances.

16 - China AWS Regions support

Stability, usability and performance improvements

Documentation updates

FAQ - [Are SageMaker notebook instances supported?](FAQ.mdare-sagemaker-notebook-instances-supported)

FAQ - [What if I want to use an estimator in a hyperparameter tuning job (HPO) and connect to a stuck training job with SSM?](FAQ.mdwhat-if-i-want-to-use-an-estimator-in-a-hyperparameter-tuning-job-hpo-and-connect-to-a-stuck-training-job-with-ssm)

FAQ - [How to configure an AWS CLI profile to work with SageMaker SSH Helper?](FAQ.mdhow-to-configure-an-aws-cli-profile-to-work-with-sagemaker-ssh-helper) (resolves 14)

Support [connecting to a different AWS Region](https://github.com/aws-samples/sagemaker-ssh-helper/blob/main/FAQ.md#how-to-start-a-job-with-sagemaker-ssh-helper-in-an-aws-region-different-from-my-default-one) by providing region_name in boto3 session and in AWS_REGION / AWS_DEFAULT_REGION env vars in CLI.

Stability fixes.

Documentation updates

FAQ - [How to troubleshoot jobs that are failing with the exception or error?](https://github.com/aws-samples/sagemaker-ssh-helper/blob/main/FAQ.md#how-to-troubleshoot-jobs-that-are-failing-with-the-exception-or-error)
FAQ - [I see folders like Desktop, Documents, Downloads, Pictures in SageMaker Studio, is it fine?](https://github.com/aws-samples/sagemaker-ssh-helper/blob/main/FAQ.md#i-see-folders-like-desktop-documents-downloads-pictures-in-sagemaker-studio-is-it-fine)
FAQ - [How do I automate my pipeline with SageMaker SSH Helper end-to-end?](https://github.com/aws-samples/sagemaker-ssh-helper/blob/main/FAQ.md#how-do-i-automate-my-pipeline-with-sagemaker-ssh-helper-end-to-end)

* Added support for batch transform - 10

* Fixed SKLearn support - 2

* Added support for basic estimator and improved support for other frameworks, including HuggingFace, TensorFlow and XGBoost.

* Added MultiDataModel support without a model object - 4

* Fix the `deregister_old_instances_from_ssm.py` to allow clean up instances with any role, not only those that contain ‘sagemaker’ - 8

* Possibility to override the public keys location path in S3 with SSH_AUTHORIZED_KEYS_PATH environment variable - 8

* Additional `sm-local-ssh-*` scripts to connect with SSH to processing, training, inference and batch transform containers.

* Fixing issue with sudo installation in some containers.

* Better support for the distributed multi-GPU scenarios.

* Improved logging (less noise)
* Fix minor issue with missing `jq` util in older Ubuntu versions
* IDE / SageMaker Studio scenario improvements:
* Adding lifecycle configuration script support for SageMaker Studio
* Refine IDE notebook
* Make it possible to override IDE settings by per-user ~/. files
* Update docs on switching IDE instances
* Make bootstrap procedure smoother – not need to stop old instance when starting a new one, the whole notebook can be restarted as many times as needed