Skip to content

Commit c7208ba

Browse files
committed
docs(api): document remote portal sync fields and enums
Add API reference details for configuring portals to fetch DNS data from a remote SRE Portal instance and reporting sync status, clarifying allowed source values to reflect remote-backed groups. Signed-off-by: David Sabatie <david.sabatie@notrenet.com>
1 parent 86191c1 commit c7208ba

3 files changed

Lines changed: 37 additions & 3 deletions

File tree

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,6 @@ tmp
3232

3333
# Hugo build output
3434
docs/public/
35-
docs/.hugo_build.lock
35+
docs/.hugo_build.lock
36+
37+
/node_modules

.mcp.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
"url": "http://localhost:8090/sse"
66
}
77
}
8-
}
8+
}

docs/content/docs/api.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ _Appears in:_
123123
| --- | --- | --- | --- |
124124
| `name` _string_ | name is the group name | | |
125125
| `description` _string_ | description is the group description | | |
126-
| `source` _string_ | source indicates where this group came from (manual or external-dns) | | Enum: [manual external-dns] |
126+
| `source` _string_ | source indicates where this group came from (manual, external-dns, or remote) | | Enum: [manual external-dns remote] |
127127
| `fqdns` _[sreportal.my.domain/v1alpha1.FQDNStatus](#sreportalmydomainv1alpha1fqdnstatus) array_ | fqdns is the list of FQDNs in this group | | |
128128

129129

@@ -205,6 +205,21 @@ _Appears in:_
205205
| `title` _string_ | title is the display title for this portal | | |
206206
| `main` _boolean_ | main marks this portal as the default portal for unmatched FQDNs | | |
207207
| `subPath` _string_ | subPath is the URL subpath for this portal (defaults to metadata.name) | | |
208+
| `remote` _[sreportal.my.domain/v1alpha1.RemotePortalSpec](#sreportalmydomainv1alpha1remoteportalspec)_ | remote configures this portal to fetch data from a remote SRE Portal instance. When set, the operator will fetch DNS information from the remote portal instead of collecting data from the local cluster. This field cannot be set when main is true. | | |
209+
210+
211+
212+
#### sreportal.my.domain/v1alpha1.RemotePortalSpec
213+
214+
RemotePortalSpec defines the configuration for fetching data from a remote portal.
215+
216+
_Appears in:_
217+
- [sreportal.my.domain/v1alpha1.PortalSpec](#sreportalmydomainv1alpha1portalspec)
218+
219+
| Field | Description | Default | Validation |
220+
| --- | --- | --- | --- |
221+
| `url` _string_ | url is the base URL of the remote SRE Portal instance. | | Pattern: `^https?://.*` |
222+
| `portal` _string_ | portal is the name of the portal to target on the remote instance. If not set, the main portal of the remote instance will be used. | | |
208223

209224

210225

@@ -219,6 +234,23 @@ _Appears in:_
219234
| --- | --- | --- | --- |
220235
| `ready` _boolean_ | ready indicates if the portal is fully configured | | |
221236
| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.33/#condition-v1-meta) array_ | conditions represent the current state of the Portal resource. | | |
237+
| `remoteSync` _[sreportal.my.domain/v1alpha1.RemoteSyncStatus](#sreportalmydomainv1alpha1remotesyncstatus)_ | remoteSync contains the status of synchronization with a remote portal. This is only populated when spec.remote is set. | | |
238+
239+
240+
241+
#### sreportal.my.domain/v1alpha1.RemoteSyncStatus
242+
243+
RemoteSyncStatus contains status information about remote portal synchronization.
244+
245+
_Appears in:_
246+
- [sreportal.my.domain/v1alpha1.PortalStatus](#sreportalmydomainv1alpha1portalstatus)
247+
248+
| Field | Description | Default | Validation |
249+
| --- | --- | --- | --- |
250+
| `lastSyncTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.33/#time-v1-meta)_ | lastSyncTime is the timestamp of the last successful synchronization. | | |
251+
| `lastSyncError` _string_ | lastSyncError contains the error message from the last failed synchronization attempt. Empty if the last sync was successful. | | |
252+
| `remoteTitle` _string_ | remoteTitle is the title of the remote portal as fetched from the remote server. | | |
253+
| `fqdnCount` _integer_ | fqdnCount is the number of FQDNs fetched from the remote portal. | | |
222254

223255

224256

0 commit comments

Comments
 (0)