github.com/nginxinc/kubernetes-ingress@v1.12.5/deployments/common/crds/k8s.nginx.org_virtualserverroutes.yaml (about)

     1  apiVersion: apiextensions.k8s.io/v1
     2  kind: CustomResourceDefinition
     3  metadata:
     4    annotations:
     5      controller-gen.kubebuilder.io/version: v0.6.2
     6    creationTimestamp: null
     7    name: virtualserverroutes.k8s.nginx.org
     8  spec:
     9    group: k8s.nginx.org
    10    names:
    11      kind: VirtualServerRoute
    12      listKind: VirtualServerRouteList
    13      plural: virtualserverroutes
    14      shortNames:
    15        - vsr
    16      singular: virtualserverroute
    17    scope: Namespaced
    18    versions:
    19      - additionalPrinterColumns:
    20          - description: Current state of the VirtualServerRoute. If the resource has a valid status, it means it has been validated and accepted by the Ingress Controller.
    21            jsonPath: .status.state
    22            name: State
    23            type: string
    24          - jsonPath: .spec.host
    25            name: Host
    26            type: string
    27          - jsonPath: .status.externalEndpoints[*].ip
    28            name: IP
    29            type: string
    30          - jsonPath: .status.externalEndpoints[*].ports
    31            name: Ports
    32            type: string
    33          - jsonPath: .metadata.creationTimestamp
    34            name: Age
    35            type: date
    36        name: v1
    37        schema:
    38          openAPIV3Schema:
    39            description: VirtualServerRoute defines the VirtualServerRoute resource.
    40            type: object
    41            properties:
    42              apiVersion:
    43                description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    44                type: string
    45              kind:
    46                description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    47                type: string
    48              metadata:
    49                type: object
    50              spec:
    51                description: VirtualServerRouteSpec is the spec of the VirtualServerRoute resource.
    52                type: object
    53                properties:
    54                  host:
    55                    type: string
    56                  ingressClassName:
    57                    type: string
    58                  subroutes:
    59                    type: array
    60                    items:
    61                      description: Route defines a route.
    62                      type: object
    63                      properties:
    64                        action:
    65                          description: Action defines an action.
    66                          type: object
    67                          properties:
    68                            pass:
    69                              type: string
    70                            proxy:
    71                              description: ActionProxy defines a proxy in an Action.
    72                              type: object
    73                              properties:
    74                                requestHeaders:
    75                                  description: ProxyRequestHeaders defines the request headers manipulation in an ActionProxy.
    76                                  type: object
    77                                  properties:
    78                                    pass:
    79                                      type: boolean
    80                                    set:
    81                                      type: array
    82                                      items:
    83                                        description: Header defines an HTTP Header.
    84                                        type: object
    85                                        properties:
    86                                          name:
    87                                            type: string
    88                                          value:
    89                                            type: string
    90                                responseHeaders:
    91                                  description: ProxyResponseHeaders defines the response headers manipulation in an ActionProxy.
    92                                  type: object
    93                                  properties:
    94                                    add:
    95                                      type: array
    96                                      items:
    97                                        description: AddHeader defines an HTTP Header with an optional Always field to use with the add_header NGINX directive.
    98                                        type: object
    99                                        properties:
   100                                          always:
   101                                            type: boolean
   102                                          name:
   103                                            type: string
   104                                          value:
   105                                            type: string
   106                                    hide:
   107                                      type: array
   108                                      items:
   109                                        type: string
   110                                    ignore:
   111                                      type: array
   112                                      items:
   113                                        type: string
   114                                    pass:
   115                                      type: array
   116                                      items:
   117                                        type: string
   118                                rewritePath:
   119                                  type: string
   120                                upstream:
   121                                  type: string
   122                            redirect:
   123                              description: ActionRedirect defines a redirect in an Action.
   124                              type: object
   125                              properties:
   126                                code:
   127                                  type: integer
   128                                url:
   129                                  type: string
   130                            return:
   131                              description: ActionReturn defines a return in an Action.
   132                              type: object
   133                              properties:
   134                                body:
   135                                  type: string
   136                                code:
   137                                  type: integer
   138                                type:
   139                                  type: string
   140                        errorPages:
   141                          type: array
   142                          items:
   143                            description: ErrorPage defines an ErrorPage in a Route.
   144                            type: object
   145                            properties:
   146                              codes:
   147                                type: array
   148                                items:
   149                                  type: integer
   150                              redirect:
   151                                description: ErrorPageRedirect defines a redirect for an ErrorPage.
   152                                type: object
   153                                properties:
   154                                  code:
   155                                    type: integer
   156                                  url:
   157                                    type: string
   158                              return:
   159                                description: ErrorPageReturn defines a return for an ErrorPage.
   160                                type: object
   161                                properties:
   162                                  body:
   163                                    type: string
   164                                  code:
   165                                    type: integer
   166                                  headers:
   167                                    type: array
   168                                    items:
   169                                      description: Header defines an HTTP Header.
   170                                      type: object
   171                                      properties:
   172                                        name:
   173                                          type: string
   174                                        value:
   175                                          type: string
   176                                  type:
   177                                    type: string
   178                        location-snippets:
   179                          type: string
   180                        matches:
   181                          type: array
   182                          items:
   183                            description: Match defines a match.
   184                            type: object
   185                            properties:
   186                              action:
   187                                description: Action defines an action.
   188                                type: object
   189                                properties:
   190                                  pass:
   191                                    type: string
   192                                  proxy:
   193                                    description: ActionProxy defines a proxy in an Action.
   194                                    type: object
   195                                    properties:
   196                                      requestHeaders:
   197                                        description: ProxyRequestHeaders defines the request headers manipulation in an ActionProxy.
   198                                        type: object
   199                                        properties:
   200                                          pass:
   201                                            type: boolean
   202                                          set:
   203                                            type: array
   204                                            items:
   205                                              description: Header defines an HTTP Header.
   206                                              type: object
   207                                              properties:
   208                                                name:
   209                                                  type: string
   210                                                value:
   211                                                  type: string
   212                                      responseHeaders:
   213                                        description: ProxyResponseHeaders defines the response headers manipulation in an ActionProxy.
   214                                        type: object
   215                                        properties:
   216                                          add:
   217                                            type: array
   218                                            items:
   219                                              description: AddHeader defines an HTTP Header with an optional Always field to use with the add_header NGINX directive.
   220                                              type: object
   221                                              properties:
   222                                                always:
   223                                                  type: boolean
   224                                                name:
   225                                                  type: string
   226                                                value:
   227                                                  type: string
   228                                          hide:
   229                                            type: array
   230                                            items:
   231                                              type: string
   232                                          ignore:
   233                                            type: array
   234                                            items:
   235                                              type: string
   236                                          pass:
   237                                            type: array
   238                                            items:
   239                                              type: string
   240                                      rewritePath:
   241                                        type: string
   242                                      upstream:
   243                                        type: string
   244                                  redirect:
   245                                    description: ActionRedirect defines a redirect in an Action.
   246                                    type: object
   247                                    properties:
   248                                      code:
   249                                        type: integer
   250                                      url:
   251                                        type: string
   252                                  return:
   253                                    description: ActionReturn defines a return in an Action.
   254                                    type: object
   255                                    properties:
   256                                      body:
   257                                        type: string
   258                                      code:
   259                                        type: integer
   260                                      type:
   261                                        type: string
   262                              conditions:
   263                                type: array
   264                                items:
   265                                  description: Condition defines a condition in a MatchRule.
   266                                  type: object
   267                                  properties:
   268                                    argument:
   269                                      type: string
   270                                    cookie:
   271                                      type: string
   272                                    header:
   273                                      type: string
   274                                    value:
   275                                      type: string
   276                                    variable:
   277                                      type: string
   278                              splits:
   279                                type: array
   280                                items:
   281                                  description: Split defines a split.
   282                                  type: object
   283                                  properties:
   284                                    action:
   285                                      description: Action defines an action.
   286                                      type: object
   287                                      properties:
   288                                        pass:
   289                                          type: string
   290                                        proxy:
   291                                          description: ActionProxy defines a proxy in an Action.
   292                                          type: object
   293                                          properties:
   294                                            requestHeaders:
   295                                              description: ProxyRequestHeaders defines the request headers manipulation in an ActionProxy.
   296                                              type: object
   297                                              properties:
   298                                                pass:
   299                                                  type: boolean
   300                                                set:
   301                                                  type: array
   302                                                  items:
   303                                                    description: Header defines an HTTP Header.
   304                                                    type: object
   305                                                    properties:
   306                                                      name:
   307                                                        type: string
   308                                                      value:
   309                                                        type: string
   310                                            responseHeaders:
   311                                              description: ProxyResponseHeaders defines the response headers manipulation in an ActionProxy.
   312                                              type: object
   313                                              properties:
   314                                                add:
   315                                                  type: array
   316                                                  items:
   317                                                    description: AddHeader defines an HTTP Header with an optional Always field to use with the add_header NGINX directive.
   318                                                    type: object
   319                                                    properties:
   320                                                      always:
   321                                                        type: boolean
   322                                                      name:
   323                                                        type: string
   324                                                      value:
   325                                                        type: string
   326                                                hide:
   327                                                  type: array
   328                                                  items:
   329                                                    type: string
   330                                                ignore:
   331                                                  type: array
   332                                                  items:
   333                                                    type: string
   334                                                pass:
   335                                                  type: array
   336                                                  items:
   337                                                    type: string
   338                                            rewritePath:
   339                                              type: string
   340                                            upstream:
   341                                              type: string
   342                                        redirect:
   343                                          description: ActionRedirect defines a redirect in an Action.
   344                                          type: object
   345                                          properties:
   346                                            code:
   347                                              type: integer
   348                                            url:
   349                                              type: string
   350                                        return:
   351                                          description: ActionReturn defines a return in an Action.
   352                                          type: object
   353                                          properties:
   354                                            body:
   355                                              type: string
   356                                            code:
   357                                              type: integer
   358                                            type:
   359                                              type: string
   360                                    weight:
   361                                      type: integer
   362                        path:
   363                          type: string
   364                        policies:
   365                          type: array
   366                          items:
   367                            description: PolicyReference references a policy by name and an optional namespace.
   368                            type: object
   369                            properties:
   370                              name:
   371                                type: string
   372                              namespace:
   373                                type: string
   374                        route:
   375                          type: string
   376                        splits:
   377                          type: array
   378                          items:
   379                            description: Split defines a split.
   380                            type: object
   381                            properties:
   382                              action:
   383                                description: Action defines an action.
   384                                type: object
   385                                properties:
   386                                  pass:
   387                                    type: string
   388                                  proxy:
   389                                    description: ActionProxy defines a proxy in an Action.
   390                                    type: object
   391                                    properties:
   392                                      requestHeaders:
   393                                        description: ProxyRequestHeaders defines the request headers manipulation in an ActionProxy.
   394                                        type: object
   395                                        properties:
   396                                          pass:
   397                                            type: boolean
   398                                          set:
   399                                            type: array
   400                                            items:
   401                                              description: Header defines an HTTP Header.
   402                                              type: object
   403                                              properties:
   404                                                name:
   405                                                  type: string
   406                                                value:
   407                                                  type: string
   408                                      responseHeaders:
   409                                        description: ProxyResponseHeaders defines the response headers manipulation in an ActionProxy.
   410                                        type: object
   411                                        properties:
   412                                          add:
   413                                            type: array
   414                                            items:
   415                                              description: AddHeader defines an HTTP Header with an optional Always field to use with the add_header NGINX directive.
   416                                              type: object
   417                                              properties:
   418                                                always:
   419                                                  type: boolean
   420                                                name:
   421                                                  type: string
   422                                                value:
   423                                                  type: string
   424                                          hide:
   425                                            type: array
   426                                            items:
   427                                              type: string
   428                                          ignore:
   429                                            type: array
   430                                            items:
   431                                              type: string
   432                                          pass:
   433                                            type: array
   434                                            items:
   435                                              type: string
   436                                      rewritePath:
   437                                        type: string
   438                                      upstream:
   439                                        type: string
   440                                  redirect:
   441                                    description: ActionRedirect defines a redirect in an Action.
   442                                    type: object
   443                                    properties:
   444                                      code:
   445                                        type: integer
   446                                      url:
   447                                        type: string
   448                                  return:
   449                                    description: ActionReturn defines a return in an Action.
   450                                    type: object
   451                                    properties:
   452                                      body:
   453                                        type: string
   454                                      code:
   455                                        type: integer
   456                                      type:
   457                                        type: string
   458                              weight:
   459                                type: integer
   460                  upstreams:
   461                    type: array
   462                    items:
   463                      description: Upstream defines an upstream.
   464                      type: object
   465                      properties:
   466                        buffer-size:
   467                          type: string
   468                        buffering:
   469                          type: boolean
   470                        buffers:
   471                          description: UpstreamBuffers defines Buffer Configuration for an Upstream.
   472                          type: object
   473                          properties:
   474                            number:
   475                              type: integer
   476                            size:
   477                              type: string
   478                        client-max-body-size:
   479                          type: string
   480                        connect-timeout:
   481                          type: string
   482                        fail-timeout:
   483                          type: string
   484                        healthCheck:
   485                          description: HealthCheck defines the parameters for active Upstream HealthChecks.
   486                          type: object
   487                          properties:
   488                            connect-timeout:
   489                              type: string
   490                            enable:
   491                              type: boolean
   492                            fails:
   493                              type: integer
   494                            headers:
   495                              type: array
   496                              items:
   497                                description: Header defines an HTTP Header.
   498                                type: object
   499                                properties:
   500                                  name:
   501                                    type: string
   502                                  value:
   503                                    type: string
   504                            interval:
   505                              type: string
   506                            jitter:
   507                              type: string
   508                            passes:
   509                              type: integer
   510                            path:
   511                              type: string
   512                            port:
   513                              type: integer
   514                            read-timeout:
   515                              type: string
   516                            send-timeout:
   517                              type: string
   518                            statusMatch:
   519                              type: string
   520                            tls:
   521                              description: UpstreamTLS defines a TLS configuration for an Upstream.
   522                              type: object
   523                              properties:
   524                                enable:
   525                                  type: boolean
   526                        keepalive:
   527                          type: integer
   528                        lb-method:
   529                          type: string
   530                        max-conns:
   531                          type: integer
   532                        max-fails:
   533                          type: integer
   534                        name:
   535                          type: string
   536                        next-upstream:
   537                          type: string
   538                        next-upstream-timeout:
   539                          type: string
   540                        next-upstream-tries:
   541                          type: integer
   542                        port:
   543                          type: integer
   544                        queue:
   545                          description: UpstreamQueue defines Queue Configuration for an Upstream.
   546                          type: object
   547                          properties:
   548                            size:
   549                              type: integer
   550                            timeout:
   551                              type: string
   552                        read-timeout:
   553                          type: string
   554                        send-timeout:
   555                          type: string
   556                        service:
   557                          type: string
   558                        sessionCookie:
   559                          description: SessionCookie defines the parameters for session persistence.
   560                          type: object
   561                          properties:
   562                            domain:
   563                              type: string
   564                            enable:
   565                              type: boolean
   566                            expires:
   567                              type: string
   568                            httpOnly:
   569                              type: boolean
   570                            name:
   571                              type: string
   572                            path:
   573                              type: string
   574                            secure:
   575                              type: boolean
   576                        slow-start:
   577                          type: string
   578                        subselector:
   579                          type: object
   580                          additionalProperties:
   581                            type: string
   582                        tls:
   583                          description: UpstreamTLS defines a TLS configuration for an Upstream.
   584                          type: object
   585                          properties:
   586                            enable:
   587                              type: boolean
   588                        use-cluster-ip:
   589                          type: boolean
   590              status:
   591                description: VirtualServerRouteStatus defines the status for the VirtualServerRoute resource.
   592                type: object
   593                properties:
   594                  externalEndpoints:
   595                    type: array
   596                    items:
   597                      description: ExternalEndpoint defines the IP and ports used to connect to this resource.
   598                      type: object
   599                      properties:
   600                        ip:
   601                          type: string
   602                        ports:
   603                          type: string
   604                  message:
   605                    type: string
   606                  reason:
   607                    type: string
   608                  referencedBy:
   609                    type: string
   610                  state:
   611                    type: string
   612        served: true
   613        storage: true
   614        subresources:
   615          status: {}
   616  status:
   617    acceptedNames:
   618      kind: ""
   619      plural: ""
   620    conditions: []
   621    storedVersions: []