API Reference for ArangoRoute V1Beta1

Spec

.spec.deployment

Type: string [ref]

This field is required

Deployment specifies the ArangoDeployment object name


.spec.destination.authentication.passMode

Type: string [ref]

PassMode define authorization details pass mode when authorization was successful

Possible Values:

  • "override" (default) - Generates new token for the user
  • "pass" - Pass token provided by the user
  • "remove" - Removes authorization details from the request

.spec.destination.authentication.type

Type: string [ref]

Type of the authentication

Possible Values:

  • "optional" (default) - Authentication is header is validated and passed to the service. In case if is unauthorized, requests is still passed
  • "required" - Authentication is header is validated and passed to the service. In case if is unauthorized, returns 403

.spec.destination.endpoints.name

Type: string [ref]

This field is required

Name of the object


.spec.destination.endpoints.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.spec.destination.endpoints.port

Type: intstr.IntOrString [ref]

This field is required

Port defines Port or Port Name used as destination


.spec.destination.path

Type: string [ref]

Path defines service path used for overrides


.spec.destination.protocol

Type: string [ref]

Protocol defines http protocol used for the route

Possible Values:

  • "http1" (default) - HTTP 1.1 Protocol
  • "http2" - HTTP 2 Protocol

.spec.destination.redirect.code

Type: integer [ref]

Code the redirection response status code

Default Value: 307


.spec.destination.schema

Type: string [ref]

Schema defines HTTP/S schema used for connection

Possible Values:

  • "http" (default) - HTTP Connection
  • "https" - HTTPS Connection (HTTP with TLS)

.spec.destination.service.name

Type: string [ref]

This field is required

Name of the object


.spec.destination.service.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.spec.destination.service.port

Type: intstr.IntOrString [ref]

This field is required

Port defines Port or Port Name used as destination


.spec.destination.timeout

Type: string [ref]

Timeout specify the upstream request timeout

Default Value: 1m0s


.spec.destination.tls.insecure

Type: boolean [ref]

Insecure allows Insecure traffic


.spec.options.upgrade[int].enabled

Type: boolean [ref]

Enabled defines if upgrade option is enabled


.spec.options.upgrade[int].type

Type: string [ref]

Type defines type of the Upgrade

Possible Values:

  • "websocket" (default) - HTTP WebSocket Upgrade type

.spec.route.path

Type: string [ref]

Path specifies the Path route