-
Notifications
You must be signed in to change notification settings - Fork 85
Add v1.1 Space parameters and addon version validation warning #421
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,7 +41,7 @@ hyp create hyp-space \ | |
| ````{tab-item} SDK | ||
| ```python | ||
| from sagemaker.hyperpod.space.hyperpod_space import HPSpace | ||
| from hyperpod_space_template.v1_0.model import SpaceConfig | ||
| from hyperpod_space_template.v1_1.model import SpaceConfig | ||
|
|
||
| # Create space configuration | ||
| space_config = SpaceConfig( | ||
|
|
@@ -66,16 +66,14 @@ When creating a space, you'll need to specify: | |
| | **display-name** | TEXT | Yes | Human-readable name for the space | | ||
| | **namespace** | TEXT | No | Kubernetes namespace | | ||
| | **image** | TEXT | No | Docker image for the workspace environment | | ||
| | **cpu** | TEXT | No | CPU resource request | | ||
| | **cpu-limit** | TEXT | No | CPU resource limit | | ||
| | **memory** | TEXT | No | Memory resource request | | ||
| | **memory-limit** | TEXT | No | Memory resource limit | | ||
| | **gpu** | TEXT | No | GPU resource request | | ||
| | **gpu-limit** | TEXT | No | GPU resource limit | | ||
| | **accelerator-partition-type** | TEXT | No | Fractional GPU partition type (e.g., 'mig-3g.20gb') | | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should these have been removed?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yea, I think we don't need to list exhaustively all the parameters in the getting_started doc. |
||
| | **accelerator-partition-count** | TEXT | No | Fractional GPU partition count | | ||
| | **volume** | TEXT | No | Volume configuration (can be specified multiple times) | | ||
| | **debug** | FLAG | No | Enable debug mode | | ||
| | **cpu** | TEXT | No | CPU resource request (e.g., '500m') | | ||
| | **memory** | TEXT | No | Memory resource request (e.g., '2Gi') | | ||
| | **gpu** | TEXT | No | GPU resource request (e.g., '1') | | ||
| | **volume** | TEXT | No | Volume configuration. Format: `name=<name>,mountPath=<path>,persistentVolumeClaimName=<pvc_name>` | | ||
| | **queue-name** | TEXT | No | Queue name for space scheduling. Required when task governance is enabled. | | ||
| | **template-ref** | TEXT | No | Reference to a WorkspaceTemplate. Format: `name=<name>,namespace=<namespace>` | | ||
|
|
||
| For the full list of parameters, see the [CLI reference](../cli/space/cli_space.md) or run `hyp create hyp-space --help`. | ||
|
|
||
|
|
||
| ## Managing Spaces | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,21 @@ | ||
| ## v1.1.0 (2026-04-20) | ||
|
|
||
| ### Features | ||
|
|
||
| * Added `access_type` parameter to control who can connect to the workspace (`Public` or `OwnerOnly`) | ||
| * Added `env` parameter for specifying environment variables for the workspace container | ||
| * Added `access_strategy` parameter to reference a WorkspaceAccessStrategy | ||
| * Added `pod_security_context` parameter for pod-level security context configuration | ||
| * Added `container_security_context` parameter for container-level security context configuration | ||
| * Added `init_containers` parameter to run init containers before the workspace container starts | ||
| * Added `queue_name` and `priority` parameters for task governance support (Kueue integration) | ||
|
|
||
| ### Changes | ||
|
|
||
| * Bumped minimum addon version from `0.1.1` to `0.1.6` | ||
|
|
||
| ## v1.0.0 (2025-11-20) | ||
|
|
||
| ### Features | ||
|
|
||
| * HyperPod Dev Spaces template for data scientists to create, manage, and access interactive ML development environments with configurable resource allocation and namespace isolation | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,9 @@ | |
| from typing import Optional, List, Dict, Literal, Any | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does this mean users with older add on versions like 0.1.1 will still be able to use this hyperpod cli version? Another option would be to say this HP CLI version is not compatible with add on <0.1.6, and customer can either downgrade HP CLI or upgrade their add on. Was this considered?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If the customer is using addon 0.1.1 and trying to use the new v1.1 parameters, it will warn them of this issue because its |
||
| from enum import Enum | ||
|
|
||
| # Minimum amazon-sagemaker-spaces addon version required for this template version | ||
| MIN_ADDON_VERSION = "0.1.1" | ||
|
|
||
|
|
||
| class OwnershipType(str, Enum): | ||
| PUBLIC = "Public" | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"). You | ||
| # may not use this file except in compliance with the License. A copy of | ||
| # the License is located at | ||
| # | ||
| # http://aws.amazon.com/apache2.0/ | ||
| # | ||
| # or in the "license" file accompanying this file. This file is | ||
| # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF | ||
| # ANY KIND, either express or implied. See the License for the specific | ||
| # language governing permissions and limitations under the License. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The queue name is based on the namespace, right? Should we just fill this in for them? If they submit a workspace without a queue name it won't get scheduled.