2024-07-26 08:32:36 +00:00
|
|
|
---
|
|
|
|
layout: page
|
|
|
|
parent: CRD reference
|
|
|
|
title: ArangoRoute V1Alpha1
|
|
|
|
---
|
|
|
|
|
|
|
|
# API Reference for ArangoRoute V1Alpha1
|
|
|
|
|
|
|
|
## Spec
|
|
|
|
|
|
|
|
### .spec.deployment
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_spec.go#L27)</sup>
|
|
|
|
|
2024-09-01 11:26:51 +00:00
|
|
|
Deployment specifies the ArangoDeployment object name
|
|
|
|
|
|
|
|
***
|
|
|
|
|
2024-09-03 15:50:59 +00:00
|
|
|
### .spec.destination.authentication.type
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_spec_destination_authentication.go#L28)</sup>
|
|
|
|
|
|
|
|
***
|
|
|
|
|
2024-09-01 11:26:51 +00:00
|
|
|
### .spec.destination.path
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_spec_destination.go#L36)</sup>
|
|
|
|
|
|
|
|
Path defines service path used for overrides
|
2024-07-26 08:32:36 +00:00
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .spec.destination.schema
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_spec_destination.go#L30)</sup>
|
|
|
|
|
|
|
|
Schema defines HTTP/S schema used for connection
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .spec.destination.service.checksum
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
|
|
|
|
|
|
|
|
UID keeps the information about object Checksum
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .spec.destination.service.name
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
|
|
|
|
|
|
|
|
Name of the object
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .spec.destination.service.namespace
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
|
|
|
|
|
|
|
|
Namespace of the object. Should default to the namespace of the parent object
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .spec.destination.service.port
|
|
|
|
|
|
|
|
Type: `intstr.IntOrString` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_spec_destination_service.go#L36)</sup>
|
|
|
|
|
|
|
|
Port defines Port or Port Name used as destination
|
|
|
|
|
|
|
|
Links:
|
|
|
|
* [Documentation](https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/)
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .spec.destination.service.uid
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
|
|
|
|
|
|
|
|
UID keeps the information about object UID
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .spec.destination.tls.insecure
|
|
|
|
|
|
|
|
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_spec_destination_tls.go#L25)</sup>
|
|
|
|
|
|
|
|
Insecure allows Insecure traffic
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .spec.route.path
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_spec_route.go#L29)</sup>
|
|
|
|
|
|
|
|
Path specifies the Path route
|
|
|
|
|
|
|
|
## Status
|
|
|
|
|
|
|
|
### .status.conditions
|
|
|
|
|
2024-08-01 12:53:48 +00:00
|
|
|
Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_status.go#L31)</sup>
|
2024-07-26 08:32:36 +00:00
|
|
|
|
|
|
|
Conditions specific to the entire extension
|
|
|
|
|
2024-08-01 12:53:48 +00:00
|
|
|
***
|
|
|
|
|
|
|
|
### .status.deployment.checksum
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
|
|
|
|
|
|
|
|
UID keeps the information about object Checksum
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .status.deployment.name
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
|
|
|
|
|
|
|
|
Name of the object
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .status.deployment.namespace
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
|
|
|
|
|
|
|
|
Namespace of the object. Should default to the namespace of the parent object
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .status.deployment.uid
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
|
|
|
|
|
|
|
|
UID keeps the information about object UID
|
|
|
|
|
|
|
|
***
|
|
|
|
|
2024-09-03 15:50:59 +00:00
|
|
|
### .status.target.authentication.type
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_status_target_authentication.go#L26)</sup>
|
|
|
|
|
|
|
|
***
|
|
|
|
|
2024-09-01 11:26:51 +00:00
|
|
|
### .status.target.destinations\[int\].host
|
2024-08-01 12:53:48 +00:00
|
|
|
|
2024-09-01 11:26:51 +00:00
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_status_target_destination.go#L38)</sup>
|
2024-08-01 12:53:48 +00:00
|
|
|
|
2024-09-01 11:26:51 +00:00
|
|
|
***
|
|
|
|
|
|
|
|
### .status.target.destinations\[int\].port
|
|
|
|
|
|
|
|
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_status_target_destination.go#L39)</sup>
|
2024-08-01 12:53:48 +00:00
|
|
|
|
|
|
|
***
|
|
|
|
|
2024-09-01 11:26:51 +00:00
|
|
|
### .status.target.path
|
|
|
|
|
2024-09-03 15:50:59 +00:00
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_status_target.go#L40)</sup>
|
2024-09-01 11:26:51 +00:00
|
|
|
|
|
|
|
Path specifies request path override
|
|
|
|
|
|
|
|
***
|
2024-08-01 12:53:48 +00:00
|
|
|
|
2024-09-01 11:26:51 +00:00
|
|
|
### .status.target.TLS.insecure
|
|
|
|
|
|
|
|
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/networking/v1alpha1/route_status_target_tls.go#L27)</sup>
|
|
|
|
|
|
|
|
Insecure allows Insecure traffic
|
2024-08-01 12:53:48 +00:00
|
|
|
|