github.com/projectcontour/contour@v1.28.2/site/content/docs/v1.3.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  </ul>
     7  <h2 id="projectcontour.io/v1">projectcontour.io/v1</h2>
     8  <p>
     9  <p>Package v1 is the v1 version of the API.</p>
    10  </p>
    11  Resource Types:
    12  <ul><li>
    13  <a href="#projectcontour.io/v1.HTTPProxy">HTTPProxy</a>
    14  </li><li>
    15  <a href="#projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation</a>
    16  </li></ul>
    17  <h3 id="projectcontour.io/v1.HTTPProxy">HTTPProxy
    18  </h3>
    19  <p>
    20  <p>HTTPProxy is an Ingress CRD specification</p>
    21  </p>
    22  <table class="table table-striped table-borderless" style="border:none">
    23  <thead class="border-bottom">
    24  <tr>
    25  <th>Field</th>
    26  <th>Description</th>
    27  </tr>
    28  </thead>
    29  <tbody class="border-top">
    30  <tr>
    31  <td>
    32  <code>apiVersion</code>
    33  <br>
    34  string</td>
    35  <td>
    36  <code>
    37  projectcontour.io/v1
    38  </code>
    39  </td>
    40  </tr>
    41  <tr>
    42  <td>
    43  <code>kind</code>
    44  <br>
    45  string
    46  </td>
    47  <td><code>HTTPProxy</code></td>
    48  </tr>
    49  <tr>
    50  <td style="white-space:nowrap">
    51  <code>metadata</code>
    52  <br>
    53  <em>
    54  <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
    55  Kubernetes meta/v1.ObjectMeta
    56  </a>
    57  </em>
    58  </td>
    59  <td>
    60  Refer to the Kubernetes API documentation for the fields of the
    61  <code>metadata</code> field.
    62  </td>
    63  </tr>
    64  <tr>
    65  <td style="white-space:nowrap">
    66  <code>spec</code>
    67  <br>
    68  <em>
    69  <a href="#projectcontour.io/v1.HTTPProxySpec">
    70  HTTPProxySpec
    71  </a>
    72  </em>
    73  </td>
    74  <td>
    75  <br>
    76  <br>
    77  <table style="border:none">
    78  <tr>
    79  <td style="white-space:nowrap">
    80  <code>virtualhost</code>
    81  <br>
    82  <em>
    83  <a href="#projectcontour.io/v1.VirtualHost">
    84  VirtualHost
    85  </a>
    86  </em>
    87  </td>
    88  <td>
    89  <em>(Optional)</em>
    90  <p>Virtualhost appears at most once. If it is present, the object is considered
    91  to be a &ldquo;root&rdquo;.</p>
    92  </td>
    93  </tr>
    94  <tr>
    95  <td style="white-space:nowrap">
    96  <code>routes</code>
    97  <br>
    98  <em>
    99  <a href="#projectcontour.io/v1.Route">
   100  []Route
   101  </a>
   102  </em>
   103  </td>
   104  <td>
   105  <em>(Optional)</em>
   106  <p>Routes are the ingress routes. If TCPProxy is present, Routes is ignored.</p>
   107  </td>
   108  </tr>
   109  <tr>
   110  <td style="white-space:nowrap">
   111  <code>tcpproxy</code>
   112  <br>
   113  <em>
   114  <a href="#projectcontour.io/v1.TCPProxy">
   115  TCPProxy
   116  </a>
   117  </em>
   118  </td>
   119  <td>
   120  <em>(Optional)</em>
   121  <p>TCPProxy holds TCP proxy information.</p>
   122  </td>
   123  </tr>
   124  <tr>
   125  <td style="white-space:nowrap">
   126  <code>includes</code>
   127  <br>
   128  <em>
   129  <a href="#projectcontour.io/v1.Include">
   130  []Include
   131  </a>
   132  </em>
   133  </td>
   134  <td>
   135  <em>(Optional)</em>
   136  <p>Includes allow for specific routing configuration to be appended to another HTTPProxy in another namespace.</p>
   137  </td>
   138  </tr>
   139  </table>
   140  </td>
   141  </tr>
   142  <tr>
   143  <td style="white-space:nowrap">
   144  <code>status</code>
   145  <br>
   146  <em>
   147  <a href="#projectcontour.io/v1.Status">
   148  Status
   149  </a>
   150  </em>
   151  </td>
   152  <td>
   153  <em>(Optional)</em>
   154  </td>
   155  </tr>
   156  </tbody>
   157  </table>
   158  <h3 id="projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation
   159  </h3>
   160  <p>
   161  <p>TLSCertificateDelegation is an TLS Certificate Delegation CRD specification.
   162  See design/tls-certificate-delegation.md for details.</p>
   163  </p>
   164  <table class="table table-striped table-borderless" style="border:none">
   165  <thead class="border-bottom">
   166  <tr>
   167  <th>Field</th>
   168  <th>Description</th>
   169  </tr>
   170  </thead>
   171  <tbody class="border-top">
   172  <tr>
   173  <td>
   174  <code>apiVersion</code>
   175  <br>
   176  string</td>
   177  <td>
   178  <code>
   179  projectcontour.io/v1
   180  </code>
   181  </td>
   182  </tr>
   183  <tr>
   184  <td>
   185  <code>kind</code>
   186  <br>
   187  string
   188  </td>
   189  <td><code>TLSCertificateDelegation</code></td>
   190  </tr>
   191  <tr>
   192  <td style="white-space:nowrap">
   193  <code>metadata</code>
   194  <br>
   195  <em>
   196  <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
   197  Kubernetes meta/v1.ObjectMeta
   198  </a>
   199  </em>
   200  </td>
   201  <td>
   202  Refer to the Kubernetes API documentation for the fields of the
   203  <code>metadata</code> field.
   204  </td>
   205  </tr>
   206  <tr>
   207  <td style="white-space:nowrap">
   208  <code>spec</code>
   209  <br>
   210  <em>
   211  <a href="#projectcontour.io/v1.TLSCertificateDelegationSpec">
   212  TLSCertificateDelegationSpec
   213  </a>
   214  </em>
   215  </td>
   216  <td>
   217  <br>
   218  <br>
   219  <table style="border:none">
   220  <tr>
   221  <td style="white-space:nowrap">
   222  <code>delegations</code>
   223  <br>
   224  <em>
   225  <a href="#projectcontour.io/v1.CertificateDelegation">
   226  []CertificateDelegation
   227  </a>
   228  </em>
   229  </td>
   230  <td>
   231  </td>
   232  </tr>
   233  </table>
   234  </td>
   235  </tr>
   236  </tbody>
   237  </table>
   238  <h3 id="projectcontour.io/v1.CertificateDelegation">CertificateDelegation
   239  </h3>
   240  <p>
   241  (<em>Appears on:</em>
   242  <a href="#projectcontour.io/v1.TLSCertificateDelegationSpec">TLSCertificateDelegationSpec</a>)
   243  </p>
   244  <p>
   245  <p>CertificateDelegation maps the authority to reference a secret
   246  in the current namespace to a set of namespaces.</p>
   247  </p>
   248  <table class="table table-striped table-borderless" style="border:none">
   249  <thead class="border-bottom">
   250  <tr>
   251  <th>Field</th>
   252  <th>Description</th>
   253  </tr>
   254  </thead>
   255  <tbody class="border-top">
   256  <tr>
   257  <td style="white-space:nowrap">
   258  <code>secretName</code>
   259  <br>
   260  <em>
   261  string
   262  </em>
   263  </td>
   264  <td>
   265  <p>required, the name of a secret in the current namespace.</p>
   266  </td>
   267  </tr>
   268  <tr>
   269  <td style="white-space:nowrap">
   270  <code>targetNamespaces</code>
   271  <br>
   272  <em>
   273  []string
   274  </em>
   275  </td>
   276  <td>
   277  <p>required, the namespaces the authority to reference the
   278  the secret will be delegated to.
   279  If TargetNamespaces is nil or empty, the CertificateDelegation&rsquo;
   280  is ignored. If the TargetNamespace list contains the character, &ldquo;*&rdquo;
   281  the secret will be delegated to all namespaces.</p>
   282  </td>
   283  </tr>
   284  </tbody>
   285  </table>
   286  <h3 id="projectcontour.io/v1.Condition">Condition
   287  </h3>
   288  <p>
   289  (<em>Appears on:</em>
   290  <a href="#projectcontour.io/v1.Include">Include</a>, 
   291  <a href="#projectcontour.io/v1.Route">Route</a>)
   292  </p>
   293  <p>
   294  <p>Condition are policies that are applied on top of HTTPProxies.
   295  One of Prefix or Header must be provided.</p>
   296  </p>
   297  <table class="table table-striped table-borderless" style="border:none">
   298  <thead class="border-bottom">
   299  <tr>
   300  <th>Field</th>
   301  <th>Description</th>
   302  </tr>
   303  </thead>
   304  <tbody class="border-top">
   305  <tr>
   306  <td style="white-space:nowrap">
   307  <code>prefix</code>
   308  <br>
   309  <em>
   310  string
   311  </em>
   312  </td>
   313  <td>
   314  <em>(Optional)</em>
   315  <p>Prefix defines a prefix match for a request.</p>
   316  </td>
   317  </tr>
   318  <tr>
   319  <td style="white-space:nowrap">
   320  <code>header</code>
   321  <br>
   322  <em>
   323  <a href="#projectcontour.io/v1.HeaderCondition">
   324  HeaderCondition
   325  </a>
   326  </em>
   327  </td>
   328  <td>
   329  <em>(Optional)</em>
   330  <p>Header specifies the header condition to match.</p>
   331  </td>
   332  </tr>
   333  </tbody>
   334  </table>
   335  <h3 id="projectcontour.io/v1.HTTPHealthCheckPolicy">HTTPHealthCheckPolicy
   336  </h3>
   337  <p>
   338  (<em>Appears on:</em>
   339  <a href="#projectcontour.io/v1.Route">Route</a>)
   340  </p>
   341  <p>
   342  <p>HTTPHealthCheckPolicy defines health checks on the upstream service.</p>
   343  </p>
   344  <table class="table table-striped table-borderless" style="border:none">
   345  <thead class="border-bottom">
   346  <tr>
   347  <th>Field</th>
   348  <th>Description</th>
   349  </tr>
   350  </thead>
   351  <tbody class="border-top">
   352  <tr>
   353  <td style="white-space:nowrap">
   354  <code>path</code>
   355  <br>
   356  <em>
   357  string
   358  </em>
   359  </td>
   360  <td>
   361  <p>HTTP endpoint used to perform health checks on upstream service</p>
   362  </td>
   363  </tr>
   364  <tr>
   365  <td style="white-space:nowrap">
   366  <code>host</code>
   367  <br>
   368  <em>
   369  string
   370  </em>
   371  </td>
   372  <td>
   373  <p>The value of the host header in the HTTP health check request.
   374  If left empty (default value), the name &ldquo;contour-envoy-healthcheck&rdquo;
   375  will be used.</p>
   376  </td>
   377  </tr>
   378  <tr>
   379  <td style="white-space:nowrap">
   380  <code>intervalSeconds</code>
   381  <br>
   382  <em>
   383  int64
   384  </em>
   385  </td>
   386  <td>
   387  <em>(Optional)</em>
   388  <p>The interval (seconds) between health checks</p>
   389  </td>
   390  </tr>
   391  <tr>
   392  <td style="white-space:nowrap">
   393  <code>timeoutSeconds</code>
   394  <br>
   395  <em>
   396  int64
   397  </em>
   398  </td>
   399  <td>
   400  <em>(Optional)</em>
   401  <p>The time to wait (seconds) for a health check response</p>
   402  </td>
   403  </tr>
   404  <tr>
   405  <td style="white-space:nowrap">
   406  <code>unhealthyThresholdCount</code>
   407  <br>
   408  <em>
   409  int64
   410  </em>
   411  </td>
   412  <td>
   413  <em>(Optional)</em>
   414  <p>The number of unhealthy health checks required before a host is marked unhealthy</p>
   415  </td>
   416  </tr>
   417  <tr>
   418  <td style="white-space:nowrap">
   419  <code>healthyThresholdCount</code>
   420  <br>
   421  <em>
   422  int64
   423  </em>
   424  </td>
   425  <td>
   426  <em>(Optional)</em>
   427  <p>The number of healthy health checks required before a host is marked healthy</p>
   428  </td>
   429  </tr>
   430  </tbody>
   431  </table>
   432  <h3 id="projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec
   433  </h3>
   434  <p>
   435  (<em>Appears on:</em>
   436  <a href="#projectcontour.io/v1.HTTPProxy">HTTPProxy</a>)
   437  </p>
   438  <p>
   439  <p>HTTPProxySpec defines the spec of the CRD.</p>
   440  </p>
   441  <table class="table table-striped table-borderless" style="border:none">
   442  <thead class="border-bottom">
   443  <tr>
   444  <th>Field</th>
   445  <th>Description</th>
   446  </tr>
   447  </thead>
   448  <tbody class="border-top">
   449  <tr>
   450  <td style="white-space:nowrap">
   451  <code>virtualhost</code>
   452  <br>
   453  <em>
   454  <a href="#projectcontour.io/v1.VirtualHost">
   455  VirtualHost
   456  </a>
   457  </em>
   458  </td>
   459  <td>
   460  <em>(Optional)</em>
   461  <p>Virtualhost appears at most once. If it is present, the object is considered
   462  to be a &ldquo;root&rdquo;.</p>
   463  </td>
   464  </tr>
   465  <tr>
   466  <td style="white-space:nowrap">
   467  <code>routes</code>
   468  <br>
   469  <em>
   470  <a href="#projectcontour.io/v1.Route">
   471  []Route
   472  </a>
   473  </em>
   474  </td>
   475  <td>
   476  <em>(Optional)</em>
   477  <p>Routes are the ingress routes. If TCPProxy is present, Routes is ignored.</p>
   478  </td>
   479  </tr>
   480  <tr>
   481  <td style="white-space:nowrap">
   482  <code>tcpproxy</code>
   483  <br>
   484  <em>
   485  <a href="#projectcontour.io/v1.TCPProxy">
   486  TCPProxy
   487  </a>
   488  </em>
   489  </td>
   490  <td>
   491  <em>(Optional)</em>
   492  <p>TCPProxy holds TCP proxy information.</p>
   493  </td>
   494  </tr>
   495  <tr>
   496  <td style="white-space:nowrap">
   497  <code>includes</code>
   498  <br>
   499  <em>
   500  <a href="#projectcontour.io/v1.Include">
   501  []Include
   502  </a>
   503  </em>
   504  </td>
   505  <td>
   506  <em>(Optional)</em>
   507  <p>Includes allow for specific routing configuration to be appended to another HTTPProxy in another namespace.</p>
   508  </td>
   509  </tr>
   510  </tbody>
   511  </table>
   512  <h3 id="projectcontour.io/v1.HeaderCondition">HeaderCondition
   513  </h3>
   514  <p>
   515  (<em>Appears on:</em>
   516  <a href="#projectcontour.io/v1.Condition">Condition</a>)
   517  </p>
   518  <p>
   519  <p>HeaderCondition specifies how to conditionally match against HTTP
   520  headers. The Name field is required, but only one of the remaining
   521  fields should be be provided.</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>name</code>
   534  <br>
   535  <em>
   536  string
   537  </em>
   538  </td>
   539  <td>
   540  <p>Name is the name of the header to match against. Name is required.
   541  Header names are case insensitive.</p>
   542  </td>
   543  </tr>
   544  <tr>
   545  <td style="white-space:nowrap">
   546  <code>present</code>
   547  <br>
   548  <em>
   549  bool
   550  </em>
   551  </td>
   552  <td>
   553  <em>(Optional)</em>
   554  <p>Present specifies that condition is true when the named header
   555  is present, regardless of its value. Note that setting Present
   556  to false does not make the condition true if the named header
   557  is absent.</p>
   558  </td>
   559  </tr>
   560  <tr>
   561  <td style="white-space:nowrap">
   562  <code>contains</code>
   563  <br>
   564  <em>
   565  string
   566  </em>
   567  </td>
   568  <td>
   569  <em>(Optional)</em>
   570  <p>Contains specifies a substring that must be present in
   571  the header value.</p>
   572  </td>
   573  </tr>
   574  <tr>
   575  <td style="white-space:nowrap">
   576  <code>notcontains</code>
   577  <br>
   578  <em>
   579  string
   580  </em>
   581  </td>
   582  <td>
   583  <em>(Optional)</em>
   584  <p>NotContains specifies a substring that must not be present
   585  in the header value.</p>
   586  </td>
   587  </tr>
   588  <tr>
   589  <td style="white-space:nowrap">
   590  <code>exact</code>
   591  <br>
   592  <em>
   593  string
   594  </em>
   595  </td>
   596  <td>
   597  <em>(Optional)</em>
   598  <p>Exact specifies a string that the header value must be equal to.</p>
   599  </td>
   600  </tr>
   601  <tr>
   602  <td style="white-space:nowrap">
   603  <code>notexact</code>
   604  <br>
   605  <em>
   606  string
   607  </em>
   608  </td>
   609  <td>
   610  <em>(Optional)</em>
   611  <p>NoExact specifies a string that the header value must not be
   612  equal to. The condition is true if the header has any other value.</p>
   613  </td>
   614  </tr>
   615  </tbody>
   616  </table>
   617  <h3 id="projectcontour.io/v1.HeaderValue">HeaderValue
   618  </h3>
   619  <p>
   620  (<em>Appears on:</em>
   621  <a href="#projectcontour.io/v1.HeadersPolicy">HeadersPolicy</a>)
   622  </p>
   623  <p>
   624  <p>HeaderValue represents a header name/value pair</p>
   625  </p>
   626  <table class="table table-striped table-borderless" style="border:none">
   627  <thead class="border-bottom">
   628  <tr>
   629  <th>Field</th>
   630  <th>Description</th>
   631  </tr>
   632  </thead>
   633  <tbody class="border-top">
   634  <tr>
   635  <td style="white-space:nowrap">
   636  <code>name</code>
   637  <br>
   638  <em>
   639  string
   640  </em>
   641  </td>
   642  <td>
   643  <p>Name represents a key of a header</p>
   644  </td>
   645  </tr>
   646  <tr>
   647  <td style="white-space:nowrap">
   648  <code>value</code>
   649  <br>
   650  <em>
   651  string
   652  </em>
   653  </td>
   654  <td>
   655  <p>Value represents the value of a header specified by a key</p>
   656  </td>
   657  </tr>
   658  </tbody>
   659  </table>
   660  <h3 id="projectcontour.io/v1.HeadersPolicy">HeadersPolicy
   661  </h3>
   662  <p>
   663  (<em>Appears on:</em>
   664  <a href="#projectcontour.io/v1.Route">Route</a>, 
   665  <a href="#projectcontour.io/v1.Service">Service</a>)
   666  </p>
   667  <p>
   668  <p>HeadersPolicy defines how headers are managed during forwarding</p>
   669  </p>
   670  <table class="table table-striped table-borderless" style="border:none">
   671  <thead class="border-bottom">
   672  <tr>
   673  <th>Field</th>
   674  <th>Description</th>
   675  </tr>
   676  </thead>
   677  <tbody class="border-top">
   678  <tr>
   679  <td style="white-space:nowrap">
   680  <code>set</code>
   681  <br>
   682  <em>
   683  <a href="#projectcontour.io/v1.HeaderValue">
   684  []HeaderValue
   685  </a>
   686  </em>
   687  </td>
   688  <td>
   689  <em>(Optional)</em>
   690  <p>Set specifies a list of HTTP header values that will be set in the HTTP header</p>
   691  </td>
   692  </tr>
   693  <tr>
   694  <td style="white-space:nowrap">
   695  <code>remove</code>
   696  <br>
   697  <em>
   698  []string
   699  </em>
   700  </td>
   701  <td>
   702  <em>(Optional)</em>
   703  <p>Remove specifies a list of HTTP header names to remove</p>
   704  </td>
   705  </tr>
   706  </tbody>
   707  </table>
   708  <h3 id="projectcontour.io/v1.Include">Include
   709  </h3>
   710  <p>
   711  (<em>Appears on:</em>
   712  <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>)
   713  </p>
   714  <p>
   715  <p>Include describes a set of policies that can be applied to an HTTPProxy in a namespace.</p>
   716  </p>
   717  <table class="table table-striped table-borderless" style="border:none">
   718  <thead class="border-bottom">
   719  <tr>
   720  <th>Field</th>
   721  <th>Description</th>
   722  </tr>
   723  </thead>
   724  <tbody class="border-top">
   725  <tr>
   726  <td style="white-space:nowrap">
   727  <code>name</code>
   728  <br>
   729  <em>
   730  string
   731  </em>
   732  </td>
   733  <td>
   734  <p>Name of the HTTPProxy</p>
   735  </td>
   736  </tr>
   737  <tr>
   738  <td style="white-space:nowrap">
   739  <code>namespace</code>
   740  <br>
   741  <em>
   742  string
   743  </em>
   744  </td>
   745  <td>
   746  <em>(Optional)</em>
   747  <p>Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.</p>
   748  </td>
   749  </tr>
   750  <tr>
   751  <td style="white-space:nowrap">
   752  <code>conditions</code>
   753  <br>
   754  <em>
   755  <a href="#projectcontour.io/v1.Condition">
   756  []Condition
   757  </a>
   758  </em>
   759  </td>
   760  <td>
   761  <em>(Optional)</em>
   762  <p>Conditions are a set of routing properties that is applied to an HTTPProxy in a namespace.</p>
   763  </td>
   764  </tr>
   765  </tbody>
   766  </table>
   767  <h3 id="projectcontour.io/v1.LoadBalancerPolicy">LoadBalancerPolicy
   768  </h3>
   769  <p>
   770  (<em>Appears on:</em>
   771  <a href="#projectcontour.io/v1.Route">Route</a>, 
   772  <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>)
   773  </p>
   774  <p>
   775  <p>LoadBalancerPolicy defines the load balancing policy.</p>
   776  </p>
   777  <table class="table table-striped table-borderless" style="border:none">
   778  <thead class="border-bottom">
   779  <tr>
   780  <th>Field</th>
   781  <th>Description</th>
   782  </tr>
   783  </thead>
   784  <tbody class="border-top">
   785  <tr>
   786  <td style="white-space:nowrap">
   787  <code>strategy</code>
   788  <br>
   789  <em>
   790  string
   791  </em>
   792  </td>
   793  <td>
   794  <p>Strategy specifies the policy used to balance requests
   795  across the pool of backend pods. Valid policy names are
   796  <code>Random</code>, <code>RoundRobin</code>, <code>WeightedLeastRequest</code>, <code>Random</code>
   797  and <code>Cookie</code>. If an unknown strategy name is specified
   798  or no policy is supplied, the default <code>RoundRobin</code> policy
   799  is used.</p>
   800  </td>
   801  </tr>
   802  </tbody>
   803  </table>
   804  <h3 id="projectcontour.io/v1.PathRewritePolicy">PathRewritePolicy
   805  </h3>
   806  <p>
   807  (<em>Appears on:</em>
   808  <a href="#projectcontour.io/v1.Route">Route</a>)
   809  </p>
   810  <p>
   811  <p>PathRewritePolicy specifies how a request URL path should be
   812  rewritten. This rewriting takes place after a request is routed
   813  and has no subsequent effects on the proxy&rsquo;s routing decision.
   814  No HTTP headers or body content is rewritten.</p>
   815  <p>Exactly one field in this struct may be specified.</p>
   816  </p>
   817  <table class="table table-striped table-borderless" style="border:none">
   818  <thead class="border-bottom">
   819  <tr>
   820  <th>Field</th>
   821  <th>Description</th>
   822  </tr>
   823  </thead>
   824  <tbody class="border-top">
   825  <tr>
   826  <td style="white-space:nowrap">
   827  <code>replacePrefix</code>
   828  <br>
   829  <em>
   830  <a href="#projectcontour.io/v1.ReplacePrefix">
   831  []ReplacePrefix
   832  </a>
   833  </em>
   834  </td>
   835  <td>
   836  <em>(Optional)</em>
   837  <p>ReplacePrefix describes how the path prefix should be replaced.</p>
   838  </td>
   839  </tr>
   840  </tbody>
   841  </table>
   842  <h3 id="projectcontour.io/v1.ReplacePrefix">ReplacePrefix
   843  </h3>
   844  <p>
   845  (<em>Appears on:</em>
   846  <a href="#projectcontour.io/v1.PathRewritePolicy">PathRewritePolicy</a>)
   847  </p>
   848  <p>
   849  <p>ReplacePrefix describes a path prefix replacement.</p>
   850  </p>
   851  <table class="table table-striped table-borderless" style="border:none">
   852  <thead class="border-bottom">
   853  <tr>
   854  <th>Field</th>
   855  <th>Description</th>
   856  </tr>
   857  </thead>
   858  <tbody class="border-top">
   859  <tr>
   860  <td style="white-space:nowrap">
   861  <code>prefix</code>
   862  <br>
   863  <em>
   864  string
   865  </em>
   866  </td>
   867  <td>
   868  <em>(Optional)</em>
   869  <p>Prefix specifies the URL path prefix to be replaced.</p>
   870  <p>If Prefix is specified, it must exactly match the Condition
   871  prefix that is rendered by the chain of including HTTPProxies
   872  and only that path prefix will be replaced by Replacement.
   873  This allows HTTPProxies that are included through multiple
   874  roots to only replace specific path prefixes, leaving others
   875  unmodified.</p>
   876  <p>If Prefix is not specified, all routing prefixes rendered
   877  by the include chain will be replaced.</p>
   878  </td>
   879  </tr>
   880  <tr>
   881  <td style="white-space:nowrap">
   882  <code>replacement</code>
   883  <br>
   884  <em>
   885  string
   886  </em>
   887  </td>
   888  <td>
   889  <p>Replacement is the string that the routing path prefix
   890  will be replaced with. This must not be empty.</p>
   891  </td>
   892  </tr>
   893  </tbody>
   894  </table>
   895  <h3 id="projectcontour.io/v1.RetryPolicy">RetryPolicy
   896  </h3>
   897  <p>
   898  (<em>Appears on:</em>
   899  <a href="#projectcontour.io/v1.Route">Route</a>)
   900  </p>
   901  <p>
   902  <p>RetryPolicy defines the attributes associated with retrying policy.</p>
   903  </p>
   904  <table class="table table-striped table-borderless" style="border:none">
   905  <thead class="border-bottom">
   906  <tr>
   907  <th>Field</th>
   908  <th>Description</th>
   909  </tr>
   910  </thead>
   911  <tbody class="border-top">
   912  <tr>
   913  <td style="white-space:nowrap">
   914  <code>count</code>
   915  <br>
   916  <em>
   917  int64
   918  </em>
   919  </td>
   920  <td>
   921  <em>(Optional)</em>
   922  <p>NumRetries is maximum allowed number of retries.
   923  If not supplied, the number of retries is one.</p>
   924  </td>
   925  </tr>
   926  <tr>
   927  <td style="white-space:nowrap">
   928  <code>perTryTimeout</code>
   929  <br>
   930  <em>
   931  string
   932  </em>
   933  </td>
   934  <td>
   935  <p>PerTryTimeout specifies the timeout per retry attempt.
   936  Ignored if NumRetries is not supplied.</p>
   937  </td>
   938  </tr>
   939  </tbody>
   940  </table>
   941  <h3 id="projectcontour.io/v1.Route">Route
   942  </h3>
   943  <p>
   944  (<em>Appears on:</em>
   945  <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>)
   946  </p>
   947  <p>
   948  <p>Route contains the set of routes for a virtual host.</p>
   949  </p>
   950  <table class="table table-striped table-borderless" style="border:none">
   951  <thead class="border-bottom">
   952  <tr>
   953  <th>Field</th>
   954  <th>Description</th>
   955  </tr>
   956  </thead>
   957  <tbody class="border-top">
   958  <tr>
   959  <td style="white-space:nowrap">
   960  <code>conditions</code>
   961  <br>
   962  <em>
   963  <a href="#projectcontour.io/v1.Condition">
   964  []Condition
   965  </a>
   966  </em>
   967  </td>
   968  <td>
   969  <em>(Optional)</em>
   970  <p>Conditions are a set of routing properties that is applied to an HTTPProxy in a namespace.</p>
   971  </td>
   972  </tr>
   973  <tr>
   974  <td style="white-space:nowrap">
   975  <code>services</code>
   976  <br>
   977  <em>
   978  <a href="#projectcontour.io/v1.Service">
   979  []Service
   980  </a>
   981  </em>
   982  </td>
   983  <td>
   984  <p>Services are the services to proxy traffic.</p>
   985  </td>
   986  </tr>
   987  <tr>
   988  <td style="white-space:nowrap">
   989  <code>enableWebsockets</code>
   990  <br>
   991  <em>
   992  bool
   993  </em>
   994  </td>
   995  <td>
   996  <em>(Optional)</em>
   997  <p>Enables websocket support for the route.</p>
   998  </td>
   999  </tr>
  1000  <tr>
  1001  <td style="white-space:nowrap">
  1002  <code>permitInsecure</code>
  1003  <br>
  1004  <em>
  1005  bool
  1006  </em>
  1007  </td>
  1008  <td>
  1009  <em>(Optional)</em>
  1010  <p>Allow this path to respond to insecure requests over HTTP which are normally
  1011  not permitted when a <code>virtualhost.tls</code> block is present.</p>
  1012  </td>
  1013  </tr>
  1014  <tr>
  1015  <td style="white-space:nowrap">
  1016  <code>timeoutPolicy</code>
  1017  <br>
  1018  <em>
  1019  <a href="#projectcontour.io/v1.TimeoutPolicy">
  1020  TimeoutPolicy
  1021  </a>
  1022  </em>
  1023  </td>
  1024  <td>
  1025  <em>(Optional)</em>
  1026  <p>The timeout policy for this route.</p>
  1027  </td>
  1028  </tr>
  1029  <tr>
  1030  <td style="white-space:nowrap">
  1031  <code>retryPolicy</code>
  1032  <br>
  1033  <em>
  1034  <a href="#projectcontour.io/v1.RetryPolicy">
  1035  RetryPolicy
  1036  </a>
  1037  </em>
  1038  </td>
  1039  <td>
  1040  <em>(Optional)</em>
  1041  <p>The retry policy for this route.</p>
  1042  </td>
  1043  </tr>
  1044  <tr>
  1045  <td style="white-space:nowrap">
  1046  <code>healthCheckPolicy</code>
  1047  <br>
  1048  <em>
  1049  <a href="#projectcontour.io/v1.HTTPHealthCheckPolicy">
  1050  HTTPHealthCheckPolicy
  1051  </a>
  1052  </em>
  1053  </td>
  1054  <td>
  1055  <em>(Optional)</em>
  1056  <p>The health check policy for this route.</p>
  1057  </td>
  1058  </tr>
  1059  <tr>
  1060  <td style="white-space:nowrap">
  1061  <code>loadBalancerPolicy</code>
  1062  <br>
  1063  <em>
  1064  <a href="#projectcontour.io/v1.LoadBalancerPolicy">
  1065  LoadBalancerPolicy
  1066  </a>
  1067  </em>
  1068  </td>
  1069  <td>
  1070  <em>(Optional)</em>
  1071  <p>The load balancing policy for this route.</p>
  1072  </td>
  1073  </tr>
  1074  <tr>
  1075  <td style="white-space:nowrap">
  1076  <code>pathRewritePolicy</code>
  1077  <br>
  1078  <em>
  1079  <a href="#projectcontour.io/v1.PathRewritePolicy">
  1080  PathRewritePolicy
  1081  </a>
  1082  </em>
  1083  </td>
  1084  <td>
  1085  <em>(Optional)</em>
  1086  <p>The policy for rewriting the path of the request URL
  1087  after the request has been routed to a Service.</p>
  1088  </td>
  1089  </tr>
  1090  <tr>
  1091  <td style="white-space:nowrap">
  1092  <code>requestHeadersPolicy</code>
  1093  <br>
  1094  <em>
  1095  <a href="#projectcontour.io/v1.HeadersPolicy">
  1096  HeadersPolicy
  1097  </a>
  1098  </em>
  1099  </td>
  1100  <td>
  1101  <em>(Optional)</em>
  1102  <p>The policy for managing request headers during proxying</p>
  1103  </td>
  1104  </tr>
  1105  <tr>
  1106  <td style="white-space:nowrap">
  1107  <code>responseHeadersPolicy</code>
  1108  <br>
  1109  <em>
  1110  <a href="#projectcontour.io/v1.HeadersPolicy">
  1111  HeadersPolicy
  1112  </a>
  1113  </em>
  1114  </td>
  1115  <td>
  1116  <em>(Optional)</em>
  1117  <p>The policy for managing response headers during proxying</p>
  1118  </td>
  1119  </tr>
  1120  </tbody>
  1121  </table>
  1122  <h3 id="projectcontour.io/v1.Service">Service
  1123  </h3>
  1124  <p>
  1125  (<em>Appears on:</em>
  1126  <a href="#projectcontour.io/v1.Route">Route</a>, 
  1127  <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>)
  1128  </p>
  1129  <p>
  1130  <p>Service defines an Kubernetes Service to proxy traffic.</p>
  1131  </p>
  1132  <table class="table table-striped table-borderless" style="border:none">
  1133  <thead class="border-bottom">
  1134  <tr>
  1135  <th>Field</th>
  1136  <th>Description</th>
  1137  </tr>
  1138  </thead>
  1139  <tbody class="border-top">
  1140  <tr>
  1141  <td style="white-space:nowrap">
  1142  <code>name</code>
  1143  <br>
  1144  <em>
  1145  string
  1146  </em>
  1147  </td>
  1148  <td>
  1149  <p>Name is the name of Kubernetes service to proxy traffic.
  1150  Names defined here will be used to look up corresponding endpoints which contain the ips to route.</p>
  1151  </td>
  1152  </tr>
  1153  <tr>
  1154  <td style="white-space:nowrap">
  1155  <code>port</code>
  1156  <br>
  1157  <em>
  1158  int
  1159  </em>
  1160  </td>
  1161  <td>
  1162  <p>Port (defined as Integer) to proxy traffic to since a service can have multiple defined.</p>
  1163  </td>
  1164  </tr>
  1165  <tr>
  1166  <td style="white-space:nowrap">
  1167  <code>protocol</code>
  1168  <br>
  1169  <em>
  1170  string
  1171  </em>
  1172  </td>
  1173  <td>
  1174  <em>(Optional)</em>
  1175  <p>Protocol may be used to specify (or override) the protocol used to reach this Service.
  1176  Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.</p>
  1177  </td>
  1178  </tr>
  1179  <tr>
  1180  <td style="white-space:nowrap">
  1181  <code>weight</code>
  1182  <br>
  1183  <em>
  1184  int64
  1185  </em>
  1186  </td>
  1187  <td>
  1188  <em>(Optional)</em>
  1189  <p>Weight defines percentage of traffic to balance traffic</p>
  1190  </td>
  1191  </tr>
  1192  <tr>
  1193  <td style="white-space:nowrap">
  1194  <code>validation</code>
  1195  <br>
  1196  <em>
  1197  <a href="#projectcontour.io/v1.UpstreamValidation">
  1198  UpstreamValidation
  1199  </a>
  1200  </em>
  1201  </td>
  1202  <td>
  1203  <em>(Optional)</em>
  1204  <p>UpstreamValidation defines how to verify the backend service&rsquo;s certificate</p>
  1205  </td>
  1206  </tr>
  1207  <tr>
  1208  <td style="white-space:nowrap">
  1209  <code>mirror</code>
  1210  <br>
  1211  <em>
  1212  bool
  1213  </em>
  1214  </td>
  1215  <td>
  1216  <p>If Mirror is true the Service will receive a read only mirror of the traffic for this route.</p>
  1217  </td>
  1218  </tr>
  1219  <tr>
  1220  <td style="white-space:nowrap">
  1221  <code>requestHeadersPolicy</code>
  1222  <br>
  1223  <em>
  1224  <a href="#projectcontour.io/v1.HeadersPolicy">
  1225  HeadersPolicy
  1226  </a>
  1227  </em>
  1228  </td>
  1229  <td>
  1230  <em>(Optional)</em>
  1231  <p>The policy for managing request headers during proxying</p>
  1232  </td>
  1233  </tr>
  1234  <tr>
  1235  <td style="white-space:nowrap">
  1236  <code>responseHeadersPolicy</code>
  1237  <br>
  1238  <em>
  1239  <a href="#projectcontour.io/v1.HeadersPolicy">
  1240  HeadersPolicy
  1241  </a>
  1242  </em>
  1243  </td>
  1244  <td>
  1245  <em>(Optional)</em>
  1246  <p>The policy for managing response headers during proxying</p>
  1247  </td>
  1248  </tr>
  1249  </tbody>
  1250  </table>
  1251  <h3 id="projectcontour.io/v1.Status">Status
  1252  </h3>
  1253  <p>
  1254  (<em>Appears on:</em>
  1255  <a href="#projectcontour.io/v1.HTTPProxy">HTTPProxy</a>)
  1256  </p>
  1257  <p>
  1258  <p>Status reports the current state of the HTTPProxy.</p>
  1259  </p>
  1260  <table class="table table-striped table-borderless" style="border:none">
  1261  <thead class="border-bottom">
  1262  <tr>
  1263  <th>Field</th>
  1264  <th>Description</th>
  1265  </tr>
  1266  </thead>
  1267  <tbody class="border-top">
  1268  <tr>
  1269  <td style="white-space:nowrap">
  1270  <code>currentStatus</code>
  1271  <br>
  1272  <em>
  1273  string
  1274  </em>
  1275  </td>
  1276  <td>
  1277  <em>(Optional)</em>
  1278  </td>
  1279  </tr>
  1280  <tr>
  1281  <td style="white-space:nowrap">
  1282  <code>description</code>
  1283  <br>
  1284  <em>
  1285  string
  1286  </em>
  1287  </td>
  1288  <td>
  1289  <em>(Optional)</em>
  1290  </td>
  1291  </tr>
  1292  </tbody>
  1293  </table>
  1294  <h3 id="projectcontour.io/v1.TCPHealthCheckPolicy">TCPHealthCheckPolicy
  1295  </h3>
  1296  <p>
  1297  (<em>Appears on:</em>
  1298  <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>)
  1299  </p>
  1300  <p>
  1301  <p>TCPHealthCheckPolicy defines health checks on the upstream service.</p>
  1302  </p>
  1303  <table class="table table-striped table-borderless" style="border:none">
  1304  <thead class="border-bottom">
  1305  <tr>
  1306  <th>Field</th>
  1307  <th>Description</th>
  1308  </tr>
  1309  </thead>
  1310  <tbody class="border-top">
  1311  <tr>
  1312  <td style="white-space:nowrap">
  1313  <code>intervalSeconds</code>
  1314  <br>
  1315  <em>
  1316  int64
  1317  </em>
  1318  </td>
  1319  <td>
  1320  <em>(Optional)</em>
  1321  <p>The interval (seconds) between health checks</p>
  1322  </td>
  1323  </tr>
  1324  <tr>
  1325  <td style="white-space:nowrap">
  1326  <code>timeoutSeconds</code>
  1327  <br>
  1328  <em>
  1329  int64
  1330  </em>
  1331  </td>
  1332  <td>
  1333  <em>(Optional)</em>
  1334  <p>The time to wait (seconds) for a health check response</p>
  1335  </td>
  1336  </tr>
  1337  <tr>
  1338  <td style="white-space:nowrap">
  1339  <code>unhealthyThresholdCount</code>
  1340  <br>
  1341  <em>
  1342  uint32
  1343  </em>
  1344  </td>
  1345  <td>
  1346  <em>(Optional)</em>
  1347  <p>The number of unhealthy health checks required before a host is marked unhealthy</p>
  1348  </td>
  1349  </tr>
  1350  <tr>
  1351  <td style="white-space:nowrap">
  1352  <code>healthyThresholdCount</code>
  1353  <br>
  1354  <em>
  1355  uint32
  1356  </em>
  1357  </td>
  1358  <td>
  1359  <em>(Optional)</em>
  1360  <p>The number of healthy health checks required before a host is marked healthy</p>
  1361  </td>
  1362  </tr>
  1363  </tbody>
  1364  </table>
  1365  <h3 id="projectcontour.io/v1.TCPProxy">TCPProxy
  1366  </h3>
  1367  <p>
  1368  (<em>Appears on:</em>
  1369  <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>)
  1370  </p>
  1371  <p>
  1372  <p>TCPProxy contains the set of services to proxy TCP connections.</p>
  1373  </p>
  1374  <table class="table table-striped table-borderless" style="border:none">
  1375  <thead class="border-bottom">
  1376  <tr>
  1377  <th>Field</th>
  1378  <th>Description</th>
  1379  </tr>
  1380  </thead>
  1381  <tbody class="border-top">
  1382  <tr>
  1383  <td style="white-space:nowrap">
  1384  <code>loadBalancerPolicy</code>
  1385  <br>
  1386  <em>
  1387  <a href="#projectcontour.io/v1.LoadBalancerPolicy">
  1388  LoadBalancerPolicy
  1389  </a>
  1390  </em>
  1391  </td>
  1392  <td>
  1393  <em>(Optional)</em>
  1394  <p>The load balancing policy for the backend services.</p>
  1395  </td>
  1396  </tr>
  1397  <tr>
  1398  <td style="white-space:nowrap">
  1399  <code>services</code>
  1400  <br>
  1401  <em>
  1402  <a href="#projectcontour.io/v1.Service">
  1403  []Service
  1404  </a>
  1405  </em>
  1406  </td>
  1407  <td>
  1408  <p>Services are the services to proxy traffic</p>
  1409  </td>
  1410  </tr>
  1411  <tr>
  1412  <td style="white-space:nowrap">
  1413  <code>include</code>
  1414  <br>
  1415  <em>
  1416  <a href="#projectcontour.io/v1.TCPProxyInclude">
  1417  TCPProxyInclude
  1418  </a>
  1419  </em>
  1420  </td>
  1421  <td>
  1422  <em>(Optional)</em>
  1423  <p>Include specifies that this tcpproxy should be delegated to another HTTPProxy.</p>
  1424  </td>
  1425  </tr>
  1426  <tr>
  1427  <td style="white-space:nowrap">
  1428  <code>includes</code>
  1429  <br>
  1430  <em>
  1431  <a href="#projectcontour.io/v1.TCPProxyInclude">
  1432  TCPProxyInclude
  1433  </a>
  1434  </em>
  1435  </td>
  1436  <td>
  1437  <em>(Optional)</em>
  1438  <p>IncludesDeprecated allow for specific routing configuration to be appended to another HTTPProxy in another namespace.</p>
  1439  <p>Exists due to a mistake when developing HTTPProxy and the field was marked plural
  1440  when it should have been singular. This field should stay to not break backwards compatibility to v1 users.</p>
  1441  </td>
  1442  </tr>
  1443  <tr>
  1444  <td style="white-space:nowrap">
  1445  <code>healthCheckPolicy</code>
  1446  <br>
  1447  <em>
  1448  <a href="#projectcontour.io/v1.TCPHealthCheckPolicy">
  1449  TCPHealthCheckPolicy
  1450  </a>
  1451  </em>
  1452  </td>
  1453  <td>
  1454  <em>(Optional)</em>
  1455  <p>The health check policy for this tcp proxy</p>
  1456  </td>
  1457  </tr>
  1458  </tbody>
  1459  </table>
  1460  <h3 id="projectcontour.io/v1.TCPProxyInclude">TCPProxyInclude
  1461  </h3>
  1462  <p>
  1463  (<em>Appears on:</em>
  1464  <a href="#projectcontour.io/v1.TCPProxy">TCPProxy</a>)
  1465  </p>
  1466  <p>
  1467  <p>TCPProxyInclude describes a target HTTPProxy document which contains the TCPProxy details.</p>
  1468  </p>
  1469  <table class="table table-striped table-borderless" style="border:none">
  1470  <thead class="border-bottom">
  1471  <tr>
  1472  <th>Field</th>
  1473  <th>Description</th>
  1474  </tr>
  1475  </thead>
  1476  <tbody class="border-top">
  1477  <tr>
  1478  <td style="white-space:nowrap">
  1479  <code>name</code>
  1480  <br>
  1481  <em>
  1482  string
  1483  </em>
  1484  </td>
  1485  <td>
  1486  <p>Name of the child HTTPProxy</p>
  1487  </td>
  1488  </tr>
  1489  <tr>
  1490  <td style="white-space:nowrap">
  1491  <code>namespace</code>
  1492  <br>
  1493  <em>
  1494  string
  1495  </em>
  1496  </td>
  1497  <td>
  1498  <em>(Optional)</em>
  1499  <p>Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.</p>
  1500  </td>
  1501  </tr>
  1502  </tbody>
  1503  </table>
  1504  <h3 id="projectcontour.io/v1.TLS">TLS
  1505  </h3>
  1506  <p>
  1507  (<em>Appears on:</em>
  1508  <a href="#projectcontour.io/v1.VirtualHost">VirtualHost</a>)
  1509  </p>
  1510  <p>
  1511  <p>TLS describes tls properties. The SNI names that will be matched on
  1512  are described in fqdn, the tls.secretName secret must contain a
  1513  matching certificate unless tls.passthrough is set to true.</p>
  1514  </p>
  1515  <table class="table table-striped table-borderless" style="border:none">
  1516  <thead class="border-bottom">
  1517  <tr>
  1518  <th>Field</th>
  1519  <th>Description</th>
  1520  </tr>
  1521  </thead>
  1522  <tbody class="border-top">
  1523  <tr>
  1524  <td style="white-space:nowrap">
  1525  <code>secretName</code>
  1526  <br>
  1527  <em>
  1528  string
  1529  </em>
  1530  </td>
  1531  <td>
  1532  <p>required, the name of a secret in the current namespace</p>
  1533  </td>
  1534  </tr>
  1535  <tr>
  1536  <td style="white-space:nowrap">
  1537  <code>minimumProtocolVersion</code>
  1538  <br>
  1539  <em>
  1540  string
  1541  </em>
  1542  </td>
  1543  <td>
  1544  <em>(Optional)</em>
  1545  <p>Minimum TLS version this vhost should negotiate</p>
  1546  </td>
  1547  </tr>
  1548  <tr>
  1549  <td style="white-space:nowrap">
  1550  <code>passthrough</code>
  1551  <br>
  1552  <em>
  1553  bool
  1554  </em>
  1555  </td>
  1556  <td>
  1557  <em>(Optional)</em>
  1558  <p>If Passthrough is set to true, the SecretName will be ignored
  1559  and the encrypted handshake will be passed through to the
  1560  backing cluster.</p>
  1561  </td>
  1562  </tr>
  1563  </tbody>
  1564  </table>
  1565  <h3 id="projectcontour.io/v1.TLSCertificateDelegationSpec">TLSCertificateDelegationSpec
  1566  </h3>
  1567  <p>
  1568  (<em>Appears on:</em>
  1569  <a href="#projectcontour.io/v1.TLSCertificateDelegation">TLSCertificateDelegation</a>)
  1570  </p>
  1571  <p>
  1572  <p>TLSCertificateDelegationSpec defines the spec of the CRD</p>
  1573  </p>
  1574  <table class="table table-striped table-borderless" style="border:none">
  1575  <thead class="border-bottom">
  1576  <tr>
  1577  <th>Field</th>
  1578  <th>Description</th>
  1579  </tr>
  1580  </thead>
  1581  <tbody class="border-top">
  1582  <tr>
  1583  <td style="white-space:nowrap">
  1584  <code>delegations</code>
  1585  <br>
  1586  <em>
  1587  <a href="#projectcontour.io/v1.CertificateDelegation">
  1588  []CertificateDelegation
  1589  </a>
  1590  </em>
  1591  </td>
  1592  <td>
  1593  </td>
  1594  </tr>
  1595  </tbody>
  1596  </table>
  1597  <h3 id="projectcontour.io/v1.TimeoutPolicy">TimeoutPolicy
  1598  </h3>
  1599  <p>
  1600  (<em>Appears on:</em>
  1601  <a href="#projectcontour.io/v1.Route">Route</a>)
  1602  </p>
  1603  <p>
  1604  <p>TimeoutPolicy defines the attributes associated with timeout.</p>
  1605  </p>
  1606  <table class="table table-striped table-borderless" style="border:none">
  1607  <thead class="border-bottom">
  1608  <tr>
  1609  <th>Field</th>
  1610  <th>Description</th>
  1611  </tr>
  1612  </thead>
  1613  <tbody class="border-top">
  1614  <tr>
  1615  <td style="white-space:nowrap">
  1616  <code>response</code>
  1617  <br>
  1618  <em>
  1619  string
  1620  </em>
  1621  </td>
  1622  <td>
  1623  <em>(Optional)</em>
  1624  <p>Timeout for receiving a response from the server after processing a request from client.
  1625  If not supplied the timeout duration is undefined.</p>
  1626  </td>
  1627  </tr>
  1628  <tr>
  1629  <td style="white-space:nowrap">
  1630  <code>idle</code>
  1631  <br>
  1632  <em>
  1633  string
  1634  </em>
  1635  </td>
  1636  <td>
  1637  <em>(Optional)</em>
  1638  <p>Timeout after which if there are no active requests for this route, the connection between
  1639  Envoy and the backend will be closed. If not specified, there is no per-route idle timeout.</p>
  1640  </td>
  1641  </tr>
  1642  </tbody>
  1643  </table>
  1644  <h3 id="projectcontour.io/v1.UpstreamValidation">UpstreamValidation
  1645  </h3>
  1646  <p>
  1647  (<em>Appears on:</em>
  1648  <a href="#projectcontour.io/v1.Service">Service</a>)
  1649  </p>
  1650  <p>
  1651  <p>UpstreamValidation defines how to verify the backend service&rsquo;s certificate</p>
  1652  </p>
  1653  <table class="table table-striped table-borderless" style="border:none">
  1654  <thead class="border-bottom">
  1655  <tr>
  1656  <th>Field</th>
  1657  <th>Description</th>
  1658  </tr>
  1659  </thead>
  1660  <tbody class="border-top">
  1661  <tr>
  1662  <td style="white-space:nowrap">
  1663  <code>caSecret</code>
  1664  <br>
  1665  <em>
  1666  string
  1667  </em>
  1668  </td>
  1669  <td>
  1670  <p>Name of the Kubernetes secret be used to validate the certificate presented by the backend</p>
  1671  </td>
  1672  </tr>
  1673  <tr>
  1674  <td style="white-space:nowrap">
  1675  <code>subjectName</code>
  1676  <br>
  1677  <em>
  1678  string
  1679  </em>
  1680  </td>
  1681  <td>
  1682  <p>Key which is expected to be present in the &lsquo;subjectAltName&rsquo; of the presented certificate</p>
  1683  </td>
  1684  </tr>
  1685  </tbody>
  1686  </table>
  1687  <h3 id="projectcontour.io/v1.VirtualHost">VirtualHost
  1688  </h3>
  1689  <p>
  1690  (<em>Appears on:</em>
  1691  <a href="#projectcontour.io/v1.HTTPProxySpec">HTTPProxySpec</a>)
  1692  </p>
  1693  <p>
  1694  <p>VirtualHost appears at most once. If it is present, the object is considered
  1695  to be a &ldquo;root&rdquo;.</p>
  1696  </p>
  1697  <table class="table table-striped table-borderless" style="border:none">
  1698  <thead class="border-bottom">
  1699  <tr>
  1700  <th>Field</th>
  1701  <th>Description</th>
  1702  </tr>
  1703  </thead>
  1704  <tbody class="border-top">
  1705  <tr>
  1706  <td style="white-space:nowrap">
  1707  <code>fqdn</code>
  1708  <br>
  1709  <em>
  1710  string
  1711  </em>
  1712  </td>
  1713  <td>
  1714  <p>The fully qualified domain name of the root of the ingress tree
  1715  all leaves of the DAG rooted at this object relate to the fqdn</p>
  1716  </td>
  1717  </tr>
  1718  <tr>
  1719  <td style="white-space:nowrap">
  1720  <code>tls</code>
  1721  <br>
  1722  <em>
  1723  <a href="#projectcontour.io/v1.TLS">
  1724  TLS
  1725  </a>
  1726  </em>
  1727  </td>
  1728  <td>
  1729  <em>(Optional)</em>
  1730  <p>If present describes tls properties. The SNI names that will be matched on
  1731  are described in fqdn, the tls.secretName secret must contain a
  1732  matching certificate</p>
  1733  </td>
  1734  </tr>
  1735  </tbody>
  1736  </table>
  1737  <hr/>
  1738  <p><em>
  1739  Generated with <code>gen-crd-api-reference-docs</code>.
  1740  </em></p>