ea88c8803d
use istio client-go library instead of knative bump kubernetes dependency version change code coverage to codecov
764 lines
36 KiB
JSON
764 lines
36 KiB
JSON
{
|
||
"openapi": "3.0.0",
|
||
"info": {
|
||
"title": "Configuration affecting label/content routing, sni routing, etc.",
|
||
"version": "v1alpha3"
|
||
},
|
||
"components": {
|
||
"schemas": {
|
||
"istio.networking.v1alpha3.PortSelector": {
|
||
"description": "PortSelector specifies the number of a port to be used for matching or selection for final routing.",
|
||
"type": "object",
|
||
"properties": {
|
||
"number": {
|
||
"description": "Valid port number",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.VirtualService": {
|
||
"description": "Configuration affecting traffic routing.",
|
||
"type": "object",
|
||
"properties": {
|
||
"exportTo": {
|
||
"description": "A list of namespaces to which this virtual service is exported. Exporting a virtual service allows it to be used by sidecars and gateways defined in other namespaces. This feature provides a mechanism for service owners and mesh administrators to control the visibility of virtual services across namespace boundaries.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"tls": {
|
||
"description": "An ordered list of route rule for non-terminated TLS \u0026 HTTPS traffic. Routing is typically performed using the SNI value presented by the ClientHello message. TLS routes will be applied to platform service ports named 'https-*', 'tls-*', unterminated gateway ports using HTTPS/TLS protocols (i.e. with \"passthrough\" TLS mode) and service entry ports using HTTPS/TLS protocols. The first rule matching an incoming request is used. NOTE: Traffic 'https-*' or 'tls-*' ports without associated virtual service will be treated as opaque TCP traffic.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.TLSRoute"
|
||
}
|
||
},
|
||
"tcp": {
|
||
"description": "An ordered list of route rules for opaque TCP traffic. TCP routes will be applied to any port that is not a HTTP or TLS port. The first rule matching an incoming request is used.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.TCPRoute"
|
||
}
|
||
},
|
||
"http": {
|
||
"description": "An ordered list of route rules for HTTP traffic. HTTP routes will be applied to platform service ports named 'http-*'/'http2-*'/'grpc-*', gateway ports with protocol HTTP/HTTP2/GRPC/ TLS-terminated-HTTPS and service entry ports using HTTP/HTTP2/GRPC protocols. The first rule matching an incoming request is used.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPRoute"
|
||
}
|
||
},
|
||
"hosts": {
|
||
"description": "The destination hosts to which traffic is being sent. Could be a DNS name with wildcard prefix or an IP address. Depending on the platform, short-names can also be used instead of a FQDN (i.e. has no dots in the name). In such a scenario, the FQDN of the host would be derived based on the underlying platform.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"gateways": {
|
||
"description": "The names of gateways and sidecars that should apply these routes. A single VirtualService is used for sidecars inside the mesh as well as for one or more gateways. The selection condition imposed by this field can be overridden using the source field in the match conditions of protocol-specific routes. The reserved word `mesh` is used to imply all the sidecars in the mesh. When this field is omitted, the default gateway (`mesh`) will be used, which would apply the rule to all sidecars in the mesh. If a list of gateway names is provided, the rules will apply only to the gateways. To apply the rules to both gateways and sidecars, specify `mesh` as one of the gateway names.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.HTTPRoute": {
|
||
"description": "Describes match conditions and actions for routing HTTP/1.1, HTTP2, and gRPC traffic. See VirtualService for usage examples.",
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"description": "The name assigned to the route for debugging purposes. The route's name will be concatenated with the match's name and will be logged in the access logs for requests matching this route/match.",
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"route": {
|
||
"description": "A http rule can either redirect or forward (default) traffic. The forwarding target can be one of several versions of a service (see glossary in beginning of document). Weights associated with the service version determine the proportion of traffic it receives.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPRouteDestination"
|
||
}
|
||
},
|
||
"match": {
|
||
"description": "Match conditions to be satisfied for the rule to be activated. All conditions inside a single match block have AND semantics, while the list of match blocks have OR semantics. The rule is matched if any one of the match blocks succeed.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPMatchRequest"
|
||
}
|
||
},
|
||
"redirect": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPRedirect"
|
||
},
|
||
"rewrite": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPRewrite"
|
||
},
|
||
"websocketUpgrade": {
|
||
"description": "Deprecated. Websocket upgrades are done automatically starting from Istio 1.0. $hide_from_docs",
|
||
"type": "boolean"
|
||
},
|
||
"timeout": {
|
||
"description": "Timeout for HTTP requests.",
|
||
"type": "string"
|
||
},
|
||
"retries": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPRetry"
|
||
},
|
||
"fault": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPFaultInjection"
|
||
},
|
||
"mirror": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Destination"
|
||
},
|
||
"mirrorPercent": {
|
||
"description": "Percentage of the traffic to be mirrored by the `mirror` field. If this field is absent, all the traffic (100%) will be mirrored. Max value is 100.",
|
||
"type": "integer",
|
||
"nullable": true
|
||
},
|
||
"corsPolicy": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.CorsPolicy"
|
||
},
|
||
"appendHeaders": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"removeResponseHeaders": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"appendResponseHeaders": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"removeRequestHeaders": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"appendRequestHeaders": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"headers": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Headers"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.TLSRoute": {
|
||
"description": "Describes match conditions and actions for routing unterminated TLS traffic (TLS/HTTPS) The following routing rule forwards unterminated TLS traffic arriving at port 443 of gateway called \"mygateway\" to internal services in the mesh based on the SNI value.",
|
||
"type": "object",
|
||
"properties": {
|
||
"route": {
|
||
"description": "The destination to which the connection should be forwarded to.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.RouteDestination"
|
||
}
|
||
},
|
||
"match": {
|
||
"description": "Match conditions to be satisfied for the rule to be activated. All conditions inside a single match block have AND semantics, while the list of match blocks have OR semantics. The rule is matched if any one of the match blocks succeed.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.TLSMatchAttributes"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.TCPRoute": {
|
||
"description": "Describes match conditions and actions for routing TCP traffic. The following routing rule forwards traffic arriving at port 27017 for mongo.prod.svc.cluster.local to another Mongo server on port 5555.",
|
||
"type": "object",
|
||
"properties": {
|
||
"route": {
|
||
"description": "The destination to which the connection should be forwarded to.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.RouteDestination"
|
||
}
|
||
},
|
||
"match": {
|
||
"description": "Match conditions to be satisfied for the rule to be activated. All conditions inside a single match block have AND semantics, while the list of match blocks have OR semantics. The rule is matched if any one of the match blocks succeed.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.L4MatchAttributes"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.Destination": {
|
||
"description": "Destination indicates the network addressable service to which the request/connection will be sent after processing a routing rule. The destination.host should unambiguously refer to a service in the service registry. Istio's service registry is composed of all the services found in the platform's service registry (e.g., Kubernetes services, Consul services), as well as services declared through the [ServiceEntry](https://istio.io/docs/reference/config/networking/service-entry/#ServiceEntry) resource.",
|
||
"type": "object",
|
||
"properties": {
|
||
"host": {
|
||
"description": "The name of a service from the service registry. Service names are looked up from the platform's service registry (e.g., Kubernetes services, Consul services, etc.) and from the hosts declared by [ServiceEntry](https://istio.io/docs/reference/config/networking/service-entry/#ServiceEntry). Traffic forwarded to destinations that are not found in either of the two, will be dropped.",
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"port": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.PortSelector"
|
||
},
|
||
"subset": {
|
||
"description": "The name of a subset within the service. Applicable only to services within the mesh. The subset must be defined in a corresponding DestinationRule.",
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.HTTPMatchRequest": {
|
||
"description": "HttpMatchRequest specifies a set of criterion to be met in order for the rule to be applied to the HTTP request. For example, the following restricts the rule to match only requests where the URL path starts with /ratings/v2/ and the request contains a custom `end-user` header with value `jason`.",
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"description": "The name assigned to a match. The match's name will be concatenated with the parent route's name and will be logged in the access logs for requests matching this route.",
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"method": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.StringMatch"
|
||
},
|
||
"port": {
|
||
"description": "Specifies the ports on the host that is being addressed. Many services only expose a single port or label ports with the protocols they support, in these cases it is not required to explicitly select the port.",
|
||
"type": "integer"
|
||
},
|
||
"gateways": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"headers": {
|
||
"description": "The header keys must be lowercase and use hyphen as the separator, e.g. _x-request-id_.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.StringMatch"
|
||
}
|
||
},
|
||
"uri": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.StringMatch"
|
||
},
|
||
"scheme": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.StringMatch"
|
||
},
|
||
"authority": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.StringMatch"
|
||
},
|
||
"sourceLabels": {
|
||
"description": "One or more labels that constrain the applicability of a rule to workloads with the given labels. If the VirtualService has a list of gateways specified at the top, it must include the reserved gateway `mesh` for this field to be applicable.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"queryParams": {
|
||
"description": "Query parameters for matching.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.StringMatch"
|
||
}
|
||
},
|
||
"ignoreUriCase": {
|
||
"description": "Flag to specify whether the URI matching should be case-insensitive.",
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.HTTPRouteDestination": {
|
||
"description": "Each routing rule is associated with one or more service versions (see glossary in beginning of document). Weights associated with the version determine the proportion of traffic it receives. For example, the following rule will route 25% of traffic for the \"reviews\" service to instances with the \"v2\" tag and the remaining traffic (i.e., 75%) to \"v1\".",
|
||
"type": "object",
|
||
"properties": {
|
||
"weight": {
|
||
"description": "The proportion of traffic to be forwarded to the service version. (0-100). Sum of weights across destinations SHOULD BE == 100. If there is only one destination in a rule, the weight value is assumed to be 100.",
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"removeResponseHeaders": {
|
||
"description": "Use of `remove_response_header` is deprecated. Use the `headers` field instead.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"appendResponseHeaders": {
|
||
"description": "Use of `append_response_headers` is deprecated. Use the `headers` field instead.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"removeRequestHeaders": {
|
||
"description": "Use of `remove_request_headers` is deprecated. Use the `headers` field instead.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"appendRequestHeaders": {
|
||
"description": "Use of `append_request_headers` is deprecated. Use the `headers` field instead.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"deprecated": true
|
||
},
|
||
"headers": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Headers"
|
||
},
|
||
"destination": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Destination"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.HTTPRedirect": {
|
||
"description": "HTTPRedirect can be used to send a 301 redirect response to the caller, where the Authority/Host and the URI in the response can be swapped with the specified values. For example, the following rule redirects requests for /v1/getProductRatings API on the ratings service to /v1/bookRatings provided by the bookratings service.",
|
||
"type": "object",
|
||
"properties": {
|
||
"uri": {
|
||
"description": "On a redirect, overwrite the Path portion of the URL with this value. Note that the entire path will be replaced, irrespective of the request URI being matched as an exact path or prefix.",
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"authority": {
|
||
"description": "On a redirect, overwrite the Authority/Host portion of the URL with this value.",
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"redirectCode": {
|
||
"description": "On a redirect, Specifies the HTTP status code to use in the redirect response. The default response code is MOVED_PERMANENTLY (301).",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.HTTPRewrite": {
|
||
"description": "HTTPRewrite can be used to rewrite specific parts of a HTTP request before forwarding the request to the destination. Rewrite primitive can be used only with HTTPRouteDestination. The following example demonstrates how to rewrite the URL prefix for api call (/ratings) to ratings service before making the actual API call.",
|
||
"type": "object",
|
||
"properties": {
|
||
"uri": {
|
||
"description": "rewrite the path (or the prefix) portion of the URI with this value. If the original URI was matched based on prefix, the value provided in this field will replace the corresponding matched prefix.",
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"authority": {
|
||
"description": "rewrite the Authority/Host header with this value.",
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.HTTPRetry": {
|
||
"description": "Describes the retry policy to use when a HTTP request fails. For example, the following rule sets the maximum number of retries to 3 when calling ratings:v1 service, with a 2s timeout per retry attempt.",
|
||
"type": "object",
|
||
"properties": {
|
||
"attempts": {
|
||
"description": "Number of retries for a given request. The interval between retries will be determined automatically (25ms+). Actual number of retries attempted depends on the httpReqTimeout.",
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"perTryTimeout": {
|
||
"description": "Timeout per retry attempt for a given request. format: 1h/1m/1s/1ms. MUST BE \u003e=1ms.",
|
||
"type": "string"
|
||
},
|
||
"retryOn": {
|
||
"description": "Specifies the conditions under which retry takes place. One or more policies can be specified using a ‘,’ delimited list. See the [retry policies](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on) and [gRPC retry policies](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-grpc-on) for more details.",
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.HTTPFaultInjection": {
|
||
"description": "HTTPFaultInjection can be used to specify one or more faults to inject while forwarding http requests to the destination specified in a route. Fault specification is part of a VirtualService rule. Faults include aborting the Http request from downstream service, and/or delaying proxying of requests. A fault rule MUST HAVE delay or abort or both.",
|
||
"type": "object",
|
||
"properties": {
|
||
"delay": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPFaultInjection.Delay"
|
||
},
|
||
"abort": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPFaultInjection.Abort"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.CorsPolicy": {
|
||
"description": "Describes the Cross-Origin Resource Sharing (CORS) policy, for a given service. Refer to [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) for further details about cross origin resource sharing. For example, the following rule restricts cross origin requests to those originating from example.com domain using HTTP POST/GET, and sets the `Access-Control-Allow-Credentials` header to false. In addition, it only exposes `X-Foo-bar` header and sets an expiry period of 1 day.",
|
||
"type": "object",
|
||
"properties": {
|
||
"allowOrigin": {
|
||
"description": "The list of origins that are allowed to perform CORS requests. The content will be serialized into the Access-Control-Allow-Origin header. Wildcard * will allow all origins.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"allowMethods": {
|
||
"description": "List of HTTP methods allowed to access the resource. The content will be serialized into the Access-Control-Allow-Methods header.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"allowHeaders": {
|
||
"description": "List of HTTP headers that can be used when requesting the resource. Serialized to Access-Control-Allow-Headers header.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"exposeHeaders": {
|
||
"description": "A white list of HTTP headers that the browsers are allowed to access. Serialized into Access-Control-Expose-Headers header.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"maxAge": {
|
||
"description": "Specifies how long the results of a preflight request can be cached. Translates to the `Access-Control-Max-Age` header.",
|
||
"type": "string"
|
||
},
|
||
"allowCredentials": {
|
||
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials. Translates to `Access-Control-Allow-Credentials` header.",
|
||
"type": "boolean",
|
||
"nullable": true
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.Headers": {
|
||
"description": "Message headers can be manipulated when Envoy forwards requests to, or responses from, a destination service. Header manipulation rules can be specified for a specific route destination or for all destinations. The following VirtualService adds a `test` header with the value `true` to requests that are routed to any `reviews` service destination. It also romoves the `foo` response header, but only from responses coming from the `v1` subset (version) of the `reviews` service.",
|
||
"type": "object",
|
||
"properties": {
|
||
"response": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Headers.HeaderOperations"
|
||
},
|
||
"request": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Headers.HeaderOperations"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.Headers.HeaderOperations": {
|
||
"description": "HeaderOperations Describes the header manipulations to apply",
|
||
"type": "object",
|
||
"properties": {
|
||
"set": {
|
||
"description": "Overwrite the headers specified by key with the given values",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"add": {
|
||
"description": "Append the given values to the headers specified by keys (will create a comma-separated list of values)",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"remove": {
|
||
"description": "Remove a the specified headers",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.TLSMatchAttributes": {
|
||
"description": "TLS connection match attributes.",
|
||
"type": "object",
|
||
"properties": {
|
||
"port": {
|
||
"description": "Specifies the port on the host that is being addressed. Many services only expose a single port or label ports with the protocols they support, in these cases it is not required to explicitly select the port.",
|
||
"type": "integer"
|
||
},
|
||
"gateways": {
|
||
"description": "Names of gateways where the rule should be applied to. Gateway names at the top of the VirtualService (if any) are overridden. The gateway match is independent of sourceLabels.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"sourceLabels": {
|
||
"description": "One or more labels that constrain the applicability of a rule to workloads with the given labels. If the VirtualService has a list of gateways specified at the top, it should include the reserved gateway `mesh` in order for this field to be applicable.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"destinationSubnets": {
|
||
"description": "IPv4 or IPv6 ip addresses of destination with optional subnet. E.g., a.b.c.d/xx form or just a.b.c.d.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"sourceSubnet": {
|
||
"description": "IPv4 or IPv6 ip address of source with optional subnet. E.g., a.b.c.d/xx form or just a.b.c.d $hide_from_docs",
|
||
"type": "string",
|
||
"format": "string"
|
||
},
|
||
"sniHosts": {
|
||
"description": "SNI (server name indicator) to match on. Wildcard prefixes can be used in the SNI value, e.g., *.com will match foo.example.com as well as example.com. An SNI value must be a subset (i.e., fall within the domain) of the corresponding virtual serivce's hosts.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.RouteDestination": {
|
||
"description": "L4 routing rule weighted destination.",
|
||
"type": "object",
|
||
"properties": {
|
||
"weight": {
|
||
"description": "The proportion of traffic to be forwarded to the service version. If there is only one destination in a rule, all traffic will be routed to it irrespective of the weight.",
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"destination": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Destination"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.L4MatchAttributes": {
|
||
"description": "L4 connection match attributes. Note that L4 connection matching support is incomplete.",
|
||
"type": "object",
|
||
"properties": {
|
||
"port": {
|
||
"description": "Specifies the port on the host that is being addressed. Many services only expose a single port or label ports with the protocols they support, in these cases it is not required to explicitly select the port.",
|
||
"type": "integer"
|
||
},
|
||
"gateways": {
|
||
"description": "Names of gateways where the rule should be applied to. Gateway names at the top of the VirtualService (if any) are overridden. The gateway match is independent of sourceLabels.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"sourceLabels": {
|
||
"description": "One or more labels that constrain the applicability of a rule to workloads with the given labels. If the VirtualService has a list of gateways specified at the top, it should include the reserved gateway `mesh` in order for this field to be applicable.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"destinationSubnets": {
|
||
"description": "IPv4 or IPv6 ip addresses of destination with optional subnet. E.g., a.b.c.d/xx form or just a.b.c.d.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
},
|
||
"sourceSubnet": {
|
||
"description": "IPv4 or IPv6 ip address of source with optional subnet. E.g., a.b.c.d/xx form or just a.b.c.d $hide_from_docs",
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
},
|
||
"istio.networking.v1alpha3.StringMatch": {
|
||
"description": "Describes how to match a given string in HTTP headers. Match is case-sensitive.",
|
||
"type": "object",
|
||
"oneOf": [
|
||
{
|
||
"required": [
|
||
"exact"
|
||
],
|
||
"properties": {
|
||
"exact": {
|
||
"description": "exact string match",
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"required": [
|
||
"prefix"
|
||
],
|
||
"properties": {
|
||
"prefix": {
|
||
"description": "prefix-based match",
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"required": [
|
||
"regex"
|
||
],
|
||
"properties": {
|
||
"regex": {
|
||
"description": "ECMAscript style regex-based match",
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"istio.networking.v1alpha3.HTTPFaultInjection.Delay": {
|
||
"description": "Delay specification is used to inject latency into the request forwarding path. The following example will introduce a 5 second delay in 1 out of every 1000 requests to the \"v1\" version of the \"reviews\" service from all pods with label env: prod",
|
||
"type": "object",
|
||
"oneOf": [
|
||
{
|
||
"required": [
|
||
"fixedDelay"
|
||
],
|
||
"properties": {
|
||
"percent": {
|
||
"description": "Percentage of requests on which the delay will be injected (0-100). Use of integer `percent` value is deprecated. Use the double `percentage` field instead.",
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"deprecated": true
|
||
},
|
||
"percentage": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Percent"
|
||
},
|
||
"fixedDelay": {
|
||
"description": "Add a fixed delay before forwarding the request. Format: 1h/1m/1s/1ms. MUST be \u003e=1ms.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"required": [
|
||
"exponentialDelay"
|
||
],
|
||
"properties": {
|
||
"percent": {
|
||
"description": "Percentage of requests on which the delay will be injected (0-100). Use of integer `percent` value is deprecated. Use the double `percentage` field instead.",
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"deprecated": true
|
||
},
|
||
"percentage": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Percent"
|
||
},
|
||
"exponentialDelay": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"istio.networking.v1alpha3.HTTPFaultInjection.Abort": {
|
||
"description": "Abort specification is used to prematurely abort a request with a pre-specified error code. The following example will return an HTTP 400 error code for 1 out of every 1000 requests to the \"ratings\" service \"v1\".",
|
||
"type": "object",
|
||
"oneOf": [
|
||
{
|
||
"required": [
|
||
"httpStatus"
|
||
],
|
||
"properties": {
|
||
"percent": {
|
||
"description": "Percentage of requests to be aborted with the error code provided (0-100). Use of integer `percent` value is deprecated. Use the double `percentage` field instead.",
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"deprecated": true
|
||
},
|
||
"percentage": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Percent"
|
||
},
|
||
"httpStatus": {
|
||
"description": "HTTP status code to use to abort the Http request.",
|
||
"type": "integer",
|
||
"format": "int32"
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"required": [
|
||
"grpcStatus"
|
||
],
|
||
"properties": {
|
||
"percent": {
|
||
"description": "Percentage of requests to be aborted with the error code provided (0-100). Use of integer `percent` value is deprecated. Use the double `percentage` field instead.",
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"deprecated": true
|
||
},
|
||
"percentage": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Percent"
|
||
},
|
||
"grpcStatus": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"required": [
|
||
"http2Error"
|
||
],
|
||
"properties": {
|
||
"percent": {
|
||
"description": "Percentage of requests to be aborted with the error code provided (0-100). Use of integer `percent` value is deprecated. Use the double `percentage` field instead.",
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"deprecated": true
|
||
},
|
||
"percentage": {
|
||
"$ref": "#/components/schemas/istio.networking.v1alpha3.Percent"
|
||
},
|
||
"http2Error": {
|
||
"type": "string",
|
||
"format": "string"
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"istio.networking.v1alpha3.Percent": {
|
||
"description": "Percent specifies a percentage in the range of [0.0, 100.0].",
|
||
"type": "object",
|
||
"properties": {
|
||
"value": {
|
||
"type": "number",
|
||
"format": "double"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
} |