Skip to content

Commit 8ecc6a0

Browse files
committed
Minor fixes
1 parent 8e2474c commit 8ecc6a0

File tree

2 files changed

+24
-19
lines changed

2 files changed

+24
-19
lines changed

content/docs/configuration/crds/v1beta1/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ For more information please click on the name
88

99
| Name | Description | Version |
1010
|---|---|---|
11+
| **[AxoSyslog](axosyslog_types/)** | AxoSyslog is the schema for the AxoSyslogs API. | v1beta1 |
1112
| **[EventTailer](../extensions/eventtailer_types/)** | Eventtailer's main goal is to listen kubernetes events and transmit their changes to stdout. This way the logging-operator is able to process them. | extensions |
1213
| **[HostTailer](../extensions/hosttailer_types/)** | HostTailer's main goal is to tail custom files and transmit their changes to stdout. This way the logging-operator is able to process them. | extensions |
1314
| **[ClusterFlow](clusterflow_types/)** | ClusterFlow is the Schema for the clusterflows API | v1beta1 |

content/docs/configuration/crds/v1beta1/axosyslog_types.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
## AxoSyslog
1+
---
2+
title: AxoSyslog
3+
weight: 200
4+
generated_file: true
5+
---
26

3-
AxoSyslog is the Schema for the AxoSyslogs API.
7+
AxoSyslog is the schema for the AxoSyslogs API.
48

59
Available in Logging operator version 5.4 and later.
610

@@ -19,86 +23,86 @@ Available in Logging operator version 5.4 and later.
1923

2024
## AxoSyslogSpec
2125

22-
AxoSyslogSpec defines the desired state of AxoSyslog
26+
AxoSyslogSpec defines the desired state of AxoSyslog.
2327

2428
### destinations ([]Destination, optional) {#axosyslogspec-destinations}
2529

26-
Destinations is a list of destinations to be rendered in the AxoSyslog configuration
30+
Destinations is a list of destinations to be rendered in the AxoSyslog configuration.
2731

2832

2933
### logPaths ([]LogPath, optional) {#axosyslogspec-logpaths}
3034

31-
LogPaths is a list of log paths to be rendered in the AxoSyslog configuration
35+
LogPaths is a list of log paths to be rendered in the AxoSyslog configuration.
3236

3337

3438

3539
## LogPath
3640

37-
LogPath defines a single log path that will be rendered in the AxoSyslog configuration
41+
LogPath defines a single log path that will be rendered in the AxoSyslog configuration.
3842

3943
### destination (string, optional) {#logpath-destination}
4044

41-
name of a destination to be used in the log path
45+
Name of a destination to be used in the log path.
4246

4347

4448
### filterx (string, optional) {#logpath-filterx}
4549

46-
filterx block to be rendered within the log path
50+
FilterX block to be rendered within the log path.
4751

4852

4953

5054
## Destination
5155

52-
Destination defines a single destination that will be rendered in the AxoSyslog configuration
56+
Destination defines a single destination that will be rendered in the AxoSyslog configuration.
5357

5458
### config (string, optional) {#destination-config}
5559

56-
Config is the configuration for the destination
60+
Config is the configuration for the destination.
5761

5862

5963
### name (string, optional) {#destination-name}
6064

61-
Name of the destination
65+
Name of the destination.
6266

6367

6468

6569
## AxoSyslogStatus
6670

67-
AxoSyslogStatus defines the observed state of AxoSyslog
71+
AxoSyslogStatus defines the observed state of AxoSyslog.
6872

6973
### problems ([]string, optional) {#axosyslogstatus-problems}
7074

71-
Problems with the AxoSyslog resource
75+
Problems with the AxoSyslog resource.
7276

7377

7478
### problemsCount (int, optional) {#axosyslogstatus-problemscount}
7579

76-
Count of problems with the AxoSyslog resource
80+
Number of problems with the AxoSyslog resource.
7781

7882

7983
### sources ([]Source, optional) {#axosyslogstatus-sources}
8084

81-
Sources configured for AxoSyslog
85+
Sources configured for AxoSyslog.
8286

8387

8488

8589
## Source
8690

87-
Source represents the source of logs for AxoSyslog
91+
Source represents the log sources for AxoSyslog.
8892

8993
### otlp (*OTLPSource, optional) {#source-otlp}
9094

91-
OTLP specific configuration
95+
OTLP specific configuration.
9296

9397

9498

9599
## OTLPSource
96100

97-
OTLPSource contains configuration for OpenTelemetry Protocol sources
101+
OTLPSource contains configuration for OpenTelemetry Protocol sources.
98102

99103
### endpoint (string, optional) {#otlpsource-endpoint}
100104

101-
Endpoint for the OTLP source
105+
Endpoint for the OTLP source.
102106

103107

104108

0 commit comments

Comments
 (0)