Skip to content

Commit fad5004

Browse files
authored
docs: correct description for externalNodes (#238)
1 parent 7bc2d6f commit fad5004

File tree

4 files changed

+7
-4
lines changed

4 files changed

+7
-4
lines changed

api/v2/apisixupstream_types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ type ApisixUpstreamSpec struct {
3333
// +kubebuilder:validation:Optional
3434
IngressClassName string `json:"ingressClassName,omitempty" yaml:"ingressClassName,omitempty"`
3535

36-
// ExternalNodes defines a static list of backend nodes located outside the cluster.
36+
// ExternalNodes defines a static list of backend nodes. These can be external hosts
37+
// outside the cluster or cluster-internal Services specified by their DNS name.
3738
// When this field is set, the upstream will route traffic directly to these nodes
3839
// without DNS resolution or service discovery.
3940
// +kubebuilder:validation:Optional

config/crd-nocel/apisix.apache.org_v2.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1433,7 +1433,8 @@ spec:
14331433
type: object
14341434
externalNodes:
14351435
description: |-
1436-
ExternalNodes defines a static list of backend nodes located outside the cluster.
1436+
ExternalNodes defines a static list of backend nodes. These can be external hosts
1437+
outside the cluster or cluster-internal Services specified by their DNS name.
14371438
When this field is set, the upstream will route traffic directly to these nodes
14381439
without DNS resolution or service discovery.
14391440
items:

config/crd/bases/apisix.apache.org_apisixupstreams.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ spec:
6565
type: object
6666
externalNodes:
6767
description: |-
68-
ExternalNodes defines a static list of backend nodes located outside the cluster.
68+
ExternalNodes defines a static list of backend nodes. These can be external hosts
69+
outside the cluster or cluster-internal Services specified by their DNS name.
6970
When this field is set, the upstream will route traffic directly to these nodes
7071
without DNS resolution or service discovery.
7172
items:

docs/en/latest/reference/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1374,7 +1374,7 @@ definitions and custom configuration.
13741374
| Field | Description |
13751375
| --- | --- |
13761376
| `ingressClassName` _string_ | IngressClassName is the name of an IngressClass cluster resource. Controller implementations use this field to determine whether they should process this ApisixUpstream resource. |
1377-
| `externalNodes` _[ApisixUpstreamExternalNode](#apisixupstreamexternalnode) array_ | ExternalNodes defines a static list of backend nodes located outside the cluster. When this field is set, the upstream will route traffic directly to these nodes without DNS resolution or service discovery. |
1377+
| `externalNodes` _[ApisixUpstreamExternalNode](#apisixupstreamexternalnode) array_ | ExternalNodes defines a static list of backend nodes. These can be external hosts outside the cluster or cluster-internal Services specified by their DNS name. When this field is set, the upstream will route traffic directly to these nodes without DNS resolution or service discovery. |
13781378
| `loadbalancer` _[LoadBalancer](#loadbalancer)_ | LoadBalancer specifies the load balancer configuration for Kubernetes Service. |
13791379
| `scheme` _string_ | Scheme is the protocol used to communicate with the upstream. Default is `http`. Can be `http`, `https`, `grpc`, or `grpcs`. |
13801380
| `retries` _integer_ | Retries defines the number of retry attempts APISIX should make when a failure occurs. Failures include timeouts, network errors, or 5xx status codes. |

0 commit comments

Comments
 (0)