github.com/projectcontour/contour@v1.28.2/site/content/docs/v1.12.0/config/api-reference.html (about) 1 <p>Packages:</p> 2 <ul> 3 <li> 4 <a href="#projectcontour.io%2fv1">projectcontour.io/v1</a> 5 </li> 6 <li> 7 <a href="#projectcontour.io%2fv1alpha1">projectcontour.io/v1alpha1</a> 8 </li> 9 </ul> 10 <h2 id="projectcontour.io/v1">projectcontour.io/v1</h2> 11 <p> 12 <p>This package holds the specification for the projectcontour.io Custom Resource Definitions (CRDs).</p> 13 <p>In building this CRD, we’ve inadvertently overloaded the word “Condition”, so we’ve tried to make 14 this spec clear as to which types of condition are which.</p> 15 <p><code>MatchConditions</code> are used by <code>Routes</code> and <code>Includes</code> to specify rules to match requests against for either 16 routing or inclusion.</p> 17 <p><code>DetailedConditions</code> are used in the <code>Status</code> of these objects to hold information about the relevant 18 state of the object and the world around it.</p> 19 <p><code>SubConditions</code> are used underneath <code>DetailedConditions</code> to give more detail to errors or warnings.</p> 20 </p> 21 Resource Types: 22 <ul><li> 23 <a href="#projectcontour.io/v1.HTTPProxy">HTTPProxy</a> 24 </li><li> 25 <a href="#projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation</a> 26 </li></ul> 27 <h3 id="projectcontour.io/v1.HTTPProxy">HTTPProxy 28 </h3> 29 <p> 30 <p>HTTPProxy is an Ingress CRD specification.</p> 31 </p> 32 <table class="table table-striped table-borderless" style="border:none"> 33 <thead class="border-bottom"> 34 <tr> 35 <th>Field</th> 36 <th>Description</th> 37 </tr> 38 </thead> 39 <tbody class="border-top"> 40 <tr> 41 <td> 42 <code>apiVersion</code> 43 <br> 44 string</td> 45 <td> 46 <code> 47 projectcontour.io/v1 48 </code> 49 </td> 50 </tr> 51 <tr> 52 <td> 53 <code>kind</code> 54 <br> 55 string 56 </td> 57 <td><code>HTTPProxy</code></td> 58 </tr> 59 <tr> 60 <td style="white-space:nowrap"> 61 <code>metadata</code> 62 <br> 63 <em> 64 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta"> 65 Kubernetes meta/v1.ObjectMeta 66 </a> 67 </em> 68 </td> 69 <td> 70 Refer to the Kubernetes API documentation for the fields of the 71 <code>metadata</code> field. 72 </td> 73 </tr> 74 <tr> 75 <td style="white-space:nowrap"> 76 <code>spec</code> 77 <br> 78 <em> 79 <a href="#projectcontour.io/v1.HTTPProxySpec"> 80 HTTPProxySpec 81 </a> 82 </em> 83 </td> 84 <td> 85 <br> 86 <br> 87 <table style="border:none"> 88 <tr> 89 <td style="white-space:nowrap"> 90 <code>virtualhost</code> 91 <br> 92 <em> 93 <a href="#projectcontour.io/v1.VirtualHost"> 94 VirtualHost 95 </a> 96 </em> 97 </td> 98 <td> 99 <em>(Optional)</em> 100 <p>Virtualhost appears at most once. If it is present, the object is considered 101 to be a “root” HTTPProxy.</p> 102 </td> 103 </tr> 104 <tr> 105 <td style="white-space:nowrap"> 106 <code>routes</code> 107 <br> 108 <em> 109 <a href="#projectcontour.io/v1.Route"> 110 []Route 111 </a> 112 </em> 113 </td> 114 <td> 115 <em>(Optional)</em> 116 <p>Routes are the ingress routes. If TCPProxy is present, Routes is ignored.</p> 117 </td> 118 </tr> 119 <tr> 120 <td style="white-space:nowrap"> 121 <code>tcpproxy</code> 122 <br> 123 <em> 124 <a href="#projectcontour.io/v1.TCPProxy"> 125 TCPProxy 126 </a> 127 </em> 128 </td> 129 <td> 130 <em>(Optional)</em> 131 <p>TCPProxy holds TCP proxy information.</p> 132 </td> 133 </tr> 134 <tr> 135 <td style="white-space:nowrap"> 136 <code>includes</code> 137 <br> 138 <em> 139 <a href="#projectcontour.io/v1.Include"> 140 []Include 141 </a> 142 </em> 143 </td> 144 <td> 145 <em>(Optional)</em> 146 <p>Includes allow for specific routing configuration to be included from another HTTPProxy, 147 possibly in another namespace.</p> 148 </td> 149 </tr> 150 </table> 151 </td> 152 </tr> 153 <tr> 154 <td style="white-space:nowrap"> 155 <code>status</code> 156 <br> 157 <em> 158 <a href="#projectcontour.io/v1.HTTPProxyStatus"> 159 HTTPProxyStatus 160 </a> 161 </em> 162 </td> 163 <td> 164 <em>(Optional)</em> 165 <p>Status is a container for computed information about the HTTPProxy.</p> 166 </td> 167 </tr> 168 </tbody> 169 </table> 170 <h3 id="projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation 171 </h3> 172 <p> 173 <p>TLSCertificateDelegation is an TLS Certificate Delegation CRD specification. 174 See design/tls-certificate-delegation.md for details.</p> 175 </p> 176 <table class="table table-striped table-borderless" style="border:none"> 177 <thead class="border-bottom"> 178 <tr> 179 <th>Field</th> 180 <th>Description</th> 181 </tr> 182 </thead> 183 <tbody class="border-top"> 184 <tr> 185 <td> 186 <code>apiVersion</code> 187 <br> 188 string</td> 189 <td> 190 <code> 191 projectcontour.io/v1 192 </code> 193 </td> 194 </tr> 195 <tr> 196 <td> 197 <code>kind</code> 198 <br> 199 string 200 </td> 201 <td><code>TLSCertificateDelegation</code></td> 202 </tr> 203 <tr> 204 <td style="white-space:nowrap"> 205 <code>metadata</code> 206 <br> 207 <em> 208 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta"> 209 Kubernetes meta/v1.ObjectMeta 210 </a> 211 </em> 212 </td> 213 <td> 214 Refer to the Kubernetes API documentation for the fields of the 215 <code>metadata</code> field. 216 </td> 217 </tr> 218 <tr> 219 <td style="white-space:nowrap"> 220 <code>spec</code> 221 <br> 222 <em> 223 <a href="#projectcontour.io/v1.TLSCertificateDelegationSpec"> 224 TLSCertificateDelegationSpec 225 </a> 226 </em> 227 </td> 228 <td> 229 <br> 230 <br> 231 <table style="border:none"> 232 <tr> 233 <td style="white-space:nowrap"> 234 <code>delegations</code> 235 <br> 236 <em> 237 <a href="#projectcontour.io/v1.CertificateDelegation"> 238 []CertificateDelegation 239 </a> 240 </em> 241 </td> 242 <td> 243 </td> 244 </tr> 245 </table> 246 </td> 247 </tr> 248 <tr> 249 <td style="white-space:nowrap"> 250 <code>status</code> 251 <br> 252 <em> 253 <a href="#projectcontour.io/v1.TLSCertificateDelegationStatus"> 254 TLSCertificateDelegationStatus 255 </a> 256 </em> 257 </td> 258 <td> 259 <em>(Optional)</em> 260 </td> 261 </tr> 262 </tbody> 263 </table> 264 <h3 id="projectcontour.io/v1.AuthorizationPolicy">AuthorizationPolicy 265 </h3> 266 <p> 267 (<em>Appears on:</em> 268 <a href="#projectcontour.io/v1.AuthorizationServer">AuthorizationServer</a>, 269 <a href="#projectcontour.io/v1.Route">Route</a>) 270 </p> 271 <p> 272 <p>AuthorizationPolicy modifies how client requests are authenticated.</p> 273 </p> 274 <table class="table table-striped table-borderless" style="border:none"> 275 <thead class="border-bottom"> 276 <tr> 277 <th>Field</th> 278 <th>Description</th> 279 </tr> 280 </thead> 281 <tbody class="border-top"> 282 <tr> 283 <td style="white-space:nowrap"> 284 <code>disabled</code> 285 <br> 286 <em> 287 bool 288 </em> 289 </td> 290 <td> 291 <em>(Optional)</em> 292 <p>When true, this field disables client request authentication 293 for the scope of the policy.</p> 294 </td> 295 </tr> 296 <tr> 297 <td style="white-space:nowrap"> 298 <code>context</code> 299 <br> 300 <em> 301 map[string]string 302 </em> 303 </td> 304 <td> 305 <em>(Optional)</em> 306 <p>Context is a set of key/value pairs that are sent to the 307 authentication server in the check request. If a context 308 is provided at an enclosing scope, the entries are merged 309 such that the inner scope overrides matching keys from the 310 outer scope.</p> 311 </td> 312 </tr> 313 </tbody> 314 </table> 315 <h3 id="projectcontour.io/v1.AuthorizationServer">AuthorizationServer 316 </h3> 317 <p> 318 (<em>Appears on:</em> 319 <a href="#projectcontour.io/v1.VirtualHost">VirtualHost</a>) 320 </p> 321 <p> 322 <p>AuthorizationServer configures an external server to authenticate 323 client requests. The external server must implement the v3 Envoy 324 external authorization GRPC protocol (<a href="https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto">https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto</a>).</p> 325 </p> 326 <table class="table table-striped table-borderless" style="border:none"> 327 <thead class="border-bottom"> 328 <tr> 329 <th>Field</th> 330 <th>Description</th> 331 </tr> 332 </thead> 333 <tbody class="border-top"> 334 <tr> 335 <td style="white-space:nowrap"> 336 <code>extensionRef</code> 337 <br> 338 <em> 339 <a href="#projectcontour.io/v1.ExtensionServiceReference"> 340 ExtensionServiceReference 341 </a> 342 </em> 343 </td> 344 <td> 345 <p>ExtensionServiceRef specifies the extension resource that will authorize client requests.</p> 346 </td> 347 </tr> 348 <tr> 349 <td style="white-space:nowrap"> 350 <code>authPolicy</code> 351 <br> 352 <em> 353 <a href="#projectcontour.io/v1.AuthorizationPolicy"> 354 AuthorizationPolicy 355 </a> 356 </em> 357 </td> 358 <td> 359 <em>(Optional)</em> 360 <p>AuthPolicy sets a default authorization policy for client requests. 361 This policy will be used unless overridden by individual routes.</p> 362 </td> 363 </tr> 364 <tr> 365 <td style="white-space:nowrap"> 366 <code>responseTimeout</code> 367 <br> 368 <em> 369 string 370 </em> 371 </td> 372 <td> 373 <em>(Optional)</em> 374 <p>ResponseTimeout configures maximum time to wait for a check response from the authorization server. 375 Timeout durations are expressed in the Go <a href="https://godoc.org/time#ParseDuration">Duration format</a>. 376 Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. 377 The string “infinity” is also a valid input and specifies no timeout.</p> 378 </td> 379 </tr> 380 <tr> 381 <td style="white-space:nowrap"> 382 <code>failOpen</code> 383 <br> 384 <em> 385 bool 386 </em> 387 </td> 388 <td> 389 <em>(Optional)</em> 390 <p>If FailOpen is true, the client request is forwarded to the upstream service 391 even if the authorization server fails to respond. This field should not be 392 set in most cases. It is intended for use only while migrating applications 393 from internal authorization to Contour external authorization.</p> 394 </td> 395 </tr> 396 </tbody> 397 </table> 398 <h3 id="projectcontour.io/v1.CORSHeaderValue">CORSHeaderValue 399 (<code>string</code> alias)</h3> 400 <p> 401 (<em>Appears on:</em> 402 <a href="#projectcontour.io/v1.CORSPolicy">CORSPolicy</a>) 403 </p> 404 <p> 405 <p>CORSHeaderValue specifies the value of the string headers returned by a cross-domain request.</p> 406 </p> 407 <h3 id="projectcontour.io/v1.CORSPolicy">CORSPolicy 408 </h3> 409 <p> 410 (<em>Appears on:</em> 411 <a href="#projectcontour.io/v1.VirtualHost">VirtualHost</a>) 412 </p> 413 <p> 414 <p>CORSPolicy allows setting the CORS policy</p> 415 </p> 416 <table class="table table-striped table-borderless" style="border:none"> 417 <thead class="border-bottom"> 418 <tr> 419 <th>Field</th> 420 <th>Description</th> 421 </tr> 422 </thead> 423 <tbody class="border-top"> 424 <tr> 425 <td style="white-space:nowrap"> 426 <code>allowCredentials</code> 427 <br> 428 <em> 429 bool 430 </em> 431 </td> 432 <td> 433 <em>(Optional)</em> 434 <p>Specifies whether the resource allows credentials.</p> 435 </td> 436 </tr> 437 <tr> 438 <td style="white-space:nowrap"> 439 <code>allowOrigin</code> 440 <br> 441 <em> 442 []string 443 </em> 444 </td> 445 <td> 446 <p>AllowOrigin specifies the origins that will be allowed to do CORS requests. “*” means 447 allow any origin.</p> 448 </td> 449 </tr> 450 <tr> 451 <td style="white-space:nowrap"> 452 <code>allowMethods</code> 453 <br> 454 <em> 455 <a href="#projectcontour.io/v1.CORSHeaderValue"> 456 []CORSHeaderValue 457 </a> 458 </em> 459 </td> 460 <td> 461 <p>AllowMethods specifies the content for the <em>access-control-allow-methods</em> header.</p> 462 </td> 463 </tr> 464 <tr> 465 <td style="white-space:nowrap"> 466 <code>allowHeaders</code> 467 <br> 468 <em> 469 <a href="#projectcontour.io/v1.CORSHeaderValue"> 470 []CORSHeaderValue 471 </a> 472 </em> 473 </td> 474 <td> 475 <em>(Optional)</em> 476 <p>AllowHeaders specifies the content for the <em>access-control-allow-headers</em> header.</p> 477 </td> 478 </tr> 479 <tr> 480 <td style="white-space:nowrap"> 481 <code>exposeHeaders</code> 482 <br> 483 <em> 484 <a href="#projectcontour.io/v1.CORSHeaderValue"> 485 []CORSHeaderValue 486 </a> 487 </em> 488 </td> 489 <td> 490 <em>(Optional)</em> 491 <p>ExposeHeaders Specifies the content for the <em>access-control-expose-headers</em> header.</p> 492 </td> 493 </tr> 494 <tr> 495 <td style="white-space:nowrap"> 496 <code>maxAge</code> 497 <br> 498 <em> 499 string 500 </em> 501 </td> 502 <td> 503 <em>(Optional)</em> 504 <p>MaxAge indicates for how long the results of a preflight request can be cached. 505 MaxAge durations are expressed in the Go <a href="https://godoc.org/time#ParseDuration">Duration format</a>. 506 Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. 507 Only positive values are allowed while 0 disables the cache requiring a preflight OPTIONS 508 check for all cross-origin requests.</p> 509 </td> 510 </tr> 511 </tbody> 512 </table> 513 <h3 id="projectcontour.io/v1.CertificateDelegation">CertificateDelegation 514 </h3> 515 <p> 516 (<em>Appears on:</em> 517 <a href="#projectcontour.io/v1.TLSCertificateDelegationSpec">TLSCertificateDelegationSpec</a>) 518 </p> 519 <p> 520 <p>CertificateDelegation maps the authority to reference a secret 521 in the current namespace to a set of namespaces.</p> 522 </p> 523 <table class="table table-striped table-borderless" style="border:none"> 524 <thead class="border-bottom"> 525 <tr> 526 <th>Field</th> 527 <th>Description</th> 528 </tr> 529 </thead> 530 <tbody class="border-top"> 531 <tr> 532 <td style="white-space:nowrap"> 533 <code>secretName</code> 534 <br> 535 <em> 536 string 537 </em> 538 </td> 539 <td> 540 <p>required, the name of a secret in the current namespace.</p> 541 </td> 542 </tr> 543 <tr> 544 <td style="white-space:nowrap"> 545 <code>targetNamespaces</code> 546 <br> 547 <em> 548 []string 549 </em> 550 </td> 551 <td> 552 <p>required, the namespaces the authority to reference the 553 the secret will be delegated to. 554 If TargetNamespaces is nil or empty, the CertificateDelegation’ 555 is ignored. If the TargetNamespace list contains the character, “*” 556 the secret will be delegated to all namespaces.</p> 557 </td> 558 </tr> 559 </tbody> 560 </table> 561 <h3 id="projectcontour.io/v1.DetailedCondition">DetailedCondition 562 </h3> 563 <p> 564 (<em>Appears on:</em> 565 <a href="#projectcontour.io/v1alpha1.ExtensionServiceStatus">ExtensionServiceStatus</a>, 566 <a href="#projectcontour.io/v1.HTTPProxyStatus">HTTPProxyStatus</a>, 567 <a href="#projectcontour.io/v1.TLSCertificateDelegationStatus">TLSCertificateDelegationStatus</a>) 568 </p> 569 <p> 570 <p>DetailedCondition is an extension of the normal Kubernetes conditions, with two extra 571 fields to hold sub-conditions, which provide more detailed reasons for the state (True or False) 572 of the condition.</p> 573 <p><code>errors</code> holds information about sub-conditions which are fatal to that condition and render its state False.</p> 574 <p><code>warnings</code> holds information about sub-conditions which are not fatal to that condition and do not force the state to be False.</p> 575 <p>Remember that Conditions have a type, a status, and a reason.</p> 576 <p>The type is the type of the condition, the most important one in this CRD set is <code>Valid</code>. 577 <code>Valid</code> is a positive-polarity condition: when it is <code>status: true</code> there are no problems.</p> 578 <p>In more detail, <code>status: true</code> means that the object is has been ingested into Contour with no errors. 579 <code>warnings</code> may still be present, and will be indicated in the Reason field. There must be zero entries in the <code>errors</code> 580 slice in this case.</p> 581 <p><code>Valid</code>, <code>status: false</code> means that the object has had one or more fatal errors during processing into Contour. 582 The details of the errors will be present under the <code>errors</code> field. There must be at least one error in the <code>errors</code> 583 slice if <code>status</code> is <code>false</code>.</p> 584 <p>For DetailedConditions of types other than <code>Valid</code>, the Condition must be in the negative polarity. 585 When they have <code>status</code> <code>true</code>, there is an error. There must be at least one entry in the <code>errors</code> Subcondition slice. 586 When they have <code>status</code> <code>false</code>, there are no serious errors, and there must be zero entries in the <code>errors</code> slice. 587 In either case, there may be entries in the <code>warnings</code> slice.</p> 588 <p>Regardless of the polarity, the <code>reason</code> and <code>message</code> fields must be updated with either the detail of the reason 589 (if there is one and only one entry in total across both the <code>errors</code> and <code>warnings</code> slices), or 590 <code>MultipleReasons</code> if there is more than one entry.</p> 591 </p> 592 <table class="table table-striped table-borderless" style="border:none"> 593 <thead class="border-bottom"> 594 <tr> 595 <th>Field</th> 596 <th>Description</th> 597 </tr> 598 </thead> 599 <tbody class="border-top"> 600 <tr> 601 <td style="white-space:nowrap"> 602 <code>Condition</code> 603 <br> 604 <em> 605 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#condition-v1-meta"> 606 Kubernetes meta/v1.Condition 607 </a> 608 </em> 609 </td> 610 <td> 611 <p> 612 (Members of <code>Condition</code> are embedded into this type.) 613 </p> 614 </td> 615 </tr> 616 <tr> 617 <td style="white-space:nowrap"> 618 <code>errors</code> 619 <br> 620 <em> 621 <a href="#projectcontour.io/v1.SubCondition"> 622 []SubCondition 623 </a> 624 </em> 625 </td> 626 <td> 627 <em>(Optional)</em> 628 <p>Errors contains a slice of relevant error subconditions for this object.</p> 629 <p>Subconditions are expected to appear when relevant (when there is a error), and disappear when not relevant. 630 An empty slice here indicates no errors.</p> 631 </td> 632 </tr> 633 <tr> 634 <td style="white-space:nowrap"> 635 <code>warnings</code> 636 <br> 637 <em> 638 <a href="#projectcontour.io/v1.SubCondition"> 639 []SubCondition 640 </a> 641 </em> 642 </td> 643 <td> 644 <em>(Optional)</em> 645 <p>Warnings contains a slice of relevant warning subconditions for this object.</p> 646 <p>Subconditions are expected to appear when relevant (when there is a warning), and disappear when not relevant. 647 An empty slice here indicates no warnings.</p> 648 </td> 649 </tr> 650 </tbody> 651 </table> 652 <h3 id="projectcontour.io/v1.DownstreamValidation">DownstreamValidation 653 </h3> 654 <p> 655 (<em>Appears on:</em> 656 <a href="#projectcontour.io/v1.TLS">TLS</a>) 657 </p> 658 <p> 659 <p>DownstreamValidation defines how to verify the client certificate.</p> 660 </p> 661 <table class="table table-striped table-borderless" style="border:none"> 662 <thead class="border-bottom"> 663 <tr> 664 <th>Field</th> 665 <th>Description</th> 666 </tr> 667 </thead> 668 <tbody class="border-top"> 669 <tr> 670 <td style="white-space:nowrap"> 671 <code>caSecret</code> 672 <br> 673 <em> 674 string 675 </em> 676 </td> 677 <td> 678 <p>Name of a Kubernetes secret that contains a CA certificate bundle. 679 The client certificate must validate against the certificates in the bundle.</p> 680 </td> 681 </tr> 682 </tbody> 683 </table> 684 <h3 id="projectcontour.io/v1.ExtensionServiceReference">ExtensionServiceReference 685 </h3> 686 <p> 687 (<em>Appears on:</em> 688 <a href="#projectcontour.io/v1.AuthorizationServer">AuthorizationServer</a>) 689 </p> 690 <p> 691 <p>ExtensionServiceReference names an ExtensionService resource.</p> 692 </p> 693 <table class="table table-striped table-borderless" style="border:none"> 694 <thead class="border-bottom"> 695 <tr> 696 <th>Field</th> 697 <th>Description</th> 698 </tr> 699 </thead> 700 <tbody class="border-top"> 701 <tr> 702 <td style="white-space:nowrap"> 703 <code>apiVersion</code> 704 <br> 705 <em> 706 string 707 </em> 708 </td> 709 <td> 710 <em>(Optional)</em> 711 <p>API version of the referent. 712 If this field is not specified, the default “projectcontour.io/v1alpha1” will be used</p> 713 </td> 714 </tr> 715 <tr> 716 <td style="white-space:nowrap"> 717 <code>namespace</code> 718 <br> 719 <em> 720 string 721 </em> 722 </td> 723 <td> 724 <em>(Optional)</em> 725 <p>Namespace of the referent. 726 If this field is not specifies, the namespace of the resource that targets the referent will be used.</p> 727 <p>More info: <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/">https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/</a></p> 728 </td> 729 </tr> 730 <tr> 731 <td style="white-space:nowrap"> 732 <code>name</code> 733 <br> 734 <em> 735 string 736 </em> 737 </td> 738 <td> 739 <p>Name of the referent.</p> 740 <p>More info: <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names">https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names</a></p> 741 </td> 742 </tr> 743 </tbody> 744 </table> 745 <h3 id="projectcontour.io/v1.HTTPHealthCheckPolicy">HTTPHealthCheckPolicy 746 </h3> 747 <p> 748 (<em>Appears on:</em> 749 <a href="#projectcontour.io/v1.Route">Route</a>) 750 </p> 751 <p> 752 <p>HTTPHealthCheckPolicy defines health checks on the upstream service.</p> 753 </p> 754 <table class="table table-striped table-borderless" style="border:none"> 755 <thead class="border-bottom"> 756 <tr> 757 <th>Field</th> 758 <th>Description</th> 759 </tr> 760 </thead> 761 <tbody class="border-top"> 762 <tr> 763 <td style="white-space:nowrap"> 764 <code>path</code> 765 <br> 766 <em> 767 string 768 </em> 769 </td> 770 <td> 771 <p>HTTP endpoint used to perform health checks on upstream service</p> 772 </td> 773 </tr> 774 <tr> 775 <td style="white-space:nowrap"> 776 <code>host</code> 777 <br> 778 <em> 779 string 780 </em> 781 </td> 782 <td> 783 <p>The value of the host header in the HTTP health check request. 784 If left empty (default value), the name “contour-envoy-healthcheck” 785 will be used.</p> 786 </td> 787 </tr> 788 <tr> 789 <td style="white-space:nowrap"> 790 <code>intervalSeconds</code> 791 <br> 792 <em> 793 int64 794 </em> 795 </td> 796 <td> 797 <em>(Optional)</em> 798 <p>The interval (seconds) between health checks</p> 799 </td> 800 </tr> 801 <tr> 802 <td style="white-space:nowrap"> 803 <code>timeoutSeconds</code> 804 <br> 805 <em> 806 int64 807 </em> 808 </td> 809 <td> 810 <em>(Optional)</em> 811 <p>The time to wait (seconds) for a health check response</p> 812 </td> 813 </tr> 814 <tr> 815 <td style="white-space:nowrap"> 816 <code>unhealthyThresholdCount</code> 817 <br> 818 <em> 819 int64 820 </em> 821 </td> 822 <td> 823 <em>(Optional)</em> 824 <p>The number of unhealthy health checks required before a host is marked unhealthy</p> 825 </td> 826 </tr> 827 <tr> 828 <td style="white-space:nowrap"> 829 <code>healthyThresholdCount</code> 830 <br> 831 <em> 832 int64 833 </em> 834 </td> 835 <td> 836 <em>(Optional)</em> 837 <p>The number of healthy health checks required before a host is marked healthy</p> 838 </td> 839 </tr> 840 </tbody> 841 </table> 842 <h3 id="projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec 843 </h3> 844 <p> 845 (<em>Appears on:</em> 846 <a href="#projectcontour.io/v1.HTTPProxy">HTTPProxy</a>) 847 </p> 848 <p> 849 <p>HTTPProxySpec defines the spec of the CRD.</p> 850 </p> 851 <table class="table table-striped table-borderless" style="border:none"> 852 <thead class="border-bottom"> 853 <tr> 854 <th>Field</th> 855 <th>Description</th> 856 </tr> 857 </thead> 858 <tbody class="border-top"> 859 <tr> 860 <td style="white-space:nowrap"> 861 <code>virtualhost</code> 862 <br> 863 <em> 864 <a href="#projectcontour.io/v1.VirtualHost"> 865 VirtualHost 866 </a> 867 </em> 868 </td> 869 <td> 870 <em>(Optional)</em> 871 <p>Virtualhost appears at most once. If it is present, the object is considered 872 to be a “root” HTTPProxy.</p> 873 </td> 874 </tr> 875 <tr> 876 <td style="white-space:nowrap"> 877 <code>routes</code> 878 <br> 879 <em> 880 <a href="#projectcontour.io/v1.Route"> 881 []Route 882 </a> 883 </em> 884 </td> 885 <td> 886 <em>(Optional)</em> 887 <p>Routes are the ingress routes. If TCPProxy is present, Routes is ignored.</p> 888 </td> 889 </tr> 890 <tr> 891 <td style="white-space:nowrap"> 892 <code>tcpproxy</code> 893 <br> 894 <em> 895 <a href="#projectcontour.io/v1.TCPProxy"> 896 TCPProxy 897 </a> 898 </em> 899 </td> 900 <td> 901 <em>(Optional)</em> 902 <p>TCPProxy holds TCP proxy information.</p> 903 </td> 904 </tr> 905 <tr> 906 <td style="white-space:nowrap"> 907 <code>includes</code> 908 <br> 909 <em> 910 <a href="#projectcontour.io/v1.Include"> 911 []Include 912 </a> 913 </em> 914 </td> 915 <td> 916 <em>(Optional)</em> 917 <p>Includes allow for specific routing configuration to be included from another HTTPProxy, 918 possibly in another namespace.</p> 919 </td> 920 </tr> 921 </tbody> 922 </table> 923 <h3 id="projectcontour.io/v1.HTTPProxyStatus">HTTPProxyStatus 924 </h3> 925 <p> 926 (<em>Appears on:</em> 927 <a href="#projectcontour.io/v1.HTTPProxy">HTTPProxy</a>) 928 </p> 929 <p> 930 <p>HTTPProxyStatus reports the current state of the HTTPProxy.</p> 931 </p> 932 <table class="table table-striped table-borderless" style="border:none"> 933 <thead class="border-bottom"> 934 <tr> 935 <th>Field</th> 936 <th>Description</th> 937 </tr> 938 </thead> 939 <tbody class="border-top"> 940 <tr> 941 <td style="white-space:nowrap"> 942 <code>currentStatus</code> 943 <br> 944 <em> 945 string 946 </em> 947 </td> 948 <td> 949 <em>(Optional)</em> 950 </td> 951 </tr> 952 <tr> 953 <td style="white-space:nowrap"> 954 <code>description</code> 955 <br> 956 <em> 957 string 958 </em> 959 </td> 960 <td> 961 <em>(Optional)</em> 962 </td> 963 </tr> 964 <tr> 965 <td style="white-space:nowrap"> 966 <code>loadBalancer</code> 967 <br> 968 <em> 969 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#loadbalancerstatus-v1-core"> 970 Kubernetes core/v1.LoadBalancerStatus 971 </a> 972 </em> 973 </td> 974 <td> 975 <em>(Optional)</em> 976 <p>LoadBalancer contains the current status of the load balancer.</p> 977 </td> 978 </tr> 979 <tr> 980 <td style="white-space:nowrap"> 981 <code>conditions</code> 982 <br> 983 <em> 984 <a href="#projectcontour.io/v1.DetailedCondition"> 985 []DetailedCondition 986 </a> 987 </em> 988 </td> 989 <td> 990 <em>(Optional)</em> 991 <p>Conditions contains information about the current status of the HTTPProxy, 992 in an upstream-friendly container.</p> 993 <p>Contour will update a single condition, <code>Valid</code>, that is in normal-true polarity. 994 That is, when <code>currentStatus</code> is <code>valid</code>, the <code>Valid</code> condition will be <code>status: true</code>, 995 and vice versa.</p> 996 <p>Contour will leave untouched any other Conditions set in this block, 997 in case some other controller wants to add a Condition.</p> 998 <p>If you are another controller owner and wish to add a condition, you <em>should</em> 999 namespace your condition with a label, like <code>controller.domain.com/ConditionName</code>.</p> 1000 </td> 1001 </tr> 1002 </tbody> 1003 </table> 1004 <h3 id="projectcontour.io/v1.HeaderHashOptions">HeaderHashOptions 1005 </h3> 1006 <p> 1007 (<em>Appears on:</em> 1008 <a href="#projectcontour.io/v1.RequestHashPolicy">RequestHashPolicy</a>) 1009 </p> 1010 <p> 1011 <p>HeaderHashOptions contains options to configure a HTTP request header hash 1012 policy, used in request attribute hash based load balancing.</p> 1013 </p> 1014 <table class="table table-striped table-borderless" style="border:none"> 1015 <thead class="border-bottom"> 1016 <tr> 1017 <th>Field</th> 1018 <th>Description</th> 1019 </tr> 1020 </thead> 1021 <tbody class="border-top"> 1022 <tr> 1023 <td style="white-space:nowrap"> 1024 <code>headerName</code> 1025 <br> 1026 <em> 1027 string 1028 </em> 1029 </td> 1030 <td> 1031 <p>HeaderName is the name of the HTTP request header that will be used to 1032 calculate the hash key. If the header specified is not present on a 1033 request, no hash will be produced.</p> 1034 </td> 1035 </tr> 1036 </tbody> 1037 </table> 1038 <h3 id="projectcontour.io/v1.HeaderMatchCondition">HeaderMatchCondition 1039 </h3> 1040 <p> 1041 (<em>Appears on:</em> 1042 <a href="#projectcontour.io/v1.MatchCondition">MatchCondition</a>) 1043 </p> 1044 <p> 1045 <p>HeaderMatchCondition specifies how to conditionally match against HTTP 1046 headers. The Name field is required, but only one of the remaining 1047 fields should be be provided.</p> 1048 </p> 1049 <table class="table table-striped table-borderless" style="border:none"> 1050 <thead class="border-bottom"> 1051 <tr> 1052 <th>Field</th> 1053 <th>Description</th> 1054 </tr> 1055 </thead> 1056 <tbody class="border-top"> 1057 <tr> 1058 <td style="white-space:nowrap"> 1059 <code>name</code> 1060 <br> 1061 <em> 1062 string 1063 </em> 1064 </td> 1065 <td> 1066 <p>Name is the name of the header to match against. Name is required. 1067 Header names are case insensitive.</p> 1068 </td> 1069 </tr> 1070 <tr> 1071 <td style="white-space:nowrap"> 1072 <code>present</code> 1073 <br> 1074 <em> 1075 bool 1076 </em> 1077 </td> 1078 <td> 1079 <em>(Optional)</em> 1080 <p>Present specifies that condition is true when the named header 1081 is present, regardless of its value. Note that setting Present 1082 to false does not make the condition true if the named header 1083 is absent.</p> 1084 </td> 1085 </tr> 1086 <tr> 1087 <td style="white-space:nowrap"> 1088 <code>contains</code> 1089 <br> 1090 <em> 1091 string 1092 </em> 1093 </td> 1094 <td> 1095 <em>(Optional)</em> 1096 <p>Contains specifies a substring that must be present in 1097 the header value.</p> 1098 </td> 1099 </tr> 1100 <tr> 1101 <td style="white-space:nowrap"> 1102 <code>notcontains</code> 1103 <br> 1104 <em> 1105 string 1106 </em> 1107 </td> 1108 <td> 1109 <em>(Optional)</em> 1110 <p>NotContains specifies a substring that must not be present 1111 in the header value.</p> 1112 </td> 1113 </tr> 1114 <tr> 1115 <td style="white-space:nowrap"> 1116 <code>exact</code> 1117 <br> 1118 <em> 1119 string 1120 </em> 1121 </td> 1122 <td> 1123 <em>(Optional)</em> 1124 <p>Exact specifies a string that the header value must be equal to.</p> 1125 </td> 1126 </tr> 1127 <tr> 1128 <td style="white-space:nowrap"> 1129 <code>notexact</code> 1130 <br> 1131 <em> 1132 string 1133 </em> 1134 </td> 1135 <td> 1136 <em>(Optional)</em> 1137 <p>NoExact specifies a string that the header value must not be 1138 equal to. The condition is true if the header has any other value.</p> 1139 </td> 1140 </tr> 1141 </tbody> 1142 </table> 1143 <h3 id="projectcontour.io/v1.HeaderValue">HeaderValue 1144 </h3> 1145 <p> 1146 (<em>Appears on:</em> 1147 <a href="#projectcontour.io/v1.HeadersPolicy">HeadersPolicy</a>, 1148 <a href="#projectcontour.io/v1.LocalRateLimitPolicy">LocalRateLimitPolicy</a>) 1149 </p> 1150 <p> 1151 <p>HeaderValue represents a header name/value pair</p> 1152 </p> 1153 <table class="table table-striped table-borderless" style="border:none"> 1154 <thead class="border-bottom"> 1155 <tr> 1156 <th>Field</th> 1157 <th>Description</th> 1158 </tr> 1159 </thead> 1160 <tbody class="border-top"> 1161 <tr> 1162 <td style="white-space:nowrap"> 1163 <code>name</code> 1164 <br> 1165 <em> 1166 string 1167 </em> 1168 </td> 1169 <td> 1170 <p>Name represents a key of a header</p> 1171 </td> 1172 </tr> 1173 <tr> 1174 <td style="white-space:nowrap"> 1175 <code>value</code> 1176 <br> 1177 <em> 1178 string 1179 </em> 1180 </td> 1181 <td> 1182 <p>Value represents the value of a header specified by a key</p> 1183 </td> 1184 </tr> 1185 </tbody> 1186 </table> 1187 <h3 id="projectcontour.io/v1.HeadersPolicy">HeadersPolicy 1188 </h3> 1189 <p> 1190 (<em>Appears on:</em> 1191 <a href="#projectcontour.io/v1.Route">Route</a>, 1192 <a href="#projectcontour.io/v1.Service">Service</a>) 1193 </p> 1194 <p> 1195 <p>HeadersPolicy defines how headers are managed during forwarding. 1196 The <code>Host</code> header is treated specially and if set in a HTTP response 1197 will be used as the SNI server name when forwarding over TLS. It is an 1198 error to attempt to set the <code>Host</code> header in a HTTP response.</p> 1199 </p> 1200 <table class="table table-striped table-borderless" style="border:none"> 1201 <thead class="border-bottom"> 1202 <tr> 1203 <th>Field</th> 1204 <th>Description</th> 1205 </tr> 1206 </thead> 1207 <tbody class="border-top"> 1208 <tr> 1209 <td style="white-space:nowrap"> 1210 <code>set</code> 1211 <br> 1212 <em> 1213 <a href="#projectcontour.io/v1.HeaderValue"> 1214 []HeaderValue 1215 </a> 1216 </em> 1217 </td> 1218 <td> 1219 <em>(Optional)</em> 1220 <p>Set specifies a list of HTTP header values that will be set in the HTTP header. 1221 If the header does not exist it will be added, otherwise it will be overwritten with the new value.</p> 1222 </td> 1223 </tr> 1224 <tr> 1225 <td style="white-space:nowrap"> 1226 <code>remove</code> 1227 <br> 1228 <em> 1229 []string 1230 </em> 1231 </td> 1232 <td> 1233 <em>(Optional)</em> 1234 <p>Remove specifies a list of HTTP header names to remove.</p> 1235 </td> 1236 </tr> 1237 </tbody> 1238 </table> 1239 <h3 id="projectcontour.io/v1.Include">Include 1240 </h3> 1241 <p> 1242 (<em>Appears on:</em> 1243 <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>) 1244 </p> 1245 <p> 1246 <p>Include describes a set of policies that can be applied to an HTTPProxy in a namespace.</p> 1247 </p> 1248 <table class="table table-striped table-borderless" style="border:none"> 1249 <thead class="border-bottom"> 1250 <tr> 1251 <th>Field</th> 1252 <th>Description</th> 1253 </tr> 1254 </thead> 1255 <tbody class="border-top"> 1256 <tr> 1257 <td style="white-space:nowrap"> 1258 <code>name</code> 1259 <br> 1260 <em> 1261 string 1262 </em> 1263 </td> 1264 <td> 1265 <p>Name of the HTTPProxy</p> 1266 </td> 1267 </tr> 1268 <tr> 1269 <td style="white-space:nowrap"> 1270 <code>namespace</code> 1271 <br> 1272 <em> 1273 string 1274 </em> 1275 </td> 1276 <td> 1277 <em>(Optional)</em> 1278 <p>Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.</p> 1279 </td> 1280 </tr> 1281 <tr> 1282 <td style="white-space:nowrap"> 1283 <code>conditions</code> 1284 <br> 1285 <em> 1286 <a href="#projectcontour.io/v1.MatchCondition"> 1287 []MatchCondition 1288 </a> 1289 </em> 1290 </td> 1291 <td> 1292 <em>(Optional)</em> 1293 <p>Conditions are a set of rules that are applied to included HTTPProxies. 1294 In effect, they are added onto the Conditions of included HTTPProxy Route 1295 structs. 1296 When applied, they are merged using AND, with one exception: 1297 There can be only one Prefix MatchCondition per Conditions slice. 1298 More than one Prefix, or contradictory Conditions, will make the 1299 include invalid.</p> 1300 </td> 1301 </tr> 1302 </tbody> 1303 </table> 1304 <h3 id="projectcontour.io/v1.LoadBalancerPolicy">LoadBalancerPolicy 1305 </h3> 1306 <p> 1307 (<em>Appears on:</em> 1308 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>, 1309 <a href="#projectcontour.io/v1.Route">Route</a>, 1310 <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>) 1311 </p> 1312 <p> 1313 <p>LoadBalancerPolicy defines the load balancing policy.</p> 1314 </p> 1315 <table class="table table-striped table-borderless" style="border:none"> 1316 <thead class="border-bottom"> 1317 <tr> 1318 <th>Field</th> 1319 <th>Description</th> 1320 </tr> 1321 </thead> 1322 <tbody class="border-top"> 1323 <tr> 1324 <td style="white-space:nowrap"> 1325 <code>strategy</code> 1326 <br> 1327 <em> 1328 string 1329 </em> 1330 </td> 1331 <td> 1332 <p>Strategy specifies the policy used to balance requests 1333 across the pool of backend pods. Valid policy names are 1334 <code>Random</code>, <code>RoundRobin</code>, <code>WeightedLeastRequest</code>, <code>Cookie</code>, 1335 and <code>RequestHash</code>. If an unknown strategy name is specified 1336 or no policy is supplied, the default <code>RoundRobin</code> policy 1337 is used.</p> 1338 </td> 1339 </tr> 1340 <tr> 1341 <td style="white-space:nowrap"> 1342 <code>requestHashPolicies</code> 1343 <br> 1344 <em> 1345 <a href="#projectcontour.io/v1.RequestHashPolicy"> 1346 []RequestHashPolicy 1347 </a> 1348 </em> 1349 </td> 1350 <td> 1351 <p>RequestHashPolicies contains a list of hash policies to apply when the 1352 <code>RequestHash</code> load balancing strategy is chosen. If an element of the 1353 supplied list of hash policies is invalid, it will be ignored. If the 1354 list of hash policies is empty after validation, the load balancing 1355 strategy will fall back to the default <code>RoundRobin</code>.</p> 1356 </td> 1357 </tr> 1358 </tbody> 1359 </table> 1360 <h3 id="projectcontour.io/v1.LocalRateLimitPolicy">LocalRateLimitPolicy 1361 </h3> 1362 <p> 1363 (<em>Appears on:</em> 1364 <a href="#projectcontour.io/v1.RateLimitPolicy">RateLimitPolicy</a>) 1365 </p> 1366 <p> 1367 <p>LocalRateLimitPolicy defines local rate limiting parameters.</p> 1368 </p> 1369 <table class="table table-striped table-borderless" style="border:none"> 1370 <thead class="border-bottom"> 1371 <tr> 1372 <th>Field</th> 1373 <th>Description</th> 1374 </tr> 1375 </thead> 1376 <tbody class="border-top"> 1377 <tr> 1378 <td style="white-space:nowrap"> 1379 <code>requests</code> 1380 <br> 1381 <em> 1382 uint32 1383 </em> 1384 </td> 1385 <td> 1386 <p>Requests defines how many requests per unit of time should 1387 be allowed before rate limiting occurs.</p> 1388 </td> 1389 </tr> 1390 <tr> 1391 <td style="white-space:nowrap"> 1392 <code>unit</code> 1393 <br> 1394 <em> 1395 string 1396 </em> 1397 </td> 1398 <td> 1399 <p>Unit defines the period of time within which requests 1400 over the limit will be rate limited. Valid values are 1401 “second”, “minute” and “hour”.</p> 1402 </td> 1403 </tr> 1404 <tr> 1405 <td style="white-space:nowrap"> 1406 <code>burst</code> 1407 <br> 1408 <em> 1409 uint32 1410 </em> 1411 </td> 1412 <td> 1413 <em>(Optional)</em> 1414 <p>Burst defines the number of requests above the requests per 1415 unit that should be allowed within a short period of time.</p> 1416 </td> 1417 </tr> 1418 <tr> 1419 <td style="white-space:nowrap"> 1420 <code>responseStatusCode</code> 1421 <br> 1422 <em> 1423 uint32 1424 </em> 1425 </td> 1426 <td> 1427 <em>(Optional)</em> 1428 <p>ResponseStatusCode is the HTTP status code to use for responses 1429 to rate-limited requests. Codes must be in the 400-599 range 1430 (inclusive). If not specified, the Envoy default of 429 (Too 1431 Many Requests) is used.</p> 1432 </td> 1433 </tr> 1434 <tr> 1435 <td style="white-space:nowrap"> 1436 <code>responseHeadersToAdd</code> 1437 <br> 1438 <em> 1439 <a href="#projectcontour.io/v1.HeaderValue"> 1440 []HeaderValue 1441 </a> 1442 </em> 1443 </td> 1444 <td> 1445 <em>(Optional)</em> 1446 <p>ResponseHeadersToAdd is an optional list of response headers to 1447 set when a request is rate-limited.</p> 1448 </td> 1449 </tr> 1450 </tbody> 1451 </table> 1452 <h3 id="projectcontour.io/v1.MatchCondition">MatchCondition 1453 </h3> 1454 <p> 1455 (<em>Appears on:</em> 1456 <a href="#projectcontour.io/v1.Include">Include</a>, 1457 <a href="#projectcontour.io/v1.Route">Route</a>) 1458 </p> 1459 <p> 1460 <p>MatchCondition are a general holder for matching rules for HTTPProxies. 1461 One of Prefix or Header must be provided.</p> 1462 </p> 1463 <table class="table table-striped table-borderless" style="border:none"> 1464 <thead class="border-bottom"> 1465 <tr> 1466 <th>Field</th> 1467 <th>Description</th> 1468 </tr> 1469 </thead> 1470 <tbody class="border-top"> 1471 <tr> 1472 <td style="white-space:nowrap"> 1473 <code>prefix</code> 1474 <br> 1475 <em> 1476 string 1477 </em> 1478 </td> 1479 <td> 1480 <em>(Optional)</em> 1481 <p>Prefix defines a prefix match for a request.</p> 1482 </td> 1483 </tr> 1484 <tr> 1485 <td style="white-space:nowrap"> 1486 <code>header</code> 1487 <br> 1488 <em> 1489 <a href="#projectcontour.io/v1.HeaderMatchCondition"> 1490 HeaderMatchCondition 1491 </a> 1492 </em> 1493 </td> 1494 <td> 1495 <em>(Optional)</em> 1496 <p>Header specifies the header condition to match.</p> 1497 </td> 1498 </tr> 1499 </tbody> 1500 </table> 1501 <h3 id="projectcontour.io/v1.PathRewritePolicy">PathRewritePolicy 1502 </h3> 1503 <p> 1504 (<em>Appears on:</em> 1505 <a href="#projectcontour.io/v1.Route">Route</a>) 1506 </p> 1507 <p> 1508 <p>PathRewritePolicy specifies how a request URL path should be 1509 rewritten. This rewriting takes place after a request is routed 1510 and has no subsequent effects on the proxy’s routing decision. 1511 No HTTP headers or body content is rewritten.</p> 1512 <p>Exactly one field in this struct may be specified.</p> 1513 </p> 1514 <table class="table table-striped table-borderless" style="border:none"> 1515 <thead class="border-bottom"> 1516 <tr> 1517 <th>Field</th> 1518 <th>Description</th> 1519 </tr> 1520 </thead> 1521 <tbody class="border-top"> 1522 <tr> 1523 <td style="white-space:nowrap"> 1524 <code>replacePrefix</code> 1525 <br> 1526 <em> 1527 <a href="#projectcontour.io/v1.ReplacePrefix"> 1528 []ReplacePrefix 1529 </a> 1530 </em> 1531 </td> 1532 <td> 1533 <em>(Optional)</em> 1534 <p>ReplacePrefix describes how the path prefix should be replaced.</p> 1535 </td> 1536 </tr> 1537 </tbody> 1538 </table> 1539 <h3 id="projectcontour.io/v1.RateLimitPolicy">RateLimitPolicy 1540 </h3> 1541 <p> 1542 (<em>Appears on:</em> 1543 <a href="#projectcontour.io/v1.Route">Route</a>, 1544 <a href="#projectcontour.io/v1.VirtualHost">VirtualHost</a>) 1545 </p> 1546 <p> 1547 <p>RateLimitPolicy defines rate limiting parameters.</p> 1548 </p> 1549 <table class="table table-striped table-borderless" style="border:none"> 1550 <thead class="border-bottom"> 1551 <tr> 1552 <th>Field</th> 1553 <th>Description</th> 1554 </tr> 1555 </thead> 1556 <tbody class="border-top"> 1557 <tr> 1558 <td style="white-space:nowrap"> 1559 <code>local</code> 1560 <br> 1561 <em> 1562 <a href="#projectcontour.io/v1.LocalRateLimitPolicy"> 1563 LocalRateLimitPolicy 1564 </a> 1565 </em> 1566 </td> 1567 <td> 1568 <p>Local defines local rate limiting parameters, i.e. parameters 1569 for rate limiting that occurs within each Envoy pod as requests 1570 are handled.</p> 1571 </td> 1572 </tr> 1573 </tbody> 1574 </table> 1575 <h3 id="projectcontour.io/v1.ReplacePrefix">ReplacePrefix 1576 </h3> 1577 <p> 1578 (<em>Appears on:</em> 1579 <a href="#projectcontour.io/v1.PathRewritePolicy">PathRewritePolicy</a>) 1580 </p> 1581 <p> 1582 <p>ReplacePrefix describes a path prefix replacement.</p> 1583 </p> 1584 <table class="table table-striped table-borderless" style="border:none"> 1585 <thead class="border-bottom"> 1586 <tr> 1587 <th>Field</th> 1588 <th>Description</th> 1589 </tr> 1590 </thead> 1591 <tbody class="border-top"> 1592 <tr> 1593 <td style="white-space:nowrap"> 1594 <code>prefix</code> 1595 <br> 1596 <em> 1597 string 1598 </em> 1599 </td> 1600 <td> 1601 <em>(Optional)</em> 1602 <p>Prefix specifies the URL path prefix to be replaced.</p> 1603 <p>If Prefix is specified, it must exactly match the MatchCondition 1604 prefix that is rendered by the chain of including HTTPProxies 1605 and only that path prefix will be replaced by Replacement. 1606 This allows HTTPProxies that are included through multiple 1607 roots to only replace specific path prefixes, leaving others 1608 unmodified.</p> 1609 <p>If Prefix is not specified, all routing prefixes rendered 1610 by the include chain will be replaced.</p> 1611 </td> 1612 </tr> 1613 <tr> 1614 <td style="white-space:nowrap"> 1615 <code>replacement</code> 1616 <br> 1617 <em> 1618 string 1619 </em> 1620 </td> 1621 <td> 1622 <p>Replacement is the string that the routing path prefix 1623 will be replaced with. This must not be empty.</p> 1624 </td> 1625 </tr> 1626 </tbody> 1627 </table> 1628 <h3 id="projectcontour.io/v1.RequestHashPolicy">RequestHashPolicy 1629 </h3> 1630 <p> 1631 (<em>Appears on:</em> 1632 <a href="#projectcontour.io/v1.LoadBalancerPolicy">LoadBalancerPolicy</a>) 1633 </p> 1634 <p> 1635 <p>RequestHashPolicy contains configuration for an individual hash policy 1636 on a request attribute.</p> 1637 </p> 1638 <table class="table table-striped table-borderless" style="border:none"> 1639 <thead class="border-bottom"> 1640 <tr> 1641 <th>Field</th> 1642 <th>Description</th> 1643 </tr> 1644 </thead> 1645 <tbody class="border-top"> 1646 <tr> 1647 <td style="white-space:nowrap"> 1648 <code>terminal</code> 1649 <br> 1650 <em> 1651 bool 1652 </em> 1653 </td> 1654 <td> 1655 <p>Terminal is a flag that allows for short-circuiting computing of a hash 1656 for a given request. If set to true, and the request attribute specified 1657 in the attribute hash options is present, no further hash policies will 1658 be used to calculate a hash for the request.</p> 1659 </td> 1660 </tr> 1661 <tr> 1662 <td style="white-space:nowrap"> 1663 <code>headerHashOptions</code> 1664 <br> 1665 <em> 1666 <a href="#projectcontour.io/v1.HeaderHashOptions"> 1667 HeaderHashOptions 1668 </a> 1669 </em> 1670 </td> 1671 <td> 1672 <p>HeaderHashOptions should be set when request header hash based load 1673 balancing is desired. It must be the only hash option field set, 1674 otherwise this request hash policy object will be ignored.</p> 1675 </td> 1676 </tr> 1677 </tbody> 1678 </table> 1679 <h3 id="projectcontour.io/v1.RetryOn">RetryOn 1680 (<code>string</code> alias)</h3> 1681 <p> 1682 (<em>Appears on:</em> 1683 <a href="#projectcontour.io/v1.RetryPolicy">RetryPolicy</a>) 1684 </p> 1685 <p> 1686 <p>RetryOn is a string type alias with validation to ensure that the value is valid.</p> 1687 </p> 1688 <h3 id="projectcontour.io/v1.RetryPolicy">RetryPolicy 1689 </h3> 1690 <p> 1691 (<em>Appears on:</em> 1692 <a href="#projectcontour.io/v1.Route">Route</a>) 1693 </p> 1694 <p> 1695 <p>RetryPolicy defines the attributes associated with retrying policy.</p> 1696 </p> 1697 <table class="table table-striped table-borderless" style="border:none"> 1698 <thead class="border-bottom"> 1699 <tr> 1700 <th>Field</th> 1701 <th>Description</th> 1702 </tr> 1703 </thead> 1704 <tbody class="border-top"> 1705 <tr> 1706 <td style="white-space:nowrap"> 1707 <code>count</code> 1708 <br> 1709 <em> 1710 int64 1711 </em> 1712 </td> 1713 <td> 1714 <em>(Optional)</em> 1715 <p>NumRetries is maximum allowed number of retries. 1716 If not supplied, the number of retries is one.</p> 1717 </td> 1718 </tr> 1719 <tr> 1720 <td style="white-space:nowrap"> 1721 <code>perTryTimeout</code> 1722 <br> 1723 <em> 1724 string 1725 </em> 1726 </td> 1727 <td> 1728 <em>(Optional)</em> 1729 <p>PerTryTimeout specifies the timeout per retry attempt. 1730 Ignored if NumRetries is not supplied.</p> 1731 </td> 1732 </tr> 1733 <tr> 1734 <td style="white-space:nowrap"> 1735 <code>retryOn</code> 1736 <br> 1737 <em> 1738 <a href="#projectcontour.io/v1.RetryOn"> 1739 []RetryOn 1740 </a> 1741 </em> 1742 </td> 1743 <td> 1744 <em>(Optional)</em> 1745 <p>RetryOn specifies the conditions on which to retry a request.</p> 1746 <p>Supported <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on">HTTP conditions</a>:</p> 1747 <ul> 1748 <li><code>5xx</code></li> 1749 <li><code>gateway-error</code></li> 1750 <li><code>reset</code></li> 1751 <li><code>connect-failure</code></li> 1752 <li><code>retriable-4xx</code></li> 1753 <li><code>refused-stream</code></li> 1754 <li><code>retriable-status-codes</code></li> 1755 <li><code>retriable-headers</code></li> 1756 </ul> 1757 <p>Supported <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-grpc-on">gRPC conditions</a>:</p> 1758 <ul> 1759 <li><code>cancelled</code></li> 1760 <li><code>deadline-exceeded</code></li> 1761 <li><code>internal</code></li> 1762 <li><code>resource-exhausted</code></li> 1763 <li><code>unavailable</code></li> 1764 </ul> 1765 </td> 1766 </tr> 1767 <tr> 1768 <td style="white-space:nowrap"> 1769 <code>retriableStatusCodes</code> 1770 <br> 1771 <em> 1772 []uint32 1773 </em> 1774 </td> 1775 <td> 1776 <em>(Optional)</em> 1777 <p>RetriableStatusCodes specifies the HTTP status codes that should be retried.</p> 1778 <p>This field is only respected when you include <code>retriable-status-codes</code> in the <code>RetryOn</code> field.</p> 1779 </td> 1780 </tr> 1781 </tbody> 1782 </table> 1783 <h3 id="projectcontour.io/v1.Route">Route 1784 </h3> 1785 <p> 1786 (<em>Appears on:</em> 1787 <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>) 1788 </p> 1789 <p> 1790 <p>Route contains the set of routes for a virtual host.</p> 1791 </p> 1792 <table class="table table-striped table-borderless" style="border:none"> 1793 <thead class="border-bottom"> 1794 <tr> 1795 <th>Field</th> 1796 <th>Description</th> 1797 </tr> 1798 </thead> 1799 <tbody class="border-top"> 1800 <tr> 1801 <td style="white-space:nowrap"> 1802 <code>conditions</code> 1803 <br> 1804 <em> 1805 <a href="#projectcontour.io/v1.MatchCondition"> 1806 []MatchCondition 1807 </a> 1808 </em> 1809 </td> 1810 <td> 1811 <em>(Optional)</em> 1812 <p>Conditions are a set of rules that are applied to a Route. 1813 When applied, they are merged using AND, with one exception: 1814 There can be only one Prefix MatchCondition per Conditions slice. 1815 More than one Prefix, or contradictory Conditions, will make the 1816 route invalid.</p> 1817 </td> 1818 </tr> 1819 <tr> 1820 <td style="white-space:nowrap"> 1821 <code>services</code> 1822 <br> 1823 <em> 1824 <a href="#projectcontour.io/v1.Service"> 1825 []Service 1826 </a> 1827 </em> 1828 </td> 1829 <td> 1830 <p>Services are the services to proxy traffic.</p> 1831 </td> 1832 </tr> 1833 <tr> 1834 <td style="white-space:nowrap"> 1835 <code>enableWebsockets</code> 1836 <br> 1837 <em> 1838 bool 1839 </em> 1840 </td> 1841 <td> 1842 <em>(Optional)</em> 1843 <p>Enables websocket support for the route.</p> 1844 </td> 1845 </tr> 1846 <tr> 1847 <td style="white-space:nowrap"> 1848 <code>permitInsecure</code> 1849 <br> 1850 <em> 1851 bool 1852 </em> 1853 </td> 1854 <td> 1855 <em>(Optional)</em> 1856 <p>Allow this path to respond to insecure requests over HTTP which are normally 1857 not permitted when a <code>virtualhost.tls</code> block is present.</p> 1858 </td> 1859 </tr> 1860 <tr> 1861 <td style="white-space:nowrap"> 1862 <code>authPolicy</code> 1863 <br> 1864 <em> 1865 <a href="#projectcontour.io/v1.AuthorizationPolicy"> 1866 AuthorizationPolicy 1867 </a> 1868 </em> 1869 </td> 1870 <td> 1871 <em>(Optional)</em> 1872 <p>AuthPolicy updates the authorization policy that was set 1873 on the root HTTPProxy object for client requests that 1874 match this route.</p> 1875 </td> 1876 </tr> 1877 <tr> 1878 <td style="white-space:nowrap"> 1879 <code>timeoutPolicy</code> 1880 <br> 1881 <em> 1882 <a href="#projectcontour.io/v1.TimeoutPolicy"> 1883 TimeoutPolicy 1884 </a> 1885 </em> 1886 </td> 1887 <td> 1888 <em>(Optional)</em> 1889 <p>The timeout policy for this route.</p> 1890 </td> 1891 </tr> 1892 <tr> 1893 <td style="white-space:nowrap"> 1894 <code>retryPolicy</code> 1895 <br> 1896 <em> 1897 <a href="#projectcontour.io/v1.RetryPolicy"> 1898 RetryPolicy 1899 </a> 1900 </em> 1901 </td> 1902 <td> 1903 <em>(Optional)</em> 1904 <p>The retry policy for this route.</p> 1905 </td> 1906 </tr> 1907 <tr> 1908 <td style="white-space:nowrap"> 1909 <code>healthCheckPolicy</code> 1910 <br> 1911 <em> 1912 <a href="#projectcontour.io/v1.HTTPHealthCheckPolicy"> 1913 HTTPHealthCheckPolicy 1914 </a> 1915 </em> 1916 </td> 1917 <td> 1918 <em>(Optional)</em> 1919 <p>The health check policy for this route.</p> 1920 </td> 1921 </tr> 1922 <tr> 1923 <td style="white-space:nowrap"> 1924 <code>loadBalancerPolicy</code> 1925 <br> 1926 <em> 1927 <a href="#projectcontour.io/v1.LoadBalancerPolicy"> 1928 LoadBalancerPolicy 1929 </a> 1930 </em> 1931 </td> 1932 <td> 1933 <em>(Optional)</em> 1934 <p>The load balancing policy for this route.</p> 1935 </td> 1936 </tr> 1937 <tr> 1938 <td style="white-space:nowrap"> 1939 <code>pathRewritePolicy</code> 1940 <br> 1941 <em> 1942 <a href="#projectcontour.io/v1.PathRewritePolicy"> 1943 PathRewritePolicy 1944 </a> 1945 </em> 1946 </td> 1947 <td> 1948 <em>(Optional)</em> 1949 <p>The policy for rewriting the path of the request URL 1950 after the request has been routed to a Service.</p> 1951 </td> 1952 </tr> 1953 <tr> 1954 <td style="white-space:nowrap"> 1955 <code>requestHeadersPolicy</code> 1956 <br> 1957 <em> 1958 <a href="#projectcontour.io/v1.HeadersPolicy"> 1959 HeadersPolicy 1960 </a> 1961 </em> 1962 </td> 1963 <td> 1964 <em>(Optional)</em> 1965 <p>The policy for managing request headers during proxying.</p> 1966 </td> 1967 </tr> 1968 <tr> 1969 <td style="white-space:nowrap"> 1970 <code>responseHeadersPolicy</code> 1971 <br> 1972 <em> 1973 <a href="#projectcontour.io/v1.HeadersPolicy"> 1974 HeadersPolicy 1975 </a> 1976 </em> 1977 </td> 1978 <td> 1979 <em>(Optional)</em> 1980 <p>The policy for managing response headers during proxying. 1981 Rewriting the ‘Host’ header is not supported.</p> 1982 </td> 1983 </tr> 1984 <tr> 1985 <td style="white-space:nowrap"> 1986 <code>rateLimitPolicy</code> 1987 <br> 1988 <em> 1989 <a href="#projectcontour.io/v1.RateLimitPolicy"> 1990 RateLimitPolicy 1991 </a> 1992 </em> 1993 </td> 1994 <td> 1995 <em>(Optional)</em> 1996 <p>The policy for rate limiting on the route.</p> 1997 </td> 1998 </tr> 1999 </tbody> 2000 </table> 2001 <h3 id="projectcontour.io/v1.Service">Service 2002 </h3> 2003 <p> 2004 (<em>Appears on:</em> 2005 <a href="#projectcontour.io/v1.Route">Route</a>, 2006 <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>) 2007 </p> 2008 <p> 2009 <p>Service defines an Kubernetes Service to proxy traffic.</p> 2010 </p> 2011 <table class="table table-striped table-borderless" style="border:none"> 2012 <thead class="border-bottom"> 2013 <tr> 2014 <th>Field</th> 2015 <th>Description</th> 2016 </tr> 2017 </thead> 2018 <tbody class="border-top"> 2019 <tr> 2020 <td style="white-space:nowrap"> 2021 <code>name</code> 2022 <br> 2023 <em> 2024 string 2025 </em> 2026 </td> 2027 <td> 2028 <p>Name is the name of Kubernetes service to proxy traffic. 2029 Names defined here will be used to look up corresponding endpoints which contain the ips to route.</p> 2030 </td> 2031 </tr> 2032 <tr> 2033 <td style="white-space:nowrap"> 2034 <code>port</code> 2035 <br> 2036 <em> 2037 int 2038 </em> 2039 </td> 2040 <td> 2041 <p>Port (defined as Integer) to proxy traffic to since a service can have multiple defined.</p> 2042 </td> 2043 </tr> 2044 <tr> 2045 <td style="white-space:nowrap"> 2046 <code>protocol</code> 2047 <br> 2048 <em> 2049 string 2050 </em> 2051 </td> 2052 <td> 2053 <em>(Optional)</em> 2054 <p>Protocol may be used to specify (or override) the protocol used to reach this Service. 2055 Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.</p> 2056 </td> 2057 </tr> 2058 <tr> 2059 <td style="white-space:nowrap"> 2060 <code>weight</code> 2061 <br> 2062 <em> 2063 int64 2064 </em> 2065 </td> 2066 <td> 2067 <em>(Optional)</em> 2068 <p>Weight defines percentage of traffic to balance traffic</p> 2069 </td> 2070 </tr> 2071 <tr> 2072 <td style="white-space:nowrap"> 2073 <code>validation</code> 2074 <br> 2075 <em> 2076 <a href="#projectcontour.io/v1.UpstreamValidation"> 2077 UpstreamValidation 2078 </a> 2079 </em> 2080 </td> 2081 <td> 2082 <em>(Optional)</em> 2083 <p>UpstreamValidation defines how to verify the backend service’s certificate</p> 2084 </td> 2085 </tr> 2086 <tr> 2087 <td style="white-space:nowrap"> 2088 <code>mirror</code> 2089 <br> 2090 <em> 2091 bool 2092 </em> 2093 </td> 2094 <td> 2095 <p>If Mirror is true the Service will receive a read only mirror of the traffic for this route.</p> 2096 </td> 2097 </tr> 2098 <tr> 2099 <td style="white-space:nowrap"> 2100 <code>requestHeadersPolicy</code> 2101 <br> 2102 <em> 2103 <a href="#projectcontour.io/v1.HeadersPolicy"> 2104 HeadersPolicy 2105 </a> 2106 </em> 2107 </td> 2108 <td> 2109 <em>(Optional)</em> 2110 <p>The policy for managing request headers during proxying. 2111 Rewriting the ‘Host’ header is not supported.</p> 2112 </td> 2113 </tr> 2114 <tr> 2115 <td style="white-space:nowrap"> 2116 <code>responseHeadersPolicy</code> 2117 <br> 2118 <em> 2119 <a href="#projectcontour.io/v1.HeadersPolicy"> 2120 HeadersPolicy 2121 </a> 2122 </em> 2123 </td> 2124 <td> 2125 <em>(Optional)</em> 2126 <p>The policy for managing response headers during proxying. 2127 Rewriting the ‘Host’ header is not supported.</p> 2128 </td> 2129 </tr> 2130 </tbody> 2131 </table> 2132 <h3 id="projectcontour.io/v1.SubCondition">SubCondition 2133 </h3> 2134 <p> 2135 (<em>Appears on:</em> 2136 <a href="#projectcontour.io/v1.DetailedCondition">DetailedCondition</a>) 2137 </p> 2138 <p> 2139 <p>SubCondition is a Condition-like type intended for use as a subcondition inside a DetailedCondition.</p> 2140 <p>It contains a subset of the Condition fields.</p> 2141 <p>It is intended for warnings and errors, so <code>type</code> names should use abnormal-true polarity, 2142 that is, they should be of the form “ErrorPresent: true”.</p> 2143 <p>The expected lifecycle for these errors is that they should only be present when the error or warning is, 2144 and should be removed when they are not relevant.</p> 2145 </p> 2146 <table class="table table-striped table-borderless" style="border:none"> 2147 <thead class="border-bottom"> 2148 <tr> 2149 <th>Field</th> 2150 <th>Description</th> 2151 </tr> 2152 </thead> 2153 <tbody class="border-top"> 2154 <tr> 2155 <td style="white-space:nowrap"> 2156 <code>type</code> 2157 <br> 2158 <em> 2159 string 2160 </em> 2161 </td> 2162 <td> 2163 <p>Type of condition in <code>CamelCase</code> or in <code>foo.example.com/CamelCase</code>.</p> 2164 <p>This must be in abnormal-true polarity, that is, <code>ErrorFound</code> or <code>controller.io/ErrorFound</code>.</p> 2165 <p>The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)</p> 2166 </td> 2167 </tr> 2168 <tr> 2169 <td style="white-space:nowrap"> 2170 <code>status</code> 2171 <br> 2172 <em> 2173 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-meta"> 2174 Kubernetes meta/v1.ConditionStatus 2175 </a> 2176 </em> 2177 </td> 2178 <td> 2179 <p>Status of the condition, one of True, False, Unknown.</p> 2180 </td> 2181 </tr> 2182 <tr> 2183 <td style="white-space:nowrap"> 2184 <code>reason</code> 2185 <br> 2186 <em> 2187 string 2188 </em> 2189 </td> 2190 <td> 2191 <p>Reason contains a programmatic identifier indicating the reason for the condition’s last transition. 2192 Producers of specific condition types may define expected values and meanings for this field, 2193 and whether the values are considered a guaranteed API.</p> 2194 <p>The value should be a CamelCase string.</p> 2195 <p>This field may not be empty.</p> 2196 </td> 2197 </tr> 2198 <tr> 2199 <td style="white-space:nowrap"> 2200 <code>message</code> 2201 <br> 2202 <em> 2203 string 2204 </em> 2205 </td> 2206 <td> 2207 <p>Message is a human readable message indicating details about the transition.</p> 2208 <p>This may be an empty string.</p> 2209 </td> 2210 </tr> 2211 </tbody> 2212 </table> 2213 <h3 id="projectcontour.io/v1.TCPHealthCheckPolicy">TCPHealthCheckPolicy 2214 </h3> 2215 <p> 2216 (<em>Appears on:</em> 2217 <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>) 2218 </p> 2219 <p> 2220 <p>TCPHealthCheckPolicy defines health checks on the upstream service.</p> 2221 </p> 2222 <table class="table table-striped table-borderless" style="border:none"> 2223 <thead class="border-bottom"> 2224 <tr> 2225 <th>Field</th> 2226 <th>Description</th> 2227 </tr> 2228 </thead> 2229 <tbody class="border-top"> 2230 <tr> 2231 <td style="white-space:nowrap"> 2232 <code>intervalSeconds</code> 2233 <br> 2234 <em> 2235 int64 2236 </em> 2237 </td> 2238 <td> 2239 <em>(Optional)</em> 2240 <p>The interval (seconds) between health checks</p> 2241 </td> 2242 </tr> 2243 <tr> 2244 <td style="white-space:nowrap"> 2245 <code>timeoutSeconds</code> 2246 <br> 2247 <em> 2248 int64 2249 </em> 2250 </td> 2251 <td> 2252 <em>(Optional)</em> 2253 <p>The time to wait (seconds) for a health check response</p> 2254 </td> 2255 </tr> 2256 <tr> 2257 <td style="white-space:nowrap"> 2258 <code>unhealthyThresholdCount</code> 2259 <br> 2260 <em> 2261 uint32 2262 </em> 2263 </td> 2264 <td> 2265 <em>(Optional)</em> 2266 <p>The number of unhealthy health checks required before a host is marked unhealthy</p> 2267 </td> 2268 </tr> 2269 <tr> 2270 <td style="white-space:nowrap"> 2271 <code>healthyThresholdCount</code> 2272 <br> 2273 <em> 2274 uint32 2275 </em> 2276 </td> 2277 <td> 2278 <em>(Optional)</em> 2279 <p>The number of healthy health checks required before a host is marked healthy</p> 2280 </td> 2281 </tr> 2282 </tbody> 2283 </table> 2284 <h3 id="projectcontour.io/v1.TCPProxy">TCPProxy 2285 </h3> 2286 <p> 2287 (<em>Appears on:</em> 2288 <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>) 2289 </p> 2290 <p> 2291 <p>TCPProxy contains the set of services to proxy TCP connections.</p> 2292 </p> 2293 <table class="table table-striped table-borderless" style="border:none"> 2294 <thead class="border-bottom"> 2295 <tr> 2296 <th>Field</th> 2297 <th>Description</th> 2298 </tr> 2299 </thead> 2300 <tbody class="border-top"> 2301 <tr> 2302 <td style="white-space:nowrap"> 2303 <code>loadBalancerPolicy</code> 2304 <br> 2305 <em> 2306 <a href="#projectcontour.io/v1.LoadBalancerPolicy"> 2307 LoadBalancerPolicy 2308 </a> 2309 </em> 2310 </td> 2311 <td> 2312 <em>(Optional)</em> 2313 <p>The load balancing policy for the backend services. Note that the 2314 <code>Cookie</code> and <code>RequestHash</code> load balancing strategies cannot be used 2315 here.</p> 2316 </td> 2317 </tr> 2318 <tr> 2319 <td style="white-space:nowrap"> 2320 <code>services</code> 2321 <br> 2322 <em> 2323 <a href="#projectcontour.io/v1.Service"> 2324 []Service 2325 </a> 2326 </em> 2327 </td> 2328 <td> 2329 <em>(Optional)</em> 2330 <p>Services are the services to proxy traffic</p> 2331 </td> 2332 </tr> 2333 <tr> 2334 <td style="white-space:nowrap"> 2335 <code>include</code> 2336 <br> 2337 <em> 2338 <a href="#projectcontour.io/v1.TCPProxyInclude"> 2339 TCPProxyInclude 2340 </a> 2341 </em> 2342 </td> 2343 <td> 2344 <em>(Optional)</em> 2345 <p>Include specifies that this tcpproxy should be delegated to another HTTPProxy.</p> 2346 </td> 2347 </tr> 2348 <tr> 2349 <td style="white-space:nowrap"> 2350 <code>includes</code> 2351 <br> 2352 <em> 2353 <a href="#projectcontour.io/v1.TCPProxyInclude"> 2354 TCPProxyInclude 2355 </a> 2356 </em> 2357 </td> 2358 <td> 2359 <em>(Optional)</em> 2360 <p>IncludesDeprecated allow for specific routing configuration to be appended to another HTTPProxy in another namespace.</p> 2361 <p>Exists due to a mistake when developing HTTPProxy and the field was marked plural 2362 when it should have been singular. This field should stay to not break backwards compatibility to v1 users.</p> 2363 </td> 2364 </tr> 2365 <tr> 2366 <td style="white-space:nowrap"> 2367 <code>healthCheckPolicy</code> 2368 <br> 2369 <em> 2370 <a href="#projectcontour.io/v1.TCPHealthCheckPolicy"> 2371 TCPHealthCheckPolicy 2372 </a> 2373 </em> 2374 </td> 2375 <td> 2376 <em>(Optional)</em> 2377 <p>The health check policy for this tcp proxy</p> 2378 </td> 2379 </tr> 2380 </tbody> 2381 </table> 2382 <h3 id="projectcontour.io/v1.TCPProxyInclude">TCPProxyInclude 2383 </h3> 2384 <p> 2385 (<em>Appears on:</em> 2386 <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>) 2387 </p> 2388 <p> 2389 <p>TCPProxyInclude describes a target HTTPProxy document which contains the TCPProxy details.</p> 2390 </p> 2391 <table class="table table-striped table-borderless" style="border:none"> 2392 <thead class="border-bottom"> 2393 <tr> 2394 <th>Field</th> 2395 <th>Description</th> 2396 </tr> 2397 </thead> 2398 <tbody class="border-top"> 2399 <tr> 2400 <td style="white-space:nowrap"> 2401 <code>name</code> 2402 <br> 2403 <em> 2404 string 2405 </em> 2406 </td> 2407 <td> 2408 <p>Name of the child HTTPProxy</p> 2409 </td> 2410 </tr> 2411 <tr> 2412 <td style="white-space:nowrap"> 2413 <code>namespace</code> 2414 <br> 2415 <em> 2416 string 2417 </em> 2418 </td> 2419 <td> 2420 <em>(Optional)</em> 2421 <p>Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.</p> 2422 </td> 2423 </tr> 2424 </tbody> 2425 </table> 2426 <h3 id="projectcontour.io/v1.TLS">TLS 2427 </h3> 2428 <p> 2429 (<em>Appears on:</em> 2430 <a href="#projectcontour.io/v1.VirtualHost">VirtualHost</a>) 2431 </p> 2432 <p> 2433 <p>TLS describes tls properties. The SNI names that will be matched on 2434 are described in the HTTPProxy’s Spec.VirtualHost.Fqdn field.</p> 2435 </p> 2436 <table class="table table-striped table-borderless" style="border:none"> 2437 <thead class="border-bottom"> 2438 <tr> 2439 <th>Field</th> 2440 <th>Description</th> 2441 </tr> 2442 </thead> 2443 <tbody class="border-top"> 2444 <tr> 2445 <td style="white-space:nowrap"> 2446 <code>secretName</code> 2447 <br> 2448 <em> 2449 string 2450 </em> 2451 </td> 2452 <td> 2453 <p>SecretName is the name of a TLS secret in the current namespace. 2454 Either SecretName or Passthrough must be specified, but not both. 2455 If specified, the named secret must contain a matching certificate 2456 for the virtual host’s FQDN.</p> 2457 </td> 2458 </tr> 2459 <tr> 2460 <td style="white-space:nowrap"> 2461 <code>minimumProtocolVersion</code> 2462 <br> 2463 <em> 2464 string 2465 </em> 2466 </td> 2467 <td> 2468 <em>(Optional)</em> 2469 <p>MinimumProtocolVersion is the minimum TLS version this vhost should 2470 negotiate. Valid options are <code>1.2</code> (default) and <code>1.3</code>. Any other value 2471 defaults to TLS 1.2.</p> 2472 </td> 2473 </tr> 2474 <tr> 2475 <td style="white-space:nowrap"> 2476 <code>passthrough</code> 2477 <br> 2478 <em> 2479 bool 2480 </em> 2481 </td> 2482 <td> 2483 <em>(Optional)</em> 2484 <p>Passthrough defines whether the encrypted TLS handshake will be 2485 passed through to the backing cluster. Either Passthrough or 2486 SecretName must be specified, but not both.</p> 2487 </td> 2488 </tr> 2489 <tr> 2490 <td style="white-space:nowrap"> 2491 <code>clientValidation</code> 2492 <br> 2493 <em> 2494 <a href="#projectcontour.io/v1.DownstreamValidation"> 2495 DownstreamValidation 2496 </a> 2497 </em> 2498 </td> 2499 <td> 2500 <em>(Optional)</em> 2501 <p>ClientValidation defines how to verify the client certificate 2502 when an external client establishes a TLS connection to Envoy.</p> 2503 <p>This setting:</p> 2504 <ol> 2505 <li>Enables TLS client certificate validation.</li> 2506 <li>Requires clients to present a TLS certificate (i.e. not optional validation).</li> 2507 <li>Specifies how the client certificate will be validated.</li> 2508 </ol> 2509 </td> 2510 </tr> 2511 <tr> 2512 <td style="white-space:nowrap"> 2513 <code>enableFallbackCertificate</code> 2514 <br> 2515 <em> 2516 bool 2517 </em> 2518 </td> 2519 <td> 2520 <p>EnableFallbackCertificate defines if the vhost should allow a default certificate to 2521 be applied which handles all requests which don’t match the SNI defined in this vhost.</p> 2522 </td> 2523 </tr> 2524 </tbody> 2525 </table> 2526 <h3 id="projectcontour.io/v1.TLSCertificateDelegationSpec">TLSCertificateDelegationSpec 2527 </h3> 2528 <p> 2529 (<em>Appears on:</em> 2530 <a href="#projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation</a>) 2531 </p> 2532 <p> 2533 <p>TLSCertificateDelegationSpec defines the spec of the CRD</p> 2534 </p> 2535 <table class="table table-striped table-borderless" style="border:none"> 2536 <thead class="border-bottom"> 2537 <tr> 2538 <th>Field</th> 2539 <th>Description</th> 2540 </tr> 2541 </thead> 2542 <tbody class="border-top"> 2543 <tr> 2544 <td style="white-space:nowrap"> 2545 <code>delegations</code> 2546 <br> 2547 <em> 2548 <a href="#projectcontour.io/v1.CertificateDelegation"> 2549 []CertificateDelegation 2550 </a> 2551 </em> 2552 </td> 2553 <td> 2554 </td> 2555 </tr> 2556 </tbody> 2557 </table> 2558 <h3 id="projectcontour.io/v1.TLSCertificateDelegationStatus">TLSCertificateDelegationStatus 2559 </h3> 2560 <p> 2561 (<em>Appears on:</em> 2562 <a href="#projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation</a>) 2563 </p> 2564 <p> 2565 <p>TLSCertificateDelegationStatus allows for the status of the delegation 2566 to be presented to the user.</p> 2567 </p> 2568 <table class="table table-striped table-borderless" style="border:none"> 2569 <thead class="border-bottom"> 2570 <tr> 2571 <th>Field</th> 2572 <th>Description</th> 2573 </tr> 2574 </thead> 2575 <tbody class="border-top"> 2576 <tr> 2577 <td style="white-space:nowrap"> 2578 <code>conditions</code> 2579 <br> 2580 <em> 2581 <a href="#projectcontour.io/v1.DetailedCondition"> 2582 []DetailedCondition 2583 </a> 2584 </em> 2585 </td> 2586 <td> 2587 <em>(Optional)</em> 2588 <p>Conditions contains information about the current status of the HTTPProxy, 2589 in an upstream-friendly container.</p> 2590 <p>Contour will update a single condition, <code>Valid</code>, that is in normal-true polarity. 2591 That is, when <code>currentStatus</code> is <code>valid</code>, the <code>Valid</code> condition will be <code>status: true</code>, 2592 and vice versa.</p> 2593 <p>Contour will leave untouched any other Conditions set in this block, 2594 in case some other controller wants to add a Condition.</p> 2595 <p>If you are another controller owner and wish to add a condition, you <em>should</em> 2596 namespace your condition with a label, like <code>controller.domain.com\ConditionName</code>.</p> 2597 </td> 2598 </tr> 2599 </tbody> 2600 </table> 2601 <h3 id="projectcontour.io/v1.TimeoutPolicy">TimeoutPolicy 2602 </h3> 2603 <p> 2604 (<em>Appears on:</em> 2605 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>, 2606 <a href="#projectcontour.io/v1.Route">Route</a>) 2607 </p> 2608 <p> 2609 <p>TimeoutPolicy configures timeouts that are used for handling network requests.</p> 2610 <p>TimeoutPolicy durations are expressed in the Go <a href="https://godoc.org/time#ParseDuration">Duration format</a>. 2611 Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. 2612 The string “infinity” is also a valid input and specifies no timeout. 2613 A value of “0s” will be treated as if the field were not set, i.e. by using Envoy’s default behavior.</p> 2614 <p>Example input values: “300ms”, “5s”, “1m”.</p> 2615 </p> 2616 <table class="table table-striped table-borderless" style="border:none"> 2617 <thead class="border-bottom"> 2618 <tr> 2619 <th>Field</th> 2620 <th>Description</th> 2621 </tr> 2622 </thead> 2623 <tbody class="border-top"> 2624 <tr> 2625 <td style="white-space:nowrap"> 2626 <code>response</code> 2627 <br> 2628 <em> 2629 string 2630 </em> 2631 </td> 2632 <td> 2633 <em>(Optional)</em> 2634 <p>Timeout for receiving a response from the server after processing a request from client. 2635 If not supplied, Envoy’s default value of 15s applies.</p> 2636 </td> 2637 </tr> 2638 <tr> 2639 <td style="white-space:nowrap"> 2640 <code>idle</code> 2641 <br> 2642 <em> 2643 string 2644 </em> 2645 </td> 2646 <td> 2647 <em>(Optional)</em> 2648 <p>Timeout after which, if there are no active requests for this route, the connection between 2649 Envoy and the backend or Envoy and the external client will be closed. 2650 If not specified, there is no per-route idle timeout, though a connection manager-wide 2651 stream_idle_timeout default of 5m still applies.</p> 2652 </td> 2653 </tr> 2654 </tbody> 2655 </table> 2656 <h3 id="projectcontour.io/v1.UpstreamValidation">UpstreamValidation 2657 </h3> 2658 <p> 2659 (<em>Appears on:</em> 2660 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>, 2661 <a href="#projectcontour.io/v1.Service">Service</a>) 2662 </p> 2663 <p> 2664 <p>UpstreamValidation defines how to verify the backend service’s certificate</p> 2665 </p> 2666 <table class="table table-striped table-borderless" style="border:none"> 2667 <thead class="border-bottom"> 2668 <tr> 2669 <th>Field</th> 2670 <th>Description</th> 2671 </tr> 2672 </thead> 2673 <tbody class="border-top"> 2674 <tr> 2675 <td style="white-space:nowrap"> 2676 <code>caSecret</code> 2677 <br> 2678 <em> 2679 string 2680 </em> 2681 </td> 2682 <td> 2683 <p>Name of the Kubernetes secret be used to validate the certificate presented by the backend</p> 2684 </td> 2685 </tr> 2686 <tr> 2687 <td style="white-space:nowrap"> 2688 <code>subjectName</code> 2689 <br> 2690 <em> 2691 string 2692 </em> 2693 </td> 2694 <td> 2695 <p>Key which is expected to be present in the ‘subjectAltName’ of the presented certificate</p> 2696 </td> 2697 </tr> 2698 </tbody> 2699 </table> 2700 <h3 id="projectcontour.io/v1.VirtualHost">VirtualHost 2701 </h3> 2702 <p> 2703 (<em>Appears on:</em> 2704 <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>) 2705 </p> 2706 <p> 2707 <p>VirtualHost appears at most once. If it is present, the object is considered 2708 to be a “root”.</p> 2709 </p> 2710 <table class="table table-striped table-borderless" style="border:none"> 2711 <thead class="border-bottom"> 2712 <tr> 2713 <th>Field</th> 2714 <th>Description</th> 2715 </tr> 2716 </thead> 2717 <tbody class="border-top"> 2718 <tr> 2719 <td style="white-space:nowrap"> 2720 <code>fqdn</code> 2721 <br> 2722 <em> 2723 string 2724 </em> 2725 </td> 2726 <td> 2727 <p>The fully qualified domain name of the root of the ingress tree 2728 all leaves of the DAG rooted at this object relate to the fqdn.</p> 2729 </td> 2730 </tr> 2731 <tr> 2732 <td style="white-space:nowrap"> 2733 <code>tls</code> 2734 <br> 2735 <em> 2736 <a href="#projectcontour.io/v1.TLS"> 2737 TLS 2738 </a> 2739 </em> 2740 </td> 2741 <td> 2742 <em>(Optional)</em> 2743 <p>If present the fields describes TLS properties of the virtual 2744 host. The SNI names that will be matched on are described in fqdn, 2745 the tls.secretName secret must contain a certificate that itself 2746 contains a name that matches the FQDN.</p> 2747 </td> 2748 </tr> 2749 <tr> 2750 <td style="white-space:nowrap"> 2751 <code>authorization</code> 2752 <br> 2753 <em> 2754 <a href="#projectcontour.io/v1.AuthorizationServer"> 2755 AuthorizationServer 2756 </a> 2757 </em> 2758 </td> 2759 <td> 2760 <em>(Optional)</em> 2761 <p>This field configures an extension service to perform 2762 authorization for this virtual host. Authorization can 2763 only be configured on virtual hosts that have TLS enabled. 2764 If the TLS configuration requires client certificate 2765 /validation, the client certificate is always included in the 2766 authentication check request.</p> 2767 </td> 2768 </tr> 2769 <tr> 2770 <td style="white-space:nowrap"> 2771 <code>corsPolicy</code> 2772 <br> 2773 <em> 2774 <a href="#projectcontour.io/v1.CORSPolicy"> 2775 CORSPolicy 2776 </a> 2777 </em> 2778 </td> 2779 <td> 2780 <em>(Optional)</em> 2781 <p>Specifies the cross-origin policy to apply to the VirtualHost.</p> 2782 </td> 2783 </tr> 2784 <tr> 2785 <td style="white-space:nowrap"> 2786 <code>rateLimitPolicy</code> 2787 <br> 2788 <em> 2789 <a href="#projectcontour.io/v1.RateLimitPolicy"> 2790 RateLimitPolicy 2791 </a> 2792 </em> 2793 </td> 2794 <td> 2795 <em>(Optional)</em> 2796 <p>The policy for rate limiting on the virtual host.</p> 2797 </td> 2798 </tr> 2799 </tbody> 2800 </table> 2801 <hr/> 2802 <h2 id="projectcontour.io/v1alpha1">projectcontour.io/v1alpha1</h2> 2803 <p> 2804 <p>Package v1alpha1 contains API Schema definitions for the projectcontour.io v1alpha1 API group</p> 2805 </p> 2806 Resource Types: 2807 <ul><li> 2808 <a href="#projectcontour.io/v1alpha1.ExtensionService">ExtensionService</a> 2809 </li></ul> 2810 <h3 id="projectcontour.io/v1alpha1.ExtensionService">ExtensionService 2811 </h3> 2812 <p> 2813 <p>ExtensionService is the schema for the Contour extension services API. 2814 An ExtensionService resource binds a network service to the Contour 2815 API so that Contour API features can be implemented by collaborating 2816 components.</p> 2817 </p> 2818 <table class="table table-striped table-borderless" style="border:none"> 2819 <thead class="border-bottom"> 2820 <tr> 2821 <th>Field</th> 2822 <th>Description</th> 2823 </tr> 2824 </thead> 2825 <tbody class="border-top"> 2826 <tr> 2827 <td> 2828 <code>apiVersion</code> 2829 <br> 2830 string</td> 2831 <td> 2832 <code> 2833 projectcontour.io/v1alpha1 2834 </code> 2835 </td> 2836 </tr> 2837 <tr> 2838 <td> 2839 <code>kind</code> 2840 <br> 2841 string 2842 </td> 2843 <td><code>ExtensionService</code></td> 2844 </tr> 2845 <tr> 2846 <td style="white-space:nowrap"> 2847 <code>metadata</code> 2848 <br> 2849 <em> 2850 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta"> 2851 Kubernetes meta/v1.ObjectMeta 2852 </a> 2853 </em> 2854 </td> 2855 <td> 2856 Refer to the Kubernetes API documentation for the fields of the 2857 <code>metadata</code> field. 2858 </td> 2859 </tr> 2860 <tr> 2861 <td style="white-space:nowrap"> 2862 <code>spec</code> 2863 <br> 2864 <em> 2865 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec"> 2866 ExtensionServiceSpec 2867 </a> 2868 </em> 2869 </td> 2870 <td> 2871 <br> 2872 <br> 2873 <table style="border:none"> 2874 <tr> 2875 <td style="white-space:nowrap"> 2876 <code>services</code> 2877 <br> 2878 <em> 2879 <a href="#projectcontour.io/v1alpha1.ExtensionServiceTarget"> 2880 []ExtensionServiceTarget 2881 </a> 2882 </em> 2883 </td> 2884 <td> 2885 <p>Services specifies the set of Kubernetes Service resources that 2886 receive GRPC extension API requests. 2887 If no weights are specified for any of the entries in 2888 this array, traffic will be spread evenly across all the 2889 services. 2890 Otherwise, traffic is balanced proportionally to the 2891 Weight field in each entry.</p> 2892 </td> 2893 </tr> 2894 <tr> 2895 <td style="white-space:nowrap"> 2896 <code>validation</code> 2897 <br> 2898 <em> 2899 <a href="#projectcontour.io/v1.UpstreamValidation"> 2900 UpstreamValidation 2901 </a> 2902 </em> 2903 </td> 2904 <td> 2905 <em>(Optional)</em> 2906 <p>UpstreamValidation defines how to verify the backend service’s certificate</p> 2907 </td> 2908 </tr> 2909 <tr> 2910 <td style="white-space:nowrap"> 2911 <code>protocol</code> 2912 <br> 2913 <em> 2914 string 2915 </em> 2916 </td> 2917 <td> 2918 <em>(Optional)</em> 2919 <p>Protocol may be used to specify (or override) the protocol used to reach this Service. 2920 Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.</p> 2921 </td> 2922 </tr> 2923 <tr> 2924 <td style="white-space:nowrap"> 2925 <code>loadBalancerPolicy</code> 2926 <br> 2927 <em> 2928 <a href="#projectcontour.io/v1.LoadBalancerPolicy"> 2929 LoadBalancerPolicy 2930 </a> 2931 </em> 2932 </td> 2933 <td> 2934 <em>(Optional)</em> 2935 <p>The policy for load balancing GRPC service requests. Note that the 2936 <code>Cookie</code> and <code>RequestHash</code> load balancing strategies cannot be used 2937 here.</p> 2938 </td> 2939 </tr> 2940 <tr> 2941 <td style="white-space:nowrap"> 2942 <code>timeoutPolicy</code> 2943 <br> 2944 <em> 2945 <a href="#projectcontour.io/v1.TimeoutPolicy"> 2946 TimeoutPolicy 2947 </a> 2948 </em> 2949 </td> 2950 <td> 2951 <em>(Optional)</em> 2952 <p>The timeout policy for requests to the services.</p> 2953 </td> 2954 </tr> 2955 <tr> 2956 <td style="white-space:nowrap"> 2957 <code>protocolVersion</code> 2958 <br> 2959 <em> 2960 <a href="#projectcontour.io/v1alpha1.ExtensionProtocolVersion"> 2961 ExtensionProtocolVersion 2962 </a> 2963 </em> 2964 </td> 2965 <td> 2966 <em>(Optional)</em> 2967 <p>This field sets the version of the GRPC protocol that Envoy uses to 2968 send requests to the extension service. Since Contour always uses the 2969 v3 Envoy API, this is currently fixed at “v3”. However, other 2970 protocol options will be available in future.</p> 2971 </td> 2972 </tr> 2973 </table> 2974 </td> 2975 </tr> 2976 <tr> 2977 <td style="white-space:nowrap"> 2978 <code>status</code> 2979 <br> 2980 <em> 2981 <a href="#projectcontour.io/v1alpha1.ExtensionServiceStatus"> 2982 ExtensionServiceStatus 2983 </a> 2984 </em> 2985 </td> 2986 <td> 2987 </td> 2988 </tr> 2989 </tbody> 2990 </table> 2991 <h3 id="projectcontour.io/v1alpha1.ExtensionProtocolVersion">ExtensionProtocolVersion 2992 (<code>string</code> alias)</h3> 2993 <p> 2994 (<em>Appears on:</em> 2995 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>) 2996 </p> 2997 <p> 2998 <p>ExtensionProtocolVersion is the version of the GRPC protocol used 2999 to access extension services. The only version currently supported 3000 is “v3”.</p> 3001 </p> 3002 <h3 id="projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec 3003 </h3> 3004 <p> 3005 (<em>Appears on:</em> 3006 <a href="#projectcontour.io/v1alpha1.ExtensionService">ExtensionService</a>) 3007 </p> 3008 <p> 3009 <p>ExtensionServiceSpec defines the desired state of an ExtensionService resource.</p> 3010 </p> 3011 <table class="table table-striped table-borderless" style="border:none"> 3012 <thead class="border-bottom"> 3013 <tr> 3014 <th>Field</th> 3015 <th>Description</th> 3016 </tr> 3017 </thead> 3018 <tbody class="border-top"> 3019 <tr> 3020 <td style="white-space:nowrap"> 3021 <code>services</code> 3022 <br> 3023 <em> 3024 <a href="#projectcontour.io/v1alpha1.ExtensionServiceTarget"> 3025 []ExtensionServiceTarget 3026 </a> 3027 </em> 3028 </td> 3029 <td> 3030 <p>Services specifies the set of Kubernetes Service resources that 3031 receive GRPC extension API requests. 3032 If no weights are specified for any of the entries in 3033 this array, traffic will be spread evenly across all the 3034 services. 3035 Otherwise, traffic is balanced proportionally to the 3036 Weight field in each entry.</p> 3037 </td> 3038 </tr> 3039 <tr> 3040 <td style="white-space:nowrap"> 3041 <code>validation</code> 3042 <br> 3043 <em> 3044 <a href="#projectcontour.io/v1.UpstreamValidation"> 3045 UpstreamValidation 3046 </a> 3047 </em> 3048 </td> 3049 <td> 3050 <em>(Optional)</em> 3051 <p>UpstreamValidation defines how to verify the backend service’s certificate</p> 3052 </td> 3053 </tr> 3054 <tr> 3055 <td style="white-space:nowrap"> 3056 <code>protocol</code> 3057 <br> 3058 <em> 3059 string 3060 </em> 3061 </td> 3062 <td> 3063 <em>(Optional)</em> 3064 <p>Protocol may be used to specify (or override) the protocol used to reach this Service. 3065 Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.</p> 3066 </td> 3067 </tr> 3068 <tr> 3069 <td style="white-space:nowrap"> 3070 <code>loadBalancerPolicy</code> 3071 <br> 3072 <em> 3073 <a href="#projectcontour.io/v1.LoadBalancerPolicy"> 3074 LoadBalancerPolicy 3075 </a> 3076 </em> 3077 </td> 3078 <td> 3079 <em>(Optional)</em> 3080 <p>The policy for load balancing GRPC service requests. Note that the 3081 <code>Cookie</code> and <code>RequestHash</code> load balancing strategies cannot be used 3082 here.</p> 3083 </td> 3084 </tr> 3085 <tr> 3086 <td style="white-space:nowrap"> 3087 <code>timeoutPolicy</code> 3088 <br> 3089 <em> 3090 <a href="#projectcontour.io/v1.TimeoutPolicy"> 3091 TimeoutPolicy 3092 </a> 3093 </em> 3094 </td> 3095 <td> 3096 <em>(Optional)</em> 3097 <p>The timeout policy for requests to the services.</p> 3098 </td> 3099 </tr> 3100 <tr> 3101 <td style="white-space:nowrap"> 3102 <code>protocolVersion</code> 3103 <br> 3104 <em> 3105 <a href="#projectcontour.io/v1alpha1.ExtensionProtocolVersion"> 3106 ExtensionProtocolVersion 3107 </a> 3108 </em> 3109 </td> 3110 <td> 3111 <em>(Optional)</em> 3112 <p>This field sets the version of the GRPC protocol that Envoy uses to 3113 send requests to the extension service. Since Contour always uses the 3114 v3 Envoy API, this is currently fixed at “v3”. However, other 3115 protocol options will be available in future.</p> 3116 </td> 3117 </tr> 3118 </tbody> 3119 </table> 3120 <h3 id="projectcontour.io/v1alpha1.ExtensionServiceStatus">ExtensionServiceStatus 3121 </h3> 3122 <p> 3123 (<em>Appears on:</em> 3124 <a href="#projectcontour.io/v1alpha1.ExtensionService">ExtensionService</a>) 3125 </p> 3126 <p> 3127 <p>ExtensionServiceStatus defines the observed state of an 3128 ExtensionService resource.</p> 3129 </p> 3130 <table class="table table-striped table-borderless" style="border:none"> 3131 <thead class="border-bottom"> 3132 <tr> 3133 <th>Field</th> 3134 <th>Description</th> 3135 </tr> 3136 </thead> 3137 <tbody class="border-top"> 3138 <tr> 3139 <td style="white-space:nowrap"> 3140 <code>conditions</code> 3141 <br> 3142 <em> 3143 <a href="#projectcontour.io/v1.DetailedCondition"> 3144 []DetailedCondition 3145 </a> 3146 </em> 3147 </td> 3148 <td> 3149 <em>(Optional)</em> 3150 <p>Conditions contains the current status of the ExtensionService resource.</p> 3151 <p>Contour will update a single condition, <code>Valid</code>, that is in normal-true polarity.</p> 3152 <p>Contour will not modify any other Conditions set in this block, 3153 in case some other controller wants to add a Condition.</p> 3154 </td> 3155 </tr> 3156 </tbody> 3157 </table> 3158 <h3 id="projectcontour.io/v1alpha1.ExtensionServiceTarget">ExtensionServiceTarget 3159 </h3> 3160 <p> 3161 (<em>Appears on:</em> 3162 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>) 3163 </p> 3164 <p> 3165 <p>ExtensionServiceTarget defines an Kubernetes Service to target with 3166 extension service traffic.</p> 3167 </p> 3168 <table class="table table-striped table-borderless" style="border:none"> 3169 <thead class="border-bottom"> 3170 <tr> 3171 <th>Field</th> 3172 <th>Description</th> 3173 </tr> 3174 </thead> 3175 <tbody class="border-top"> 3176 <tr> 3177 <td style="white-space:nowrap"> 3178 <code>name</code> 3179 <br> 3180 <em> 3181 string 3182 </em> 3183 </td> 3184 <td> 3185 <p>Name is the name of Kubernetes service that will accept service 3186 traffic.</p> 3187 </td> 3188 </tr> 3189 <tr> 3190 <td style="white-space:nowrap"> 3191 <code>port</code> 3192 <br> 3193 <em> 3194 int 3195 </em> 3196 </td> 3197 <td> 3198 <p>Port (defined as Integer) to proxy traffic to since a service can have multiple defined.</p> 3199 </td> 3200 </tr> 3201 <tr> 3202 <td style="white-space:nowrap"> 3203 <code>weight</code> 3204 <br> 3205 <em> 3206 uint32 3207 </em> 3208 </td> 3209 <td> 3210 <em>(Optional)</em> 3211 <p>Weight defines proportion of traffic to balance to the Kubernetes Service.</p> 3212 </td> 3213 </tr> 3214 </tbody> 3215 </table> 3216 <hr/> 3217 <p><em> 3218 Generated with <code>gen-crd-api-reference-docs</code>. 3219 </em></p>