Skip to content

Commit 715378d

Browse files
jasonnovichRunAIjasonnovichRunAI
authored
Merge pull request #772 from gal-revach/patch-17
Update API deprecations for 2.17
2 parents cb62c8f + b664629 commit 715378d

File tree

2 files changed

+86
-19
lines changed

2 files changed

+86
-19
lines changed

‎docs/developer/overview-developer.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ Developers can access Run:ai through various programmatic interfaces.
1212

1313
The endpoints and parameters specified in the API reference are the ones that are officially supported by Run:ai. Endpoints and parameters that are **NOT** listed in the reference are not officially supported.
1414

15-
Endpoints and parameters marked as `deprecated` means they remain operational and can be used; however, Run:ai will **NO LONGER RECOMMEND USING THEM**, **WILL NOT ADD FUNCTIONALITY TO THEM**, and **WILL NO LONGER BE SUPPORTED AFTER**
16-
17-
Option1 : <#of versions>
18-
Option 2: <time period>.
15+
API endpoints and fields marked as `deprecated` remain operational and can be used; however, Run:ai will **NO LONGER RECOMMEND USING THEM**, **WILL NOT ADD FUNCTIONALITY TO THEM**, and **WILL STOP SUPPORTING THEM** after 2 major releases (for self-hosted deployments), and after 6 months of support for SaaS deployments.
1916

