github.com/projectcontour/contour@v1.28.2/site/content/docs/v1.11.0/config/api-reference.html (about)

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