Skip to content

docs(upgrade): add example 0.1.5 upgrade guide #4520

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.

Sign up for GitHub

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

Draft
matthewgrossman wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(upgrade): add example 0.1.5 upgrade guide #4520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/index.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@ navigation:
- section: "Upgrade Guides"
slug: upgrade
contents:
- page: "0.1.5"
path: upgrade/0-1-5.mdx
- page: "0.1.0"
path: upgrade/0-1-0.mdx
- folder: resources
Expand Down
18 changes: 18 additions & 0 deletions docs/upgrade/0-1-5.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
title: "Upgrade to NVIDIA OpenShell 0.1.5"
sidebar-title: "0.1.5"
description: "Prepare OpenShell operators and users for the changes in version 0.1.5."
keywords: "Generative AI, Cybersecurity, AI Agents, Sandboxing, Upgrade, Migration"
---

Review the changes that apply to your role before upgrading from 0.1.4. The [0.1.0 upgrade guide](/upgrade/0-1-0) covers upgrades from 0.0.x.

## Operators

- **Allowlist sandbox template pod annotations and labels.** The Kubernetes driver rejects sandbox template annotations and labels unless their keys are listed in `allowed_pod_annotations` or `allowed_pod_labels`. Both lists are empty by default. If API or SDK clients set `SandboxTemplate.annotations` or `SandboxTemplate.labels`, add those keys before upgrading. See [Kubernetes Driver](/how-it-works/sandboxes/runtimes#kubernetes-driver) and [PR #4497](https://github.com/NVIDIA/OpenShell/pull/4497).

## End users

- **Expect rejected template metadata on Kubernetes.** Sandbox creation fails with `InvalidArgument` when a template sets an annotation or label key that the gateway does not allow. The error lists the rejected keys. Ask your gateway administrator to allow the keys you need. The `openshell` CLI does not set template annotations or labels ([PR #4497](https://github.com/NVIDIA/OpenShell/pull/4497)).
Loading