NVIDIA / NVIDIA/OpenShell

test: establish Docker Compose support and add smoke coverage

Open
#2,919 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

state:stale
Dominant language
Rust
Stars
8.7k
Forks
1.3k
Avg merge
2d 11h
Merged PRs (30d)
253

Description

Description

Establish whether the checked-in Docker Compose deployment is a supported OpenShell configuration. If it is supported, add automated Compose-based smoke coverage that verifies the user-facing path from starting the gateway through creating a Docker-backed sandbox.

Context

The Compose deployment currently lacks end-to-end coverage. Issue #2891 reports that its gateway cannot create sandboxes because gateway JWT material is not configured. This work should make the supported-configuration decision explicit and prevent compatible deployment regressions from escaping without a runnable check.

Definition of Done

  • Maintainers record whether deploy/docker/docker-compose.yml is a supported configuration, including the intended support boundary.
  • If supported, automated coverage starts the Compose deployment with mutually compatible gateway and CLI artifacts and creates a Docker-backed sandbox.
  • The smoke test checks the externally documented readiness/health behavior that users are expected to rely on.
  • The test exercises the sandbox authentication path, including the configuration required to prevent #2891.
  • If Compose is not supported, documentation and the deployment artifact clearly communicate the unsupported or experimental status instead of implying a maintained quickstart.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting deploy/docker/docker-compose.yml and the failure described in issue #2891, then identify the documented readiness and health behavior plus the gateway authentication configuration. Determine with maintainers whether Compose is supported; if so, add runnable smoke coverage for startup and Docker-backed sandbox creation, otherwise update the deployment artifact and documentation to state its status.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose
Domain
devops, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.