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