Route [route.openshift.io/v1]
Important
Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.
Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us
- Description
-
A route allows developers to expose services through an HTTP(S) aware load balancing and proxy layer via a public DNS entry. The route may further specify TLS options and a certificate, or specify a public CNAME that the router should also accept for HTTP and HTTPS traffic. An administrator typically configures their router to be visible outside the cluster firewall, and may also add additional security, caching, or traffic controls on the service content. Routers usually talk directly to the service endpoints.
Once a route is created, the host field may not be changed. Generally, routers use the oldest route with a given host when resolving conflicts.
Routers are subject to additional customization and may support additional controls via the annotations field.
Because administrators may configure multiple routers, the route status field is used to return information to clients about the names and states of the route under each router. If a client chooses a duplicate name, for instance, the route status conditions are used to indicate the route cannot be chosen.
- Type
-
object - Required
-
-
spec
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
|
Standard object metadata. |
|
|
|
RouteSpec describes the hostname or path the route exposes, any security information, and one to four backends (services) the route points to. Requests are distributed among the backends depending on the weights assigned to each backend. When using roundrobin scheduling the portion of requests that go to each backend is the backend weight divided by the sum of all of the backend weights. When the backend has more than one endpoint the requests that end up on the backend are roundrobin distributed among the endpoints. Weights are between 0 and 256 with default 1. Weight 0 causes no requests to the backend. If all weights are zero the route will be considered to have no backends and return a standard 503 response. The |
|
|
RouteStatus provides relevant info about the status of a route, including which routers acknowledge it. |
- Description
-
RouteSpec describes the hostname or path the route exposes, any security information, and one to four backends (services) the route points to. Requests are distributed among the backends depending on the weights assigned to each backend. When using roundrobin scheduling the portion of requests that go to each backend is the backend weight divided by the sum of all of the backend weights. When the backend has more than one endpoint the requests that end up on the backend are roundrobin distributed among the endpoints. Weights are between 0 and 256 with default 1. Weight 0 causes no requests to the backend. If all weights are zero the route will be considered to have no backends and return a standard 503 response.
The tls field is optional and allows specific certificates or behavior for the route. Routers typically configure a default certificate on a wildcard domain to terminate routes without explicit certificates, but custom hostnames usually must choose passthrough (send traffic directly to the backend via the TLS Server-Name- Indication field) or provide a certificate.
- Type
-
object - Required
-
-
to
-
| Property | Type | Description |
|---|---|---|
|
|
alternateBackends allows up to 3 additional backends to be assigned to the route. Only the Service kind is allowed, and it will be defaulted to Service. Use the weight field in RouteTargetReference object to specify relative preference. |
|
|
RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others. |
|
|
host is an alias/DNS that points to the service. Optional. If not specified a route name will typically be automatically chosen. Must follow DNS952 subdomain conventions. |
|
|
Path that the router watches for, to route traffic for to the service. Optional |
|
|
RoutePort defines a port mapping from a router to an endpoint in the service endpoints. |
|
|
TLSConfig defines config used to secure a route and provide termination |
|
|
RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others. |
|
|
Wildcard policy if any for the route. Currently only 'Subdomain' or 'None' is allowed. |
- Description
-
alternateBackends allows up to 3 additional backends to be assigned to the route. Only the Service kind is allowed, and it will be defaulted to Service. Use the weight field in RouteTargetReference object to specify relative preference.
- Type
-
array
- Description
-
RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others.
- Type
-
object - Required
-
-
kind -
name
-
| Property | Type | Description |
|---|---|---|
|
|
The kind of target that the route is referring to. Currently, only 'Service' is allowed |
|
|
name of the service/target that is being referred to. e.g. name of the service |
|
|
weight as an integer between 0 and 256, default 1, that specifies the target’s relative weight against other target reference objects. 0 suppresses requests to this backend. |
- Description
-
RoutePort defines a port mapping from a router to an endpoint in the service endpoints.
- Type
-
object - Required
-
-
targetPort
-
| Property | Type | Description |
|---|---|---|
|
The target port on pods selected by the service this route points to. If this is a string, it will be looked up as a named port in the target endpoints port list. Required |
- Description
-
TLSConfig defines config used to secure a route and provide termination
- Type
-
object - Required
-
-
termination
-
| Property | Type | Description |
|---|---|---|
|
|
caCertificate provides the cert authority certificate contents |
|
|
certificate provides certificate contents |
|
|
destinationCACertificate provides the contents of the ca certificate of the final destination. When using reencrypt termination this file should be provided in order to have routers use it for health checks on the secure connection. If this field is not specified, the router may provide its own destination CA and perform hostname validation using the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically verify. |
|
|
insecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to a route. While each router may make its own decisions on which ports to expose, this is normally port 80. * Allow - traffic is sent to the server on the insecure port (default) * Disable - no traffic is allowed on the insecure port. * Redirect - clients are redirected to the secure port. |
|
|
key provides key file contents |
|
|
termination indicates termination type. |
- Description
-
RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others.
- Type
-
object - Required
-
-
kind -
name
-
| Property | Type | Description |
|---|---|---|
|
|
The kind of target that the route is referring to. Currently, only 'Service' is allowed |
|
|
name of the service/target that is being referred to. e.g. name of the service |
|
|
weight as an integer between 0 and 256, default 1, that specifies the target’s relative weight against other target reference objects. 0 suppresses requests to this backend. |
- Description
-
RouteStatus provides relevant info about the status of a route, including which routers acknowledge it.
- Type
-
object - Required
-
-
ingress
-
| Property | Type | Description |
|---|---|---|
|
|
ingress describes the places where the route may be exposed. The list of ingress points may contain duplicate Host or RouterName values. Routes are considered live once they are |
|
|
RouteIngress holds information about the places where a route is exposed. |
- Description
-
ingress describes the places where the route may be exposed. The list of ingress points may contain duplicate Host or RouterName values. Routes are considered live once they are
Ready - Type
-
array
- Description
-
RouteIngress holds information about the places where a route is exposed.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
Conditions is the state of the route, may be empty. |
|
|
RouteIngressCondition contains details for the current condition of this route on a particular router. |
|
|
Host is the host string under which the route is exposed; this value is required |
|
|
CanonicalHostname is the external host name for the router that can be used as a CNAME for the host requested for this route. This value is optional and may not be set in all cases. |
|
|
Name is a name chosen by the router to identify itself; this value is required |
|
|
Wildcard policy is the wildcard policy that was allowed where this route is exposed. |
- Description
-
Conditions is the state of the route, may be empty.
- Type
-
array
- Description
-
RouteIngressCondition contains details for the current condition of this route on a particular router.
- Type
-
object - Required
-
-
type -
status
-
| Property | Type | Description |
|---|---|---|
|
RFC 3339 date and time when this condition last transitioned |
|
|
|
Human readable message indicating details about last transition. |
|
|
(brief) reason for the condition’s last transition, and is usually a machine and human readable constant |
|
|
Status is the status of the condition. Can be True, False, Unknown. |
|
|
Type is the type of the condition. Currently only Ready. |
API endpoints
The following API endpoints are available:
-
/apis/route.openshift.io/v1/routes-
GET: list or watch objects of kind Route
-
-
/apis/route.openshift.io/v1/namespaces/{namespace}/routes-
DELETE: delete collection of Route -
GET: list or watch objects of kind Route -
POST: create a Route
-
-
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}-
DELETE: delete a Route -
GET: read the specified Route -
PATCH: partially update the specified Route -
PUT: replace the specified Route
-
-
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}/status-
GET: read status of the specified Route -
PATCH: partially update status of the specified Route -
PUT: replace status of the specified Route
-
/apis/route.openshift.io/v1/routes
| Parameter | Type | Description |
|---|---|---|
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
If true, partially initialized resources are included in the response. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
If 'true', then the output is pretty printed. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
- HTTP method
-
GET - Description
-
list or watch objects of kind Route
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
/apis/route.openshift.io/v1/namespaces/{namespace}/routes
| Parameter | Type | Description |
|---|---|---|
|
|
object name and auth scope, such as for teams and projects |
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
DELETE - Description
-
delete collection of Route
| Parameter | Type | Description |
|---|---|---|
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
If true, partially initialized resources are included in the response. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
- HTTP method
-
GET - Description
-
list or watch objects of kind Route
| Parameter | Type | Description |
|---|---|---|
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
If true, partially initialized resources are included in the response. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
- HTTP method
-
POST - Description
-
create a Route
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
name of the Route |
|
|
object name and auth scope, such as for teams and projects |
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
DELETE - Description
-
delete a Route
| Parameter | Type | Description |
|---|---|---|
|
|
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
|
|
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
|
|
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
- HTTP method
-
GET - Description
-
read the specified Route
| Parameter | Type | Description |
|---|---|---|
|
|
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
|
|
Should this value be exported. Export strips fields that a user can not specify. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
- HTTP method
-
PATCH - Description
-
partially update the specified Route
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
- HTTP method
-
PUT - Description
-
replace the specified Route
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}/status
| Parameter | Type | Description |
|---|---|---|
|
|
name of the Route |
|
|
object name and auth scope, such as for teams and projects |
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
GET - Description
-
read status of the specified Route
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
- HTTP method
-
PATCH - Description
-
partially update status of the specified Route
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
- HTTP method
-
PUT - Description
-
replace status of the specified Route
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |