apoxy

Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

Synopsis

Apoxy is an open-source edge platform built on Envoy, Kubernetes API infrastructure, and QUIC tunneling. Core capabilities include:

• API Gateway with Gateway API routing
• Edge computing runtime for JS/WASM/Go functions
• Secure tunneling via QUIC and connect-ip protocols

Apoxy Cloud is the managed offering: it handles DNS registration, instant TLS certificates, and built-in observability so you focus on routing and logic instead of infrastructure.

Get started at https://apoxy.dev and log in with 'apoxy auth'.

Options

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). -h, --help help for apoxy --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha - Alpha features that are still under development
• apoxy apply - Apply resources from file(s) or directory
• apoxy auth - Authenticate this CLI
• apoxy backend - Manage backend objects
• apoxy build - Build a compute service bundle from a JS/TS project
• apoxy bundle - Manage compute service bundles
• apoxy compute - Manage compute objects
• apoxy delete - Delete resources by file or type/name
• apoxy deploy - Build, push, and apply a compute Service end to end
• apoxy dev - Develop against the Apoxy API locally
• apoxy domain - Manage domain record objects
• apoxy edgefunction - Manage edge function objects
• apoxy gateway - Manage gateway objects
• apoxy k8s - Commands that manage Apoxy on Kubernetes
• apoxy logs - View proxy logs
• apoxy proxy - Manage proxy objects
• apoxy run - Run Apoxy runtime components defined in config
• apoxy secret - Manage secret stores and their values
• apoxy tunnel - Manage tunnels
• apoxy upgrade - Upgrade Apoxy CLI to the latest version
• apoxy version - The version of this CLI
• apoxy vpc - Manage VPC networking objects

apoxy alpha

Alpha features that are still under development

$terminalTXTCOPY

apoxy alpha [flags]

Options

$terminalTXTCOPY

-h, --help help for alpha

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy alpha domains - Manage domain record objects
• apoxy alpha tunnel - Manage tunnels

apoxy alpha domains

Manage domain record objects

Synopsis

Domain records configure individual DNS records within a domain zone.

$terminalTXTCOPY

