You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1a8e819
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .agents/skills/helm-dev-environment/SKILL.md
+40-5Lines changed: 40 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -195,6 +195,17 @@ every member one at a time. The PID must survive each case, while an open
195
195
replacement confirmed within the recovery timeout, so the runtime terminated
196
196
the workload.
197
197
198
+
For RFC 0017 app-listener validation, enable the listener and supply the app TLS
199
+
Secret on the shared Deployment, plus a separate NetworkPolicy allowing the test
200
+
client/proxy to reach its app port. Runtime-port access does not grant app access.
201
+
Discovery returns the acknowledged owner's Pod IP and app port; no headless app
202
+
Service is needed. Exercise HTTP/WebSocket reconnection through graceful downscale
203
+
and abrupt loss, preserving workload generation/PID/in-memory state and the public
204
+
hostname. Verify stale-owner rejection independently of the replacement's success.
205
+
Shared serving leases expire within fifteen seconds of issuance and do not renew
206
+
from configuration alone. Do not claim seamless socket migration or infer external
207
+
ingress readiness from an advertisement.
208
+
198
209
### 2. Deploy OpenShell
199
210
200
211
**Iterative dev** (rebuilds on file changes, recommended during active development):
@@ -255,8 +266,9 @@ task running while using those endpoints.
255
266
### Viewing local traces
256
267
257
268
The gateway exports OTLP/gRPC to
258
-
`http://openshell-collector.observability.svc.cluster.local:4317`through the
259
-
default Skaffold values. Forward OTLP/gRPC and the trace UI to the host:
`ci/values-local-tracing.yaml`, which only `skaffold.yaml` layers. The Kubernetes
271
+
E2E wrapper omits it, so E2E clusters export no traces. Forward OTLP/gRPC and the trace UI to the host:
260
272
261
273
```bash
262
274
mise run helm:k3s:forward
@@ -267,9 +279,10 @@ Kubernetes compute-driver spans under their distinct service names, along with
267
279
Agent Sandbox controller reconciliation spans linked through the Sandbox
268
280
trace-context annotation. The same command exposes OTLP/gRPC on
269
281
`http://127.0.0.1:4317`and, when deployed, the Kubernetes gateway on
270
-
`http://127.0.0.1:8090`. The local `gateway:docker`, `gateway:podman`, and
271
-
`gateway:vm`tasks detect the collector listener at startup and enable trace
272
-
export, OCSF log export, and the agent trace relay only while it is reachable.
282
+
`http://127.0.0.1:8090`. The local `gateway`, `gateway:docker`,
283
+
`gateway:podman`, and `gateway:vm` tasks enable trace export, OCSF log export,
284
+
and the agent trace relay only when `OPENSHELL_DEV_OTLP_ENDPOINT` is set, for
285
+
example `OPENSHELL_DEV_OTLP_ENDPOINT=http://127.0.0.1:4317`.
273
286
Spans an agent exports from inside a sandbox arrive through the supervisor's
274
287
relay with `openshell.telemetry.source=agent` and share `openshell.sandbox.id`
275
288
with that sandbox's supervisor spans.
@@ -445,6 +458,16 @@ public `SandboxStatus` image fields. Resume a pending operation with
445
458
`SandboxUpdates.UpdateSandbox`, the current resource version, and no selected
446
459
fields, following the documented request-ID semantics.
447
460
461
+
462
+
For the opt-in application listener, build/import matching branch images and run
463
+
`mise run e2e:kubernetes:app-listener`; see `e2e/kubernetes/app-listener/README.md`
464
+
for image, topology, delivery-mode and takeover inputs. The task owns an isolated
465
+
Helm release/namespace, temporary TLS material, in-cluster clients, teardown and
466
+
evidence under `results/app-listener/`. It checks policy denial, Pod-IP ingress without app Services, shared-owner takeover, gateway-outage expiry and disabled-listener
467
+
gateway compatibility, without discovery or a proxy. CI runs four cases under
468
+
`test:e2e`and includes them in `Core E2E result`. Its reusable kind setup installs
469
+
pinned Calico only for this lane; other jobs retain kindnet. Local k3s already
470
+
enforces policy. The lower-level `verify.py` can target a predeployed release.
448
471
The kube e2e wrapper creates only one port-forward, to `svc/openshell`; it no
449
472
longer forwards the unauthenticated health listener or runs a `/readyz` e2e
450
473
target. `/readyz` remains covered by server unit/integration tests.
@@ -621,6 +644,7 @@ for dependencies still declared in `Chart.yaml`.
Copy file name to clipboardExpand all lines: .agents/skills/release-openshell/SKILL.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,3 +83,18 @@ updating a Snap Store support track. Docs retain an
83
83
immutable version and advance latest only for a newer version.
84
84
85
85
Watch the stable release run and report its result.
86
+
87
+
## PyPI publishing
88
+
89
+
Stable releases publish the Python wheel to PyPI from `wheel-publish.yml`, which the `publish-pypi` job in `release-publish.yml` calls after the GitHub Release is created. The workflow downloads the wheel from the stable GitHub Release, not a 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. PyPI matches the workflow file that contains the publishing job, so configure the `openshell` PyPI project's GitHub publisher with owner `NVIDIA`, repository `OpenShell`, workflow `wheel-publish.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 or `wheel-publish.yml`. For a support release, explicitly allow its support branch before dispatching. Required reviewers, if configured, must approve the PyPI job. An existing wheel on PyPI is skipped; PyPI does not allow replacing a published wheel.
92
+
93
+
If a stable release did not reach PyPI, publish the wheel without rerunning Release:
94
+
95
+
```shell
96
+
gh workflow run wheel-publish.yml -R NVIDIA/OpenShell --ref main \
Copy file name to clipboardExpand all lines: .agents/skills/sync-agent-infra/SKILL.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,7 @@ Run after adding, removing, or renaming a skill or crate; changing issue or PR c
28
28
| TUI behavior |`tui-development`|
29
29
| Release artifacts or smoke coverage |`test-release-canary`|
30
30
| Release cadence, tagging, or qualification workflows |`release-captain`|
31
+
| Release workflows or publishers |`release-openshell`, `release-captain`; keep the Release workflows table and the manual-trigger rule in `CI.md` current |
31
32
| CI diagnostics |`watch-github-actions`|
32
33
| Native Windows builds, runtime, or release branch guidance |`build-openshell-mxc-windows`; keep Windows implementation links on `windows` even in docs merged to `main`|
Copy file name to clipboardExpand all lines: .agents/skills/watch-github-actions/SKILL.md
+23-10Lines changed: 23 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,29 +125,42 @@ gh run list --json databaseId,status,headBranch,url --jq '.[] | {id: .databaseId
125
125
126
126
## View Job Logs
127
127
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.
129
135
130
136
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/`.
131
137
132
-
`Pre-release` temporarily omits Codex Security from its `Security Scan` job.
133
-
`Release` uses the passing prerelease qualification result. Other scanners and
134
-
qualification gates still run. Use the standalone
135
-
`Codex Security Release Qualification` workflow for manual investigation.
138
+
`Pre-release` runs Codex Security as a separate advisory qualification job.
139
+
It scans the exact prerelease tag against the previous stable release. Findings
140
+
and scanner execution failures do not affect qualification or publication;
141
+
failed steps and warnings remain visible. `Release` uses the passing prerelease
142
+
qualification result. Codex Security has no schedule or manual trigger.
136
143
137
-
For `Codex Security`, an exit code of 2 with partial coverage is an incomplete
138
-
scan, not a HIGH/CRITICAL threshold failure. Check the execution diagnostics in
139
-
the job summary and the `codex-security-diagnostics-<run>-<attempt>` artifact on
144
+
For Codex Security `0.8.3`, exit code 2 means an execution or required-output
145
+
failure. Deferred investigations no longer cause that exit code. Check the
146
+
execution diagnostics in the job summary and the
147
+
`codex-security-diagnostics-<run>-<attempt>` artifact on
140
148
scan failure. It contains fixed status values, aggregate coverage counts, and
141
149
disk space before, after, and the minimum sampled every five seconds. Missing
142
150
coverage or manifest documents indicate no readable final report was available;
143
-
deferred items or surfaces needing follow-up can explain partial coverage.
151
+
deferred items or surfaces needing follow-up describe coverage limitations.
152
+
Current reports omit the legacy completeness field, so the diagnostic's
153
+
`coverage` value is `unknown`; use `scan_status` and the exit code for execution.
144
154
Sampling cannot rule out a disk spike between samples.
145
155
146
156
Artifacts and logs in this public repository are public. Never upload the raw
147
157
scan directory, `report.md`, `coverage.json`, findings, agent state, or scanner
148
158
logs. Coverage reasons and notes are free text and may disclose vulnerabilities.
149
159
The public diagnostic intentionally omits them; detailed review needs an
150
-
approved private destination. Helpers must come from the workflow revision,
160
+
approved private destination. Setting the repository variable
161
+
`CODEX_SECURITY_DIAGNOSTICS_PUBLIC_KEY` enables bounded scanner logging and
162
+
encrypted report retention. Only ciphertext is uploaded; the private key stays
163
+
local. See `CI.md` for decryption. Helpers must come from the workflow revision,
151
164
not from the candidate under scan.
152
165
153
166
`setup-nix` retries development-shell preparation once when `prepare-shell`
0 commit comments