HTTP Server#
Management → HSHTTP Servers
The HTTPServer enables the JSON-RPC programmable interface on a node.
Support is currently limited to SR Linux.
HTTPS#
If the selected protocol is HTTPS instead of HTTP, the tlsProfile property must reference a valid TLS profile deployed on the node.
Dependencies#
Each HTTPServer resource targets either a ManagementRouter, a DefaultRouter, or a Router. While only one of the three is required, all three are listed as dependencies.
ManagementRouter#
If the HTTPServer is reachable through a ManagementRouter, the resource referenced by the router property must exist.
Management routers cannot be selected through label selectors.
DefaultRouter#
If the HTTPServer is reachable through a DefaultRouter, the resource referenced by the router property must exist.
Label selectors may be used to select multiple DefaultRouters.
Router#
If the HTTPServer is reachable through a Router, the resource referenced by the router property must exist.
Routers cannot be selected through label selectors.
Referenced resources#
The HTTPServer does not reference any other EDA resources.
Examples#
Custom Resource Definition#
To browse the Custom Resource Definition go to crd.eda.dev.
HTTPServer
SPEC
HTTPServerSpec defines the desired state of HTTPServer
-
Enable authentication for the HTTP(s) server.
-
Enable the HTTP API server.
-
Port for the server to listen on.
format: int32range: 1 to 65535 -
Specifies the protocol to use.
enum: "HTTP", "HTTPS" -
Router to associate the server with.
-
The Kind of the router for the server.
enum: "ManagementRouter", "Router", "DefaultRouter" -
Selects router resources based on the defined Kind. Applies to DefaultRouter only. Not supported for Router and ManagementRouter.
-
Maximum number of HTTP(s) sessions.
format: int32range: 0 to 65535 -
TLS profile name to use with HTTPS protocol.
STATUS
HTTPServerStatus defines the observed state of HTTPServer
-
Health score of the HTTP server.
format: int32range: <= 100 -
Reason for the health score.
-
Indicates when the HTTP server last changed state.
-
Operational state of the HTTP server.
enum: "Up", "Down", "Degraded", "Unknown"