apoxy alpha domains [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for domains -o, --output string Output format: "json" or "yaml". Default is table. --zone string Filter domain records by zone name.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha - Alpha features that are still under development
• apoxy alpha domains apply - Apply domainrecord configuration using server-side apply
• apoxy alpha domains create - Create domainrecord objects
• apoxy alpha domains delete - Delete domainrecord objects
• apoxy alpha domains get - Get domainrecord objects
• apoxy alpha domains list - List domainrecord objects

apoxy alpha domains apply

Apply domainrecord configuration using server-side apply

Synopsis

Apply domainrecord configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update domainrecord objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy alpha domains apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha domains - Manage domain record objects

apoxy alpha domains create

Create domainrecord objects

Synopsis

Create domainrecord objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy alpha domains create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha domains - Manage domain record objects

apoxy alpha domains delete

Delete domainrecord objects

$terminalTXTCOPY

apoxy alpha domains delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha domains - Manage domain record objects

apoxy alpha domains get

Get domainrecord objects

$terminalTXTCOPY

apoxy alpha domains get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha domains - Manage domain record objects

apoxy alpha domains list

List domainrecord objects

$terminalTXTCOPY

apoxy alpha domains list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the domainrecord's labels. --zone string Filter domain records by zone name.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha domains - Manage domain record objects

apoxy alpha tunnel

Manage tunnels

Synopsis

Manage icx tunnels and connect to the remote Apoxy Edge fabric.

Options

$terminalTXTCOPY

-h, --help help for tunnel

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha - Alpha features that are still under development
• apoxy alpha tunnel run - Run a tunnel

apoxy alpha tunnel run

Run a tunnel

Synopsis

Create a secure tunnel to the remote Apoxy Edge fabric.

$terminalTXTCOPY

apoxy alpha tunnel run [flags]

Options

$terminalTXTCOPY

--admin-addr string Listen address for underlay-only /livez, /readyz, and /metrics endpoints. Empty disables. -h, --help help for run --insecure-skip-verify Skip TLS certificate verification for relay connections. --label stringToString Agent-declared label (key=value) for VPCService selection; repeatable. Bounded by the credential's allowed label sets. (default []) --min-conns int Minimum number of relays to maintain connections to (randomly selected from the discovered relay set). (default 1) -n, --name string Tunnel name (default: a random Docker-style name). --no-tui Disable the interactive connection display. -p, --pcap string Path to an optional packet capture file to write. -r, --relay-addr string Seed relay address (host:port), required if not using kubernetes-based discovery. --route stringArray CIDR reachable behind this agent, advertised to the relay; repeatable. Bounded by the credential's allowed routes. --socks-addr string Listen address for SOCKS proxy. (default "localhost:1080") -k, --token string The token to use for authenticating with the tunnel relays, required if not using kubernetes-based discovery. --tun Use a kernel TUN device for the overlay datapath instead of the in-process netstack + SOCKS proxy. Any process in the same network namespace can then reach overlay destinations by plain kernel route. Linux only; requires NET_ADMIN and /dev/net/tun. --tun-ifname string Name of the TUN interface created in --tun mode. (default "apoxy0") --vpc string The VPC network to connect to. (default "default")

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy alpha tunnel - Manage tunnels

apoxy apply

Apply resources from file(s) or directory

Synopsis

Apply configuration to resources using server-side apply.

Supports multiple files, directories, and stdin. When a directory is specified, all .yaml, .yml, and .json files are processed.

Examples:

Apply a single file

apoxy apply -f gateway.yaml

Apply multiple files

apoxy apply -f gateway.yaml -f routes.yaml

Apply all manifests in a directory

apoxy apply -f ./manifests/

Apply from stdin

cat manifest.yaml | apoxy apply -f -

$terminalTXTCOPY

apoxy apply -f <filename> [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply (default "apoxy-cli") -f, --filename stringArray Files or directories containing resources to apply (can be specified multiple times) --force-conflicts Force apply even if there are field ownership conflicts -h, --help help for apply -R, --recursive Process directories recursively

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy auth

Authenticate this CLI

Synopsis

If you are not authenticated, this will open a browser window to login via the Apoxy Dashboard.

If your CLI is already authenticated this will return information about your session.

$terminalTXTCOPY

apoxy auth [flags]

Options

$terminalTXTCOPY

--api-base-url string API base URL (default: https://api.apoxy.dev) --check only check the authentication status --dashboard-url string dashboard URL for authentication (default: https://dashboard.apoxy.dev) -h, --help help for auth

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy backend

Manage backend objects

Synopsis

Backends configure upstream endpoints for proxies.

$terminalTXTCOPY

apoxy backend [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for backend -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy backend apply - Apply backend configuration using server-side apply
• apoxy backend create - Create backend objects
• apoxy backend delete - Delete backend objects
• apoxy backend get - Get backend objects
• apoxy backend list - List backend objects

apoxy backend apply

Apply backend configuration using server-side apply

Synopsis

Apply backend configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update backend objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy backend apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy backend - Manage backend objects

apoxy backend create

Create backend objects

Synopsis

Create backend objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy backend create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy backend - Manage backend objects

apoxy backend delete

Delete backend objects

$terminalTXTCOPY

apoxy backend delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy backend - Manage backend objects

apoxy backend get

Get backend objects

$terminalTXTCOPY

apoxy backend get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy backend - Manage backend objects

apoxy backend list

List backend objects

$terminalTXTCOPY

apoxy backend list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the backend's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy backend - Manage backend objects

apoxy build

Build a compute service bundle from a JS/TS project

Synopsis

Bundles the project with esbuild (ESM output, workerd resolution) into a staged service bundle: JS/TS is bundled into a single entry module, while .wasm/.txt/.bin/.data imports become separate bundle modules.

The entrypoint is taken from --entry, package.json (module, then main), or common locations (src/index.ts, index.js, ...).

Examples:

Build the current directory into .apoxy/build

apoxy build

Build a specific project and entrypoint

apoxy build ./my-worker --entry src/main.ts

$terminalTXTCOPY

apoxy build [dir] [flags]

Options

$terminalTXTCOPY

--compatibility-date string workerd compatibility date for the bundle (default "2025-01-01") --compatibility-flags strings workerd compatibility flags for the bundle --entry string Entrypoint relative to the project dir (auto-detected when empty) -h, --help help for build --minify Minify the bundled entry module --out string Staging directory for the built bundle (default <dir>/.apoxy/build)

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy bundle

Manage compute service bundles

Synopsis

Bundles are the OCI artifacts compute Services run: JS/Wasm modules plus a manifest describing them. Build one with "apoxy build", push it with "apoxy bundle push", and reference it from Service.spec.source.oci.

Options

$terminalTXTCOPY

-h, --help help for bundle

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy bundle push - Push a built bundle to an OCI registry

apoxy bundle push

Push a built bundle to an OCI registry

Synopsis

Packages the staged build output as an OCI artifact and pushes it, printing the immutable digest to pin in Service.spec.source.oci.digest.

Authentication uses the local docker credential store (the same credentials "docker push" would use) unless --username is given, in which case the password is read from --password-stdin or $APOXY_REGISTRY_PASSWORD.

Examples:

Push the default build output

apoxy bundle push registry.example.com/acme/api

Push with an explicit tag and a CI token

echo "$TOKEN" | apoxy bundle push ghcr.io/acme/api:v3 --username acme-ci --password-stdin

$terminalTXTCOPY

apoxy bundle push <repo>[:tag] [flags]

Options

$terminalTXTCOPY

--dir string Staged bundle directory (the output of "apoxy build") (default ".apoxy/build") -h, --help help for push --password-stdin Read the registry password from stdin --username string Registry username; password comes from --password-stdin or $APOXY_REGISTRY_PASSWORD

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy bundle - Manage compute service bundles

apoxy compute

Manage compute objects

Synopsis

Manage compute.apoxy.dev objects: services and their revisions.

Options

$terminalTXTCOPY

-h, --help help for compute

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy compute service - Manage compute Service objects
• apoxy compute servicerevisions - List ServiceRevision objects

apoxy compute service

Manage compute Service objects

Synopsis

Service (compute.apoxy.dev/v1alpha1) runs a JS/TS worker bundle on the Apoxy edge.

$terminalTXTCOPY

apoxy compute service [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for service -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute - Manage compute objects
• apoxy compute service apply - Apply service configuration using server-side apply
• apoxy compute service create - Create service objects
• apoxy compute service delete - Delete service objects
• apoxy compute service get - Get service objects
• apoxy compute service list - List service objects
• apoxy compute service versions - List ServiceRevision objects

apoxy compute service apply

Apply service configuration using server-side apply

Synopsis

Apply service configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update service objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy compute service apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute service - Manage compute Service objects

apoxy compute service create

Create service objects

Synopsis

Create service objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy compute service create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute service - Manage compute Service objects

apoxy compute service delete

Delete service objects

$terminalTXTCOPY

apoxy compute service delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute service - Manage compute Service objects

apoxy compute service get

Get service objects

$terminalTXTCOPY

apoxy compute service get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute service - Manage compute Service objects

apoxy compute service list

List service objects

$terminalTXTCOPY

apoxy compute service list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the service's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute service - Manage compute Service objects

apoxy compute service versions

List ServiceRevision objects

Synopsis

ServiceRevision (compute.apoxy.dev/v1alpha1) is an immutable, digest-pinned snapshot minted by the controller each time a Service's template changes.

The optional [name] argument is the name of the owning Service, not of a revision: it restricts the list to that Service's revisions by matching the compute.apoxy.dev/service label. Omit it to list every revision in the project. A Service name that does not exist is not an error - it simply matches nothing and prints an empty table.

Use apoxy compute service versions get <revision> to inspect a single revision, whose name is the owning Service's name plus a short hash of its template and bundle.

$terminalTXTCOPY

apoxy compute service versions [name] [flags]

Examples

$terminalTXTCOPY

# List every revision in the project. apoxy compute service versions # List the revisions of the "checkout" Service. apoxy compute service versions checkout # Same, but also print each revision's labels (--show-labels is only # available on the list subcommand). apoxy compute service versions list checkout --show-labels # Inspect a single revision as YAML. apoxy compute service versions get checkout-3f9a1c7b2d -o yaml

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for versions -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute service - Manage compute Service objects
• apoxy compute service versions get - Get servicerevision objects
• apoxy compute service versions list - List a Service's revisions

apoxy compute service versions get

Get servicerevision objects

$terminalTXTCOPY

apoxy compute service versions get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute service versions - List ServiceRevision objects

apoxy compute service versions list

List a Service's revisions

Synopsis

ServiceRevision (compute.apoxy.dev/v1alpha1) is an immutable, digest-pinned snapshot minted by the controller each time a Service's template changes.

The optional [name] argument is the name of the owning Service, not of a revision: it restricts the list to that Service's revisions by matching the compute.apoxy.dev/service label. Omit it to list every revision in the project. A Service name that does not exist is not an error - it simply matches nothing and prints an empty table.

Use apoxy compute service versions get <revision> to inspect a single revision, whose name is the owning Service's name plus a short hash of its template and bundle.

$terminalTXTCOPY

apoxy compute service versions list [name] [flags]

Examples

$terminalTXTCOPY

# List every revision in the project. apoxy compute service versions # List the revisions of the "checkout" Service. apoxy compute service versions checkout # Same, but also print each revision's labels (--show-labels is only # available on the list subcommand). apoxy compute service versions list checkout --show-labels # Inspect a single revision as YAML. apoxy compute service versions get checkout-3f9a1c7b2d -o yaml

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the servicerevision's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute service versions - List ServiceRevision objects

apoxy compute servicerevisions

List ServiceRevision objects

Synopsis

ServiceRevision (compute.apoxy.dev/v1alpha1) is an immutable, digest-pinned snapshot minted by the controller each time a Service's template changes.

$terminalTXTCOPY

apoxy compute servicerevisions [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for servicerevisions -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute - Manage compute objects
• apoxy compute servicerevisions get - Get servicerevision objects
• apoxy compute servicerevisions list - List servicerevision objects

apoxy compute servicerevisions get

Get servicerevision objects

$terminalTXTCOPY

apoxy compute servicerevisions get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute servicerevisions - List ServiceRevision objects

apoxy compute servicerevisions list

List servicerevision objects

$terminalTXTCOPY

apoxy compute servicerevisions list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the servicerevision's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy compute servicerevisions - List ServiceRevision objects

apoxy delete

Delete resources by file or type/name

Synopsis

Delete resources identified in file(s), directories, stdin, or by type and name.

Supports two modes:

1. File-based: delete resources specified in YAML/JSON files, directories, or stdin.
2. Type+name: delete one or more resources by specifying the resource type and name(s).

When a directory is specified with -f, all .yaml, .yml, and .json files are processed.

Examples:

Delete resources in a single file

apoxy delete -f gateway.yaml

Delete resources in multiple files

apoxy delete -f gateway.yaml -f routes.yaml

Delete all resources in a directory

apoxy delete -f ./manifests/

Delete from stdin

cat manifest.yaml | apoxy delete -f -

Delete a resource by type and name

apoxy delete proxy my-proxy

Delete multiple resources by type and name

apoxy delete backend backend-a backend-b

Delete a resource, ignoring if it doesn't exist

apoxy delete proxy my-proxy --ignore-not-found

Delete and wait for the resource to be fully removed

apoxy delete proxy my-proxy --wait

$terminalTXTCOPY

apoxy delete (-f <filename> | <type> <name> [<name>...]) [flags]

Options

$terminalTXTCOPY

-f, --filename stringArray Files or directories containing resources to delete (can be specified multiple times) -h, --help help for delete --ignore-not-found Treat "resource not found" as a successful delete -R, --recursive Process directories recursively --timeout duration Timeout for --wait (e.g. 30s, 2m) (default 1m0s) --wait Wait for the resource to be fully deleted before returning

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy deploy

Build, push, and apply a compute Service end to end

Synopsis

Runs the full push-mode flow: build the project, push the bundle to the repository named by the Service manifest's spec.source.oci.repo, write the pushed digest into spec.source.oci.digest, and server-side apply the Service. The digest is pinned by the CLI so humans never hand-copy it.

The manifest defaults to service.yaml inside the project directory. When the project has no service.yaml yet, deploy generates a minimal one with a random docker-style name (override with --name) and continues.

A file path deploys a standalone worker rooted in the file's directory. For a nested entrypoint in a project or monorepo package, pass the project directory and set --entry to the project-relative source path.

Examples:

Build ., push to the repo in ./service.yaml, and apply it

apoxy deploy

Deploy a project from another directory (uses my-worker/service.yaml)

apoxy deploy ./my-worker

Deploy a nested entrypoint from a monorepo package

apoxy deploy ./edge --entry src/worker.js

Deploy a single-file worker (dir is the file's directory)

apoxy deploy ./worker.js

$terminalTXTCOPY

apoxy deploy [path] [flags]

Options

$terminalTXTCOPY

--compatibility-date string workerd compatibility date for the bundle (default "2025-01-01") --compatibility-flags strings workerd compatibility flags for the bundle --dir string Staging directory for the built bundle (default <dir>/.apoxy/build) --entry string Entrypoint relative to the project dir (auto-detected when empty) --field-manager string Name of the field manager for the manifest's server-side apply (default "apoxy-cli") -f, --filename string Compute Service manifest to deploy (default <dir>/service.yaml) --force-conflicts Force apply even if there are field ownership conflicts -h, --help help for deploy --minify Minify the bundled entry module --name string Service name for a generated service.yaml (default: a random docker-style name) --no-build Skip the build step and push the already-staged bundle --password-stdin Read the registry password from stdin --repo string Bundle repository to push to, overriding the manifest's spec.source.oci.repo (recorded in a generated service.yaml) --username string Registry username; password comes from --password-stdin or $APOXY_REGISTRY_PASSWORD -y, --yes Skip the deploy-target confirmation prompt (required for non-interactive runs)

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy dev

Develop against the Apoxy API locally

$terminalTXTCOPY

apoxy dev [path/to/proxy.yaml] [flags]

Options

$terminalTXTCOPY

--clickhouse-addr string ClickHouse address (host only, port 9000 will be used). -h, --help help for dev --use-subprocess Use subprocess for apiserver and backplane. --workerd-image apoxy dev Stock workerd OCI image to run the APO-796 compute Service runtime. When set, apoxy dev starts the privileged workerd-manager alongside the backplane (docker driver only).

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy domain

Manage domain record objects

Synopsis

Domain records configure DNS records and routing for your services.

$terminalTXTCOPY

apoxy domain [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for domain -o, --output string Output format: "json" or "yaml". Default is table. --zone string Filter domain records by zone name.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy domain apply - Apply domainrecord configuration using server-side apply
• apoxy domain create - Create domainrecord objects
• apoxy domain delete - Delete domainrecord objects
• apoxy domain get - Get domainrecord objects
• apoxy domain list - List domainrecord objects
• apoxy domain zone - Manage domain zone objects

apoxy domain apply

Apply domainrecord configuration using server-side apply

Synopsis

Apply domainrecord configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update domainrecord objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy domain apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain - Manage domain record objects

apoxy domain create

Create domainrecord objects

Synopsis

Create domainrecord objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy domain create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain - Manage domain record objects

apoxy domain delete

Delete domainrecord objects

$terminalTXTCOPY

apoxy domain delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain - Manage domain record objects

apoxy domain get

Get domainrecord objects

$terminalTXTCOPY

apoxy domain get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain - Manage domain record objects

apoxy domain list

List domainrecord objects

$terminalTXTCOPY

apoxy domain list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the domainrecord's labels. --zone string Filter domain records by zone name.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain - Manage domain record objects

apoxy domain zone

Manage domain zone objects

Synopsis

Domain zones represent DNS zones that domains are managed under.

$terminalTXTCOPY

apoxy domain zone [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for zone -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain - Manage domain record objects
• apoxy domain zone apply - Apply domainzone configuration using server-side apply
• apoxy domain zone create - Create domainzone objects
• apoxy domain zone delete - Delete domainzone objects
• apoxy domain zone get - Get domainzone objects
• apoxy domain zone list - List domainzone objects

apoxy domain zone apply

Apply domainzone configuration using server-side apply

Synopsis

Apply domainzone configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update domainzone objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy domain zone apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain zone - Manage domain zone objects

apoxy domain zone create

Create domainzone objects

Synopsis

Create domainzone objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy domain zone create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain zone - Manage domain zone objects

apoxy domain zone delete

Delete domainzone objects

$terminalTXTCOPY

apoxy domain zone delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain zone - Manage domain zone objects

apoxy domain zone get

Get domainzone objects

$terminalTXTCOPY

apoxy domain zone get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain zone - Manage domain zone objects

apoxy domain zone list

List domainzone objects

$terminalTXTCOPY

apoxy domain zone list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the domainzone's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy domain zone - Manage domain zone objects

apoxy edgefunction

Manage edge function objects

Synopsis

Edge functions allow you to run custom code at the edge of the Apoxy network.

$terminalTXTCOPY

apoxy edgefunction [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for edgefunction -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy edgefunction apply - Apply edge function configuration using server-side apply
• apoxy edgefunction create - Create edge function objects
• apoxy edgefunction delete - Delete edge function objects
• apoxy edgefunction get - Get edge function objects
• apoxy edgefunction list - List edge function objects

apoxy edgefunction apply

Apply edge function configuration using server-side apply

Synopsis

Apply edge function configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update edge function objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy edgefunction apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy edgefunction - Manage edge function objects

apoxy edgefunction create

Create edge function objects

Synopsis

Create edge function objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy edgefunction create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy edgefunction - Manage edge function objects

apoxy edgefunction delete

Delete edge function objects

$terminalTXTCOPY

apoxy edgefunction delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy edgefunction - Manage edge function objects

apoxy edgefunction get

Get edge function objects

$terminalTXTCOPY

apoxy edgefunction get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy edgefunction - Manage edge function objects

apoxy edgefunction list

List edge function objects

$terminalTXTCOPY

apoxy edgefunction list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the edge function's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy edgefunction - Manage edge function objects

apoxy gateway

Manage gateway objects

Synopsis

The gateway object in the Apoxy API.

$terminalTXTCOPY

apoxy gateway [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for gateway -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy gateway apply - Apply gateway configuration using server-side apply
• apoxy gateway create - Create gateway objects
• apoxy gateway delete - Delete gateway objects
• apoxy gateway get - Get gateway objects
• apoxy gateway list - List gateway objects
• apoxy gateway routes - Manage gateway routes (HTTP, TCP, TLS)

apoxy gateway apply

Apply gateway configuration using server-side apply

Synopsis

Apply gateway configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update gateway objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy gateway apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway - Manage gateway objects

apoxy gateway create

Create gateway objects

Synopsis

Create gateway objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy gateway create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway - Manage gateway objects

apoxy gateway delete

Delete gateway objects

$terminalTXTCOPY

apoxy gateway delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway - Manage gateway objects

apoxy gateway get

Get gateway objects

$terminalTXTCOPY

apoxy gateway get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway - Manage gateway objects

apoxy gateway list

List gateway objects

$terminalTXTCOPY

apoxy gateway list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the gateway's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway - Manage gateway objects

apoxy gateway routes

Manage gateway routes (HTTP, TCP, TLS)

Synopsis

Manage routes attached to gateways. Supports HTTPRoute, TCPRoute, and TLSRoute resources.

$terminalTXTCOPY

apoxy gateway routes [flags]

Options

$terminalTXTCOPY

-h, --help help for routes -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the route's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway - Manage gateway objects
• apoxy gateway routes apply - Apply a route configuration using server-side apply
• apoxy gateway routes create - Create a route from file
• apoxy gateway routes delete - Delete a route by name
• apoxy gateway routes get - Get a route by name
• apoxy gateway routes list - List all routes

apoxy gateway routes apply

Apply a route configuration using server-side apply

Synopsis

Apply a route configuration using Kubernetes server-side apply. The route type is detected from the file.

$terminalTXTCOPY

apoxy gateway routes apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string File containing the route configuration. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway routes - Manage gateway routes (HTTP, TCP, TLS)

apoxy gateway routes create

Create a route from file

Synopsis

Create a route from a YAML or JSON file. The route type is detected from the file.

$terminalTXTCOPY

apoxy gateway routes create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string File containing the route configuration. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway routes - Manage gateway routes (HTTP, TCP, TLS)

apoxy gateway routes delete

Delete a route by name

Synopsis

Delete a route by name. Optionally specify the type as a prefix.

Examples: apoxy gateway routes delete my-route # delete HTTPRoute (default) apoxy gateway routes delete http/my-route # delete HTTPRoute apoxy gateway routes delete tcp/my-route # delete TCPRoute apoxy gateway routes delete tls/my-route # delete TLSRoute

$terminalTXTCOPY

apoxy gateway routes delete [TYPE/]<name> [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway routes - Manage gateway routes (HTTP, TCP, TLS)

apoxy gateway routes get

Get a route by name

Synopsis

Get a route by name. Optionally specify the type as a prefix.

Examples: apoxy gateway routes get my-route # get HTTPRoute (default) apoxy gateway routes get http/my-route # get HTTPRoute apoxy gateway routes get tcp/my-route # get TCPRoute apoxy gateway routes get tls/my-route # get TLSRoute

$terminalTXTCOPY

apoxy gateway routes get [TYPE/]<name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway routes - Manage gateway routes (HTTP, TCP, TLS)

apoxy gateway routes list

List all routes

$terminalTXTCOPY

apoxy gateway routes list [flags]

Options

$terminalTXTCOPY

-h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the route's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy gateway routes - Manage gateway routes (HTTP, TCP, TLS)

apoxy k8s

Commands that manage Apoxy on Kubernetes

Options

$terminalTXTCOPY

-h, --help help for k8s

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy k8s certs - Manage the service-account certificate used by the in-cluster controller
• apoxy k8s install - Install Apoxy Controller in Kubernetes

apoxy k8s certs

Manage the service-account certificate used by the in-cluster controller

Options

$terminalTXTCOPY

-h, --help help for certs

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy k8s - Commands that manage Apoxy on Kubernetes
• apoxy k8s certs list - Show the in-cluster cert and its server-side status
• apoxy k8s certs revoke - Revoke a service-account cert by SHA1 fingerprint
• apoxy k8s certs rotate - Rotate the in-cluster cert without dropping the aggregated API

apoxy k8s certs list

Show the in-cluster cert and its server-side status

$terminalTXTCOPY

apoxy k8s certs list [flags]

Options

$terminalTXTCOPY

--all Also list every cert cosmos has for this project (including revoked) --context string Kubernetes context to use -h, --help help for list --kubeconfig string Path to the kubeconfig file --namespace string Namespace where the controller is installed (default "apoxy")

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy k8s certs - Manage the service-account certificate used by the in-cluster controller

apoxy k8s certs revoke

Revoke a service-account cert by SHA1 fingerprint

$terminalTXTCOPY

apoxy k8s certs revoke <fingerprint> [flags]

Options

$terminalTXTCOPY

-h, --help help for revoke --user-jwt string User JWT used for revoke; defaults to APOXY_USER_JWT then ~/.config/apoxy/user-jwt

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy k8s certs - Manage the service-account certificate used by the in-cluster controller

apoxy k8s certs rotate

Rotate the in-cluster cert without dropping the aggregated API

Synopsis

Rotate the service-account certificate held by the kube-controller Deployment.

The flow:

1. Issue a new cert from cosmos (the old cert remains valid).
2. Update Secret apoxy/apiz-cert with the new cert material.
3. Trigger a rolling restart of Deployment apoxy/kube-controller. With 1 replica and the default rolling-update strategy, k8s brings the new pod up Ready before terminating the old one, so traffic never goes through a controller with no cert.
4. Optionally revoke the old cert (requires a user JWT; cosmos refuses to accept API-key auth on revoke so a leaked API key can't kill its own cert).

If --revoke is not set, the old cert keeps working until natural expiry; the follow-up apoxy k8s certs revoke command is printed at the end.

$terminalTXTCOPY

apoxy k8s certs rotate [flags]

Options

$terminalTXTCOPY

--allow-disruption Allow rotate to proceed against multi-replica or Recreate-strategy Deployments --context string Kubernetes context to use -h, --help help for rotate --kubeconfig string Path to the kubeconfig file --namespace string Namespace where the controller is installed (default "apoxy") --no-restart Skip the pod-template restart; rely on the controller's fsnotify hot-reload (requires a controller built with hot-reload support) --reload-wait duration Maximum wait for the running pod to pick up the new cert when --no-restart is set (default 3m0s) --revoke Revoke the old cert after the rollout completes (needs --user-jwt or APOXY_USER_JWT) --user-jwt string User JWT used for revoke; defaults to APOXY_USER_JWT then ~/.config/apoxy/user-jwt --wait-timeout duration Maximum wait for the new pod to become Ready (kube-controller startup probe is generous) (default 5m0s) -y, --yes Skip the confirmation prompt

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy k8s certs - Manage the service-account certificate used by the in-cluster controller

apoxy k8s install

Install Apoxy Controller in Kubernetes

Synopsis

Install the Apoxy Controller into the target Kubernetes cluster.

This will create a new namespace and deploy the controller and supporting resources. The controller will automatically connect to the Apoxy API and begin managing your in-cluster Apoxy resources.

$terminalTXTCOPY

apoxy k8s install [flags]

Options

$terminalTXTCOPY

--cluster-name string Cluster name identifier (defaults to kube context name) --context string Kubernetes context to use from the kubeconfig file --dry-run If true, only print the YAML that would be applied --force If true, forces value overwrites (See: https://v1-28.docs.kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts) -h, --help help for install --image string Controller image override to pass to the onboarding manifest generator --kubeconfig string Path to the kubeconfig file to use for Kubernetes API access --mirror string Mirror mode (gateway, ingress, all) --namespace string The namespace to install the controller into (default "apoxy") --single-replica Render a single-replica controller manifest without pod anti-affinity or a PodDisruptionBudget (for single-node or resource-constrained clusters) --version string Controller version override (e.g. v0.3.0) --wait Wait for Deployments and StatefulSets to become healthy after apply (default true) --wait-timeout duration Maximum time to wait for workloads to become healthy (default 1m30s) -y, --yes Skip confirmation and apply changes immediately

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy k8s - Commands that manage Apoxy on Kubernetes

apoxy logs

View proxy logs

Synopsis

View the request/process logs generated by your proxies. Logs can be filtered by proxy instance and/or date range. By default, logs are streamed in real-time.

$terminalTXTCOPY

apoxy logs [flags]

Options

$terminalTXTCOPY

-f, --follow Follow logs in real-time -h, --help help for logs --json Output in raw JSON format -p, --proxy string Proxy name --since duration Show logs since a given duration (e.g. 5m, 1h) --since-time string Show logs from a given date (e.g. 2019-01-01T00:00:00Z)

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy proxy

Manage proxy objects

Synopsis

The controllers object in the Apoxy API.

$terminalTXTCOPY

apoxy proxy [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for proxy -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy proxy apply - Apply proxy configuration using server-side apply
• apoxy proxy create - Create proxy objects
• apoxy proxy delete - Delete proxy objects
• apoxy proxy get - Get proxy objects
• apoxy proxy list - List proxy objects

apoxy proxy apply

Apply proxy configuration using server-side apply

Synopsis

Apply proxy configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update proxy objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy proxy apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy proxy - Manage proxy objects

apoxy proxy create

Create proxy objects

Synopsis

Create proxy objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy proxy create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy proxy - Manage proxy objects

apoxy proxy delete

Delete proxy objects

$terminalTXTCOPY

apoxy proxy delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy proxy - Manage proxy objects

apoxy proxy get

Get proxy objects

$terminalTXTCOPY

apoxy proxy get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy proxy - Manage proxy objects

apoxy proxy list

List proxy objects

$terminalTXTCOPY

apoxy proxy list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the proxy's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy proxy - Manage proxy objects

apoxy run

Run Apoxy runtime components defined in config

Synopsis

Start and monitor all runtime components specified in the config file's runtime section.

Components are defined under runtime.components in the config. Example:

runtime: components:

• type: kube-aggregation kubeAggregation: clusterName: "prod-us-east-1" namespace: "apoxy"
• type: kube-mirror kubeMirror: mirror: "all"
• type: tunnel tunnel: mode: "kernel"

$terminalTXTCOPY

apoxy run [flags]

Options

$terminalTXTCOPY

-h, --help help for run

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy secret

Manage secret stores and their values

Synopsis

SecretStores hold named secret values that compute Services consume through secret bindings. Values are write-only: they can be set here but are never returned by the API; confirm writes via the key digests in 'secret list'.

Options

$terminalTXTCOPY

-h, --help help for secret

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy secret create - Create a secret store
• apoxy secret delete - Delete a secret store and all its values
• apoxy secret list - List secret stores, or one store's keys and value digests
• apoxy secret set - Set one secret value (from stdin or --from-file)
• apoxy secret unset - Delete one key from a secret store

apoxy secret create

Create a secret store

$terminalTXTCOPY

apoxy secret create <store> [flags]

Options

$terminalTXTCOPY

-h, --help help for create --scope strings Consumer scope, "<surface>" or "<surface>:<name-glob>" (e.g. compute:frontend-*); repeatable. Empty = open to all consumers

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy secret - Manage secret stores and their values

apoxy secret delete

Delete a secret store and all its values

$terminalTXTCOPY

apoxy secret delete <store> [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy secret - Manage secret stores and their values

apoxy secret list

List secret stores, or one store's keys and value digests

$terminalTXTCOPY

apoxy secret list [<store>] [flags]

Options

$terminalTXTCOPY

-h, --help help for list

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy secret - Manage secret stores and their values

apoxy secret set

Set one secret value (from stdin or --from-file)

Synopsis

Reads the value from --from-file when given, otherwise from stdin. A trailing newline is stripped from terminal input.

Examples: echo -n "$TOKEN" | apoxy secret set my-store api-token apoxy secret set my-store tls-key --from-file key.pem

$terminalTXTCOPY

apoxy secret set <store> <key> [flags]

Options

$terminalTXTCOPY

--from-file string Read the value from a file instead of stdin -h, --help help for set

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy secret - Manage secret stores and their values

apoxy secret unset

Delete one key from a secret store

$terminalTXTCOPY

apoxy secret unset <store> <key> [flags]

Options

$terminalTXTCOPY

-h, --help help for unset

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy secret - Manage secret stores and their values

apoxy tunnel

Manage tunnels

Synopsis

Manage WireGuard tunnels state and connect to the remote Apoxy Edge fabric.

$terminalTXTCOPY

apoxy tunnel [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for tunnel -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy tunnel apply - Apply tunnelnode configuration using server-side apply
• apoxy tunnel create - Create tunnelnode objects
• apoxy tunnel delete - Delete tunnelnode objects
• apoxy tunnel get - Get tunnelnode objects
• apoxy tunnel list - List tunnelnode objects
• apoxy tunnel run - Run a tunnel

apoxy tunnel apply

Apply tunnelnode configuration using server-side apply

Synopsis

Apply tunnelnode configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update tunnelnode objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy tunnel apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy tunnel - Manage tunnels

apoxy tunnel create

Create tunnelnode objects

Synopsis

Create tunnelnode objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy tunnel create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy tunnel - Manage tunnels

apoxy tunnel delete

Delete tunnelnode objects

$terminalTXTCOPY

apoxy tunnel delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy tunnel - Manage tunnels

apoxy tunnel get

Get tunnelnode objects

$terminalTXTCOPY

apoxy tunnel get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy tunnel - Manage tunnels

apoxy tunnel list

List tunnelnode objects

$terminalTXTCOPY

apoxy tunnel list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the tunnelnode's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy tunnel - Manage tunnels

apoxy tunnel run

Run a tunnel

Synopsis

Create a secure tunnel to the remote Apoxy Edge fabric.

$terminalTXTCOPY

apoxy tunnel run [flags]

Options

$terminalTXTCOPY

--auto Automatically create TunnelNode if it doesn't exist. --dns-addr string Listen address for the DNS proxy. Note that you must configure backplane to use this address as well. (default "127.0.0.1:8053") --endpoint-selection string Endpoint selection strategy: 'latency' (default) or 'random' (default "latency") --health-addr string Listen address for health endpoint (default: :8080). (default ":8080") -h, --help help for run --insecure-skip-verify Skip TLS certificate verification. --metrics-addr string Listen address for metrics endpoint (default: :8081). (default ":8081") --min-conns int Minimum number of connections to maintain. (default 1) -m, --mode string Mode to run the TunnelNode in. (default "user") --no-tui Disable TUI interface. -p, --pcap string Path to the TunnelNode file to create. --preserve-default-gw-dsts strings Preserve default gateway. --socks-addr string Listen address for SOCKS proxy. (default "localhost:1080")

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy tunnel - Manage tunnels

apoxy upgrade

Upgrade Apoxy CLI to the latest version

Synopsis

Upgrade Apoxy CLI to the latest version.

$terminalTXTCOPY

apoxy upgrade [flags]

Options

$terminalTXTCOPY

--force Force upgrade even for dev builds. -h, --help help for upgrade

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy version

The version of this CLI

$terminalTXTCOPY

apoxy version [flags]

Options

$terminalTXTCOPY

-h, --help help for version

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

apoxy vpc

Manage VPC networking objects

Synopsis

Manage vpc.apoxy.dev objects: networks, services, relays, and tunnels.

Options

$terminalTXTCOPY

-h, --help help for vpc

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
• apoxy vpc egressgateway - Manage EgressGateway objects
• apoxy vpc egressroute - Manage EgressRoute objects
• apoxy vpc network - Manage VPC networks
• apoxy vpc relay - Inspect relays
• apoxy vpc service - Manage VPC services
• apoxy vpc tunnel - Inspect tunnels

apoxy vpc egressgateway

Manage EgressGateway objects

Synopsis

EgressGateway (compute.apoxy.dev/v1alpha1) declares egress interception listeners and a default policy for compute Services' outbound traffic.

$terminalTXTCOPY

apoxy vpc egressgateway [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for egressgateway -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc - Manage VPC networking objects
• apoxy vpc egressgateway apply - Apply egressgateway configuration using server-side apply
• apoxy vpc egressgateway create - Create egressgateway objects
• apoxy vpc egressgateway delete - Delete egressgateway objects
• apoxy vpc egressgateway get - Get egressgateway objects
• apoxy vpc egressgateway list - List egressgateway objects

apoxy vpc egressgateway apply

Apply egressgateway configuration using server-side apply

Synopsis

Apply egressgateway configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update egressgateway objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy vpc egressgateway apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressgateway - Manage EgressGateway objects

apoxy vpc egressgateway create

Create egressgateway objects

Synopsis

Create egressgateway objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy vpc egressgateway create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressgateway - Manage EgressGateway objects

apoxy vpc egressgateway delete

Delete egressgateway objects

$terminalTXTCOPY

apoxy vpc egressgateway delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressgateway - Manage EgressGateway objects

apoxy vpc egressgateway get

Get egressgateway objects

$terminalTXTCOPY

apoxy vpc egressgateway get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressgateway - Manage EgressGateway objects

apoxy vpc egressgateway list

List egressgateway objects

$terminalTXTCOPY

apoxy vpc egressgateway list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the egressgateway's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressgateway - Manage EgressGateway objects

apoxy vpc egressroute

Manage EgressRoute objects

Synopsis

EgressRoute (compute.apoxy.dev/v1alpha1) allows destination-matched egress for the compute Services attached to its parent EgressGateway(s).

$terminalTXTCOPY

apoxy vpc egressroute [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for egressroute -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc - Manage VPC networking objects
• apoxy vpc egressroute apply - Apply egressroute configuration using server-side apply
• apoxy vpc egressroute create - Create egressroute objects
• apoxy vpc egressroute delete - Delete egressroute objects
• apoxy vpc egressroute get - Get egressroute objects
• apoxy vpc egressroute list - List egressroute objects

apoxy vpc egressroute apply

Apply egressroute configuration using server-side apply

Synopsis

Apply egressroute configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update egressroute objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy vpc egressroute apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressroute - Manage EgressRoute objects

apoxy vpc egressroute create

Create egressroute objects

Synopsis

Create egressroute objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy vpc egressroute create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressroute - Manage EgressRoute objects

apoxy vpc egressroute delete

Delete egressroute objects

$terminalTXTCOPY

apoxy vpc egressroute delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressroute - Manage EgressRoute objects

apoxy vpc egressroute get

Get egressroute objects

$terminalTXTCOPY

apoxy vpc egressroute get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressroute - Manage EgressRoute objects

apoxy vpc egressroute list

List egressroute objects

$terminalTXTCOPY

apoxy vpc egressroute list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the egressroute's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc egressroute - Manage EgressRoute objects

apoxy vpc network

Manage VPC networks

Synopsis

VPCNetwork is the domain object for a virtual private network on the Apoxy Edge fabric.

$terminalTXTCOPY

apoxy vpc network [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for network -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc - Manage VPC networking objects
• apoxy vpc network apply - Apply vpcnetwork configuration using server-side apply
• apoxy vpc network create - Create vpcnetwork objects
• apoxy vpc network delete - Delete vpcnetwork objects
• apoxy vpc network get - Get vpcnetwork objects
• apoxy vpc network list - List vpcnetwork objects

apoxy vpc network apply

Apply vpcnetwork configuration using server-side apply

Synopsis

Apply vpcnetwork configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update vpcnetwork objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy vpc network apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc network - Manage VPC networks

apoxy vpc network create

Create vpcnetwork objects

Synopsis

Create vpcnetwork objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy vpc network create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc network - Manage VPC networks

apoxy vpc network delete

Delete vpcnetwork objects

$terminalTXTCOPY

apoxy vpc network delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc network - Manage VPC networks

apoxy vpc network get

Get vpcnetwork objects

$terminalTXTCOPY

apoxy vpc network get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc network - Manage VPC networks

apoxy vpc network list

List vpcnetwork objects

$terminalTXTCOPY

apoxy vpc network list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the vpcnetwork's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc network - Manage VPC networks

apoxy vpc relay

Inspect relays

Synopsis

Relay objects are registered by tunnel relays and are read-only from the CLI.

$terminalTXTCOPY

apoxy vpc relay [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for relay -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc - Manage VPC networking objects
• apoxy vpc relay get - Get relay objects
• apoxy vpc relay list - List relay objects

apoxy vpc relay get

Get relay objects

$terminalTXTCOPY

apoxy vpc relay get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc relay - Inspect relays

apoxy vpc relay list

List relay objects

$terminalTXTCOPY

apoxy vpc relay list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the relay's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc relay - Inspect relays

apoxy vpc service

Manage VPC services

Synopsis

VPCService selects tunnels within a VPC network and exposes their endpoints.

$terminalTXTCOPY

apoxy vpc service [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for service -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc - Manage VPC networking objects
• apoxy vpc service apply - Apply vpcservice configuration using server-side apply
• apoxy vpc service create - Create vpcservice objects
• apoxy vpc service delete - Delete vpcservice objects
• apoxy vpc service get - Get vpcservice objects
• apoxy vpc service list - List vpcservice objects

apoxy vpc service apply

Apply vpcservice configuration using server-side apply

Synopsis

Apply vpcservice configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update vpcservice objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

$terminalTXTCOPY

apoxy vpc service apply [-f filename] [flags]

Options

$terminalTXTCOPY

--field-manager string Name of the field manager for server-side apply. (default "apoxy-cli") -f, --filename string The file that contains the configuration to apply. --force-conflicts Force apply even if there are field ownership conflicts. -h, --help help for apply

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc service - Manage VPC services

apoxy vpc service create

Create vpcservice objects

Synopsis

Create vpcservice objects by providing a configuration as a file or via stdin.

$terminalTXTCOPY

apoxy vpc service create [-f filename] [flags]

Options

$terminalTXTCOPY

-f, --filename string The file that contains the configuration to create. -h, --help help for create

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc service - Manage VPC services

apoxy vpc service delete

Delete vpcservice objects

$terminalTXTCOPY

apoxy vpc service delete [flags]

Options

$terminalTXTCOPY

-h, --help help for delete

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc service - Manage VPC services

apoxy vpc service get

Get vpcservice objects

$terminalTXTCOPY

apoxy vpc service get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc service - Manage VPC services

apoxy vpc service list

List vpcservice objects

$terminalTXTCOPY

apoxy vpc service list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the vpcservice's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc service - Manage VPC services

apoxy vpc tunnel

Inspect tunnels

Synopsis

Tunnel objects represent live agent connections and are read-only from the CLI.

$terminalTXTCOPY

apoxy vpc tunnel [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for tunnel -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc - Manage VPC networking objects
• apoxy vpc tunnel get - Get tunnel objects
• apoxy vpc tunnel list - List tunnel objects

apoxy vpc tunnel get

Get tunnel objects

$terminalTXTCOPY

apoxy vpc tunnel get <name> [flags]

Options

$terminalTXTCOPY

-h, --help help for get -o, --output string Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc tunnel - Inspect tunnels

apoxy vpc tunnel list

List tunnel objects

$terminalTXTCOPY

apoxy vpc tunnel list [flags]

Options

$terminalTXTCOPY

--field-selector string Filter list results by field selectors (e.g. spec.zone=example.com). -h, --help help for list -o, --output string Output format: "json" or "yaml". Default is table. --show-labels Print the tunnel's labels.

Options inherited from parent commands

$terminalTXTCOPY

--alsologtostderr Log to standard error as well as files. --config string Config file (default is $HOME/.apoxy/config.yaml). --local Run in local mode. --pprof Enable pprof HTTP server on :6060. --project string The project ID to use. -v, --verbose Enable verbose output.

SEE ALSO

• apoxy vpc tunnel - Inspect tunnels