Skip to content

Commit 36ad7f2

Browse files
committed
chore: merge main
Signed-off-by: Eric Curtin <[email protected]>
2 parents 6e31232 + 32dcc4a commit 36ad7f2

159 files changed

Lines changed: 10363 additions & 1708 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.agents/skills/create-security-advisory/SKILL.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ metadata:
1010
Prepare every report with the required [advisory template](assets/advisory-template.md);
1111
keep GitHub metadata separate from its description.
1212

13+
Keep the [private reporting form](../../../.github/VULNERABILITY_REPORT.yml) and
14+
the template aligned when changing report requirements.
15+
1316
## Scope and privacy
1417

1518
Follow the repository's current [SECURITY.md](../../../SECURITY.md). This contributor

‎.agents/skills/create-security-advisory/assets/advisory-template.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ revision. State who verified what and any failed attempts or limitations.}}
2828
## Additional details
2929

3030
{{Optional: include supported details that help review, such as the root cause,
31-
severity rationale and CVSS/CWE, a proposed fix or verified workaround, known
32-
unaffected deployments, or a related private PR. Omit this section if none are available.}}
31+
severity rationale and CVSS/CWE, existing CVE identifiers, disclosure deadlines,
32+
a proposed fix or verified workaround, known unaffected deployments, or a related
33+
private PR. Omit this section if none are available.}}
3334

3435
## Open questions
3536

‎.agents/skills/helm-dev-environment/SKILL.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,16 @@ public `SandboxStatus` image fields. Resume a pending operation with
445445
`SandboxUpdates.UpdateSandbox`, the current resource version, and no selected
446446
fields, following the documented request-ID semantics.
447447

448+
449+
For the opt-in application listener, build/import matching branch images and run
450+
`mise run e2e:kubernetes:app-listener`; see `e2e/kubernetes/app-listener/README.md`
451+
for image, topology, delivery-mode and takeover inputs. The task owns an isolated
452+
Helm release/namespace, temporary TLS material, in-cluster clients, teardown and
453+
evidence under `results/app-listener/`. It checks policy denial, Pod-IP ingress without app Services, shared-owner takeover, gateway-outage expiry and disabled-listener
454+
gateway compatibility, without discovery or a proxy. CI runs four cases under
455+
`test:e2e` and includes them in `Core E2E result`. Its reusable kind setup installs
456+
pinned Calico only for this lane; other jobs retain kindnet. Local k3s already
457+
enforces policy. The lower-level `verify.py` can target a predeployed release.
448458
The kube e2e wrapper creates only one port-forward, to `svc/openshell`; it no
449459
longer forwards the unauthenticated health listener or runs a `/readyz` e2e
450460
target. `/readyz` remains covered by server unit/integration tests.
@@ -645,3 +655,14 @@ identity and contents, command/environment changes, and request replay.
645655
`OPENSHELL_E2E_UPDATE_ORIGINAL_IMAGE` and `OPENSHELL_E2E_UPDATE_TARGET_IMAGE` can
646656
select mirrored Alpine 3.21 and 3.22 manifests. Defaults use the public registry
647657
cache; keep immutable digests when overriding them.
658+
659+
## App listener fixture
660+
661+
The opt-in `deploy/helm/openshell/ci/values-app-listener.yaml` enables the
662+
supervisor listener at port 9443 without discovery or a proxy. Provision the
663+
operator TLS Secret and an ingress-client NetworkPolicy first. Follow
664+
`e2e/kubernetes/app-listener/README.md` for direct in-cluster verification,
665+
shared-member selection, and the HA follow-up checks. Keep the fixture disabled
666+
in default profiles. Dedicated and shared supervisors expose app ports on their
667+
Pod IPs without app Services. Select the member owning the sandbox; automatic
668+
owner selection belongs to the later discovery API.

‎.agents/skills/release-captain/SKILL.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ tag, or start a second `Pre-release` run for a tag; it has no concurrency guard.
4141
- `Release` (`release.yml`) is dispatched by hand with the stable version. It
4242
picks the highest `-pre.N` on `main` whose whole `Pre-release` run passed,
4343
creates the stable tag on that commit, and publishes without requalifying.
44+
- Stable releases publish public schemas to `buf.build/openshell/core` with
45+
the release tag as the label; prereleases skip Buf publication. The Buf
46+
repository must exist and Actions must have a `BUF_TOKEN` secret with write
47+
access. A failed Buf push fails the release run; follow Recovery before
48+
rerunning the failed publication job.
4449

4550
## Setup
4651

‎.agents/skills/release-openshell/SKILL.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,11 @@ updating a Snap Store support track. Docs retain an
8383
immutable version and advance latest only for a newer version.
8484

