tokers commented on a change in pull request #151: URL: https://github.com/apache/apisix-ingress-controller/pull/151#discussion_r551726850
########## File path: docs/CRD-specification.md ########## @@ -0,0 +1,196 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +# CRD specification + +Use the following CRDs to define your routing rules. Normally, you only need to use ApisixRoute to complete a simple route definition. + +## CRD Types + +- [ApisixRoute](#apisixroute) +- [ApisixService](#apisixservice) +- [ApisixUpstream](#apisixupstream) +- [ApisixTls](#apisixtls) + +## ApisixRoute + +`ApisixRoute` corresponds to the `Route` object in Apache APISIX. The `Route` matches the client's request by defining rules, +then loads and executes the corresponding plugin based on the matching result, and forwards the request to the specified Upstream. +To learn more, please check the [Apache APISIX architecture-design docs](https://github.com/apache/apisix/blob/master/doc/architecture-design.md#route). + +Structure example: + +```yaml +apiVersion: apisix.apache.org/v1 +kind: ApisixRoute +metadata: + name: httpserverRoute + namespace: cloud +spec: + rules: + - host: test.apisix.apache.org + http: + paths: + - backend: + serviceName: httpserver + servicePort: 8080 + path: /hello* + plugins: + - name: limit-count + enable: true + config: + count: 2 + time_window: 60 + rejected_code: 503 + key: remote_addr +``` + +| Field | Type | Description | +|---------------|----------|----------------------------------------------------| +| rules | array | ApisixRoute's request matching rules. | +| host | string | The requested host. | +| http | string | The routing rule of the request. | +| paths | array | The routing rule of the request. | +| backend | object | Backend service information configuration. | +| serviceName | string | The name of backend service. `namespace + serviceName + servicePort` form a unique identifier to match the back-end service. | +| servicePort | int | The port of backend service. `namespace + serviceName + servicePort` form a unique identifier to match the back-end service. | +| path | string | The URI matched by the route. Supports exact match and prefix match. Example，exact match: `/hello`, prefix match: `/hello*`. | +| plugins | array | Custom plugin collection (Plugins defined in the `route` level). For more plugin information, please refer to the [Apache APISIX plugin docs](https://github.com/apache/apisix/tree/master/doc/plugins). | +| name | string | The name of the plugin. For more information about the example plugin, please check the [limit-count docs](https://github.com/apache/apisix/blob/master/doc/plugins/limit-count.md#Attributes). | +| enable | boolean | Whether to enable the plugin, `true`: means enable, `false`: means disable. | +| config | object | Configuration of plugin information. Note: The check of configuration schema is missing now, so please be careful when editing. | + +**Support partial `annotation`** + +Structure example: + +```yaml +apiVersion: apisix.apache.org/v1 +kind: ApisixRoute +metadata: + annotations: + k8s.apisix.apache.org/ingress.class: apisix_group + k8s.apisix.apache.org/ssl-redirect: 'false' + k8s.apisix.apache.org/whitelist-source-range: + - 1.2.3.4/16 + - 4.3.2.1/8 + name: httpserverRoute + namespace: cloud +spec: +``` + +| Field | Type | Description | +|------------------------------------------------|------------|--------------------------------------------------------------------| +| `k8s.apisix.apache.org/ssl-redirect` | boolean | Whether to use SSL forwarding, true: means using SSL forwarding, false: means not using SSL forwarding. | Review comment: OK, that's more appropriate. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
