Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions docs/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,3 @@ metadata:
spec:
controllerName: "apisix.apache.org/apisix-ingress-controller"
```

### Addresses
Copy link
Contributor Author

@kayx23 kayx23 May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section should be removed. It was missed out from #96.


The `addresses` field records the status address of the Gateway.

```yaml
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
name: gateway1
spec:
gatewayClassName: apisix
listeners:
- name: http
port: 80
protocol: HTTP
status:
addresses:
- type: IPAddress
value: 172.18.0.4
```
6 changes: 3 additions & 3 deletions docs/crd/api.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Resource Definitions API Reference
title: Custom Resource Definitions API Reference
slug: /reference/apisix-ingress-controller/crd-reference
description: Explore detailed reference documentation for the custom resource definitions (CRDs) supported by the APISIX Ingress Controller.
---

This document provides the API resource description for the APISIX Ingress Controller.
This document provides the API resource description the API7 Ingress Controller custom resource definitions (CRDs).

## Packages
- [apisix.apache.org/v1alpha1](#apisixapacheorgv1alpha1)
Expand Down Expand Up @@ -157,7 +157,7 @@ _Base type:_ `LocalPolicyTargetReferenceWithSectionName`
| `group` _[Group](#group)_ | Group is the group of the target resource. |
| `kind` _[Kind](#kind)_ | Kind is kind of the target resource. |
| `name` _[ObjectName](#objectname)_ | Name is the name of the target resource. |
| `sectionName` _[SectionName](#sectionname)_ | SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following:<br /><br /> * Gateway: Listener name * HTTPRoute: HTTPRouteRule name * Service: Port name<br /><br /> If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status. |
| `sectionName` _[SectionName](#sectionname)_ | SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following:<br /><br /> Gateway: Listener name<br /> • HTTPRoute: HTTPRouteRule name<br /> • Service: Port name<br /><br /> If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status. |


_Appears in:_
Expand Down
4 changes: 2 additions & 2 deletions docs/template/gv_list.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
{{- $groupVersions := . -}}

---
title: Resource Definitions API Reference
title: Custom Resource Definitions API Reference
slug: /reference/apisix-ingress-controller/crd-reference
description: Explore detailed reference documentation for the custom resource definitions (CRDs) supported by the APISIX Ingress Controller.
---

This document provides the API resource description for the APISIX Ingress Controller.
This document provides the API resource description the API7 Ingress Controller custom resource definitions (CRDs).

## Packages
{{- range $groupVersions }}
Expand Down
2 changes: 1 addition & 1 deletion docs/template/type_members.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Please refer to the Kubernetes API documentation for details on the `metadata` field.
{{- else -}}
{{- /* First replace makes paragraphs separated, second merges lines in paragraphs. */ -}}
{{ $field.Doc | replace "\n\n" "<br /><br />" | replace "\n" " " }}
{{ $field.Doc | replace "\n\n" "<br /><br />" | replace "\n" " " | replace " *" "<br /> •" | replace "<br /><br /><br />" "<br /><br />" }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before:

Screenshot at May 21 17-23-59

After:

Screenshot at May 21 17-23-26

{{- end -}}
{{- end -}}
Loading