8585
Watch the stable release run and report its result.
86+
87+
## PyPI publishing
88+
89+
Stable releases publish the built Python wheel directly to PyPI from the `publish-pypi` job in `release.yml`, after the other release publishers succeed. The job downloads the wheel from the stable GitHub Release, not the run's build artifact, and checks the stable tag's source commit and the wheel's release checksum. It uses Trusted Publishing with the `pypi` GitHub environment. Configure the `openshell` PyPI project's GitHub publisher with owner `NVIDIA`, repository `OpenShell`, workflow `release.yml`, and environment `pypi`. No PyPI API token or GitLab trigger credentials are required.
90+
91+
The environment must allow the branch used to dispatch Release. For a support release, explicitly allow its support branch before dispatching. Required reviewers, if configured, must approve the PyPI job. Stable docs publish after PyPI succeeds. An existing wheel on PyPI is skipped when retrying Release; PyPI does not allow replacing a published wheel. Because the job publishes the release asset, a new Release run for the same tag can finish a failed PyPI upload.
92+
93+
Development and prerelease wheels remain GitHub Release assets and do not publish to PyPI.

‎.agents/skills/watch-github-actions/SKILL.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,13 @@ gh run list --json databaseId,status,headBranch,url --jq '.[] | {id: .databaseId
125125

126126
## View Job Logs
127127

128-
For tmachine Kubernetes conformance failures, inspect the `e2e-results-conformance-sandbox-ubuntu-k3s-*` artifact. Its `diagnostics/` holds the K3s report with Agent Sandbox controller state, leader leases, events, and current and previous controller logs. The k3s installers check reconciliation after guest boot with a temporary scheduling-gated Sandbox probe, so a failed probe fails provisioning before any test runs. Distinguish a failed controller probe from a failed conformance scenario; gateway connectivity and controller Deployment availability do not prove reconciliation works.
128+
For Kubernetes app-listener E2E failures during kind setup, inspect the uploaded
129+
`results/app-listener/cni-setup/` evidence. It includes node and Calico pod
130+
descriptions, events, and current/previous container logs. A CNI rollout timeout
131+
occurs before the listener tests run; use these diagnostics to distinguish image
132+
pulls, init failures, and readiness failures.
133+
134+
For tmachine Kubernetes conformance failures, inspect the `e2e-results-conformance-conformance-ubuntu-k3s-*` artifact. Its `diagnostics/` holds the K3s report with Agent Sandbox controller state, leader leases, events, and current and previous controller logs. The k3s installers check reconciliation after guest boot with a temporary scheduling-gated Sandbox probe, so a failed probe fails provisioning before any test runs. Distinguish a failed controller probe from a failed conformance scenario; gateway connectivity and controller Deployment availability do not prove reconciliation works.
129135

130136
For the `e2e-suites` lane (`.github/workflows/e2e-suites.yml`), the last lines of the job log give the runner's result: PASS, FAIL (exit 1) after the end of the nextest log (which names the failed tests), or ERROR (exit 2) with the step that broke. FAIL and ERROR also appear as annotations on the run's summary page. Then inspect the `e2e-results-<family>-<package>-<environment>-<installer>` artifact, which holds `junit.xml`, `nextest.log` and, after a failure, the guest's `diagnostics/`.
131137

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ contact_links:
1515
url: https://github.com/NVIDIA/OpenShell/blob/main/SECURITY.md
1616
about: >
1717
Do not report security vulnerabilities through GitHub issues. Follow
18-
the disclosure process in SECURITY.md — report through the NVIDIA PSIRT
19-
web form or email [email protected].
18+
the disclosure process in SECURITY.md — use GitHub's private vulnerability
19+
reporting form.

