Skip to content

Commit cb42f5d

Browse files
authored
fix(snap): use openshell-prover instead of openshell.prover (#4835)
The alias `openshell-prover` has been granted for OpenShell: https://forum.snapcraft.io/t/alias-request-for-openshell/53658 Thus, we can remove guidance differentiating `openshell.prover` for the snap from `openshell-prover` for other packaging formats. It is still worth noting that installing a locally-built snap directly, rather than from the store, means there is no alias. Signed-off-by: Oliver Calder <oliver.calder@canonical.com>
1 parent fac8232 commit cb42f5d

7 files changed

Lines changed: 12 additions & 23 deletions

File tree

‎.agents/skills/test-release-canary/SKILL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Loopback registration auto-derives the gateway name to `openshell` if `--name` i
144144
| Sandbox create or exec fails | Published sandbox and supervisor artifacts are missing, incompatible, or cannot establish the protected runtime channel. | Gateway logs plus Docker, Podman, VM, snap, or Kubernetes runtime diagnostics for the job. |
145145
| `macos`/`ubuntu-deb`/`fedora` job fails on `openshell status` | Local gateway service did not start (systemd/brew/podman). Often a driver issue. | Service logs in the job log; `OPENSHELL_COMPUTE_DRIVER` env in the "Ensure …" step. |
146146
| `ubuntu-snap-system-docker` fails during `install.sh` | System Docker was unavailable to the runner user, the edge revision or automatic interfaces were unavailable, or the user gateway did not become reachable. | Failure diagnostics dump system Docker, snap service/connection/change state, user and legacy gateway journals, snap logs, and port 17670 listeners. |
147-
| `ubuntu-snap-system-docker` fails during the prover checks | The prover artifact is missing or packaged for the wrong architecture, `openshell.prover` is not exposed or confined to read the test policies, or its solver linkage is not runnable. | The `Install and check status` and `Check a policy boundary with the snap prover` steps, plus `snap info openshell` and `snap connections openshell`. |
147+
| `ubuntu-snap-system-docker` fails during the prover checks | The prover artifact is missing or packaged for the wrong architecture, `openshell.prover` is not exposed, missing the alias to `openshell-prover`, or not permitted to read the test policies, or its solver linkage is not runnable. | The `Install and check status` and `Check a policy boundary with the snap prover` steps, plus `snap info openshell` and `snap connections openshell`. |
148148
| `ubuntu-snap-docker-preflight` unexpectedly succeeds | The installer no longer fails before installing the OpenShell snap when Docker is absent or supplied by the Docker snap. | Inspect `install.log`, `docker-snap.log`, `snap list`, and snapd changes. |
149149
| `kubernetes` job fails on `helm install --wait` | Chart did not deploy in 5 min — usually image pull failure or readiness probe failing. | "Diagnostics on failure" step dumps `helm status`, manifest, pod describe, pod logs. |
150150
| `kubernetes` job fails on `kubectl wait` | Gateway pod stuck `CrashLoopBackOff` or `ImagePullBackOff`. | Diagnostics dump; check `:dev` image existence at `ghcr.io/nvidia/openshell/gateway`. |

‎.github/workflows/release-canary.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ jobs:
239239
docker info
240240
sudo snap connections openshell | grep -E '^docker +openshell:docker +:docker +'
241241
openshell --version
242-
openshell.prover --version
242+
openshell-prover --version
243243
snap services openshell
244244
systemctl --user is-enabled --quiet snap.openshell.user-gateway.service
245245
systemctl --user is-active snap.openshell.user-gateway.service
@@ -283,7 +283,7 @@ jobs:
283283
read_only:
284284
- /usr
285285
EOF
286-
result=$(openshell.prover check "$prover_dir/candidate.yaml" \
286+
result=$(openshell-prover check "$prover_dir/candidate.yaml" \
287287
--boundary "$prover_dir/boundary.yaml")
288288
grep -q '^result: within_boundary$' <<<"$result"
289289

‎docs/about/installation.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,7 @@ The global command prevents automatic activation for other users but does not st
143143
systemctl --user disable --now snap.openshell.user-gateway.service
144144
```
145145

146-
The snap installs the standalone policy prover as `openshell.prover`. The
147-
`openshell-prover` alias requires Snap Store approval and may not be available.
148-
The prover reads local policy files through the `home` interface and does not
149-
connect to the gateway.
146+
The snap installs the standalone policy prover as `openshell.prover` with an alias to `openshell-prover`. Installs of locally-built snaps will not have the alias. The prover reads local policy files through the `home` interface and does not connect to the gateway.
150147

151148
The gateway runs at `https://127.0.0.1:17670`. It reads `~/snap/openshell/common/.config/openshell/gateway.toml` when that file exists. Its database defaults to `~/snap/openshell/common/.local/state/openshell/gateway/openshell.db`, and its TLS material lives under `~/snap/openshell/common/.local/state/openshell/tls`. Register it from the same user account:
152149

‎docs/about/support-matrix.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,7 @@ OpenShell publishes standalone `openshell-prover` release assets for manual down
113113

114114
These artifacts are attached to GitHub releases. The Linux binaries are static and do not require glibc. All prover archives include the required solver linkage.
115115

116-
The Debian, RPM, Homebrew, and snap packages also include the prover. Debian,
117-
RPM, and Homebrew installations expose it as `openshell-prover`; use
118-
`openshell.prover` with the snap. The `openshell-prover` snap alias requires
119-
Store approval and may not be available.
116+
The Debian, RPM, Homebrew, and snap packages also include the prover.
120117

121118
## Runtimes
122119

‎docs/how-it-works/policies/prover.mdx‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,6 @@ contain access that the proposal risk check would flag.
3636
This page covers the boundary check. To learn about the proposal risk check,
3737
refer to [Policy Advisor](/how-it-works/policies/advisor).
3838

39-
For snap installations, replace `openshell-prover` in these examples with
40-
`openshell.prover`. The `openshell-prover` snap alias requires Store approval
41-
and may not be available.
42-
4339
The prover remains independent of the gateway at runtime. If you only need the
4440
standalone binary, use the artifacts listed in the
4541
[Support Matrix](/about/support-matrix#standalone-policy-prover). These
@@ -60,10 +56,9 @@ or MCP rules, the prover reports that it cannot check the policy instead of
6056
ignoring those rules. [What the Boundary Check
6157
Covers](#what-the-boundary-check-covers) describes each part and its limits.
6258

63-
The Homebrew, Debian, RPM, and snap packages install the prover. Homebrew,
64-
Debian, and RPM expose it as `openshell-prover`; use `openshell.prover` with the
65-
snap. The CLI reads policy files on your machine, does not need a gateway, and
66-
does not apply or approve policies.
59+
The Homebrew, Debian, RPM, and snap packages install the prover. The CLI reads
60+
policy files on your machine, does not need a gateway, and does not apply or
61+
approve policies.
6762

6863
Create `boundary.yaml`, a boundary that allows reading `/usr` and `/etc`:
6964

‎snapcraft.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ description: |
1111
policy-enforced egress routing, credential proxying, and privacy-aware
1212
profile-backed model-provider access.
1313
14-
The OpenShell snap ships a CLI (`openshell`), a terminal UI
15-
(`openshell.term`), a standalone policy prover (`openshell.prover`), and a
16-
managed gateway daemon (`openshell.user-gateway`). The user gateway is
14+
The OpenShell snap ships a CLI (`openshell`), a terminal UI (`openshell.term`),
15+
a standalone policy prover (`openshell.prover` with alias `openshell-prover`),
16+
and a managed gateway daemon (`openshell.user-gateway`). The user gateway is
1717
disabled by default so that one selected user can run it.
1818
1919
**Setup instructions**

‎tasks/scripts/test-packaging-assets.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ assert_not_contains "$snap_install_docs" "snap services --user"
260260
assert_contains "$snap_canary" "install.sh | sh"
261261
assert_contains "$snap_canary" "ubuntu-snap-system-docker:"
262262
assert_contains "$snap_canary" "ubuntu-snap-docker-preflight:"
263-
assert_contains "$snap_canary" "openshell.prover check"
263+
assert_contains "$snap_canary" "openshell-prover check"
264264
assert_not_contains "$snap_canary" "--dangerous"
265265
assert_not_contains "$snap_canary" "snap connect openshell:docker"
266266
if ! awk '/config preflight/ { seen = 1 } /generate-certs/ { exit !seen }' "$service"; then

0 commit comments

Comments
 (0)