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 17c7e7e
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: deploy/helm/openshell/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -372,7 +372,7 @@ discovery endpoint or its TLS CA.
372
372
| grpcRoute.gateway.listener.port | int |`80`| Listener port for the generated Gateway resource. Use 443 with protocol HTTPS. |
373
373
| grpcRoute.gateway.listener.protocol | string |`"HTTP"`| Listener protocol for the generated Gateway resource: HTTP or HTTPS. HTTPS terminates TLS at the Gateway listener; pair it with server.disableTls=true so the proxy forwards plaintext to the gateway pod, and use OIDC for client identity (the gateway never sees the client certificate). |
374
374
| grpcRoute.gateway.listener.tls.certificateRefs | list |`[]`| certificateRefs for the HTTPS listener. Required when protocol is HTTPS. Each entry needs a `name` pointing at a kubernetes.io/tls Secret in the Gateway's namespace. May reference a cert-manager-issued Secret or the existing openshell-server-tls Secret (its SANs must include the external hostname). |
375
-
| grpcRoute.gateway.name | string |`""`| Name of the Gateway resource. Defaults to `<fullname>-ingress`, which stays distinct from the OpenShell Service name. When gateway.create is false, set this to the name of the existing Gateway. |
375
+
| grpcRoute.gateway.name | string |`""`| Name of the Gateway resource. Defaults to `<fullname>`. Set a distinct name when the selected controller creates a proxy Service with the Gateway name. When gateway.create is false, set this to the name of the existing Gateway. |
376
376
| grpcRoute.gateway.namespace | string |`""`| Namespace of the Gateway referenced by the GRPCRoute parentRef. Defaults to the release namespace. A chart-created Gateway always resides in the release namespace. |
377
377
| grpcRoute.gateway.sectionName | string |`""`| Listener name on an existing Gateway. Leave empty to let Gateway API listener matching select compatible listeners. |
378
378
| grpcRoute.hostnames | list |`[]`| Hostnames the GRPCRoute matches on. Leave empty to match all hosts. |
The generated Gateway defaults to `<fullname>-ingress`, while the OpenShell Service keeps the `<fullname>` name. Keeping these names distinct avoids collisions with Gateway implementations that name their proxy Service after the Gateway.
66
-
67
-
<Note>
68
-
Existing releases that created a Gateway under the previous `<fullname>` default can retain that resource name by setting `grpcRoute.gateway.name=<fullname>` before upgrading.
69
-
</Note>
65
+
The generated Gateway defaults to the chart fullname.
For ingress, the OpenShell chart creates only the Gateway and GRPCRoute. Install and manage the selected controller, GatewayClass, and Gateway API CRDs separately.
82
+
Some Gateway API implementations name their proxy Service after the Gateway. Set a distinct Gateway name, such as `openshell-ingress`, when the default would conflict with the OpenShell Service. For ingress, the OpenShell chart creates only the Gateway and GRPCRoute. Install and manage the selected controller, GatewayClass, and Gateway API CRDs separately.
86
83
87
84
### Use an existing Gateway
88
85
@@ -107,7 +104,7 @@ The existing Gateway listener must allow routes from the OpenShell release names
107
104
With the Envoy Gateway example above, the controller creates a LoadBalancer service in the `openshell` namespace. Wait for it to get an external address:
108
105
109
106
```shell
110
-
kubectl -n openshell get svc -l gateway.envoyproxy.io/owning-gateway-name=openshell-ingress
107
+
kubectl -n openshell get svc -l gateway.envoyproxy.io/owning-gateway-name=openshell
111
108
```
112
109
113
110
For another Gateway API implementation or an existing Gateway, follow that implementation's instructions to find the external address.
Copy file name to clipboardExpand all lines: skills/debug-openshell-cluster/SKILL.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1037,7 +1037,7 @@ credential failures.
1037
1037
| Sandbox remains `Stopping` or `Starting`| Driver stop/start failed, retained resource is missing, or a fresh supervisor has not connected | Gateway and driver logs; `docker inspect`, `podman inspect`, Agent Sandbox status/PVC, or VM state marker and launcher process |
1038
1038
| Image pull failure | Gateway or sandbox image cannot be pulled | Runtime events and image pull credentials |
1039
1039
| Gateway API resources fail with `the server could not find the requested resource`| Optional Gateway API resources were applied without Gateway API CRDs | Install the standard Gateway API CRDs and selected controller, then enable `grpcRoute` before applying the optional ingress resources |
1040
-
| A custom GatewayClass does not program the chart-created Gateway, or its proxy Service conflicts with the OpenShell Service | The selected controller is unavailable, or an explicit`grpcRoute.gateway.name` reuses the OpenShell Service name | Check `kubectl get gatewayclass,gateway,grpcroute -A`; leave the Gateway name empty to use `<fullname>-ingress`, or set a distinct name. For an existing Gateway, set `gateway.create=false` plus `gateway.name`, `gateway.namespace`, and optional `gateway.sectionName`|
1040
+
| A custom GatewayClass does not program the chart-created Gateway, or its proxy Service conflicts with the OpenShell Service | The selected controller is unavailable, or the default`grpcRoute.gateway.name` reuses the OpenShell Service name | Check `kubectl get gatewayclass,gateway,grpcroute -A`; set a distinct Gateway name such as `<fullname>-ingress`. For an existing Gateway, set `gateway.create=false` plus `gateway.name`, `gateway.namespace`, and optional `gateway.sectionName`|
1041
1041
| HTTPS ingress (`grpcRoute.gateway.listener.protocol=HTTPS`) connection resets or TLS handshake hangs | Envoy terminates TLS but the gateway pod still expects TLS, so the plaintext backend hop fails | Set `server.disableTls=true` so Envoy forwards plaintext to the pod; verify the listener `certificateRefs` Secret exists in the release namespace and `openshell status` over `https://<host>`|
1042
1042
| With `grpcRoute.replicaRouting.enabled=true`, sandbox SSH, forward, or exec still relay through a peer replica | A `<release>-replica-<i>` Service has no endpoint, so Envoy returns `Unavailable` and the CLI retries unrouted |`kubectl -n openshell get endpoints <release>-replica-0 <release>-replica-1`; confirm `workload.kind=statefulset` and the GRPCRoute status is `Accepted`/`ResolvedRefs`|
1043
1043
| HTTPS ingress returns `Unauthenticated` after connecting | TLS terminates at Envoy, so the gateway never sees a client cert; no OIDC issuer is configured for identity | Configure `server.oidc.issuer` and register with `openshell gateway add https://<host> --oidc-issuer <url>`, or set `server.auth.allowUnauthenticatedUsers=true` for a trusted-proxy/dev cluster |
0 commit comments