API Reference for ArangoRoute V1Alpha1

Spec

.spec.deployment

Type: string [ref]

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.checksum

Type: string [ref]

UID keeps the information about object Checksum


.spec.destination.endpoints.name

Type: string [ref]

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]

Port defines Port or Port Name used as destination


.spec.destination.endpoints.uid

Type: string [ref]

UID keeps the information about object UID


.spec.destination.path

Type: string [ref]

Path defines service path used for overrides


.spec.destination.schema

Type: string [ref]

Schema defines HTTP/S schema used for connection


.spec.destination.service.checksum

Type: string [ref]

UID keeps the information about object Checksum


.spec.destination.service.name

Type: string [ref]

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]

Port defines Port or Port Name used as destination


.spec.destination.service.uid

Type: string [ref]

UID keeps the information about object UID


.spec.destination.tls.insecure

Type: boolean [ref]

Insecure allows Insecure traffic


.spec.route.path

Type: string [ref]

Path specifies the Path route

Status

.status.conditions

Type: api.Conditions [ref]

Conditions specific to the entire extension


.status.deployment.checksum

Type: string [ref]

UID keeps the information about object Checksum


.status.deployment.name

Type: string [ref]

Name of the object


.status.deployment.namespace

Type: string [ref]

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


.status.deployment.uid

Type: string [ref]

UID keeps the information about object UID


.status.target.authentication.passMode

Type: string [ref]


.status.target.authentication.type

Type: string [ref]


.status.target.destinations[int].host

Type: string [ref]


.status.target.destinations[int].port

Type: integer [ref]


.status.target.path

Type: string [ref]

Path specifies request path override


.status.target.TLS.insecure

Type: boolean [ref]

Insecure allows Insecure traffic


.status.target.type

Type: string [ref]

Type define destination type