You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: docs/content/docs/api.md
+33-1Lines changed: 33 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ _Appears in:_
123
123
| --- | --- | --- | --- |
124
124
|`name`_string_| name is the group name |||
125
125
|`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]|
127
127
|`fqdns`_[sreportal.my.domain/v1alpha1.FQDNStatus](#sreportalmydomainv1alpha1fqdnstatus) array_| fqdns is the list of FQDNs in this group |||
128
128
129
129
@@ -205,6 +205,21 @@ _Appears in:_
205
205
|`title`_string_| title is the display title for this portal |||
206
206
|`main`_boolean_| main marks this portal as the default portal for unmatched FQDNs |||
207
207
|`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. |||
|`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. |||
208
223
209
224
210
225
@@ -219,6 +234,23 @@ _Appears in:_
219
234
| --- | --- | --- | --- |
220
235
|`ready`_boolean_| ready indicates if the portal is fully configured |||
221
236
|`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. |||
|`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. |||
0 commit comments