diff --git a/docs/home/whats-new-2-18.md b/docs/home/whats-new-2-18.md new file mode 100644 index 0000000000..b5ac089a9a --- /dev/null +++ b/docs/home/whats-new-2-18.md @@ -0,0 +1,123 @@ +--- +title: Version 2.18 +summary: This article describes new features and functionality in the version. +authors: + - Jamie Weider + - Jason Novich +date: 2024-June-14 +--- + +## Release Content - June 30, 2024 + +* [Deprecation notifications](#deprecation-notifications) +* [Breaking changes](#breaking-changes) + +### Researcher + +#### Jobs, Workloads, and Workspaces + +* Added to UI backoff limit functionality to Training and Workspace workloads. The backoff limit is the maximum number of retry attempts for failed workloads. After reaching the limit, the workload's status will change to `Failed`. + +* Updated *Auto-deletion time* default value from **never** to **30 days**. The *Auto-deletion time* is determined when any Run:ai workload reaches a a completed, or failed status will be automatically deleted (including logs). This change only affects new or cloned workloads. + +* Added new *Data sources* of type *Secret* to workload form. *Data sources* of type *Secret* are used to hide 3rd party access credentials when submitting workloads. For more information, see [Workloads](). + +* Added new graphs for *Inference* workloads. The new graphs provide more information for *Inference* workloads to help analyze performance of the workloads. For more information, see [Workloads View](../admin/workloads/README.md#workloads-view). + +* Added latency metric for autoscaling. This feature is used to set a target threshold for the response time of requests. This will adjust the number of applications to keep the response time below that threshold. + +* Improved autoscaling for ChatUi models. Run:ai has improved autoscaling performance with ChatI models by adding them to *Environments*. ChatUi is an addition to inference workloads and is not mandatory for all types of workloads. + +* + +#### Command Line Interface + +* Added an improved researcher focused Command Line Interface (CLI). The improved CLI brings usability enhancements for researcher which include: + + * Support multiple clusters + * Self upgrade + * Interactive mode + * Align CLI to be data consistent with UI and API + * Improved usability and performance + + This is an early access feature available for customers to use; however be aware that there may be functional gaps versus the legacy CLI. + For more information about installing and using the Improved CLI, see [Improved CLI](../Researcher/cli-reference/new-cli/runai.md). + +#### GPU memory swap + +* Added new GPU to CPU memory swap. To ensure efficient usage of an organization’s resources, Run:ai provides multiple features on multiple layers to help administrators and practitioners maximize their existing GPUs resource utilization. Run:ai’s GPU memory swap feature helps administrators and AI practitioners to further increase the utilization of existing GPU HW by improving GPU sharing between AI initiatives and stakeholders. This is done by expending the GPU physical memory to the CPU memory which is typically an order of magnitude larger than that of the GPU. For more information see, [GPU Memory Swap](../Researcher/scheduling/gpu-memory-swap.md). + +#### YAML Workload Reference table + +* Added a new YAML reference document that contains the value types and workload YAML references. Each table contains the field name, its description and the supported Run:ai workload types. The YAML field details contains information on the value type and currently available example workload snippets. For more information see, [YAML Reference](). + +### Run:ai Administrator + +#### Data Sources + +* Added *Data Volumes* new feature. Data Volumes are snapshots of datasets stored in Kubernetes Persistent Volume Claims (PVCs). They act as a central repository for training data, and offer several key benefits. + + * Managed with dedicated permissions—Data Admins, a new role within Run.ai, have exclusive control over data volume creation, data population, and sharing. + * Shared between multiple scopes—unlike other Run:ai data sources, data volumes can be shared across projects, departments, or clusters. This promotes data reuse and collaboration within your organization. + * Coupled to workloads in the submission process—similar to other Run:ai data sources, Data volumes can be easily attached to AI workloads during submission, specifying the data path within the workload environment. + + For more information, see [Data Volumes](../developer/admin-rest-api/data-volumes.md). + +* Added new data source of type *Secret*. Run:ai now allows you to configure a *Credential* (Secret) as a data source. A *Data source* of type *Secret* is best used in workloads so that access to 3rd party interfaces and storage used in containers keep access credentials hidden. For more information, see [Secrets as a data source](../Researcher/user-interface/workspaces/create/create-ds.md#create-a-new-data-source#secret). + +#### Credentials + +* Added new *Generic secret* to the *Credentials*. *Credentials* had been used only for access to data sources (S3, Git, etc.). However, AI practitioners need to use secrets to access sensitive data (interacting with 3rd party APIs, or other services) without having to put their credentials in their source code. *Generic secrets* are best used as a data source of type *Secret* so that they can be used in containers to keep access credentials hidden. + +#### SSO + +* Added support for SSO using OpenShift v4 (OIDC based). When using OpenShift, you must first define OAuthClient which interacts with OpenShift's OAuth server to authenticate users and request access tokens. For more information, see [Single Sign-On](../admin/runai-setup/authentication/sso/). + +* Added OIDC scopes to authentication requests. OIDC Scopes are used to specify what access privileges are being requested for access tokens. The scopes associated with the access tokens determine what resource are available when they are used to access OAuth 2.0 protected endpoints. Protected endpoints may perform different actions and return different information based on the scope values and other parameters used when requesting the presented access token. For more information, see [UI configuration](../admin/runai-setup/authentication/sso/#step-1-ui-configuration). + +#### Ownership protection + +* Added new ownership protection feature. Run:ai *Ownership Protection* ensures that only authorized users can delete or modify workloads. This feature is designed to safeguard important jobs and configurations from accidental or unauthorized modifications by users who did not originally create the workload. For configuration information, see your Run:ai representative. + +#### System notifications + +* Added new system notifications feature. Email Notifications sends alerts for critical workload life cycle changes empowering data scientists to take necessary actions and prevent delays. + + * System administrators will need to configure the email notifications. For more information, see [System notifications](docs/admin/runai-setup/notifications/notifications.md). + * AI Practitioners will need to setup the types of notifications they want to receive. For more information, see [Email notifications](docs/Researcher/best-practices/researcher-notifications.md). + +## Deprecation Notifications + +Deprecation notifications allow you to plan for future changes in the Run:ai Platform. + +### Feature deprecations + +Deprecated features will be available for **two** versions ahead of the notification. For questions, see your Run:ai representative. + + + +### API support and endpoint deprecations + +The endpoints and parameters specified in the API reference are the ones that are officially supported by Run:ai. For more information about Run:ai's API support policy and deprecation process, see [Developer overview](../developer/overview-developer.md#api-support). + +#### Deprecated APIs and API fields + +##### Departments API + +| Deprecated | Replacement | +| --- | --- | +| /v1/k8s/clusters/{clusterId}/departments | /api/v1/org-unit/departments | +| /v1/k8s/clusters/{clusterId}/departments/{department-id} | /api/v1/org-unit/departments/{departmentId} | +| /v1/k8s/clusters/{clusterId}/departments/{department-id} | /api/v1/org-unit/departments/{departmentId}+PUT/PATCH /api/v1/org-unit/departments/{departmentId}/resources | + +##### Projects APi + +| Deprecated | Replacement | +| --- | --- | +| /v1/k8s/clusters/{clusterId}/projects | /api/v1/org-unit/projects | +| /v1/k8s/clusters/{clusterId}/projects/{id} | /api/v1/org-unit/projects/{projectId} | +| /v1/k8s/clusters/{clusterId}/projects/{id} | /api/v1/org-unit/projects/{projectId} + /api/v1/org-unit/projects/{projectId}/resources | + +## Breaking changes + +Breaking changes notifications allow you to plan around potential changes that may interfere your current workflow when interfacing with the Run:ai Platform. diff --git a/mkdocs.yml b/mkdocs.yml index 8828399004..b2ba745dee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -121,12 +121,14 @@ nav: - 'Overview': 'index.md' - 'System Components' : 'home/components.md' - 'Whats New' : + - 'home/whats-new-2-18.md' - 'home/whats-new-2-17.md' - 'home/whats-new-2-16.md' - 'Version 2.15' : 'home/whats-new-2-15.md' - 'Version 2.13' : 'home/whats-new-2-13.md' - 'Version 2.9' : 'home/whats-new-2-9.md' - 'Changelog': + - 'Hot Fixes for 2.17' : 'home/changelog/hotfixes-2-17.md' - 'Hot Fixes for 2.16' : 'home/changelog/hotfixes-2-16.md' - 'Hot Fixes for 2.15' : 'home/changelog/hotfixes-2-15.md' - 'Hot Fixes for 2.13' : 'home/changelog/hotfixes-2-13.md'