boe gen-config

The gen-config command generates Envoy configuration YAML for the specified extensions. This is useful for inspecting the generated configuration, integrating with existing Envoy deployments, or using with external Envoy management tools.

By default, it outputs a complete Envoy bootstrap configuration ready to use with Envoy. Use the --minimal flag to generate only the extension-generated resources (useful for embedding in existing configs).

You can enable multiple extensions using the --extension flag, and also load extensions from local directories using --local for development and testing purposes.

Remote composer (Go plugin) extensions use oci:// URLs in the generated configuration, allowing Envoy to fetch the plugin binary directly from the OCI registry at runtime. Local extensions use file:// URLs pointing to the locally cached binaries.

Examples

Generate a complete Envoy configuration for the desired extensions:

boe gen-config --extension ip-restriction
boe gen-config --local ~/src/my-extension
# Generate minimal configuration with only extension-generated resources
boe gen-config --extension ip-restriction --minimal

Export the configuration and extension files to a folder by providing the --output flag:

boe gen-config --extension ip-restriction --output /tmp/export

Generate configuration providing dedicated JSON config to an extension:

boe gen-config --local ~/src/my-extension --config '{"client_id":"my-id","client_secret":"my-secret"}'

Generate configuration with an additional upstream cluster using the shorthand format host:tlsPort. The cluster name is the short format string itself (e.g. my-service.example.com:443):

boe gen-config --local ~/src/my-extension --cluster my-service.example.com:443

For full control over the cluster configuration, raw JSON is also supported:

boe gen-config --local ~/src/my-extension --cluster-json '{"name":"my-service","type":"STRICT_DNS","load_assignment":{"cluster_name":"my-service","endpoints":[{"lb_endpoints":[{"endpoint":{"address":{"socket_address":{"address":"my-service.example.com","port_value":443}}}}]}]}}'

Generate configuration from a specific version hosted in a custom OCI registry:

export BOE_REGISTRY=acme.org/extensions
export BOE_REGISTRY_USERNAME=username
export BOE_REGISTRY_PASSWORD=password

boe gen-config --extension example-go:0.3.0

Usage details

boe gen-config [flags]
boe gen-config --help

Flags