Skip to content

[Feature]: Allow services to declare that they require a gateway #3412

@jvstme

Description

@jvstme

Problem

Some services cannot run without a gateway, e.g., if they use websockets or do not support running with a path prefix. However, it is not possible to indicate in a service configuration that a gateway is required. Consequently, users may run the service without a gateway and experience unexpected behavior.

Solution

Allow setting gateway: true in service configurations, which will enforce that the service runs on the default gateway or fails if one isn't available.

This setting is an addition to the existing gateway: false (do not use a gateway) and gateway: <name> (use the specified gateway).

Workaround

  • Use gateway: <name> if you know in advance which gateway will be used.
  • Leave a comment in the service configuration hoping that those applying the configuration will check for a gateway.

Would you like to help us implement this feature by sending a PR?

Yes

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions