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