API Reference
Packages
sreportal.io/v1alpha1
Resource Types
- sreportal.io/v1alpha1.Alertmanager
- sreportal.io/v1alpha1.Component
- sreportal.io/v1alpha1.DNS
- sreportal.io/v1alpha1.DNSRecord
- sreportal.io/v1alpha1.FlowEdgeSet
- sreportal.io/v1alpha1.FlowNodeSet
- sreportal.io/v1alpha1.Incident
- sreportal.io/v1alpha1.Maintenance
- sreportal.io/v1alpha1.NetworkFlowDiscovery
- sreportal.io/v1alpha1.Portal
- sreportal.io/v1alpha1.Release
sreportal.io/v1alpha1.Alertmanager
Alertmanager is the Schema for the alertmanagers API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | Alertmanager | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.AlertmanagerSpec | spec defines the desired state of Alertmanager | ||
status sreportal.io/v1alpha1.AlertmanagerStatus | status defines the observed state of Alertmanager |
sreportal.io/v1alpha1.Component
Component is the Schema for the components API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | Component | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.ComponentSpec | spec defines the desired state of Component | ||
status sreportal.io/v1alpha1.ComponentStatus | status defines the observed state of Component |
sreportal.io/v1alpha1.DNS
DNS is the Schema for the dns API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | DNS | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.DNSSpec | spec defines the desired state of DNS | ||
status sreportal.io/v1alpha1.DNSStatus | status defines the observed state of DNS |
sreportal.io/v1alpha1.DNSRecord
DNSRecord is the Schema for the dnsrecords API. It represents DNS endpoints discovered from a specific external-dns source.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | DNSRecord | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.DNSRecordSpec | spec defines the desired state of DNSRecord | ||
status sreportal.io/v1alpha1.DNSRecordStatus | status defines the observed state of DNSRecord |
sreportal.io/v1alpha1.FlowEdgeSet
FlowEdgeSet stores the discovered flow edges for a NetworkFlowDiscovery resource.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | FlowEdgeSet | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.FlowEdgeSetSpec | |||
status sreportal.io/v1alpha1.FlowEdgeSetStatus |
sreportal.io/v1alpha1.FlowNodeSet
FlowNodeSet stores the discovered flow nodes for a NetworkFlowDiscovery resource.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | FlowNodeSet | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.FlowNodeSetSpec | |||
status sreportal.io/v1alpha1.FlowNodeSetStatus |
sreportal.io/v1alpha1.Incident
Incident is the Schema for the incidents API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | Incident | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.IncidentSpec | spec defines the desired state of Incident | ||
status sreportal.io/v1alpha1.IncidentStatus | status defines the observed state of Incident |
sreportal.io/v1alpha1.Maintenance
Maintenance is the Schema for the maintenances API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | Maintenance | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.MaintenanceSpec | spec defines the desired state of Maintenance | ||
status sreportal.io/v1alpha1.MaintenanceStatus | status defines the observed state of Maintenance |
sreportal.io/v1alpha1.NetworkFlowDiscovery
NetworkFlowDiscovery is the Schema for the networkflowdiscoveries API. It discovers network flows from Kubernetes NetworkPolicies and FQDNNetworkPolicies.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | NetworkFlowDiscovery | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.NetworkFlowDiscoverySpec | spec defines the desired state of NetworkFlowDiscovery | ||
status sreportal.io/v1alpha1.NetworkFlowDiscoveryStatus | status defines the observed state of NetworkFlowDiscovery |
sreportal.io/v1alpha1.Portal
Portal is the Schema for the portals API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | Portal | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.PortalSpec | spec defines the desired state of Portal | ||
status sreportal.io/v1alpha1.PortalStatus | status defines the observed state of Portal |
sreportal.io/v1alpha1.Release
Release is the Schema for the releases API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | sreportal.io/v1alpha1 | ||
kind string | Release | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec sreportal.io/v1alpha1.ReleaseSpec | spec defines the desired state of Release | ||
status sreportal.io/v1alpha1.ReleaseStatus | status defines the observed state of Release |
sreportal.io/v1alpha1.AlertmanagerSpec
AlertmanagerSpec defines the desired state of Alertmanager
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
portalRef string | portalRef is the name of the Portal this Alertmanager resource is linked to | ||
url sreportal.io/v1alpha1.AlertmanagerURL | url contains the Alertmanager API endpoints | ||
isRemote boolean | IsRemote indicates that the corresponding portal is remote and the operator should fetch alerts from the remote portal instead of local Alertmanager API. This field is used to determine how to fetch alerts. |
sreportal.io/v1alpha1.AlertmanagerURL
AlertmanagerURL holds the local and remote Alertmanager API URLs
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
local string | local is the URL used by the controller to fetch active alerts (e.g. http://alertmanager.monitoring:9093) | Pattern: ^https?://.* | |
remote string | remote is an optional externally-reachable URL for dashboard links | Pattern: ^https?://.* |
sreportal.io/v1alpha1.AlertmanagerStatus
AlertmanagerStatus defines the observed state of Alertmanager. remote is an optional externally-reachable URL for dashboard links
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
activeAlerts sreportal.io/v1alpha1.AlertStatus array | activeAlerts is the list of currently firing alerts retrieved from the Alertmanager API | ||
silences sreportal.io/v1alpha1.SilenceStatus array | silences is the list of active silences for identifying silenced alerts | ||
conditions Condition array | conditions represent the current state of the Alertmanager resource. | ||
lastReconcileTime Time | lastReconcileTime is the timestamp of the last reconciliation |
sreportal.io/v1alpha1.AlertStatus
AlertStatus represents a single active alert from Alertmanager
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
fingerprint string | fingerprint is the unique identifier of the alert | ||
labels sreportal.io/v1alpha1.map[string]string | labels are the identifying key-value pairs of the alert | ||
annotations sreportal.io/v1alpha1.map[string]string | annotations are additional informational key-value pairs | ||
state string | state is the alert state (active, suppressed, unprocessed) | Enum: [active suppressed unprocessed] | |
startsAt Time | startsAt is when the alert started firing | ||
endsAt Time | endsAt is when the alert is expected to resolve | ||
updatedAt Time | updatedAt is the last time the alert was updated | ||
receivers string array | receivers are the notification integrations this alert is routed to | ||
silencedBy string array | silencedBy contains the IDs of silences that suppress this alert |
sreportal.io/v1alpha1.SilenceStatus
SilenceStatus represents a silence from Alertmanager (for identifying silenced alerts)
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string | |||
matchers sreportal.io/v1alpha1.MatcherStatus array | |||
startsAt Time | |||
endsAt Time | |||
status string | |||
createdBy string | |||
comment string | |||
updatedAt Time |
sreportal.io/v1alpha1.MatcherStatus
MatcherStatus is a label matcher within a silence
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | |||
value string | |||
isRegex boolean |
sreportal.io/v1alpha1.ComponentSpec
ComponentSpec defines the desired state of Component
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
displayName string | displayName is the human-readable name shown on the status page | ||
description string | description is a short text displayed below the component name | ||
group string | group is a logical grouping for the status page (e.g. “Infrastructure”, “Applications”) | ||
link string | link is an optional external URL (e.g. GCP console, Grafana dashboard) | Pattern: ^https?://.* | |
portalRef string | portalRef is the name of the Portal this component is linked to | ||
status sreportal.io/v1alpha1.ComponentStatusValue | status is the manually declared operational status |
sreportal.io/v1alpha1.DailyComponentStatus
DailyComponentStatus records the worst observed status for a single UTC calendar day. status is the manually declared operational status
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
date string | date is the UTC calendar day in YYYY-MM-DD format. | Pattern: ^\d\{4\}-\d\{2\}-\d\{2\}$ | |
worstStatus sreportal.io/v1alpha1.ComputedComponentStatus | worstStatus is the worst computed status observed during this day. |
sreportal.io/v1alpha1.ComponentStatus
ComponentStatus defines the observed state of Component. worstStatus is the worst computed status observed during this day.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
computedStatus sreportal.io/v1alpha1.ComputedComponentStatus | computedStatus is the effective status calculated by the controller. If a maintenance is in progress on this component, it is overridden to “maintenance”. Otherwise it reflects spec.status. | ||
activeIncidents integer | activeIncidents is the number of active (non-resolved) incidents linked to this component | ||
lastStatusChange Time | lastStatusChange is the timestamp of the last computedStatus transition | ||
dailyWorstStatus sreportal.io/v1alpha1.DailyComponentStatus array | dailyWorstStatus records the worst computed status per UTC day over a sliding window (30 days). | ||
conditions Condition array | conditions represent the current state of the Component resource. |
sreportal.io/v1alpha1.DNSSpec
DNSSpec defines the desired state of DNS
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
portalRef string | portalRef is the name of the Portal this DNS resource is linked to | ||
groups sreportal.io/v1alpha1.DNSGroup array | groups is a list of DNS entry groups for organizing entries in the UI | ||
isRemote boolean | isRemote indicates this DNS resource is managed by the portal controller for a remote portal. When true, the DNS controller skips reconciliation and the portal controller manages the status directly. |
sreportal.io/v1alpha1.DNSGroup
DNSGroup represents a group of DNS entries
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | name is the display name for this group | ||
description string | description is an optional description for the group | ||
entries sreportal.io/v1alpha1.DNSEntry array | entries is a list of DNS entries in this group |
sreportal.io/v1alpha1.DNSEntry
DNSEntry represents a manual DNS entry
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
fqdn string | fqdn is the fully qualified domain name | ||
description string | description is an optional description for the DNS entry |
sreportal.io/v1alpha1.DNSStatus
DNSStatus defines the observed state of DNS.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
groups sreportal.io/v1alpha1.FQDNGroupStatus array | groups is the list of FQDN groups with their status | ||
conditions Condition array | conditions represent the current state of the DNS resource. | ||
lastReconcileTime Time | lastReconcileTime is the timestamp of the last reconciliation |
sreportal.io/v1alpha1.FQDNGroupStatus
FQDNGroupStatus represents a group of FQDNs in the status
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | name is the group name | ||
description string | description is the group description | ||
source string | source indicates where this group came from (manual, external-dns, or remote) | Enum: [manual external-dns remote] | |
fqdns sreportal.io/v1alpha1.FQDNStatus array | fqdns is the list of FQDNs in this group |
sreportal.io/v1alpha1.OriginResourceRef
OriginResourceRef identifies the Kubernetes resource that produced an FQDN. Only populated for FQDNs discovered via external-dns sources.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
kind string | kind is the Kubernetes resource kind (e.g. Service, Ingress, DNSEndpoint) | ||
namespace string | namespace is the Kubernetes namespace of the origin resource | ||
name string | name is the name of the origin Kubernetes resource |
sreportal.io/v1alpha1.FQDNStatus
FQDNStatus represents the status of an aggregated FQDN
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
fqdn string | fqdn is the fully qualified domain name | ||
description string | description is an optional description for the FQDN | ||
recordType string | recordType is the DNS record type (A, AAAA, CNAME, etc.) | ||
targets string array | targets is the list of target addresses for this FQDN | ||
syncStatus string | syncStatus indicates whether the FQDN is correctly resolved in DNS. sync: the FQDN resolves to the expected type and targets. notavailable: the FQDN does not exist in DNS. notsync: the FQDN exists but resolves to different targets or type. | Enum: [sync notavailable notsync ] | |
lastSeen Time | lastSeen is the timestamp when this FQDN was last observed | ||
originRef sreportal.io/v1alpha1.OriginResourceRef | originRef identifies the Kubernetes resource (Service, Ingress, DNSEndpoint) that produced this FQDN via external-dns. Not set for manual entries. |
sreportal.io/v1alpha1.DNSRecordSpec
DNSRecordSpec defines the desired state of DNSRecord
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
sourceType string | sourceType indicates the external-dns source type that provides this record | Enum: [service ingress dnsendpoint istio-gateway istio-virtualservice gateway-httproute gateway-grpcroute gateway-tlsroute gateway-tcproute gateway-udproute] | |
portalRef string | portalRef is the name of the Portal this record belongs to |
sreportal.io/v1alpha1.DNSRecordStatus
DNSRecordStatus defines the observed state of DNSRecord portalRef is the name of the Portal this record belongs to
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
endpoints sreportal.io/v1alpha1.EndpointStatus array | endpoints contains the DNS endpoints discovered from this source | ||
endpointsHash string | endpointsHash is a SHA-256 digest of the source-provided endpoint data (DNSName, RecordType, Targets, Labels). It is used by the SourceReconciler to skip status updates when endpoints have not changed between ticks. | ||
lastReconcileTime Time | lastReconcileTime is the timestamp of the last reconciliation | ||
conditions Condition array | conditions represent the current state of the DNSRecord resource |
sreportal.io/v1alpha1.EndpointStatus
EndpointStatus represents a single DNS endpoint discovered from external-dns
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
dnsName string | dnsName is the fully qualified domain name | ||
recordType string | recordType is the DNS record type (A, AAAA, CNAME, TXT, etc.) | ||
targets string array | targets is the list of target addresses for this endpoint | ||
ttl integer | ttl is the DNS record TTL in seconds | ||
labels sreportal.io/v1alpha1.map[string]string | labels contains the endpoint labels from external-dns | ||
syncStatus string | syncStatus indicates whether the endpoint is correctly resolved in DNS. sync: the FQDN resolves to the expected type and targets. notavailable: the FQDN does not exist in DNS. notsync: the FQDN exists but resolves to different targets or type. | Enum: [sync notavailable notsync ] | |
lastSeen Time | lastSeen is the timestamp when this endpoint was last observed |
sreportal.io/v1alpha1.FlowEdgeSetSpec
FlowEdgeSetSpec defines the desired state of FlowEdgeSet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
discoveryRef string | discoveryRef is the name of the parent NetworkFlowDiscovery resource |
sreportal.io/v1alpha1.FlowEdgeSetStatus
FlowEdgeSetStatus defines the observed state of FlowEdgeSet. discoveryRef is the name of the parent NetworkFlowDiscovery resource
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
edges sreportal.io/v1alpha1.FlowEdge array | edges are the directional flow relations between nodes |
sreportal.io/v1alpha1.FlowNodeSetSpec
FlowNodeSetSpec defines the desired state of FlowNodeSet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
discoveryRef string | discoveryRef is the name of the parent NetworkFlowDiscovery resource |
sreportal.io/v1alpha1.FlowNodeSetStatus
FlowNodeSetStatus defines the observed state of FlowNodeSet. discoveryRef is the name of the parent NetworkFlowDiscovery resource
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
nodes sreportal.io/v1alpha1.FlowNode array | nodes are all discovered services, databases, crons, and external endpoints |
sreportal.io/v1alpha1.IncidentUpdate
IncidentUpdate represents a single timeline entry in the incident lifecycle.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
timestamp Time | timestamp is the time of this update | ||
phase sreportal.io/v1alpha1.IncidentPhase | phase is the incident phase at the time of this update | ||
message string | message is a human-readable description of the update |
sreportal.io/v1alpha1.IncidentSpec
IncidentSpec defines the desired state of Incident message is a human-readable description of the update
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
title string | title is the headline of the incident | ||
portalRef string | portalRef is the name of the Portal this incident is linked to | ||
components string array | components is the list of Component metadata.name values affected | ||
severity sreportal.io/v1alpha1.IncidentSeverity | severity indicates the impact level of the incident | ||
updates sreportal.io/v1alpha1.IncidentUpdate array | updates is the chronological timeline of the incident, appended via kubectl edit/patch |
sreportal.io/v1alpha1.IncidentStatus
IncidentStatus defines the observed state of Incident.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
currentPhase sreportal.io/v1alpha1.IncidentPhase | currentPhase is the phase from the most recent update (by timestamp) | ||
startedAt Time | startedAt is the timestamp of the first update | ||
resolvedAt Time | resolvedAt is the timestamp of the first update with phase=resolved | ||
durationMinutes integer | durationMinutes is the incident duration in minutes (computed when resolved) | ||
conditions Condition array | conditions represent the current state of the Incident resource. |
sreportal.io/v1alpha1.MaintenanceSpec
MaintenanceSpec defines the desired state of Maintenance
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
title string | title is the headline displayed on the status page | ||
description string | description is a longer explanation (markdown supported in the UI) | ||
portalRef string | portalRef is the name of the Portal this maintenance is linked to | ||
components string array | components is the list of Component metadata.name values affected by this maintenance | ||
scheduledStart Time | scheduledStart is the planned start time of the maintenance window | ||
scheduledEnd Time | scheduledEnd is the planned end time of the maintenance window | ||
affectedStatus sreportal.io/v1alpha1.MaintenanceAffectedStatus | affectedStatus is the status applied to affected components during in_progress phase |
sreportal.io/v1alpha1.MaintenanceStatus
MaintenanceStatus defines the observed state of Maintenance. affectedStatus is the status applied to affected components during in_progress phase
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
phase sreportal.io/v1alpha1.MaintenancePhase | phase is the lifecycle phase computed by the controller (upcoming, in_progress, completed) | ||
conditions Condition array | conditions represent the current state of the Maintenance resource. |
sreportal.io/v1alpha1.NetworkFlowDiscoverySpec
NetworkFlowDiscoverySpec defines the desired state of NetworkFlowDiscovery.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
portalRef string | portalRef is the name of the Portal this resource is linked to | ||
namespaces string array | namespaces is an optional list of namespaces to scan. When empty, all namespaces are scanned. | ||
isRemote boolean | isRemote indicates that the corresponding portal is remote and the operator should fetch network flows from the remote portal Connect API instead of scanning local Kubernetes NetworkPolicies. | ||
remoteURL string | remoteURL is the base URL of the remote SRE Portal to fetch network flows from. Only used when isRemote is true. |
sreportal.io/v1alpha1.NetworkFlowDiscoveryStatus
NetworkFlowDiscoveryStatus defines the observed state of NetworkFlowDiscovery.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
nodeCount integer | nodeCount is the number of discovered nodes | ||
edgeCount integer | edgeCount is the number of discovered edges | ||
conditions Condition array | conditions represent the current state of the resource. | ||
lastReconcileTime Time | lastReconcileTime is the timestamp of the last reconciliation |
sreportal.io/v1alpha1.FlowNode
FlowNode represents a service, database, cron job, or external endpoint.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string | id is the unique node identifier (e.g. “service:core:my-account-api”) | ||
label string | label is the human-readable name | ||
namespace string | namespace is the Kubernetes namespace | ||
nodeType string | nodeType is one of: service, cron, database, messaging, external | ||
group string | group is the logical group (namespace name by default) |
sreportal.io/v1alpha1.FlowEdge
FlowEdge represents a directional flow between two nodes.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
from string | from is the source node id | ||
to string | to is the target node id | ||
edgeType string | edgeType describes the flow type (e.g. internal, cross-ns, cron, database, messaging, external) |
sreportal.io/v1alpha1.PortalSpec
PortalSpec defines the desired state of Portal
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
title string | title is the display title for this portal | ||
main boolean | main marks this portal as the default portal for unmatched FQDNs | ||
subPath string | subPath is the URL subpath for this portal (defaults to metadata.name) | ||
remote sreportal.io/v1alpha1.RemotePortalSpec | 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. | ||
features sreportal.io/v1alpha1.PortalFeatures | features controls which features are enabled for this portal. All features default to true when not specified. |
sreportal.io/v1alpha1.PortalFeatures
PortalFeatures controls which features are enabled for a portal. All features default to true when not specified.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
dns boolean | dns enables DNS discovery (controllers, gRPC, MCP, web page) for this portal. | ||
releases boolean | releases enables the releases page for this portal. | ||
networkPolicy boolean | networkPolicy enables network policy visualization for this portal. | ||
alerts boolean | alerts enables alertmanager integration for this portal. | ||
statusPage boolean | statusPage enables the status page (components, incidents, maintenances) for this portal. |
sreportal.io/v1alpha1.RemotePortalSpec
RemotePortalSpec defines the configuration for fetching data from a remote portal.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
url string | url is the base URL of the remote SRE Portal instance. | Pattern: ^https?://.* | |
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. | ||
tls sreportal.io/v1alpha1.RemoteTLSConfig | tls configures TLS settings for connecting to the remote portal. If not set, the default system TLS configuration is used. |
sreportal.io/v1alpha1.RemoteTLSConfig
RemoteTLSConfig defines the TLS configuration for connecting to a remote portal.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
insecureSkipVerify boolean | insecureSkipVerify disables TLS certificate verification when connecting to the remote portal. Use with caution: this makes the connection susceptible to man-in-the-middle attacks. | ||
caSecretRef sreportal.io/v1alpha1.SecretRef | caSecretRef references a Secret containing a custom CA certificate bundle. The Secret must contain the key “ca.crt”. | ||
certSecretRef sreportal.io/v1alpha1.SecretRef | certSecretRef references a Secret containing a client certificate and key for mTLS. The Secret must contain the keys “tls.crt” and “tls.key”. |
sreportal.io/v1alpha1.SecretRef
SecretRef is a reference to a Kubernetes Secret in the same namespace.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | name is the name of the Secret. |
sreportal.io/v1alpha1.PortalStatus
PortalStatus defines the observed state of Portal. name is the name of the Secret.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean | ready indicates if the portal is fully configured | ||
conditions Condition array | conditions represent the current state of the Portal resource. | ||
remoteSync sreportal.io/v1alpha1.RemoteSyncStatus | remoteSync contains the status of synchronization with a remote portal. This is only populated when spec.remote is set. |
sreportal.io/v1alpha1.RemoteSyncStatus
RemoteSyncStatus contains status information about remote portal synchronization.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
lastSyncTime Time | lastSyncTime is the timestamp of the last successful synchronization. | ||
lastSyncError string | lastSyncError contains the error message from the last failed synchronization attempt. Empty if the last sync was successful. | ||
remoteTitle string | remoteTitle is the title of the remote portal as fetched from the remote server. | ||
fqdnCount integer | fqdnCount is the number of FQDNs fetched from the remote portal. | ||
features sreportal.io/v1alpha1.PortalFeaturesStatus | features contains the feature flags reported by the remote portal. Used to compute effective features for remote portals (local AND remote). |
sreportal.io/v1alpha1.PortalFeaturesStatus
PortalFeaturesStatus contains the observed feature flags from a remote portal. Unlike PortalFeatures (spec), these are explicit booleans with no nil-defaults-to-true semantics.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
dns boolean | dns indicates whether the remote portal has DNS discovery enabled. | ||
releases boolean | releases indicates whether the remote portal has releases enabled. | ||
networkPolicy boolean | networkPolicy indicates whether the remote portal has network policy visualization enabled. | ||
alerts boolean | alerts indicates whether the remote portal has alertmanager integration enabled. | ||
statusPage boolean | statusPage indicates whether the remote portal has the status page enabled. |
sreportal.io/v1alpha1.ReleaseSpec
ReleaseSpec defines the desired state of Release
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
portalRef string | portalRef is the name of the Portal this release is linked to | ||
entries sreportal.io/v1alpha1.ReleaseEntry array | entries is the list of release events for this day |
sreportal.io/v1alpha1.ReleaseEntry
ReleaseEntry represents a single release event
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type string | type is the kind of release (e.g., “deployment”, “rollback”, “hotfix”) | ||
version string | version is the version string of the release | ||
origin string | origin identifies where the release came from (e.g., “ci/cd”, “manual”, service name) | ||
date Time | date is the timestamp of the release | ||
author string | author is the author of the release | ||
message string | message is the message of the release | ||
link string | link is the link to the release |
sreportal.io/v1alpha1.ReleaseStatus
ReleaseStatus defines the observed state of Release. link is the link to the release
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
entryCount integer | entryCount is the number of release entries in this CR | ||
conditions Condition array | conditions represent the current state of the Release resource. |