Skip to content

Commit e70f10c

Browse files
committed
Adds generated LoggingRoute spec docs
Signed-off-by: Robert Fekete <fekete77.robert@gmail.com>
1 parent c275f78 commit e70f10c

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: LoggingRouteSpec
3+
weight: 200
4+
generated_file: true
5+
---
6+
7+
## LoggingRouteSpec
8+
9+
LoggingRouteSpec defines the desired state of LoggingRoute
10+
11+
### source (string, required) {#loggingroutespec-source}
12+
13+
Source identifies the logging that this policy applies to
14+
15+
Default: -
16+
17+
### targets (metav1.LabelSelector, required) {#loggingroutespec-targets}
18+
19+
Targets refers to the list of logging resources specified by a label selector to forward logs to. Filtering of namespaces will happen based on the watchNamespaces and watchNamespaceSelector fields of the target logging resource
20+
21+
Default: -
22+
23+
24+
## LoggingRouteStatus
25+
26+
LoggingRouteStatus defines the actual state of the LoggingRoute
27+
28+
### tenants ([]Tenant, optional) {#loggingroutestatus-tenants}
29+
30+
Enumerate all loggings with all the destination namespaces expanded
31+
32+
Default: -
33+
34+
### problems ([]string, optional) {#loggingroutestatus-problems}
35+
36+
Enumerate problems that prohibits this route to take effect and populate the tenants field
37+
38+
Default: -
39+
40+
### problemsCount (int, optional) {#loggingroutestatus-problemscount}
41+
42+
Summarize the number of problems for the CLI output
43+
44+
Default: -
45+
46+
### notices ([]string, optional) {#loggingroutestatus-notices}
47+
48+
Enumerate non-blocker issues the user should pay attention to
49+
50+
Default: -
51+
52+
### noticesCount (int, optional) {#loggingroutestatus-noticescount}
53+
54+
Summarize the number of notices for the CLI output
55+
56+
Default: -
57+
58+
59+
## Tenant
60+
61+
### name (string, required) {#tenant-name}
62+
63+
Default: -
64+
65+
### namespaces ([]string, optional) {#tenant-namespaces}
66+
67+
Default: -
68+
69+
70+
## LoggingRoute
71+
72+
LoggingRoute (experimental)
73+
Connects a log collector with log aggregators from other logging domains and routes relevant logs based on watch namespaces
74+
75+
### (metav1.TypeMeta, required) {#loggingroute-}
76+
77+
Default: -
78+
79+
### metadata (metav1.ObjectMeta, optional) {#loggingroute-metadata}
80+
81+
Default: -
82+
83+
### spec (LoggingRouteSpec, optional) {#loggingroute-spec}
84+
85+
Default: -
86+
87+
### status (LoggingRouteStatus, optional) {#loggingroute-status}
88+
89+
Default: -
90+
91+
92+
## LoggingRouteList
93+
94+
### (metav1.TypeMeta, required) {#loggingroutelist-}
95+
96+
Default: -
97+
98+
### metadata (metav1.ListMeta, optional) {#loggingroutelist-metadata}
99+
100+
Default: -
101+
102+
### items ([]LoggingRoute, required) {#loggingroutelist-items}
103+
104+
Default: -
105+
106+

0 commit comments

Comments
 (0)