Browse Source

Fixing documentation for preserving prefixes for ingress. (#870)

pull/871/head
Justin Kotalik 6 years ago
committed by GitHub
parent
commit
89148557a7
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      docs/reference/schema.md
  2. 10
      src/schema/tye-schema.json

8
docs/reference/schema.md

@ -566,7 +566,11 @@ The path `/mypath` or `/mypath/` will match:
#### `host` (`string`)
The host to match.
The host to match.
#### `preservePath` (`boolean`)
Whether to preserve the matched path prefix when routing to a specific service. By default, path-prefixes are trimmed (`preservePath` is false). For example, if a path consisted of `/serviceA/foo` and an ingress rule including a match on `/serviceA`, the `/serviceA` portion would be trimmed when routing to the backend service, resulting in the path `/foo`. By setting `preservePath` to true, the `/serviceA` portion would be kept when routing to the backend service.
## Liveness and Readiness
@ -685,4 +689,4 @@ If both `port` and `protocol` are provided, Tye selects the first biding with th
#### `headers` (`(name, value)[]`)
Array of headers that are sent as part of the HTTP request that probes the replicas of the service.
Array of headers that are sent as part of the HTTP request that probes the replicas of the service.

10
src/schema/tye-schema.json

@ -447,10 +447,6 @@
"protocol": {
"description": "The protocol used by the binding",
"type": "string"
},
"preservePath": {
"description": "Whether to keep the path that was originally present or not.",
"type": "boolean"
}
}
},
@ -468,6 +464,10 @@
"host": {
"description": "The hostname to match.",
"type": "string"
},
"preservePath": {
"description": "Whether to keep the path that was originally present or not after a prefix match.",
"type": "boolean"
}
},
"required": [
@ -538,4 +538,4 @@
]
}
}
}
}

Loading…
Cancel
Save