github.com/projectcontour/contour@v1.28.2/site/content/docs/v1.13.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>Package v1 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/v1.HTTPProxyStatus">HTTPProxyStatus</a>, 566 <a href="#projectcontour.io/v1.TLSCertificateDelegationStatus">TLSCertificateDelegationStatus</a>, 567 <a href="#projectcontour.io/v1alpha1.ExtensionServiceStatus">ExtensionServiceStatus</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.GenericKeyDescriptor">GenericKeyDescriptor 746 </h3> 747 <p> 748 (<em>Appears on:</em> 749 <a href="#projectcontour.io/v1.RateLimitDescriptorEntry">RateLimitDescriptorEntry</a>) 750 </p> 751 <p> 752 <p>GenericKeyDescriptor defines a descriptor entry with a static key and 753 value.</p> 754 </p> 755 <table class="table table-striped table-borderless" style="border:none"> 756 <thead class="border-bottom"> 757 <tr> 758 <th>Field</th> 759 <th>Description</th> 760 </tr> 761 </thead> 762 <tbody class="border-top"> 763 <tr> 764 <td style="white-space:nowrap"> 765 <code>key</code> 766 <br> 767 <em> 768 string 769 </em> 770 </td> 771 <td> 772 <em>(Optional)</em> 773 <p>Key defines the key of the descriptor entry. If not set, the 774 key is set to “generic_key”.</p> 775 </td> 776 </tr> 777 <tr> 778 <td style="white-space:nowrap"> 779 <code>value</code> 780 <br> 781 <em> 782 string 783 </em> 784 </td> 785 <td> 786 <p>Value defines the value of the descriptor entry.</p> 787 </td> 788 </tr> 789 </tbody> 790 </table> 791 <h3 id="projectcontour.io/v1.GlobalRateLimitPolicy">GlobalRateLimitPolicy 792 </h3> 793 <p> 794 (<em>Appears on:</em> 795 <a href="#projectcontour.io/v1.RateLimitPolicy">RateLimitPolicy</a>) 796 </p> 797 <p> 798 <p>GlobalRateLimitPolicy defines global rate limiting parameters.</p> 799 </p> 800 <table class="table table-striped table-borderless" style="border:none"> 801 <thead class="border-bottom"> 802 <tr> 803 <th>Field</th> 804 <th>Description</th> 805 </tr> 806 </thead> 807 <tbody class="border-top"> 808 <tr> 809 <td style="white-space:nowrap"> 810 <code>descriptors</code> 811 <br> 812 <em> 813 <a href="#projectcontour.io/v1.RateLimitDescriptor"> 814 []RateLimitDescriptor 815 </a> 816 </em> 817 </td> 818 <td> 819 <p>Descriptors defines the list of descriptors that will 820 be generated and sent to the rate limit service. Each 821 descriptor contains 1+ key-value pair entries.</p> 822 </td> 823 </tr> 824 </tbody> 825 </table> 826 <h3 id="projectcontour.io/v1.HTTPHealthCheckPolicy">HTTPHealthCheckPolicy 827 </h3> 828 <p> 829 (<em>Appears on:</em> 830 <a href="#projectcontour.io/v1.Route">Route</a>) 831 </p> 832 <p> 833 <p>HTTPHealthCheckPolicy defines health checks on the upstream service.</p> 834 </p> 835 <table class="table table-striped table-borderless" style="border:none"> 836 <thead class="border-bottom"> 837 <tr> 838 <th>Field</th> 839 <th>Description</th> 840 </tr> 841 </thead> 842 <tbody class="border-top"> 843 <tr> 844 <td style="white-space:nowrap"> 845 <code>path</code> 846 <br> 847 <em> 848 string 849 </em> 850 </td> 851 <td> 852 <p>HTTP endpoint used to perform health checks on upstream service</p> 853 </td> 854 </tr> 855 <tr> 856 <td style="white-space:nowrap"> 857 <code>host</code> 858 <br> 859 <em> 860 string 861 </em> 862 </td> 863 <td> 864 <p>The value of the host header in the HTTP health check request. 865 If left empty (default value), the name “contour-envoy-healthcheck” 866 will be used.</p> 867 </td> 868 </tr> 869 <tr> 870 <td style="white-space:nowrap"> 871 <code>intervalSeconds</code> 872 <br> 873 <em> 874 int64 875 </em> 876 </td> 877 <td> 878 <em>(Optional)</em> 879 <p>The interval (seconds) between health checks</p> 880 </td> 881 </tr> 882 <tr> 883 <td style="white-space:nowrap"> 884 <code>timeoutSeconds</code> 885 <br> 886 <em> 887 int64 888 </em> 889 </td> 890 <td> 891 <em>(Optional)</em> 892 <p>The time to wait (seconds) for a health check response</p> 893 </td> 894 </tr> 895 <tr> 896 <td style="white-space:nowrap"> 897 <code>unhealthyThresholdCount</code> 898 <br> 899 <em> 900 int64 901 </em> 902 </td> 903 <td> 904 <em>(Optional)</em> 905 <p>The number of unhealthy health checks required before a host is marked unhealthy</p> 906 </td> 907 </tr> 908 <tr> 909 <td style="white-space:nowrap"> 910 <code>healthyThresholdCount</code> 911 <br> 912 <em> 913 int64 914 </em> 915 </td> 916 <td> 917 <em>(Optional)</em> 918 <p>The number of healthy health checks required before a host is marked healthy</p> 919 </td> 920 </tr> 921 </tbody> 922 </table> 923 <h3 id="projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec 924 </h3> 925 <p> 926 (<em>Appears on:</em> 927 <a href="#projectcontour.io/v1.HTTPProxy">HTTPProxy</a>) 928 </p> 929 <p> 930 <p>HTTPProxySpec defines the spec of the CRD.</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>virtualhost</code> 943 <br> 944 <em> 945 <a href="#projectcontour.io/v1.VirtualHost"> 946 VirtualHost 947 </a> 948 </em> 949 </td> 950 <td> 951 <em>(Optional)</em> 952 <p>Virtualhost appears at most once. If it is present, the object is considered 953 to be a “root” HTTPProxy.</p> 954 </td> 955 </tr> 956 <tr> 957 <td style="white-space:nowrap"> 958 <code>routes</code> 959 <br> 960 <em> 961 <a href="#projectcontour.io/v1.Route"> 962 []Route 963 </a> 964 </em> 965 </td> 966 <td> 967 <em>(Optional)</em> 968 <p>Routes are the ingress routes. If TCPProxy is present, Routes is ignored.</p> 969 </td> 970 </tr> 971 <tr> 972 <td style="white-space:nowrap"> 973 <code>tcpproxy</code> 974 <br> 975 <em> 976 <a href="#projectcontour.io/v1.TCPProxy"> 977 TCPProxy 978 </a> 979 </em> 980 </td> 981 <td> 982 <em>(Optional)</em> 983 <p>TCPProxy holds TCP proxy information.</p> 984 </td> 985 </tr> 986 <tr> 987 <td style="white-space:nowrap"> 988 <code>includes</code> 989 <br> 990 <em> 991 <a href="#projectcontour.io/v1.Include"> 992 []Include 993 </a> 994 </em> 995 </td> 996 <td> 997 <em>(Optional)</em> 998 <p>Includes allow for specific routing configuration to be included from another HTTPProxy, 999 possibly in another namespace.</p> 1000 </td> 1001 </tr> 1002 </tbody> 1003 </table> 1004 <h3 id="projectcontour.io/v1.HTTPProxyStatus">HTTPProxyStatus 1005 </h3> 1006 <p> 1007 (<em>Appears on:</em> 1008 <a href="#projectcontour.io/v1.HTTPProxy">HTTPProxy</a>) 1009 </p> 1010 <p> 1011 <p>HTTPProxyStatus reports the current state of the HTTPProxy.</p> 1012 </p> 1013 <table class="table table-striped table-borderless" style="border:none"> 1014 <thead class="border-bottom"> 1015 <tr> 1016 <th>Field</th> 1017 <th>Description</th> 1018 </tr> 1019 </thead> 1020 <tbody class="border-top"> 1021 <tr> 1022 <td style="white-space:nowrap"> 1023 <code>currentStatus</code> 1024 <br> 1025 <em> 1026 string 1027 </em> 1028 </td> 1029 <td> 1030 <em>(Optional)</em> 1031 </td> 1032 </tr> 1033 <tr> 1034 <td style="white-space:nowrap"> 1035 <code>description</code> 1036 <br> 1037 <em> 1038 string 1039 </em> 1040 </td> 1041 <td> 1042 <em>(Optional)</em> 1043 </td> 1044 </tr> 1045 <tr> 1046 <td style="white-space:nowrap"> 1047 <code>loadBalancer</code> 1048 <br> 1049 <em> 1050 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#loadbalancerstatus-v1-core"> 1051 Kubernetes core/v1.LoadBalancerStatus 1052 </a> 1053 </em> 1054 </td> 1055 <td> 1056 <em>(Optional)</em> 1057 <p>LoadBalancer contains the current status of the load balancer.</p> 1058 </td> 1059 </tr> 1060 <tr> 1061 <td style="white-space:nowrap"> 1062 <code>conditions</code> 1063 <br> 1064 <em> 1065 <a href="#projectcontour.io/v1.DetailedCondition"> 1066 []DetailedCondition 1067 </a> 1068 </em> 1069 </td> 1070 <td> 1071 <em>(Optional)</em> 1072 <p>Conditions contains information about the current status of the HTTPProxy, 1073 in an upstream-friendly container.</p> 1074 <p>Contour will update a single condition, <code>Valid</code>, that is in normal-true polarity. 1075 That is, when <code>currentStatus</code> is <code>valid</code>, the <code>Valid</code> condition will be <code>status: true</code>, 1076 and vice versa.</p> 1077 <p>Contour will leave untouched any other Conditions set in this block, 1078 in case some other controller wants to add a Condition.</p> 1079 <p>If you are another controller owner and wish to add a condition, you <em>should</em> 1080 namespace your condition with a label, like <code>controller.domain.com/ConditionName</code>.</p> 1081 </td> 1082 </tr> 1083 </tbody> 1084 </table> 1085 <h3 id="projectcontour.io/v1.HeaderHashOptions">HeaderHashOptions 1086 </h3> 1087 <p> 1088 (<em>Appears on:</em> 1089 <a href="#projectcontour.io/v1.RequestHashPolicy">RequestHashPolicy</a>) 1090 </p> 1091 <p> 1092 <p>HeaderHashOptions contains options to configure a HTTP request header hash 1093 policy, used in request attribute hash based load balancing.</p> 1094 </p> 1095 <table class="table table-striped table-borderless" style="border:none"> 1096 <thead class="border-bottom"> 1097 <tr> 1098 <th>Field</th> 1099 <th>Description</th> 1100 </tr> 1101 </thead> 1102 <tbody class="border-top"> 1103 <tr> 1104 <td style="white-space:nowrap"> 1105 <code>headerName</code> 1106 <br> 1107 <em> 1108 string 1109 </em> 1110 </td> 1111 <td> 1112 <p>HeaderName is the name of the HTTP request header that will be used to 1113 calculate the hash key. If the header specified is not present on a 1114 request, no hash will be produced.</p> 1115 </td> 1116 </tr> 1117 </tbody> 1118 </table> 1119 <h3 id="projectcontour.io/v1.HeaderMatchCondition">HeaderMatchCondition 1120 </h3> 1121 <p> 1122 (<em>Appears on:</em> 1123 <a href="#projectcontour.io/v1.MatchCondition">MatchCondition</a>) 1124 </p> 1125 <p> 1126 <p>HeaderMatchCondition specifies how to conditionally match against HTTP 1127 headers. The Name field is required, but only one of the remaining 1128 fields should be be provided.</p> 1129 </p> 1130 <table class="table table-striped table-borderless" style="border:none"> 1131 <thead class="border-bottom"> 1132 <tr> 1133 <th>Field</th> 1134 <th>Description</th> 1135 </tr> 1136 </thead> 1137 <tbody class="border-top"> 1138 <tr> 1139 <td style="white-space:nowrap"> 1140 <code>name</code> 1141 <br> 1142 <em> 1143 string 1144 </em> 1145 </td> 1146 <td> 1147 <p>Name is the name of the header to match against. Name is required. 1148 Header names are case insensitive.</p> 1149 </td> 1150 </tr> 1151 <tr> 1152 <td style="white-space:nowrap"> 1153 <code>present</code> 1154 <br> 1155 <em> 1156 bool 1157 </em> 1158 </td> 1159 <td> 1160 <em>(Optional)</em> 1161 <p>Present specifies that condition is true when the named header 1162 is present, regardless of its value. Note that setting Present 1163 to false does not make the condition true if the named header 1164 is absent.</p> 1165 </td> 1166 </tr> 1167 <tr> 1168 <td style="white-space:nowrap"> 1169 <code>contains</code> 1170 <br> 1171 <em> 1172 string 1173 </em> 1174 </td> 1175 <td> 1176 <em>(Optional)</em> 1177 <p>Contains specifies a substring that must be present in 1178 the header value.</p> 1179 </td> 1180 </tr> 1181 <tr> 1182 <td style="white-space:nowrap"> 1183 <code>notcontains</code> 1184 <br> 1185 <em> 1186 string 1187 </em> 1188 </td> 1189 <td> 1190 <em>(Optional)</em> 1191 <p>NotContains specifies a substring that must not be present 1192 in the header value.</p> 1193 </td> 1194 </tr> 1195 <tr> 1196 <td style="white-space:nowrap"> 1197 <code>exact</code> 1198 <br> 1199 <em> 1200 string 1201 </em> 1202 </td> 1203 <td> 1204 <em>(Optional)</em> 1205 <p>Exact specifies a string that the header value must be equal to.</p> 1206 </td> 1207 </tr> 1208 <tr> 1209 <td style="white-space:nowrap"> 1210 <code>notexact</code> 1211 <br> 1212 <em> 1213 string 1214 </em> 1215 </td> 1216 <td> 1217 <em>(Optional)</em> 1218 <p>NoExact specifies a string that the header value must not be 1219 equal to. The condition is true if the header has any other value.</p> 1220 </td> 1221 </tr> 1222 </tbody> 1223 </table> 1224 <h3 id="projectcontour.io/v1.HeaderValue">HeaderValue 1225 </h3> 1226 <p> 1227 (<em>Appears on:</em> 1228 <a href="#projectcontour.io/v1.HeadersPolicy">HeadersPolicy</a>, 1229 <a href="#projectcontour.io/v1.LocalRateLimitPolicy">LocalRateLimitPolicy</a>) 1230 </p> 1231 <p> 1232 <p>HeaderValue represents a header name/value pair</p> 1233 </p> 1234 <table class="table table-striped table-borderless" style="border:none"> 1235 <thead class="border-bottom"> 1236 <tr> 1237 <th>Field</th> 1238 <th>Description</th> 1239 </tr> 1240 </thead> 1241 <tbody class="border-top"> 1242 <tr> 1243 <td style="white-space:nowrap"> 1244 <code>name</code> 1245 <br> 1246 <em> 1247 string 1248 </em> 1249 </td> 1250 <td> 1251 <p>Name represents a key of a header</p> 1252 </td> 1253 </tr> 1254 <tr> 1255 <td style="white-space:nowrap"> 1256 <code>value</code> 1257 <br> 1258 <em> 1259 string 1260 </em> 1261 </td> 1262 <td> 1263 <p>Value represents the value of a header specified by a key</p> 1264 </td> 1265 </tr> 1266 </tbody> 1267 </table> 1268 <h3 id="projectcontour.io/v1.HeadersPolicy">HeadersPolicy 1269 </h3> 1270 <p> 1271 (<em>Appears on:</em> 1272 <a href="#projectcontour.io/v1.Route">Route</a>, 1273 <a href="#projectcontour.io/v1.Service">Service</a>) 1274 </p> 1275 <p> 1276 <p>HeadersPolicy defines how headers are managed during forwarding. 1277 The <code>Host</code> header is treated specially and if set in a HTTP response 1278 will be used as the SNI server name when forwarding over TLS. It is an 1279 error to attempt to set the <code>Host</code> header in a HTTP response.</p> 1280 </p> 1281 <table class="table table-striped table-borderless" style="border:none"> 1282 <thead class="border-bottom"> 1283 <tr> 1284 <th>Field</th> 1285 <th>Description</th> 1286 </tr> 1287 </thead> 1288 <tbody class="border-top"> 1289 <tr> 1290 <td style="white-space:nowrap"> 1291 <code>set</code> 1292 <br> 1293 <em> 1294 <a href="#projectcontour.io/v1.HeaderValue"> 1295 []HeaderValue 1296 </a> 1297 </em> 1298 </td> 1299 <td> 1300 <em>(Optional)</em> 1301 <p>Set specifies a list of HTTP header values that will be set in the HTTP header. 1302 If the header does not exist it will be added, otherwise it will be overwritten with the new value.</p> 1303 </td> 1304 </tr> 1305 <tr> 1306 <td style="white-space:nowrap"> 1307 <code>remove</code> 1308 <br> 1309 <em> 1310 []string 1311 </em> 1312 </td> 1313 <td> 1314 <em>(Optional)</em> 1315 <p>Remove specifies a list of HTTP header names to remove.</p> 1316 </td> 1317 </tr> 1318 </tbody> 1319 </table> 1320 <h3 id="projectcontour.io/v1.Include">Include 1321 </h3> 1322 <p> 1323 (<em>Appears on:</em> 1324 <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>) 1325 </p> 1326 <p> 1327 <p>Include describes a set of policies that can be applied to an HTTPProxy in a namespace.</p> 1328 </p> 1329 <table class="table table-striped table-borderless" style="border:none"> 1330 <thead class="border-bottom"> 1331 <tr> 1332 <th>Field</th> 1333 <th>Description</th> 1334 </tr> 1335 </thead> 1336 <tbody class="border-top"> 1337 <tr> 1338 <td style="white-space:nowrap"> 1339 <code>name</code> 1340 <br> 1341 <em> 1342 string 1343 </em> 1344 </td> 1345 <td> 1346 <p>Name of the HTTPProxy</p> 1347 </td> 1348 </tr> 1349 <tr> 1350 <td style="white-space:nowrap"> 1351 <code>namespace</code> 1352 <br> 1353 <em> 1354 string 1355 </em> 1356 </td> 1357 <td> 1358 <em>(Optional)</em> 1359 <p>Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.</p> 1360 </td> 1361 </tr> 1362 <tr> 1363 <td style="white-space:nowrap"> 1364 <code>conditions</code> 1365 <br> 1366 <em> 1367 <a href="#projectcontour.io/v1.MatchCondition"> 1368 []MatchCondition 1369 </a> 1370 </em> 1371 </td> 1372 <td> 1373 <em>(Optional)</em> 1374 <p>Conditions are a set of rules that are applied to included HTTPProxies. 1375 In effect, they are added onto the Conditions of included HTTPProxy Route 1376 structs. 1377 When applied, they are merged using AND, with one exception: 1378 There can be only one Prefix MatchCondition per Conditions slice. 1379 More than one Prefix, or contradictory Conditions, will make the 1380 include invalid.</p> 1381 </td> 1382 </tr> 1383 </tbody> 1384 </table> 1385 <h3 id="projectcontour.io/v1.LoadBalancerPolicy">LoadBalancerPolicy 1386 </h3> 1387 <p> 1388 (<em>Appears on:</em> 1389 <a href="#projectcontour.io/v1.Route">Route</a>, 1390 <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>, 1391 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>) 1392 </p> 1393 <p> 1394 <p>LoadBalancerPolicy defines the load balancing policy.</p> 1395 </p> 1396 <table class="table table-striped table-borderless" style="border:none"> 1397 <thead class="border-bottom"> 1398 <tr> 1399 <th>Field</th> 1400 <th>Description</th> 1401 </tr> 1402 </thead> 1403 <tbody class="border-top"> 1404 <tr> 1405 <td style="white-space:nowrap"> 1406 <code>strategy</code> 1407 <br> 1408 <em> 1409 string 1410 </em> 1411 </td> 1412 <td> 1413 <p>Strategy specifies the policy used to balance requests 1414 across the pool of backend pods. Valid policy names are 1415 <code>Random</code>, <code>RoundRobin</code>, <code>WeightedLeastRequest</code>, <code>Cookie</code>, 1416 and <code>RequestHash</code>. If an unknown strategy name is specified 1417 or no policy is supplied, the default <code>RoundRobin</code> policy 1418 is used.</p> 1419 </td> 1420 </tr> 1421 <tr> 1422 <td style="white-space:nowrap"> 1423 <code>requestHashPolicies</code> 1424 <br> 1425 <em> 1426 <a href="#projectcontour.io/v1.RequestHashPolicy"> 1427 []RequestHashPolicy 1428 </a> 1429 </em> 1430 </td> 1431 <td> 1432 <p>RequestHashPolicies contains a list of hash policies to apply when the 1433 <code>RequestHash</code> load balancing strategy is chosen. If an element of the 1434 supplied list of hash policies is invalid, it will be ignored. If the 1435 list of hash policies is empty after validation, the load balancing 1436 strategy will fall back to the default <code>RoundRobin</code>.</p> 1437 </td> 1438 </tr> 1439 </tbody> 1440 </table> 1441 <h3 id="projectcontour.io/v1.LocalRateLimitPolicy">LocalRateLimitPolicy 1442 </h3> 1443 <p> 1444 (<em>Appears on:</em> 1445 <a href="#projectcontour.io/v1.RateLimitPolicy">RateLimitPolicy</a>) 1446 </p> 1447 <p> 1448 <p>LocalRateLimitPolicy defines local rate limiting parameters.</p> 1449 </p> 1450 <table class="table table-striped table-borderless" style="border:none"> 1451 <thead class="border-bottom"> 1452 <tr> 1453 <th>Field</th> 1454 <th>Description</th> 1455 </tr> 1456 </thead> 1457 <tbody class="border-top"> 1458 <tr> 1459 <td style="white-space:nowrap"> 1460 <code>requests</code> 1461 <br> 1462 <em> 1463 uint32 1464 </em> 1465 </td> 1466 <td> 1467 <p>Requests defines how many requests per unit of time should 1468 be allowed before rate limiting occurs.</p> 1469 </td> 1470 </tr> 1471 <tr> 1472 <td style="white-space:nowrap"> 1473 <code>unit</code> 1474 <br> 1475 <em> 1476 string 1477 </em> 1478 </td> 1479 <td> 1480 <p>Unit defines the period of time within which requests 1481 over the limit will be rate limited. Valid values are 1482 “second”, “minute” and “hour”.</p> 1483 </td> 1484 </tr> 1485 <tr> 1486 <td style="white-space:nowrap"> 1487 <code>burst</code> 1488 <br> 1489 <em> 1490 uint32 1491 </em> 1492 </td> 1493 <td> 1494 <em>(Optional)</em> 1495 <p>Burst defines the number of requests above the requests per 1496 unit that should be allowed within a short period of time.</p> 1497 </td> 1498 </tr> 1499 <tr> 1500 <td style="white-space:nowrap"> 1501 <code>responseStatusCode</code> 1502 <br> 1503 <em> 1504 uint32 1505 </em> 1506 </td> 1507 <td> 1508 <em>(Optional)</em> 1509 <p>ResponseStatusCode is the HTTP status code to use for responses 1510 to rate-limited requests. Codes must be in the 400-599 range 1511 (inclusive). If not specified, the Envoy default of 429 (Too 1512 Many Requests) is used.</p> 1513 </td> 1514 </tr> 1515 <tr> 1516 <td style="white-space:nowrap"> 1517 <code>responseHeadersToAdd</code> 1518 <br> 1519 <em> 1520 <a href="#projectcontour.io/v1.HeaderValue"> 1521 []HeaderValue 1522 </a> 1523 </em> 1524 </td> 1525 <td> 1526 <em>(Optional)</em> 1527 <p>ResponseHeadersToAdd is an optional list of response headers to 1528 set when a request is rate-limited.</p> 1529 </td> 1530 </tr> 1531 </tbody> 1532 </table> 1533 <h3 id="projectcontour.io/v1.MatchCondition">MatchCondition 1534 </h3> 1535 <p> 1536 (<em>Appears on:</em> 1537 <a href="#projectcontour.io/v1.Include">Include</a>, 1538 <a href="#projectcontour.io/v1.Route">Route</a>) 1539 </p> 1540 <p> 1541 <p>MatchCondition are a general holder for matching rules for HTTPProxies. 1542 One of Prefix or Header must be provided.</p> 1543 </p> 1544 <table class="table table-striped table-borderless" style="border:none"> 1545 <thead class="border-bottom"> 1546 <tr> 1547 <th>Field</th> 1548 <th>Description</th> 1549 </tr> 1550 </thead> 1551 <tbody class="border-top"> 1552 <tr> 1553 <td style="white-space:nowrap"> 1554 <code>prefix</code> 1555 <br> 1556 <em> 1557 string 1558 </em> 1559 </td> 1560 <td> 1561 <em>(Optional)</em> 1562 <p>Prefix defines a prefix match for a request.</p> 1563 </td> 1564 </tr> 1565 <tr> 1566 <td style="white-space:nowrap"> 1567 <code>header</code> 1568 <br> 1569 <em> 1570 <a href="#projectcontour.io/v1.HeaderMatchCondition"> 1571 HeaderMatchCondition 1572 </a> 1573 </em> 1574 </td> 1575 <td> 1576 <em>(Optional)</em> 1577 <p>Header specifies the header condition to match.</p> 1578 </td> 1579 </tr> 1580 </tbody> 1581 </table> 1582 <h3 id="projectcontour.io/v1.PathRewritePolicy">PathRewritePolicy 1583 </h3> 1584 <p> 1585 (<em>Appears on:</em> 1586 <a href="#projectcontour.io/v1.Route">Route</a>) 1587 </p> 1588 <p> 1589 <p>PathRewritePolicy specifies how a request URL path should be 1590 rewritten. This rewriting takes place after a request is routed 1591 and has no subsequent effects on the proxy’s routing decision. 1592 No HTTP headers or body content is rewritten.</p> 1593 <p>Exactly one field in this struct may be specified.</p> 1594 </p> 1595 <table class="table table-striped table-borderless" style="border:none"> 1596 <thead class="border-bottom"> 1597 <tr> 1598 <th>Field</th> 1599 <th>Description</th> 1600 </tr> 1601 </thead> 1602 <tbody class="border-top"> 1603 <tr> 1604 <td style="white-space:nowrap"> 1605 <code>replacePrefix</code> 1606 <br> 1607 <em> 1608 <a href="#projectcontour.io/v1.ReplacePrefix"> 1609 []ReplacePrefix 1610 </a> 1611 </em> 1612 </td> 1613 <td> 1614 <em>(Optional)</em> 1615 <p>ReplacePrefix describes how the path prefix should be replaced.</p> 1616 </td> 1617 </tr> 1618 </tbody> 1619 </table> 1620 <h3 id="projectcontour.io/v1.RateLimitDescriptor">RateLimitDescriptor 1621 </h3> 1622 <p> 1623 (<em>Appears on:</em> 1624 <a href="#projectcontour.io/v1.GlobalRateLimitPolicy">GlobalRateLimitPolicy</a>) 1625 </p> 1626 <p> 1627 <p>RateLimitDescriptor defines a list of key-value pair generators.</p> 1628 </p> 1629 <table class="table table-striped table-borderless" style="border:none"> 1630 <thead class="border-bottom"> 1631 <tr> 1632 <th>Field</th> 1633 <th>Description</th> 1634 </tr> 1635 </thead> 1636 <tbody class="border-top"> 1637 <tr> 1638 <td style="white-space:nowrap"> 1639 <code>entries</code> 1640 <br> 1641 <em> 1642 <a href="#projectcontour.io/v1.RateLimitDescriptorEntry"> 1643 []RateLimitDescriptorEntry 1644 </a> 1645 </em> 1646 </td> 1647 <td> 1648 <p>Entries is the list of key-value pair generators.</p> 1649 </td> 1650 </tr> 1651 </tbody> 1652 </table> 1653 <h3 id="projectcontour.io/v1.RateLimitDescriptorEntry">RateLimitDescriptorEntry 1654 </h3> 1655 <p> 1656 (<em>Appears on:</em> 1657 <a href="#projectcontour.io/v1.RateLimitDescriptor">RateLimitDescriptor</a>) 1658 </p> 1659 <p> 1660 <p>RateLimitDescriptorEntry is a key-value pair generator. Exactly 1661 one field on this struct must be non-nil.</p> 1662 </p> 1663 <table class="table table-striped table-borderless" style="border:none"> 1664 <thead class="border-bottom"> 1665 <tr> 1666 <th>Field</th> 1667 <th>Description</th> 1668 </tr> 1669 </thead> 1670 <tbody class="border-top"> 1671 <tr> 1672 <td style="white-space:nowrap"> 1673 <code>genericKey</code> 1674 <br> 1675 <em> 1676 <a href="#projectcontour.io/v1.GenericKeyDescriptor"> 1677 GenericKeyDescriptor 1678 </a> 1679 </em> 1680 </td> 1681 <td> 1682 <em>(Optional)</em> 1683 <p>GenericKey defines a descriptor entry with a static key and value.</p> 1684 </td> 1685 </tr> 1686 <tr> 1687 <td style="white-space:nowrap"> 1688 <code>requestHeader</code> 1689 <br> 1690 <em> 1691 <a href="#projectcontour.io/v1.RequestHeaderDescriptor"> 1692 RequestHeaderDescriptor 1693 </a> 1694 </em> 1695 </td> 1696 <td> 1697 <em>(Optional)</em> 1698 <p>RequestHeader defines a descriptor entry that’s populated only if 1699 a given header is present on the request. The descriptor key is static, 1700 and the descriptor value is equal to the value of the header.</p> 1701 </td> 1702 </tr> 1703 <tr> 1704 <td style="white-space:nowrap"> 1705 <code>remoteAddress</code> 1706 <br> 1707 <em> 1708 <a href="#projectcontour.io/v1.RemoteAddressDescriptor"> 1709 RemoteAddressDescriptor 1710 </a> 1711 </em> 1712 </td> 1713 <td> 1714 <em>(Optional)</em> 1715 <p>RemoteAddress defines a descriptor entry with a key of “remote_address” 1716 and a value equal to the client’s IP address (from x-forwarded-for).</p> 1717 </td> 1718 </tr> 1719 </tbody> 1720 </table> 1721 <h3 id="projectcontour.io/v1.RateLimitPolicy">RateLimitPolicy 1722 </h3> 1723 <p> 1724 (<em>Appears on:</em> 1725 <a href="#projectcontour.io/v1.Route">Route</a>, 1726 <a href="#projectcontour.io/v1.VirtualHost">VirtualHost</a>) 1727 </p> 1728 <p> 1729 <p>RateLimitPolicy defines rate limiting parameters.</p> 1730 </p> 1731 <table class="table table-striped table-borderless" style="border:none"> 1732 <thead class="border-bottom"> 1733 <tr> 1734 <th>Field</th> 1735 <th>Description</th> 1736 </tr> 1737 </thead> 1738 <tbody class="border-top"> 1739 <tr> 1740 <td style="white-space:nowrap"> 1741 <code>local</code> 1742 <br> 1743 <em> 1744 <a href="#projectcontour.io/v1.LocalRateLimitPolicy"> 1745 LocalRateLimitPolicy 1746 </a> 1747 </em> 1748 </td> 1749 <td> 1750 <em>(Optional)</em> 1751 <p>Local defines local rate limiting parameters, i.e. parameters 1752 for rate limiting that occurs within each Envoy pod as requests 1753 are handled.</p> 1754 </td> 1755 </tr> 1756 <tr> 1757 <td style="white-space:nowrap"> 1758 <code>global</code> 1759 <br> 1760 <em> 1761 <a href="#projectcontour.io/v1.GlobalRateLimitPolicy"> 1762 GlobalRateLimitPolicy 1763 </a> 1764 </em> 1765 </td> 1766 <td> 1767 <em>(Optional)</em> 1768 <p>Global defines global rate limiting parameters, i.e. parameters 1769 defining descriptors that are sent to an external rate limit 1770 service (RLS) for a rate limit decision on each request.</p> 1771 </td> 1772 </tr> 1773 </tbody> 1774 </table> 1775 <h3 id="projectcontour.io/v1.RemoteAddressDescriptor">RemoteAddressDescriptor 1776 </h3> 1777 <p> 1778 (<em>Appears on:</em> 1779 <a href="#projectcontour.io/v1.RateLimitDescriptorEntry">RateLimitDescriptorEntry</a>) 1780 </p> 1781 <p> 1782 <p>RemoteAddressDescriptor defines a descriptor entry with a key of 1783 “remote_address” and a value equal to the client’s IP address 1784 (from x-forwarded-for).</p> 1785 </p> 1786 <h3 id="projectcontour.io/v1.ReplacePrefix">ReplacePrefix 1787 </h3> 1788 <p> 1789 (<em>Appears on:</em> 1790 <a href="#projectcontour.io/v1.PathRewritePolicy">PathRewritePolicy</a>) 1791 </p> 1792 <p> 1793 <p>ReplacePrefix describes a path prefix replacement.</p> 1794 </p> 1795 <table class="table table-striped table-borderless" style="border:none"> 1796 <thead class="border-bottom"> 1797 <tr> 1798 <th>Field</th> 1799 <th>Description</th> 1800 </tr> 1801 </thead> 1802 <tbody class="border-top"> 1803 <tr> 1804 <td style="white-space:nowrap"> 1805 <code>prefix</code> 1806 <br> 1807 <em> 1808 string 1809 </em> 1810 </td> 1811 <td> 1812 <em>(Optional)</em> 1813 <p>Prefix specifies the URL path prefix to be replaced.</p> 1814 <p>If Prefix is specified, it must exactly match the MatchCondition 1815 prefix that is rendered by the chain of including HTTPProxies 1816 and only that path prefix will be replaced by Replacement. 1817 This allows HTTPProxies that are included through multiple 1818 roots to only replace specific path prefixes, leaving others 1819 unmodified.</p> 1820 <p>If Prefix is not specified, all routing prefixes rendered 1821 by the include chain will be replaced.</p> 1822 </td> 1823 </tr> 1824 <tr> 1825 <td style="white-space:nowrap"> 1826 <code>replacement</code> 1827 <br> 1828 <em> 1829 string 1830 </em> 1831 </td> 1832 <td> 1833 <p>Replacement is the string that the routing path prefix 1834 will be replaced with. This must not be empty.</p> 1835 </td> 1836 </tr> 1837 </tbody> 1838 </table> 1839 <h3 id="projectcontour.io/v1.RequestHashPolicy">RequestHashPolicy 1840 </h3> 1841 <p> 1842 (<em>Appears on:</em> 1843 <a href="#projectcontour.io/v1.LoadBalancerPolicy">LoadBalancerPolicy</a>) 1844 </p> 1845 <p> 1846 <p>RequestHashPolicy contains configuration for an individual hash policy 1847 on a request attribute.</p> 1848 </p> 1849 <table class="table table-striped table-borderless" style="border:none"> 1850 <thead class="border-bottom"> 1851 <tr> 1852 <th>Field</th> 1853 <th>Description</th> 1854 </tr> 1855 </thead> 1856 <tbody class="border-top"> 1857 <tr> 1858 <td style="white-space:nowrap"> 1859 <code>terminal</code> 1860 <br> 1861 <em> 1862 bool 1863 </em> 1864 </td> 1865 <td> 1866 <p>Terminal is a flag that allows for short-circuiting computing of a hash 1867 for a given request. If set to true, and the request attribute specified 1868 in the attribute hash options is present, no further hash policies will 1869 be used to calculate a hash for the request.</p> 1870 </td> 1871 </tr> 1872 <tr> 1873 <td style="white-space:nowrap"> 1874 <code>headerHashOptions</code> 1875 <br> 1876 <em> 1877 <a href="#projectcontour.io/v1.HeaderHashOptions"> 1878 HeaderHashOptions 1879 </a> 1880 </em> 1881 </td> 1882 <td> 1883 <p>HeaderHashOptions should be set when request header hash based load 1884 balancing is desired. It must be the only hash option field set, 1885 otherwise this request hash policy object will be ignored.</p> 1886 </td> 1887 </tr> 1888 </tbody> 1889 </table> 1890 <h3 id="projectcontour.io/v1.RequestHeaderDescriptor">RequestHeaderDescriptor 1891 </h3> 1892 <p> 1893 (<em>Appears on:</em> 1894 <a href="#projectcontour.io/v1.RateLimitDescriptorEntry">RateLimitDescriptorEntry</a>) 1895 </p> 1896 <p> 1897 <p>RequestHeaderDescriptor defines a descriptor entry that’s populated only 1898 if a given header is present on the request. The value of the descriptor 1899 entry is equal to the value of the header (if present).</p> 1900 </p> 1901 <table class="table table-striped table-borderless" style="border:none"> 1902 <thead class="border-bottom"> 1903 <tr> 1904 <th>Field</th> 1905 <th>Description</th> 1906 </tr> 1907 </thead> 1908 <tbody class="border-top"> 1909 <tr> 1910 <td style="white-space:nowrap"> 1911 <code>headerName</code> 1912 <br> 1913 <em> 1914 string 1915 </em> 1916 </td> 1917 <td> 1918 <p>HeaderName defines the name of the header to look for on the request.</p> 1919 </td> 1920 </tr> 1921 <tr> 1922 <td style="white-space:nowrap"> 1923 <code>descriptorKey</code> 1924 <br> 1925 <em> 1926 string 1927 </em> 1928 </td> 1929 <td> 1930 <p>DescriptorKey defines the key to use on the descriptor entry.</p> 1931 </td> 1932 </tr> 1933 </tbody> 1934 </table> 1935 <h3 id="projectcontour.io/v1.RetryOn">RetryOn 1936 (<code>string</code> alias)</h3> 1937 <p> 1938 (<em>Appears on:</em> 1939 <a href="#projectcontour.io/v1.RetryPolicy">RetryPolicy</a>) 1940 </p> 1941 <p> 1942 <p>RetryOn is a string type alias with validation to ensure that the value is valid.</p> 1943 </p> 1944 <h3 id="projectcontour.io/v1.RetryPolicy">RetryPolicy 1945 </h3> 1946 <p> 1947 (<em>Appears on:</em> 1948 <a href="#projectcontour.io/v1.Route">Route</a>) 1949 </p> 1950 <p> 1951 <p>RetryPolicy defines the attributes associated with retrying policy.</p> 1952 </p> 1953 <table class="table table-striped table-borderless" style="border:none"> 1954 <thead class="border-bottom"> 1955 <tr> 1956 <th>Field</th> 1957 <th>Description</th> 1958 </tr> 1959 </thead> 1960 <tbody class="border-top"> 1961 <tr> 1962 <td style="white-space:nowrap"> 1963 <code>count</code> 1964 <br> 1965 <em> 1966 int64 1967 </em> 1968 </td> 1969 <td> 1970 <em>(Optional)</em> 1971 <p>NumRetries is maximum allowed number of retries. 1972 If not supplied, the number of retries is one.</p> 1973 </td> 1974 </tr> 1975 <tr> 1976 <td style="white-space:nowrap"> 1977 <code>perTryTimeout</code> 1978 <br> 1979 <em> 1980 string 1981 </em> 1982 </td> 1983 <td> 1984 <em>(Optional)</em> 1985 <p>PerTryTimeout specifies the timeout per retry attempt. 1986 Ignored if NumRetries is not supplied.</p> 1987 </td> 1988 </tr> 1989 <tr> 1990 <td style="white-space:nowrap"> 1991 <code>retryOn</code> 1992 <br> 1993 <em> 1994 <a href="#projectcontour.io/v1.RetryOn"> 1995 []RetryOn 1996 </a> 1997 </em> 1998 </td> 1999 <td> 2000 <em>(Optional)</em> 2001 <p>RetryOn specifies the conditions on which to retry a request.</p> 2002 <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> 2003 <ul> 2004 <li><code>5xx</code></li> 2005 <li><code>gateway-error</code></li> 2006 <li><code>reset</code></li> 2007 <li><code>connect-failure</code></li> 2008 <li><code>retriable-4xx</code></li> 2009 <li><code>refused-stream</code></li> 2010 <li><code>retriable-status-codes</code></li> 2011 <li><code>retriable-headers</code></li> 2012 </ul> 2013 <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> 2014 <ul> 2015 <li><code>cancelled</code></li> 2016 <li><code>deadline-exceeded</code></li> 2017 <li><code>internal</code></li> 2018 <li><code>resource-exhausted</code></li> 2019 <li><code>unavailable</code></li> 2020 </ul> 2021 </td> 2022 </tr> 2023 <tr> 2024 <td style="white-space:nowrap"> 2025 <code>retriableStatusCodes</code> 2026 <br> 2027 <em> 2028 []uint32 2029 </em> 2030 </td> 2031 <td> 2032 <em>(Optional)</em> 2033 <p>RetriableStatusCodes specifies the HTTP status codes that should be retried.</p> 2034 <p>This field is only respected when you include <code>retriable-status-codes</code> in the <code>RetryOn</code> field.</p> 2035 </td> 2036 </tr> 2037 </tbody> 2038 </table> 2039 <h3 id="projectcontour.io/v1.Route">Route 2040 </h3> 2041 <p> 2042 (<em>Appears on:</em> 2043 <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>) 2044 </p> 2045 <p> 2046 <p>Route contains the set of routes for a virtual host.</p> 2047 </p> 2048 <table class="table table-striped table-borderless" style="border:none"> 2049 <thead class="border-bottom"> 2050 <tr> 2051 <th>Field</th> 2052 <th>Description</th> 2053 </tr> 2054 </thead> 2055 <tbody class="border-top"> 2056 <tr> 2057 <td style="white-space:nowrap"> 2058 <code>conditions</code> 2059 <br> 2060 <em> 2061 <a href="#projectcontour.io/v1.MatchCondition"> 2062 []MatchCondition 2063 </a> 2064 </em> 2065 </td> 2066 <td> 2067 <em>(Optional)</em> 2068 <p>Conditions are a set of rules that are applied to a Route. 2069 When applied, they are merged using AND, with one exception: 2070 There can be only one Prefix MatchCondition per Conditions slice. 2071 More than one Prefix, or contradictory Conditions, will make the 2072 route invalid.</p> 2073 </td> 2074 </tr> 2075 <tr> 2076 <td style="white-space:nowrap"> 2077 <code>services</code> 2078 <br> 2079 <em> 2080 <a href="#projectcontour.io/v1.Service"> 2081 []Service 2082 </a> 2083 </em> 2084 </td> 2085 <td> 2086 <p>Services are the services to proxy traffic.</p> 2087 </td> 2088 </tr> 2089 <tr> 2090 <td style="white-space:nowrap"> 2091 <code>enableWebsockets</code> 2092 <br> 2093 <em> 2094 bool 2095 </em> 2096 </td> 2097 <td> 2098 <em>(Optional)</em> 2099 <p>Enables websocket support for the route.</p> 2100 </td> 2101 </tr> 2102 <tr> 2103 <td style="white-space:nowrap"> 2104 <code>permitInsecure</code> 2105 <br> 2106 <em> 2107 bool 2108 </em> 2109 </td> 2110 <td> 2111 <em>(Optional)</em> 2112 <p>Allow this path to respond to insecure requests over HTTP which are normally 2113 not permitted when a <code>virtualhost.tls</code> block is present.</p> 2114 </td> 2115 </tr> 2116 <tr> 2117 <td style="white-space:nowrap"> 2118 <code>authPolicy</code> 2119 <br> 2120 <em> 2121 <a href="#projectcontour.io/v1.AuthorizationPolicy"> 2122 AuthorizationPolicy 2123 </a> 2124 </em> 2125 </td> 2126 <td> 2127 <em>(Optional)</em> 2128 <p>AuthPolicy updates the authorization policy that was set 2129 on the root HTTPProxy object for client requests that 2130 match this route.</p> 2131 </td> 2132 </tr> 2133 <tr> 2134 <td style="white-space:nowrap"> 2135 <code>timeoutPolicy</code> 2136 <br> 2137 <em> 2138 <a href="#projectcontour.io/v1.TimeoutPolicy"> 2139 TimeoutPolicy 2140 </a> 2141 </em> 2142 </td> 2143 <td> 2144 <em>(Optional)</em> 2145 <p>The timeout policy for this route.</p> 2146 </td> 2147 </tr> 2148 <tr> 2149 <td style="white-space:nowrap"> 2150 <code>retryPolicy</code> 2151 <br> 2152 <em> 2153 <a href="#projectcontour.io/v1.RetryPolicy"> 2154 RetryPolicy 2155 </a> 2156 </em> 2157 </td> 2158 <td> 2159 <em>(Optional)</em> 2160 <p>The retry policy for this route.</p> 2161 </td> 2162 </tr> 2163 <tr> 2164 <td style="white-space:nowrap"> 2165 <code>healthCheckPolicy</code> 2166 <br> 2167 <em> 2168 <a href="#projectcontour.io/v1.HTTPHealthCheckPolicy"> 2169 HTTPHealthCheckPolicy 2170 </a> 2171 </em> 2172 </td> 2173 <td> 2174 <em>(Optional)</em> 2175 <p>The health check policy for this route.</p> 2176 </td> 2177 </tr> 2178 <tr> 2179 <td style="white-space:nowrap"> 2180 <code>loadBalancerPolicy</code> 2181 <br> 2182 <em> 2183 <a href="#projectcontour.io/v1.LoadBalancerPolicy"> 2184 LoadBalancerPolicy 2185 </a> 2186 </em> 2187 </td> 2188 <td> 2189 <em>(Optional)</em> 2190 <p>The load balancing policy for this route.</p> 2191 </td> 2192 </tr> 2193 <tr> 2194 <td style="white-space:nowrap"> 2195 <code>pathRewritePolicy</code> 2196 <br> 2197 <em> 2198 <a href="#projectcontour.io/v1.PathRewritePolicy"> 2199 PathRewritePolicy 2200 </a> 2201 </em> 2202 </td> 2203 <td> 2204 <em>(Optional)</em> 2205 <p>The policy for rewriting the path of the request URL 2206 after the request has been routed to a Service.</p> 2207 </td> 2208 </tr> 2209 <tr> 2210 <td style="white-space:nowrap"> 2211 <code>requestHeadersPolicy</code> 2212 <br> 2213 <em> 2214 <a href="#projectcontour.io/v1.HeadersPolicy"> 2215 HeadersPolicy 2216 </a> 2217 </em> 2218 </td> 2219 <td> 2220 <em>(Optional)</em> 2221 <p>The policy for managing request headers during proxying.</p> 2222 </td> 2223 </tr> 2224 <tr> 2225 <td style="white-space:nowrap"> 2226 <code>responseHeadersPolicy</code> 2227 <br> 2228 <em> 2229 <a href="#projectcontour.io/v1.HeadersPolicy"> 2230 HeadersPolicy 2231 </a> 2232 </em> 2233 </td> 2234 <td> 2235 <em>(Optional)</em> 2236 <p>The policy for managing response headers during proxying. 2237 Rewriting the ‘Host’ header is not supported.</p> 2238 </td> 2239 </tr> 2240 <tr> 2241 <td style="white-space:nowrap"> 2242 <code>rateLimitPolicy</code> 2243 <br> 2244 <em> 2245 <a href="#projectcontour.io/v1.RateLimitPolicy"> 2246 RateLimitPolicy 2247 </a> 2248 </em> 2249 </td> 2250 <td> 2251 <em>(Optional)</em> 2252 <p>The policy for rate limiting on the route.</p> 2253 </td> 2254 </tr> 2255 </tbody> 2256 </table> 2257 <h3 id="projectcontour.io/v1.Service">Service 2258 </h3> 2259 <p> 2260 (<em>Appears on:</em> 2261 <a href="#projectcontour.io/v1.Route">Route</a>, 2262 <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>) 2263 </p> 2264 <p> 2265 <p>Service defines an Kubernetes Service to proxy traffic.</p> 2266 </p> 2267 <table class="table table-striped table-borderless" style="border:none"> 2268 <thead class="border-bottom"> 2269 <tr> 2270 <th>Field</th> 2271 <th>Description</th> 2272 </tr> 2273 </thead> 2274 <tbody class="border-top"> 2275 <tr> 2276 <td style="white-space:nowrap"> 2277 <code>name</code> 2278 <br> 2279 <em> 2280 string 2281 </em> 2282 </td> 2283 <td> 2284 <p>Name is the name of Kubernetes service to proxy traffic. 2285 Names defined here will be used to look up corresponding endpoints which contain the ips to route.</p> 2286 </td> 2287 </tr> 2288 <tr> 2289 <td style="white-space:nowrap"> 2290 <code>port</code> 2291 <br> 2292 <em> 2293 int 2294 </em> 2295 </td> 2296 <td> 2297 <p>Port (defined as Integer) to proxy traffic to since a service can have multiple defined.</p> 2298 </td> 2299 </tr> 2300 <tr> 2301 <td style="white-space:nowrap"> 2302 <code>protocol</code> 2303 <br> 2304 <em> 2305 string 2306 </em> 2307 </td> 2308 <td> 2309 <em>(Optional)</em> 2310 <p>Protocol may be used to specify (or override) the protocol used to reach this Service. 2311 Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.</p> 2312 </td> 2313 </tr> 2314 <tr> 2315 <td style="white-space:nowrap"> 2316 <code>weight</code> 2317 <br> 2318 <em> 2319 int64 2320 </em> 2321 </td> 2322 <td> 2323 <em>(Optional)</em> 2324 <p>Weight defines percentage of traffic to balance traffic</p> 2325 </td> 2326 </tr> 2327 <tr> 2328 <td style="white-space:nowrap"> 2329 <code>validation</code> 2330 <br> 2331 <em> 2332 <a href="#projectcontour.io/v1.UpstreamValidation"> 2333 UpstreamValidation 2334 </a> 2335 </em> 2336 </td> 2337 <td> 2338 <em>(Optional)</em> 2339 <p>UpstreamValidation defines how to verify the backend service’s certificate</p> 2340 </td> 2341 </tr> 2342 <tr> 2343 <td style="white-space:nowrap"> 2344 <code>mirror</code> 2345 <br> 2346 <em> 2347 bool 2348 </em> 2349 </td> 2350 <td> 2351 <p>If Mirror is true the Service will receive a read only mirror of the traffic for this route.</p> 2352 </td> 2353 </tr> 2354 <tr> 2355 <td style="white-space:nowrap"> 2356 <code>requestHeadersPolicy</code> 2357 <br> 2358 <em> 2359 <a href="#projectcontour.io/v1.HeadersPolicy"> 2360 HeadersPolicy 2361 </a> 2362 </em> 2363 </td> 2364 <td> 2365 <em>(Optional)</em> 2366 <p>The policy for managing request headers during proxying. 2367 Rewriting the ‘Host’ header is not supported.</p> 2368 </td> 2369 </tr> 2370 <tr> 2371 <td style="white-space:nowrap"> 2372 <code>responseHeadersPolicy</code> 2373 <br> 2374 <em> 2375 <a href="#projectcontour.io/v1.HeadersPolicy"> 2376 HeadersPolicy 2377 </a> 2378 </em> 2379 </td> 2380 <td> 2381 <em>(Optional)</em> 2382 <p>The policy for managing response headers during proxying. 2383 Rewriting the ‘Host’ header is not supported.</p> 2384 </td> 2385 </tr> 2386 </tbody> 2387 </table> 2388 <h3 id="projectcontour.io/v1.SubCondition">SubCondition 2389 </h3> 2390 <p> 2391 (<em>Appears on:</em> 2392 <a href="#projectcontour.io/v1.DetailedCondition">DetailedCondition</a>) 2393 </p> 2394 <p> 2395 <p>SubCondition is a Condition-like type intended for use as a subcondition inside a DetailedCondition.</p> 2396 <p>It contains a subset of the Condition fields.</p> 2397 <p>It is intended for warnings and errors, so <code>type</code> names should use abnormal-true polarity, 2398 that is, they should be of the form “ErrorPresent: true”.</p> 2399 <p>The expected lifecycle for these errors is that they should only be present when the error or warning is, 2400 and should be removed when they are not relevant.</p> 2401 </p> 2402 <table class="table table-striped table-borderless" style="border:none"> 2403 <thead class="border-bottom"> 2404 <tr> 2405 <th>Field</th> 2406 <th>Description</th> 2407 </tr> 2408 </thead> 2409 <tbody class="border-top"> 2410 <tr> 2411 <td style="white-space:nowrap"> 2412 <code>type</code> 2413 <br> 2414 <em> 2415 string 2416 </em> 2417 </td> 2418 <td> 2419 <p>Type of condition in <code>CamelCase</code> or in <code>foo.example.com/CamelCase</code>.</p> 2420 <p>This must be in abnormal-true polarity, that is, <code>ErrorFound</code> or <code>controller.io/ErrorFound</code>.</p> 2421 <p>The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)</p> 2422 </td> 2423 </tr> 2424 <tr> 2425 <td style="white-space:nowrap"> 2426 <code>status</code> 2427 <br> 2428 <em> 2429 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-meta"> 2430 Kubernetes meta/v1.ConditionStatus 2431 </a> 2432 </em> 2433 </td> 2434 <td> 2435 <p>Status of the condition, one of True, False, Unknown.</p> 2436 </td> 2437 </tr> 2438 <tr> 2439 <td style="white-space:nowrap"> 2440 <code>reason</code> 2441 <br> 2442 <em> 2443 string 2444 </em> 2445 </td> 2446 <td> 2447 <p>Reason contains a programmatic identifier indicating the reason for the condition’s last transition. 2448 Producers of specific condition types may define expected values and meanings for this field, 2449 and whether the values are considered a guaranteed API.</p> 2450 <p>The value should be a CamelCase string.</p> 2451 <p>This field may not be empty.</p> 2452 </td> 2453 </tr> 2454 <tr> 2455 <td style="white-space:nowrap"> 2456 <code>message</code> 2457 <br> 2458 <em> 2459 string 2460 </em> 2461 </td> 2462 <td> 2463 <p>Message is a human readable message indicating details about the transition.</p> 2464 <p>This may be an empty string.</p> 2465 </td> 2466 </tr> 2467 </tbody> 2468 </table> 2469 <h3 id="projectcontour.io/v1.TCPHealthCheckPolicy">TCPHealthCheckPolicy 2470 </h3> 2471 <p> 2472 (<em>Appears on:</em> 2473 <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>) 2474 </p> 2475 <p> 2476 <p>TCPHealthCheckPolicy defines health checks on the upstream service.</p> 2477 </p> 2478 <table class="table table-striped table-borderless" style="border:none"> 2479 <thead class="border-bottom"> 2480 <tr> 2481 <th>Field</th> 2482 <th>Description</th> 2483 </tr> 2484 </thead> 2485 <tbody class="border-top"> 2486 <tr> 2487 <td style="white-space:nowrap"> 2488 <code>intervalSeconds</code> 2489 <br> 2490 <em> 2491 int64 2492 </em> 2493 </td> 2494 <td> 2495 <em>(Optional)</em> 2496 <p>The interval (seconds) between health checks</p> 2497 </td> 2498 </tr> 2499 <tr> 2500 <td style="white-space:nowrap"> 2501 <code>timeoutSeconds</code> 2502 <br> 2503 <em> 2504 int64 2505 </em> 2506 </td> 2507 <td> 2508 <em>(Optional)</em> 2509 <p>The time to wait (seconds) for a health check response</p> 2510 </td> 2511 </tr> 2512 <tr> 2513 <td style="white-space:nowrap"> 2514 <code>unhealthyThresholdCount</code> 2515 <br> 2516 <em> 2517 uint32 2518 </em> 2519 </td> 2520 <td> 2521 <em>(Optional)</em> 2522 <p>The number of unhealthy health checks required before a host is marked unhealthy</p> 2523 </td> 2524 </tr> 2525 <tr> 2526 <td style="white-space:nowrap"> 2527 <code>healthyThresholdCount</code> 2528 <br> 2529 <em> 2530 uint32 2531 </em> 2532 </td> 2533 <td> 2534 <em>(Optional)</em> 2535 <p>The number of healthy health checks required before a host is marked healthy</p> 2536 </td> 2537 </tr> 2538 </tbody> 2539 </table> 2540 <h3 id="projectcontour.io/v1.TCPProxy">TCPProxy 2541 </h3> 2542 <p> 2543 (<em>Appears on:</em> 2544 <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>) 2545 </p> 2546 <p> 2547 <p>TCPProxy contains the set of services to proxy TCP connections.</p> 2548 </p> 2549 <table class="table table-striped table-borderless" style="border:none"> 2550 <thead class="border-bottom"> 2551 <tr> 2552 <th>Field</th> 2553 <th>Description</th> 2554 </tr> 2555 </thead> 2556 <tbody class="border-top"> 2557 <tr> 2558 <td style="white-space:nowrap"> 2559 <code>loadBalancerPolicy</code> 2560 <br> 2561 <em> 2562 <a href="#projectcontour.io/v1.LoadBalancerPolicy"> 2563 LoadBalancerPolicy 2564 </a> 2565 </em> 2566 </td> 2567 <td> 2568 <em>(Optional)</em> 2569 <p>The load balancing policy for the backend services. Note that the 2570 <code>Cookie</code> and <code>RequestHash</code> load balancing strategies cannot be used 2571 here.</p> 2572 </td> 2573 </tr> 2574 <tr> 2575 <td style="white-space:nowrap"> 2576 <code>services</code> 2577 <br> 2578 <em> 2579 <a href="#projectcontour.io/v1.Service"> 2580 []Service 2581 </a> 2582 </em> 2583 </td> 2584 <td> 2585 <em>(Optional)</em> 2586 <p>Services are the services to proxy traffic</p> 2587 </td> 2588 </tr> 2589 <tr> 2590 <td style="white-space:nowrap"> 2591 <code>include</code> 2592 <br> 2593 <em> 2594 <a href="#projectcontour.io/v1.TCPProxyInclude"> 2595 TCPProxyInclude 2596 </a> 2597 </em> 2598 </td> 2599 <td> 2600 <em>(Optional)</em> 2601 <p>Include specifies that this tcpproxy should be delegated to another HTTPProxy.</p> 2602 </td> 2603 </tr> 2604 <tr> 2605 <td style="white-space:nowrap"> 2606 <code>includes</code> 2607 <br> 2608 <em> 2609 <a href="#projectcontour.io/v1.TCPProxyInclude"> 2610 TCPProxyInclude 2611 </a> 2612 </em> 2613 </td> 2614 <td> 2615 <em>(Optional)</em> 2616 <p>IncludesDeprecated allow for specific routing configuration to be appended to another HTTPProxy in another namespace.</p> 2617 <p>Exists due to a mistake when developing HTTPProxy and the field was marked plural 2618 when it should have been singular. This field should stay to not break backwards compatibility to v1 users.</p> 2619 </td> 2620 </tr> 2621 <tr> 2622 <td style="white-space:nowrap"> 2623 <code>healthCheckPolicy</code> 2624 <br> 2625 <em> 2626 <a href="#projectcontour.io/v1.TCPHealthCheckPolicy"> 2627 TCPHealthCheckPolicy 2628 </a> 2629 </em> 2630 </td> 2631 <td> 2632 <em>(Optional)</em> 2633 <p>The health check policy for this tcp proxy</p> 2634 </td> 2635 </tr> 2636 </tbody> 2637 </table> 2638 <h3 id="projectcontour.io/v1.TCPProxyInclude">TCPProxyInclude 2639 </h3> 2640 <p> 2641 (<em>Appears on:</em> 2642 <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>) 2643 </p> 2644 <p> 2645 <p>TCPProxyInclude describes a target HTTPProxy document which contains the TCPProxy details.</p> 2646 </p> 2647 <table class="table table-striped table-borderless" style="border:none"> 2648 <thead class="border-bottom"> 2649 <tr> 2650 <th>Field</th> 2651 <th>Description</th> 2652 </tr> 2653 </thead> 2654 <tbody class="border-top"> 2655 <tr> 2656 <td style="white-space:nowrap"> 2657 <code>name</code> 2658 <br> 2659 <em> 2660 string 2661 </em> 2662 </td> 2663 <td> 2664 <p>Name of the child HTTPProxy</p> 2665 </td> 2666 </tr> 2667 <tr> 2668 <td style="white-space:nowrap"> 2669 <code>namespace</code> 2670 <br> 2671 <em> 2672 string 2673 </em> 2674 </td> 2675 <td> 2676 <em>(Optional)</em> 2677 <p>Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.</p> 2678 </td> 2679 </tr> 2680 </tbody> 2681 </table> 2682 <h3 id="projectcontour.io/v1.TLS">TLS 2683 </h3> 2684 <p> 2685 (<em>Appears on:</em> 2686 <a href="#projectcontour.io/v1.VirtualHost">VirtualHost</a>) 2687 </p> 2688 <p> 2689 <p>TLS describes tls properties. The SNI names that will be matched on 2690 are described in the HTTPProxy’s Spec.VirtualHost.Fqdn field.</p> 2691 </p> 2692 <table class="table table-striped table-borderless" style="border:none"> 2693 <thead class="border-bottom"> 2694 <tr> 2695 <th>Field</th> 2696 <th>Description</th> 2697 </tr> 2698 </thead> 2699 <tbody class="border-top"> 2700 <tr> 2701 <td style="white-space:nowrap"> 2702 <code>secretName</code> 2703 <br> 2704 <em> 2705 string 2706 </em> 2707 </td> 2708 <td> 2709 <p>SecretName is the name of a TLS secret in the current namespace. 2710 Either SecretName or Passthrough must be specified, but not both. 2711 If specified, the named secret must contain a matching certificate 2712 for the virtual host’s FQDN.</p> 2713 </td> 2714 </tr> 2715 <tr> 2716 <td style="white-space:nowrap"> 2717 <code>minimumProtocolVersion</code> 2718 <br> 2719 <em> 2720 string 2721 </em> 2722 </td> 2723 <td> 2724 <em>(Optional)</em> 2725 <p>MinimumProtocolVersion is the minimum TLS version this vhost should 2726 negotiate. Valid options are <code>1.2</code> (default) and <code>1.3</code>. Any other value 2727 defaults to TLS 1.2.</p> 2728 </td> 2729 </tr> 2730 <tr> 2731 <td style="white-space:nowrap"> 2732 <code>passthrough</code> 2733 <br> 2734 <em> 2735 bool 2736 </em> 2737 </td> 2738 <td> 2739 <em>(Optional)</em> 2740 <p>Passthrough defines whether the encrypted TLS handshake will be 2741 passed through to the backing cluster. Either Passthrough or 2742 SecretName must be specified, but not both.</p> 2743 </td> 2744 </tr> 2745 <tr> 2746 <td style="white-space:nowrap"> 2747 <code>clientValidation</code> 2748 <br> 2749 <em> 2750 <a href="#projectcontour.io/v1.DownstreamValidation"> 2751 DownstreamValidation 2752 </a> 2753 </em> 2754 </td> 2755 <td> 2756 <em>(Optional)</em> 2757 <p>ClientValidation defines how to verify the client certificate 2758 when an external client establishes a TLS connection to Envoy.</p> 2759 <p>This setting:</p> 2760 <ol> 2761 <li>Enables TLS client certificate validation.</li> 2762 <li>Requires clients to present a TLS certificate (i.e. not optional validation).</li> 2763 <li>Specifies how the client certificate will be validated.</li> 2764 </ol> 2765 </td> 2766 </tr> 2767 <tr> 2768 <td style="white-space:nowrap"> 2769 <code>enableFallbackCertificate</code> 2770 <br> 2771 <em> 2772 bool 2773 </em> 2774 </td> 2775 <td> 2776 <p>EnableFallbackCertificate defines if the vhost should allow a default certificate to 2777 be applied which handles all requests which don’t match the SNI defined in this vhost.</p> 2778 </td> 2779 </tr> 2780 </tbody> 2781 </table> 2782 <h3 id="projectcontour.io/v1.TLSCertificateDelegationSpec">TLSCertificateDelegationSpec 2783 </h3> 2784 <p> 2785 (<em>Appears on:</em> 2786 <a href="#projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation</a>) 2787 </p> 2788 <p> 2789 <p>TLSCertificateDelegationSpec defines the spec of the CRD</p> 2790 </p> 2791 <table class="table table-striped table-borderless" style="border:none"> 2792 <thead class="border-bottom"> 2793 <tr> 2794 <th>Field</th> 2795 <th>Description</th> 2796 </tr> 2797 </thead> 2798 <tbody class="border-top"> 2799 <tr> 2800 <td style="white-space:nowrap"> 2801 <code>delegations</code> 2802 <br> 2803 <em> 2804 <a href="#projectcontour.io/v1.CertificateDelegation"> 2805 []CertificateDelegation 2806 </a> 2807 </em> 2808 </td> 2809 <td> 2810 </td> 2811 </tr> 2812 </tbody> 2813 </table> 2814 <h3 id="projectcontour.io/v1.TLSCertificateDelegationStatus">TLSCertificateDelegationStatus 2815 </h3> 2816 <p> 2817 (<em>Appears on:</em> 2818 <a href="#projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation</a>) 2819 </p> 2820 <p> 2821 <p>TLSCertificateDelegationStatus allows for the status of the delegation 2822 to be presented to the user.</p> 2823 </p> 2824 <table class="table table-striped table-borderless" style="border:none"> 2825 <thead class="border-bottom"> 2826 <tr> 2827 <th>Field</th> 2828 <th>Description</th> 2829 </tr> 2830 </thead> 2831 <tbody class="border-top"> 2832 <tr> 2833 <td style="white-space:nowrap"> 2834 <code>conditions</code> 2835 <br> 2836 <em> 2837 <a href="#projectcontour.io/v1.DetailedCondition"> 2838 []DetailedCondition 2839 </a> 2840 </em> 2841 </td> 2842 <td> 2843 <em>(Optional)</em> 2844 <p>Conditions contains information about the current status of the HTTPProxy, 2845 in an upstream-friendly container.</p> 2846 <p>Contour will update a single condition, <code>Valid</code>, that is in normal-true polarity. 2847 That is, when <code>currentStatus</code> is <code>valid</code>, the <code>Valid</code> condition will be <code>status: true</code>, 2848 and vice versa.</p> 2849 <p>Contour will leave untouched any other Conditions set in this block, 2850 in case some other controller wants to add a Condition.</p> 2851 <p>If you are another controller owner and wish to add a condition, you <em>should</em> 2852 namespace your condition with a label, like <code>controller.domain.com\ConditionName</code>.</p> 2853 </td> 2854 </tr> 2855 </tbody> 2856 </table> 2857 <h3 id="projectcontour.io/v1.TimeoutPolicy">TimeoutPolicy 2858 </h3> 2859 <p> 2860 (<em>Appears on:</em> 2861 <a href="#projectcontour.io/v1.Route">Route</a>, 2862 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>) 2863 </p> 2864 <p> 2865 <p>TimeoutPolicy configures timeouts that are used for handling network requests.</p> 2866 <p>TimeoutPolicy durations are expressed in the Go <a href="https://godoc.org/time#ParseDuration">Duration format</a>. 2867 Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. 2868 The string “infinity” is also a valid input and specifies no timeout. 2869 A value of “0s” will be treated as if the field were not set, i.e. by using Envoy’s default behavior.</p> 2870 <p>Example input values: “300ms”, “5s”, “1m”.</p> 2871 </p> 2872 <table class="table table-striped table-borderless" style="border:none"> 2873 <thead class="border-bottom"> 2874 <tr> 2875 <th>Field</th> 2876 <th>Description</th> 2877 </tr> 2878 </thead> 2879 <tbody class="border-top"> 2880 <tr> 2881 <td style="white-space:nowrap"> 2882 <code>response</code> 2883 <br> 2884 <em> 2885 string 2886 </em> 2887 </td> 2888 <td> 2889 <em>(Optional)</em> 2890 <p>Timeout for receiving a response from the server after processing a request from client. 2891 If not supplied, Envoy’s default value of 15s applies.</p> 2892 </td> 2893 </tr> 2894 <tr> 2895 <td style="white-space:nowrap"> 2896 <code>idle</code> 2897 <br> 2898 <em> 2899 string 2900 </em> 2901 </td> 2902 <td> 2903 <em>(Optional)</em> 2904 <p>Timeout after which, if there are no active requests for this route, the connection between 2905 Envoy and the backend or Envoy and the external client will be closed. 2906 If not specified, there is no per-route idle timeout, though a connection manager-wide 2907 stream_idle_timeout default of 5m still applies.</p> 2908 </td> 2909 </tr> 2910 </tbody> 2911 </table> 2912 <h3 id="projectcontour.io/v1.UpstreamValidation">UpstreamValidation 2913 </h3> 2914 <p> 2915 (<em>Appears on:</em> 2916 <a href="#projectcontour.io/v1.Service">Service</a>, 2917 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>) 2918 </p> 2919 <p> 2920 <p>UpstreamValidation defines how to verify the backend service’s certificate</p> 2921 </p> 2922 <table class="table table-striped table-borderless" style="border:none"> 2923 <thead class="border-bottom"> 2924 <tr> 2925 <th>Field</th> 2926 <th>Description</th> 2927 </tr> 2928 </thead> 2929 <tbody class="border-top"> 2930 <tr> 2931 <td style="white-space:nowrap"> 2932 <code>caSecret</code> 2933 <br> 2934 <em> 2935 string 2936 </em> 2937 </td> 2938 <td> 2939 <p>Name of the Kubernetes secret be used to validate the certificate presented by the backend</p> 2940 </td> 2941 </tr> 2942 <tr> 2943 <td style="white-space:nowrap"> 2944 <code>subjectName</code> 2945 <br> 2946 <em> 2947 string 2948 </em> 2949 </td> 2950 <td> 2951 <p>Key which is expected to be present in the ‘subjectAltName’ of the presented certificate</p> 2952 </td> 2953 </tr> 2954 </tbody> 2955 </table> 2956 <h3 id="projectcontour.io/v1.VirtualHost">VirtualHost 2957 </h3> 2958 <p> 2959 (<em>Appears on:</em> 2960 <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>) 2961 </p> 2962 <p> 2963 <p>VirtualHost appears at most once. If it is present, the object is considered 2964 to be a “root”.</p> 2965 </p> 2966 <table class="table table-striped table-borderless" style="border:none"> 2967 <thead class="border-bottom"> 2968 <tr> 2969 <th>Field</th> 2970 <th>Description</th> 2971 </tr> 2972 </thead> 2973 <tbody class="border-top"> 2974 <tr> 2975 <td style="white-space:nowrap"> 2976 <code>fqdn</code> 2977 <br> 2978 <em> 2979 string 2980 </em> 2981 </td> 2982 <td> 2983 <p>The fully qualified domain name of the root of the ingress tree 2984 all leaves of the DAG rooted at this object relate to the fqdn.</p> 2985 </td> 2986 </tr> 2987 <tr> 2988 <td style="white-space:nowrap"> 2989 <code>tls</code> 2990 <br> 2991 <em> 2992 <a href="#projectcontour.io/v1.TLS"> 2993 TLS 2994 </a> 2995 </em> 2996 </td> 2997 <td> 2998 <em>(Optional)</em> 2999 <p>If present the fields describes TLS properties of the virtual 3000 host. The SNI names that will be matched on are described in fqdn, 3001 the tls.secretName secret must contain a certificate that itself 3002 contains a name that matches the FQDN.</p> 3003 </td> 3004 </tr> 3005 <tr> 3006 <td style="white-space:nowrap"> 3007 <code>authorization</code> 3008 <br> 3009 <em> 3010 <a href="#projectcontour.io/v1.AuthorizationServer"> 3011 AuthorizationServer 3012 </a> 3013 </em> 3014 </td> 3015 <td> 3016 <em>(Optional)</em> 3017 <p>This field configures an extension service to perform 3018 authorization for this virtual host. Authorization can 3019 only be configured on virtual hosts that have TLS enabled. 3020 If the TLS configuration requires client certificate 3021 /validation, the client certificate is always included in the 3022 authentication check request.</p> 3023 </td> 3024 </tr> 3025 <tr> 3026 <td style="white-space:nowrap"> 3027 <code>corsPolicy</code> 3028 <br> 3029 <em> 3030 <a href="#projectcontour.io/v1.CORSPolicy"> 3031 CORSPolicy 3032 </a> 3033 </em> 3034 </td> 3035 <td> 3036 <em>(Optional)</em> 3037 <p>Specifies the cross-origin policy to apply to the VirtualHost.</p> 3038 </td> 3039 </tr> 3040 <tr> 3041 <td style="white-space:nowrap"> 3042 <code>rateLimitPolicy</code> 3043 <br> 3044 <em> 3045 <a href="#projectcontour.io/v1.RateLimitPolicy"> 3046 RateLimitPolicy 3047 </a> 3048 </em> 3049 </td> 3050 <td> 3051 <em>(Optional)</em> 3052 <p>The policy for rate limiting on the virtual host.</p> 3053 </td> 3054 </tr> 3055 </tbody> 3056 </table> 3057 <hr/> 3058 <h2 id="projectcontour.io/v1alpha1">projectcontour.io/v1alpha1</h2> 3059 <p> 3060 <p>Package v1alpha1 contains API Schema definitions for the projectcontour.io v1alpha1 API group</p> 3061 </p> 3062 Resource Types: 3063 <ul><li> 3064 <a href="#projectcontour.io/v1alpha1.ExtensionService">ExtensionService</a> 3065 </li></ul> 3066 <h3 id="projectcontour.io/v1alpha1.ExtensionService">ExtensionService 3067 </h3> 3068 <p> 3069 <p>ExtensionService is the schema for the Contour extension services API. 3070 An ExtensionService resource binds a network service to the Contour 3071 API so that Contour API features can be implemented by collaborating 3072 components.</p> 3073 </p> 3074 <table class="table table-striped table-borderless" style="border:none"> 3075 <thead class="border-bottom"> 3076 <tr> 3077 <th>Field</th> 3078 <th>Description</th> 3079 </tr> 3080 </thead> 3081 <tbody class="border-top"> 3082 <tr> 3083 <td> 3084 <code>apiVersion</code> 3085 <br> 3086 string</td> 3087 <td> 3088 <code> 3089 projectcontour.io/v1alpha1 3090 </code> 3091 </td> 3092 </tr> 3093 <tr> 3094 <td> 3095 <code>kind</code> 3096 <br> 3097 string 3098 </td> 3099 <td><code>ExtensionService</code></td> 3100 </tr> 3101 <tr> 3102 <td style="white-space:nowrap"> 3103 <code>metadata</code> 3104 <br> 3105 <em> 3106 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta"> 3107 Kubernetes meta/v1.ObjectMeta 3108 </a> 3109 </em> 3110 </td> 3111 <td> 3112 Refer to the Kubernetes API documentation for the fields of the 3113 <code>metadata</code> field. 3114 </td> 3115 </tr> 3116 <tr> 3117 <td style="white-space:nowrap"> 3118 <code>spec</code> 3119 <br> 3120 <em> 3121 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec"> 3122 ExtensionServiceSpec 3123 </a> 3124 </em> 3125 </td> 3126 <td> 3127 <br> 3128 <br> 3129 <table style="border:none"> 3130 <tr> 3131 <td style="white-space:nowrap"> 3132 <code>services</code> 3133 <br> 3134 <em> 3135 <a href="#projectcontour.io/v1alpha1.ExtensionServiceTarget"> 3136 []ExtensionServiceTarget 3137 </a> 3138 </em> 3139 </td> 3140 <td> 3141 <p>Services specifies the set of Kubernetes Service resources that 3142 receive GRPC extension API requests. 3143 If no weights are specified for any of the entries in 3144 this array, traffic will be spread evenly across all the 3145 services. 3146 Otherwise, traffic is balanced proportionally to the 3147 Weight field in each entry.</p> 3148 </td> 3149 </tr> 3150 <tr> 3151 <td style="white-space:nowrap"> 3152 <code>validation</code> 3153 <br> 3154 <em> 3155 <a href="#projectcontour.io/v1.UpstreamValidation"> 3156 UpstreamValidation 3157 </a> 3158 </em> 3159 </td> 3160 <td> 3161 <em>(Optional)</em> 3162 <p>UpstreamValidation defines how to verify the backend service’s certificate</p> 3163 </td> 3164 </tr> 3165 <tr> 3166 <td style="white-space:nowrap"> 3167 <code>protocol</code> 3168 <br> 3169 <em> 3170 string 3171 </em> 3172 </td> 3173 <td> 3174 <em>(Optional)</em> 3175 <p>Protocol may be used to specify (or override) the protocol used to reach this Service. 3176 Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.</p> 3177 </td> 3178 </tr> 3179 <tr> 3180 <td style="white-space:nowrap"> 3181 <code>loadBalancerPolicy</code> 3182 <br> 3183 <em> 3184 <a href="#projectcontour.io/v1.LoadBalancerPolicy"> 3185 LoadBalancerPolicy 3186 </a> 3187 </em> 3188 </td> 3189 <td> 3190 <em>(Optional)</em> 3191 <p>The policy for load balancing GRPC service requests. Note that the 3192 <code>Cookie</code> and <code>RequestHash</code> load balancing strategies cannot be used 3193 here.</p> 3194 </td> 3195 </tr> 3196 <tr> 3197 <td style="white-space:nowrap"> 3198 <code>timeoutPolicy</code> 3199 <br> 3200 <em> 3201 <a href="#projectcontour.io/v1.TimeoutPolicy"> 3202 TimeoutPolicy 3203 </a> 3204 </em> 3205 </td> 3206 <td> 3207 <em>(Optional)</em> 3208 <p>The timeout policy for requests to the services.</p> 3209 </td> 3210 </tr> 3211 <tr> 3212 <td style="white-space:nowrap"> 3213 <code>protocolVersion</code> 3214 <br> 3215 <em> 3216 <a href="#projectcontour.io/v1alpha1.ExtensionProtocolVersion"> 3217 ExtensionProtocolVersion 3218 </a> 3219 </em> 3220 </td> 3221 <td> 3222 <em>(Optional)</em> 3223 <p>This field sets the version of the GRPC protocol that Envoy uses to 3224 send requests to the extension service. Since Contour always uses the 3225 v3 Envoy API, this is currently fixed at “v3”. However, other 3226 protocol options will be available in future.</p> 3227 </td> 3228 </tr> 3229 </table> 3230 </td> 3231 </tr> 3232 <tr> 3233 <td style="white-space:nowrap"> 3234 <code>status</code> 3235 <br> 3236 <em> 3237 <a href="#projectcontour.io/v1alpha1.ExtensionServiceStatus"> 3238 ExtensionServiceStatus 3239 </a> 3240 </em> 3241 </td> 3242 <td> 3243 </td> 3244 </tr> 3245 </tbody> 3246 </table> 3247 <h3 id="projectcontour.io/v1alpha1.ExtensionProtocolVersion">ExtensionProtocolVersion 3248 (<code>string</code> alias)</h3> 3249 <p> 3250 (<em>Appears on:</em> 3251 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>) 3252 </p> 3253 <p> 3254 <p>ExtensionProtocolVersion is the version of the GRPC protocol used 3255 to access extension services. The only version currently supported 3256 is “v3”.</p> 3257 </p> 3258 <h3 id="projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec 3259 </h3> 3260 <p> 3261 (<em>Appears on:</em> 3262 <a href="#projectcontour.io/v1alpha1.ExtensionService">ExtensionService</a>) 3263 </p> 3264 <p> 3265 <p>ExtensionServiceSpec defines the desired state of an ExtensionService resource.</p> 3266 </p> 3267 <table class="table table-striped table-borderless" style="border:none"> 3268 <thead class="border-bottom"> 3269 <tr> 3270 <th>Field</th> 3271 <th>Description</th> 3272 </tr> 3273 </thead> 3274 <tbody class="border-top"> 3275 <tr> 3276 <td style="white-space:nowrap"> 3277 <code>services</code> 3278 <br> 3279 <em> 3280 <a href="#projectcontour.io/v1alpha1.ExtensionServiceTarget"> 3281 []ExtensionServiceTarget 3282 </a> 3283 </em> 3284 </td> 3285 <td> 3286 <p>Services specifies the set of Kubernetes Service resources that 3287 receive GRPC extension API requests. 3288 If no weights are specified for any of the entries in 3289 this array, traffic will be spread evenly across all the 3290 services. 3291 Otherwise, traffic is balanced proportionally to the 3292 Weight field in each entry.</p> 3293 </td> 3294 </tr> 3295 <tr> 3296 <td style="white-space:nowrap"> 3297 <code>validation</code> 3298 <br> 3299 <em> 3300 <a href="#projectcontour.io/v1.UpstreamValidation"> 3301 UpstreamValidation 3302 </a> 3303 </em> 3304 </td> 3305 <td> 3306 <em>(Optional)</em> 3307 <p>UpstreamValidation defines how to verify the backend service’s certificate</p> 3308 </td> 3309 </tr> 3310 <tr> 3311 <td style="white-space:nowrap"> 3312 <code>protocol</code> 3313 <br> 3314 <em> 3315 string 3316 </em> 3317 </td> 3318 <td> 3319 <em>(Optional)</em> 3320 <p>Protocol may be used to specify (or override) the protocol used to reach this Service. 3321 Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.</p> 3322 </td> 3323 </tr> 3324 <tr> 3325 <td style="white-space:nowrap"> 3326 <code>loadBalancerPolicy</code> 3327 <br> 3328 <em> 3329 <a href="#projectcontour.io/v1.LoadBalancerPolicy"> 3330 LoadBalancerPolicy 3331 </a> 3332 </em> 3333 </td> 3334 <td> 3335 <em>(Optional)</em> 3336 <p>The policy for load balancing GRPC service requests. Note that the 3337 <code>Cookie</code> and <code>RequestHash</code> load balancing strategies cannot be used 3338 here.</p> 3339 </td> 3340 </tr> 3341 <tr> 3342 <td style="white-space:nowrap"> 3343 <code>timeoutPolicy</code> 3344 <br> 3345 <em> 3346 <a href="#projectcontour.io/v1.TimeoutPolicy"> 3347 TimeoutPolicy 3348 </a> 3349 </em> 3350 </td> 3351 <td> 3352 <em>(Optional)</em> 3353 <p>The timeout policy for requests to the services.</p> 3354 </td> 3355 </tr> 3356 <tr> 3357 <td style="white-space:nowrap"> 3358 <code>protocolVersion</code> 3359 <br> 3360 <em> 3361 <a href="#projectcontour.io/v1alpha1.ExtensionProtocolVersion"> 3362 ExtensionProtocolVersion 3363 </a> 3364 </em> 3365 </td> 3366 <td> 3367 <em>(Optional)</em> 3368 <p>This field sets the version of the GRPC protocol that Envoy uses to 3369 send requests to the extension service. Since Contour always uses the 3370 v3 Envoy API, this is currently fixed at “v3”. However, other 3371 protocol options will be available in future.</p> 3372 </td> 3373 </tr> 3374 </tbody> 3375 </table> 3376 <h3 id="projectcontour.io/v1alpha1.ExtensionServiceStatus">ExtensionServiceStatus 3377 </h3> 3378 <p> 3379 (<em>Appears on:</em> 3380 <a href="#projectcontour.io/v1alpha1.ExtensionService">ExtensionService</a>) 3381 </p> 3382 <p> 3383 <p>ExtensionServiceStatus defines the observed state of an 3384 ExtensionService resource.</p> 3385 </p> 3386 <table class="table table-striped table-borderless" style="border:none"> 3387 <thead class="border-bottom"> 3388 <tr> 3389 <th>Field</th> 3390 <th>Description</th> 3391 </tr> 3392 </thead> 3393 <tbody class="border-top"> 3394 <tr> 3395 <td style="white-space:nowrap"> 3396 <code>conditions</code> 3397 <br> 3398 <em> 3399 <a href="#projectcontour.io/v1.DetailedCondition"> 3400 []DetailedCondition 3401 </a> 3402 </em> 3403 </td> 3404 <td> 3405 <em>(Optional)</em> 3406 <p>Conditions contains the current status of the ExtensionService resource.</p> 3407 <p>Contour will update a single condition, <code>Valid</code>, that is in normal-true polarity.</p> 3408 <p>Contour will not modify any other Conditions set in this block, 3409 in case some other controller wants to add a Condition.</p> 3410 </td> 3411 </tr> 3412 </tbody> 3413 </table> 3414 <h3 id="projectcontour.io/v1alpha1.ExtensionServiceTarget">ExtensionServiceTarget 3415 </h3> 3416 <p> 3417 (<em>Appears on:</em> 3418 <a href="#projectcontour.io/v1alpha1.ExtensionServiceSpec">ExtensionServiceSpec</a>) 3419 </p> 3420 <p> 3421 <p>ExtensionServiceTarget defines an Kubernetes Service to target with 3422 extension service traffic.</p> 3423 </p> 3424 <table class="table table-striped table-borderless" style="border:none"> 3425 <thead class="border-bottom"> 3426 <tr> 3427 <th>Field</th> 3428 <th>Description</th> 3429 </tr> 3430 </thead> 3431 <tbody class="border-top"> 3432 <tr> 3433 <td style="white-space:nowrap"> 3434 <code>name</code> 3435 <br> 3436 <em> 3437 string 3438 </em> 3439 </td> 3440 <td> 3441 <p>Name is the name of Kubernetes service that will accept service 3442 traffic.</p> 3443 </td> 3444 </tr> 3445 <tr> 3446 <td style="white-space:nowrap"> 3447 <code>port</code> 3448 <br> 3449 <em> 3450 int 3451 </em> 3452 </td> 3453 <td> 3454 <p>Port (defined as Integer) to proxy traffic to since a service can have multiple defined.</p> 3455 </td> 3456 </tr> 3457 <tr> 3458 <td style="white-space:nowrap"> 3459 <code>weight</code> 3460 <br> 3461 <em> 3462 uint32 3463 </em> 3464 </td> 3465 <td> 3466 <em>(Optional)</em> 3467 <p>Weight defines proportion of traffic to balance to the Kubernetes Service.</p> 3468 </td> 3469 </tr> 3470 </tbody> 3471 </table> 3472 <hr/> 3473 <p><em> 3474 Generated with <code>gen-crd-api-reference-docs</code>. 3475 </em></p>