You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by tr...@apache.org on 2025/09/03 02:35:35 UTC
(apisix-ingress-controller) branch master updated: docs: correct description for externalNodes (#2541)
This is an automated email from the ASF dual-hosted git repository.
traky pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new efc29bff docs: correct description for externalNodes (#2541)
efc29bff is described below
commit efc29bff519783f9598b1f60055bfbec8ee304eb
Author: Traky Deng <tr...@gmail.com>
AuthorDate: Wed Sep 3 10:35:30 2025 +0800
docs: correct description for externalNodes (#2541)
---
api/v2/apisixupstream_types.go | 3 ++-
config/crd/bases/apisix.apache.org_apisixupstreams.yaml | 3 ++-
docs/en/latest/reference/api-reference.md | 2 +-
3 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/api/v2/apisixupstream_types.go b/api/v2/apisixupstream_types.go
index 38b41c62..c6578f91 100644
--- a/api/v2/apisixupstream_types.go
+++ b/api/v2/apisixupstream_types.go
@@ -33,7 +33,8 @@ type ApisixUpstreamSpec struct {
// +kubebuilder:validation:Optional
IngressClassName string `json:"ingressClassName,omitempty" yaml:"ingressClassName,omitempty"`
- // ExternalNodes defines a static list of backend nodes located outside the cluster.
+ // 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.
// +kubebuilder:validation:Optional
diff --git a/config/crd/bases/apisix.apache.org_apisixupstreams.yaml b/config/crd/bases/apisix.apache.org_apisixupstreams.yaml
index c07b08e5..37880aba 100644
--- a/config/crd/bases/apisix.apache.org_apisixupstreams.yaml
+++ b/config/crd/bases/apisix.apache.org_apisixupstreams.yaml
@@ -65,7 +65,8 @@ spec:
type: object
externalNodes:
description: |-
- ExternalNodes defines a static list of backend nodes located outside the cluster.
+ 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.
items:
diff --git a/docs/en/latest/reference/api-reference.md b/docs/en/latest/reference/api-reference.md
index 914742fd..1a81da84 100644
--- a/docs/en/latest/reference/api-reference.md
+++ b/docs/en/latest/reference/api-reference.md
@@ -1375,7 +1375,7 @@ definitions and custom configuration.
| Field | Description |
| --- | --- |
| `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. |
-| `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. |
+| `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. |
| `loadbalancer` _[LoadBalancer](#loadbalancer)_ | LoadBalancer specifies the load balancer configuration for Kubernetes Service. |
| `scheme` _string_ | Scheme is the protocol used to communicate with the upstream. Default is `http`. Can be `http`, `https`, `grpc`, or `grpcs`. |
| `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. |