2017
For details, see the [Deprecation notifications](../home/whats-new-2-17.md#deprecation-notifications).
2118

‎docs/home/whats-new-2-17.md

Lines changed: 85 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -128,30 +128,100 @@ Deprecated features will be available for **two** versions ahead of the notifica
128128

129129
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#overview-developer-documentation).
130130

131-
The following list of API endpoints have been marked for deprecation:
131+
#### Deprecated APIs and API fields
132132

133-
#### Jobs, events, pods API (replaced by workloads/pods/events)
133+
The following list of API endpoints and fields that have been marked for deprecation:
134134

135-
| Deprecated endpoint | Replacement endpoint |
135+
##### Jobs and Pods API
136+
137+
| Deprecated | Replacement |
138+
| -- | -- |
139+
| /v1/k8s/clusters/{uuid}/jobs | /api/v1/workloads |
140+
| /v1/k8s/clusters/{uuid}/jobs/count | /api/v1/workloads/count |
141+
| /v1/k8s/clusters/{uuid}/jobs/{jobId}/pods | /api/v1/workloads/{workloadId}/pods |
142+
| /v1/k8s/clusters/{uuid}/pods | /api/v1/workloads/pods |
143+
144+
##### Clusters API
145+
146+
| Deprecated | Replacement |
136147
| -- | -- |
137-
| https://app.run.ai/v1/k8s/clusters/{uuid}/jobs | https://app.run.ai/api/v1/workloads |
138-
| https://app.run.ai/v1/k8s/clusters/{uuid}/jobs/count | https://app.run.ai/api/v1/workloads/count |
139-
| https://app.run.ai/v1/k8s/clusters/{uuid}/jobs/{jobId}/pods | https://app.run.ai/api/v1/workloads/{workloadId}/pods |
140-
| https://app.run.ai/v1/k8s/clusters/{uuid}/pods | https://app.run.ai/api/v1/workloads/pods |
148+
| /v1/k8s/clusters/{clusterUuid}/metrics | /api/v1/clusters/{clusterUuid}/metrics |
141149

142-
#### Users, Applications, and Groups API
150+
##### Authorization and Authentication API
143151

144-
| Deprecated endpoint | Replacement endpoint |
152+
| Deprecated | Replacement |
145153
| -- | -- |
146-
| https://app.run.ai/v1/k8s/apps | https://app.run.ai/api/v1/k8s/apps |
147-
| https://app.run.ai/v1/k8s/users | https://app.run.ai/api/v1/k8s/users |
148-
| https://app.run.ai/v1/k8s/groups | https://app.run.ai/api/v1/authorization/access-rules (groups should no longer be created, you can only add access rules to them) |
154+
| /v1/k8s/auth/token/exchange | /api/v1/token |
155+
| /v1/k8s/auth/oauth/tokens/refresh | /api/v1/token |
156+
| /v1/k8s/auth/oauth/apptoken | /api/v1/token |
157+
| /v1/k8s/users/roles | /api/v1/authorization/roles |
158+
| /v1/k8s/users | /api/v1/users |
159+
| /v1/k8s/users/{userId} | /api/v1/users/{userId} |
160+
| /v1/k8s/users/{userId}/roles | /api/v1/authorization/access-rules |
161+
| /v1/k8s/apps | /api/v1/apps |
162+
| /v1/k8s/apps/{clientId} | /api/v1/apps/{appId} |
163+
| /v1/k8s/groups | /api/v1/authorization/access-rules |
164+
| /v1/k8s/groups/{groupName} | /api/v1/authorization/access-rules |
165+
| /v1/k8s/clusters/{clusterId}/departments/{department-id}/access-control | /api/v1/authorization/access-rules |
166+
| /api/v1/authorization/access-rules - `subjectIdFilter` field | Use `filterBy` / `sortBy` fields |
167+
| /api/v1/authorization/access-rules - `scopeType` field | Use `filterBy` / `sortBy` fields |
168+
| /api/v1/authorization/access-rules - `roleId` field | Use `filterBy` / `sortBy` fields |
169+
170+
##### Projects API
171+
172+
| Deprecated | Replacement |
173+
| -- | -- |
174+
| /v1/k8s/clusters/{clusterId}/projects - `permissions` field | /api/v1/authorization/access-rules |
175+
| /v1/k8s/clusters/{clusterId}/projects - `resources` field | Use `nodePoolResources` field |
176+
| /v1/k8s/clusters/{clusterId}/projects - `deservedGpus` field | Use `nodePoolResources` field |
177+
| /v1/k8s/clusters/{clusterId}/projects - `maxAllowedGpus` field | Use `nodePoolResources` field |
178+
| /v1/k8s/clusters/{clusterId}/projects - `gpuOverQuotaWeight` field | Use `nodePoolResources` field |
179+
180+
##### Departments API
181+
182+
| Deprecated | Replacement |
183+
| -- | -- |
184+
| /v1/k8s/clusters/{clusterId}/departments - `resources` field | Use `nodePoolResources` field |
185+
| /v1/k8s/clusters/{clusterId}/departments - `deservedGpus` field | Use `nodePoolResources` field |
186+
| /v1/k8s/clusters/{clusterId}/departments - `allowOverQuota` field | Use `nodePoolResources` field |
187+
| /v1/k8s/clusters/{clusterId}/departments - `maxAllowedGpus` field | Use `nodePoolResources` field |
188+
189+
##### Policy API
190+
191+
| Deprecated | Replacement |
192+
| -- | -- |
193+
| /api/v1/policy/workspace | /api/v2/policy/workspaces |
194+
| /api/v1/policy/training | /api/v2/policy/trainings |
195+
196+
#### Removed APIs and API fields (completed deprecation)
197+
198+
The following list of API endpoints and fields that have completed their deprecation process and therefore will be changed as follows:
149199

150-
#### Cluster metrics v1 (replaced by v2)
200+
##### Assets API
151201

152-
| Deprecated endpoint | Replacement endpoint |
202+
| Endpoint | Change |
153203
| -- | -- |
154-
| https://app.run.ai/v1/k8s/clusters/{clusterUuid}/metrics | https://app.run.ai/api/v2/clusters/{clusterUuid}/metrics |
204+
| /api/v1/asset/compute | `gpuRequest` field was removed and is replaced by the following fields `gpuDevicesRequest`, `gpuRequestType`, `gpuPortionRequest`, `gpuPortionLimit`, `gpuMemoryRequest`, `gpuMemoryLimit`, `migProfile` |
205+
206+
### Metrics deprecations
207+
208+
The following metrics are deprecated and replaced by API endpoints. For details about the replacement APIs, see [Changed Metrics](../developer/metrics/metrics.md#changed-metrics-and-api-mapping):
209+
210+
| Metric |
211+
| -- |
212+
| runai\_active\_job\_cpu\_requested\_cores |
213+
| runai\_active\_job\_memory\_requested\_bytes |
214+
| runai\_cluster\_cpu\_utilization |
215+
| runai\_cluster\_memory\_utilization |
216+
| runai\_gpu\_utilization\_per\_pod\_per\_gpu |
217+
| runai\_gpu\_utilization\_per\_workload |
218+
| runai\_job\_requested\_gpu\_memory |
219+
| runai\_gpu\_memory\_used\_mebibytes\_per\_workload |
220+
| runai\_gpu\_memory\_used\_mebibytes\_per\_pod\_per\_gpu |
221+
| runai\_active\_job\_cpu\_limits |
222+
| runai\_job\_cpu\_usage |
223+
| runai\_active\_job\_memory\_limits |
224+
| runai\_job\_memory\_used\_bytes |
155225

156226
## Breaking changes
157227

0 commit comments

Comments
 (0)