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 ac8c621
Browse filesBrowse the repository at this point in the historyBrowse files
Part of agent-substrate#1661.
- Documents the JSON array form of ate-setup's `--credential-provider`
in `docs/guides/egress-credential-injection.md` and
`cmd/ate-setup/commands.md`, and that the gateway sends each
`ate-secret://` URI to the provider its host names.
- Updates comments that still described one provider: the egress
manifest's marker comment and
`cmd/atenet/internal/router/egress/provider.go`.
Docs and comments only, so it can merge during the freeze.
AI use: AI-assisted draft, reviewed by me.
- [x] Tests pass (no code changes)
- [x] Docs updated
Signed-off-by: Max Thompson <[email protected]>
Copy file name to clipboardExpand all lines: cmd/ate-setup/commands.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
@@ -29,7 +29,7 @@ every setting with its environment variable.
29
29
|`--ingress-allowed-spiffe-ids IDS`| Comma-separated SPIFFE IDs (exact match) of the clients the ingress router lets reach actors; any listed client may reach any actor. Unset, no client may reach actors through the router. Both dataplanes require a Pod Identity CA client certificate on HTTPS and TLS CONNECT. The SPIFFE URI SAN allowlist may be checked during or after TLS, including after CONNECT acceptance, but unlisted clients must be denied before actor routing. The podidentity signer issues `spiffe://cluster.local/ns/<namespace>/sa/<service-account>`. `ATE_INGRESS_ALLOWED_SPIFFE_IDS` when the flag is absent |
30
30
|`--egress-gateway-extra-spiffe-ids IDS`| Comma-separated SPIFFE IDs that hold ate-api-server's `egress_gateway` role next to atenet-egress, such as a credential provider that mints actor JWTs. ate-setup passes atenet-egress's ID and then each listed ID as repeated `--egress-gateway-spiffe-id` flags; unset passes none, leaving ate-api-server's default. `ATE_EGRESS_GATEWAY_EXTRA_SPIFFE_IDS` when the flag is absent |
|`--credential-provider JSON`| Required by `deploy ate-system` and `deploy atenet`. A JSON object: `{"name":"k8s.io"}` deploys and uses the bundled Kubernetes Secrets provider, with a NetworkPolicy that admits only the egress gateway; `{"enabled":false}` turns egress credential injection off; `{"name":"<provider>","address":"<host>:<port>"}` uses a provider you deploy yourself. See [`docs/guides/egress-credential-injection.md`](../../docs/guides/egress-credential-injection.md). `ATE_CREDENTIAL_PROVIDER` when the flag is absent |
32
+
|`--credential-provider JSON`| Required by `deploy ate-system` and `deploy atenet`. A JSON object: `{"name":"k8s.io"}` deploys and uses the bundled Kubernetes Secrets provider, with a NetworkPolicy that admits only the egress gateway; `{"enabled":false}` turns egress credential injection off; `{"name":"<provider>","address":"<host>:<port>"}` uses a provider you deploy yourself. A JSON array of provider objects selects several, each serving the `ate-secret://` URIs its name is the host of. See [`docs/guides/egress-credential-injection.md`](../../docs/guides/egress-credential-injection.md). `ATE_CREDENTIAL_PROVIDER` when the flag is absent |
33
33
|`--ateapi-log-level LEVEL`| ate-api-server log level: `debug`, `info`, `warn`, or `error`. Written to the `ate-api-config` ConfigMap on every deploy when set; unset keeps the installed level (`info` on a new install). Changing the level updates the env-hash annotation and rolls `ate-api-server`. `ATE_API_LOG_LEVEL` when the flag is absent |
34
34
|`--otlp-endpoint URL`| Send control plane telemetry to `URL` instead of the cluster default (see [`benchmarking/telemetry/README.md`](../../benchmarking/telemetry/README.md)). `ATE_OTLP_ENDPOINT` when the flag is absent |
35
35
|`--preview GATES`| Preview gates passed as `--preview` to every substrate component: comma-separated gate names, or `ALL` for all. `ATE_PREVIEW` or `config.preview` when the flag is absent. An explicit `--preview=''` turns them all off, even when `ATE_PREVIEW` is set |
Copy file name to clipboardExpand all lines: docs/guides/egress-credential-injection.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -203,12 +203,13 @@ go run ./cmd/ate-setup deploy atenet --credential-provider='{"name":"k8s.io"}'
203
203
```
204
204
205
205
`--credential-provider`(or `ATE_CREDENTIAL_PROVIDER` when the flag is
206
-
absent) is a JSON object with these keys; any other key is an error:
206
+
absent) is a JSON object with these keys, or a JSON array of such objects to
207
+
select several providers; any other key is an error:
207
208
208
209
| Key | Value |
209
210
|---|---|
210
-
| `enabled` | Defaults to `true`. `false` turns injection off, and then no other key is allowed |
211
-
| `name` | Required unless `enabled` is `false`. A DNS name: `k8s.io`for the bundled Kubernetes Secrets provider, or the name of a provider you deploy, which is the host of the `ate-secret://` URIs it serves, e.g. `vault.example.com` for `ate-secret://vault.example.com/...`. A policy URI naming any other provider fails closed |
211
+
| `enabled` | Defaults to `true`. `false` turns injection off, and then no other key is allowed. An array entry can't be `false` |
212
+
| `name` | Required unless `enabled` is `false`. A DNS name: `k8s.io`for the bundled Kubernetes Secrets provider, or the name of a provider you deploy, which is the host of the `ate-secret://` URIs it serves, e.g. `vault.example.com` for `ate-secret://vault.example.com/...`. Names in an array must differ. A policy URI naming no configured provider fails closed |
212
213
| `address` | The `host:port` the gateway dials the provider at. Required for a provider you deploy; optional with `k8s.io`, where it defaults to the bundled provider's Service, `k8s-credential-provider.ate-system.svc:50051` |
a policy URI naming any other class fails closed rather than being sent to the
332
-
wrong provider.
332
+
A gateway can front several providers, one per class. It sends each URI to the
333
+
provider its host names, and a policy URI naming no configured class fails
334
+
closed rather than being sent to the wrong provider.
333
335
334
-
The gateway reads only the URI host, to confirm the URI targets the provider it
335
-
serves. The provider interprets the path, within the rules under
336
+
The gateway reads only the URI host, to pick the provider the URI targets. The
337
+
provider interprets the path, within the rules under
336
338
[Credential URIs](#credential-uris).
337
339
338
340
[credprovider-gcp-secret-manager](https://github.com/agent-substrate-plugins/credprovider-gcp-secret-manager) is such a provider for Google Cloud Secret Manager.
0 commit comments