‎.github/VULNERABILITY_REPORT.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Keep the sections and prompts aligned with
2+
# .agents/skills/create-security-advisory/assets/advisory-template.md.
3+
name: Private vulnerability report
4+
description: Report an OpenShell vulnerability privately using the required advisory template.
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Follow [SECURITY.md](https://github.com/NVIDIA/OpenShell/blob/main/SECURITY.md) and the [advisory template](https://github.com/NVIDIA/OpenShell/blob/main/.agents/skills/create-security-advisory/assets/advisory-template.md).
10+
11+
Review the report and verify its accuracy before submitting. Distinguish reproduced behavior, code inspection, and unverified claims. Remove secrets and personal information from evidence.
12+
13+
- type: textarea
14+
id: summary-and-impact
15+
attributes:
16+
label: Summary and impact
17+
description: Describe what the attacker can do, which security boundary should prevent it, and the demonstrated impact. Separate unverified consequences.
18+
placeholder: Summarize the vulnerability and its impact in two or three sentences.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: scope-and-prerequisites
24+
attributes:
25+
label: Scope and prerequisites
26+
description: Include each item below. Separate the tested revision from confirmed affected releases. For unknowns, state what needs checking.
27+
placeholder: |
28+
- Product and tested version: Component, release or full commit SHA; image digest if relevant.
29+
- Affected versions: Confirmed release range and evidence, or Unknown with the needed check.
30+
- Environment and configuration: Relevant OS, runtime/driver, topology, and exact settings; default or opt-in.
31+
- Attacker access: Starting privileges, controlled input, and resources in scope.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: reproduction-and-evidence
37+
attributes:
38+
label: Reproduction and evidence
39+
description: Provide reproduction steps and observed results, or concrete code evidence of the attack path. State what was verified and what was not run; scanner output alone is insufficient.
40+
placeholder: |
41+
Verification status: Reproduced / code inspection only / reporter claim not reproduced.
42+
43+
1. Operator setup: Minimal prerequisites, test resources, and copyable commands/configuration.
44+
2. Attacker actions: Exact steps under the privileges stated above.
45+
3. Check: Read back the response or state change that demonstrates the impact.
46+
47+
Expected: Security-preserving behavior; link the applicable policy, contract, or enforcing code.
48+
Observed: Actual result and concise redacted output; if not executed, say so.
49+
50+
Link the source report, private artifacts, and relevant code at an immutable revision.
51+
State who verified what and any failed attempts or limitations.
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: additional-details
57+
attributes:
58+
label: Additional details
59+
description: Include supported optional details that help review. Leave blank if none are available.
60+
placeholder: |
61+
Root cause, severity rationale and CVSS/CWE, existing CVE identifiers,
62+
disclosure deadlines, a proposed fix or verified workaround, known
63+
unaffected deployments, or a related private PR.
64+
validations:
65+
required: false
66+
67+
- type: textarea
68+
id: open-questions
69+
attributes:
70+
label: Open questions
71+
description: List missing evidence that affects the assessment and the next check for each gap. Leave blank if there are no known gaps.
72+
validations:
73+
required: false

‎.github/actions/setup-e2e-kind/action.yml‎

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ inputs:
2929
description: mise release to install
3030
required: false
3131
default: v2026.9.9
32+
enforce-network-policy:
33+
description: Replace kindnet with pinned Calico for NetworkPolicy assertions
34+
required: false
35+
default: "false"
3236

3337
runs:
3438
using: composite
@@ -45,11 +49,72 @@ runs:
4549
REGISTRY_PASSWORD: ${{ inputs.registry-password }}
4650
run: echo "$REGISTRY_PASSWORD" | docker login "${REGISTRY%%/*}" -u "$REGISTRY_USERNAME" --password-stdin
4751

52+
- name: Configure policy-enforcing kind network
53+
id: kind-config
54+
if: inputs.enforce-network-policy == 'true'
55+
shell: bash
56+
run: |
57+
set -euo pipefail
58+
config="$RUNNER_TEMP/kind-network-policy.yaml"
59+
cat > "$config" <<'YAML'
60+
kind: Cluster
61+
apiVersion: kind.x-k8s.io/v1alpha4
62+
networking:
63+
disableDefaultCNI: true
64+
podSubnet: 10.244.0.0/16
65+
YAML
66+
echo "path=$config" >> "$GITHUB_OUTPUT"
67+
4868
- name: Create kind cluster
4969
uses: helm/kind-action@ef37e7f390d99f746eb8b610417061a60e82a6cc # v1.14.0
5070
with:
5171
cluster_name: ${{ inputs.cluster-name }}
52-
wait: 120s
72+
# Nodes cannot become Ready until the following CNI installation.
73+
wait: ${{ inputs.enforce-network-policy == 'true' && '0s' || '120s' }}
74+
config: ${{ steps.kind-config.outputs.path }}
75+
76+
- name: Install policy-enforcing CNI
77+
if: inputs.enforce-network-policy == 'true'
78+
shell: bash
79+
env:
80+
CLUSTER_NAME: ${{ inputs.cluster-name }}
81+
CALICO_VERSION: v3.30.3
82+
run: |
83+
set -euo pipefail
84+
collect_cni_diagnostics() {
85+
failure_status=$?
86+
set +e
87+
diagnostics="$GITHUB_WORKSPACE/results/app-listener/cni-setup"
88+
mkdir -p "$diagnostics"
89+
kubectl --context "kind-$CLUSTER_NAME" get nodes -o wide > "$diagnostics/nodes.txt" 2>&1
90+
kubectl --context "kind-$CLUSTER_NAME" describe nodes > "$diagnostics/node-details.txt" 2>&1
91+
kubectl --context "kind-$CLUSTER_NAME" -n kube-system get pods -o wide > "$diagnostics/pods.txt" 2>&1
92+
kubectl --context "kind-$CLUSTER_NAME" -n kube-system get events --sort-by=.lastTimestamp > "$diagnostics/events.txt" 2>&1
93+
for component in calico-node calico-kube-controllers; do
94+
kubectl --context "kind-$CLUSTER_NAME" -n kube-system describe pods -l "k8s-app=$component" > "$diagnostics/$component-details.txt" 2>&1
95+
kubectl --context "kind-$CLUSTER_NAME" -n kube-system logs -l "k8s-app=$component" --all-containers --prefix --tail=200 > "$diagnostics/$component.log" 2>&1
96+
kubectl --context "kind-$CLUSTER_NAME" -n kube-system logs -l "k8s-app=$component" --all-containers --prefix --tail=200 --previous > "$diagnostics/$component-previous.log" 2>&1
97+
done
98+
cat "$diagnostics/pods.txt" "$diagnostics/events.txt"
99+
exit "$failure_status"
100+
}
101+
trap collect_cni_diagnostics ERR
102+
curl -fsSL "https://raw.githubusercontent.com/projectcalico/calico/$CALICO_VERSION/manifests/calico.yaml" \
103+
-o "$RUNNER_TEMP/calico.yaml"
104+
sed '[email protected]/[email protected]/16@g' "$RUNNER_TEMP/calico.yaml" > "$RUNNER_TEMP/calico-kind.yaml"
105+
# The kind node's containerd pulls Docker Hub anonymously and is rate
106+
# limited. The host daemon pulls through the runner's registry mirror.
107+
for component in cni node kube-controllers; do
108+
image="docker.io/calico/$component:$CALICO_VERSION"
109+
archive="$RUNNER_TEMP/calico-$component-linux-amd64.tar"
110+
docker pull --platform linux/amd64 "$image"
111+
docker image save --platform linux/amd64 --output "$archive" "$image"
112+
kind load image-archive "$archive" --name "$CLUSTER_NAME"
113+
done
114+
kubectl --context "kind-$CLUSTER_NAME" apply -f "$RUNNER_TEMP/calico-kind.yaml"
115+
kubectl --context "kind-$CLUSTER_NAME" -n kube-system rollout status daemonset/calico-node --timeout=300s
116+
kubectl --context "kind-$CLUSTER_NAME" -n kube-system rollout status deployment/calico-kube-controllers --timeout=300s
117+
kubectl --context "kind-$CLUSTER_NAME" wait nodes --all --for=condition=Ready --timeout=120s
53118
54119
- name: Export kind kubeconfig to mise path
55120
shell: bash

‎.github/workflows/branch-checks.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ jobs:
233233
cargo fmt --manifest-path tests/testkit/Cargo.toml --all -- --check
234234
cargo fmt --manifest-path tests/tmachine/Cargo.toml --all -- --check
235235
cargo fmt --manifest-path tests/runner/Cargo.toml --all -- --check
236-
cargo fmt --manifest-path tests/suites/conformance/Cargo.toml -p sandbox -- --check
236+
cargo fmt --manifest-path tests/suites/conformance/Cargo.toml -p conformance -- --check
237237
cargo fmt --manifest-path tests/suites/features/Cargo.toml -p keycloak-provider-refresh -- --check
238238
cargo fmt --manifest-path tests/support/Cargo.toml --all -- --check
239239
@@ -297,7 +297,7 @@ jobs:
297297
cargo clippy --locked --manifest-path tests/testkit/Cargo.toml --all-targets -- -D warnings
298298
cargo clippy --locked --manifest-path tests/tmachine/Cargo.toml --all-targets -- -D warnings
299299
cargo clippy --locked --manifest-path tests/runner/Cargo.toml --all-targets -- -D warnings
300-
cargo clippy --locked --manifest-path tests/suites/conformance/Cargo.toml -p sandbox --all-targets -- -D warnings
300+
cargo clippy --locked --manifest-path tests/suites/conformance/Cargo.toml -p conformance --all-targets -- -D warnings
301301
cargo clippy --locked --manifest-path tests/suites/features/Cargo.toml -p keycloak-provider-refresh --all-targets -- -D warnings
302302
cargo clippy --locked --manifest-path tests/support/Cargo.toml --all-targets -- -D warnings
303303

0 commit comments

Comments
 (0)