Skip to content

Commit

Permalink
NETOBSERV-1104: remove italic text in CRD doc (#407)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jotak
jotak authored Aug 29, 2023
1 parent db6f62b commit 5e28ebf
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 68 deletions.
14 changes: 7 additions & 7 deletions api/v1beta1/flowcollector_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const (

// Defines the desired state of the FlowCollector resource.
// <br><br>
// *: the mention of <i>"unsupported"</i>, or <i>"deprecated"</i> for a feature throughout this document means that this feature
// *: the mention of "unsupported", or "deprecated" for a feature throughout this document means that this feature
// is not officially supported by Red Hat. It might have been, for instance, contributed by the community
// and accepted without a formal agreement for maintenance. The product maintainers might provide some support
// for these features as a best effort only.
Expand Down Expand Up @@ -89,7 +89,7 @@ type FlowCollectorSpec struct {
type FlowCollectorAgent struct {
// `type` selects the flows tracing agent. Possible values are:<br>
// - `EBPF` (default) to use NetObserv eBPF agent.<br>
// - `IPFIX` - <i>deprecated (*)</i> - to use the legacy IPFIX collector.<br>
// - `IPFIX` [deprecated (*)] - to use the legacy IPFIX collector.<br>
// `EBPF` is recommended as it offers better performances and should work regardless of the CNI installed on the cluster.
// `IPFIX` works with OVN-Kubernetes CNI (other CNIs could work if they support exporting IPFIX,
// but they would require manual configuration).
Expand All @@ -98,7 +98,7 @@ type FlowCollectorAgent struct {
// +kubebuilder:default:=EBPF
Type string `json:"type,omitempty"`

// `ipfix` - <i>deprecated (*)</i> - describes the settings related to the IPFIX-based flow reporter when `spec.agent.type`
// `ipfix` [deprecated (*)] - describes the settings related to the IPFIX-based flow reporter when `spec.agent.type`
// is set to `IPFIX`.
// +optional
IPFIX FlowCollectorIPFIX `json:"ipfix,omitempty"`
Expand Down Expand Up @@ -250,7 +250,7 @@ type FlowCollectorKafka struct {
// +optional
TLS ClientTLS `json:"tls"`

// SASL authentication configuration. <i>Unsupported (*)</i>
// SASL authentication configuration. [Unsupported (*)].
// +optional
// +k8s:conversion-gen=false
SASL SASLConfig `json:"sasl"`
Expand Down Expand Up @@ -535,7 +535,7 @@ type FlowCollectorLoki struct {
// `authToken` describes the way to get a token to authenticate to Loki.<br>
// - `DISABLED` will not send any token with the request.<br>
// - `FORWARD` will forward the user token for authorization.<br>
// - `HOST` - <i>deprecated (*)</i> - will use the local pod service account to authenticate to Loki.<br>
// - `HOST` [deprecated (*)] - will use the local pod service account to authenticate to Loki.<br>
// When using the Loki Operator, this must be set to `FORWARD`.
AuthToken string `json:"authToken,omitempty"`

Expand Down Expand Up @@ -797,7 +797,7 @@ const (

// `FlowCollectorExporter` defines an additional exporter to send enriched flows to.
type FlowCollectorExporter struct {
// `type` selects the type of exporters. The available options are `KAFKA` and `IPFIX`. `IPFIX` is <i>unsupported (*)</i>.
// `type` selects the type of exporters. The available options are `KAFKA` and `IPFIX`. `IPFIX` is unsupported (*).
// +unionDiscriminator
// +kubebuilder:validation:Enum:="KAFKA";"IPFIX"
// +kubebuilder:validation:Required
Expand All @@ -807,7 +807,7 @@ type FlowCollectorExporter struct {
// +optional
Kafka FlowCollectorKafka `json:"kafka,omitempty"`

// IPFIX configuration, such as the IP address and port to send enriched IPFIX flows to. <i>Unsupported (*)</i>.
// IPFIX configuration, such as the IP address and port to send enriched IPFIX flows to. [Unsupported (*)].
// +optional
IPFIX FlowCollectorIPFIXReceiver `json:"ipfix,omitempty"`
}
Expand Down
45 changes: 21 additions & 24 deletions bundle/manifests/flows.netobserv.io_flowcollectors.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2247,12 +2247,12 @@ spec:
type: object
spec:
description: 'Defines the desired state of the FlowCollector resource.
<br><br> *: the mention of <i>"unsupported"</i>, or <i>"deprecated"</i>
for a feature throughout this document means that this feature is not
officially supported by Red Hat. It might have been, for instance, contributed
by the community and accepted without a formal agreement for maintenance.
The product maintainers might provide some support for these features
as a best effort only.'
<br><br> *: the mention of "unsupported", or "deprecated" for a feature
throughout this document means that this feature is not officially supported
by Red Hat. It might have been, for instance, contributed by the community
and accepted without a formal agreement for maintenance. The product
maintainers might provide some support for these features as a best
effort only.'
properties:
agent:
description: Agent configuration for flows extraction.
Expand Down Expand Up @@ -2415,8 +2415,8 @@ spec:
type: integer
type: object
ipfix:
description: '`ipfix` - <i>deprecated (*)</i> - describes the
settings related to the IPFIX-based flow reporter when `spec.agent.type`
description: '`ipfix` [deprecated (*)] - describes the settings
related to the IPFIX-based flow reporter when `spec.agent.type`
is set to `IPFIX`.'
properties:
cacheActiveTimeout:
Expand Down Expand Up @@ -2490,12 +2490,11 @@ spec:
default: EBPF
description: '`type` selects the flows tracing agent. Possible
values are:<br> - `EBPF` (default) to use NetObserv eBPF agent.<br>
- `IPFIX` - <i>deprecated (*)</i> - to use the legacy IPFIX
collector.<br> `EBPF` is recommended as it offers better performances
and should work regardless of the CNI installed on the cluster.
`IPFIX` works with OVN-Kubernetes CNI (other CNIs could work
if they support exporting IPFIX, but they would require manual
configuration).'
- `IPFIX` [deprecated (*)] - to use the legacy IPFIX collector.<br>
`EBPF` is recommended as it offers better performances and should
work regardless of the CNI installed on the cluster. `IPFIX`
works with OVN-Kubernetes CNI (other CNIs could work if they
support exporting IPFIX, but they would require manual configuration).'
enum:
- EBPF
- IPFIX
Expand Down Expand Up @@ -3202,7 +3201,7 @@ spec:
properties:
ipfix:
description: IPFIX configuration, such as the IP address and
port to send enriched IPFIX flows to. <i>Unsupported (*)</i>.
port to send enriched IPFIX flows to. [Unsupported (*)].
properties:
targetHost:
default: ""
Expand Down Expand Up @@ -3231,8 +3230,8 @@ spec:
description: Address of the Kafka server
type: string
sasl:
description: SASL authentication configuration. <i>Unsupported
(*)</i>
description: SASL authentication configuration. [Unsupported
(*)].
properties:
clientIDKey:
description: Key for client ID within the provided `reference`
Expand Down Expand Up @@ -3373,8 +3372,7 @@ spec:
type: object
type:
description: '`type` selects the type of exporters. The available
options are `KAFKA` and `IPFIX`. `IPFIX` is <i>unsupported
(*)</i>.'
options are `KAFKA` and `IPFIX`. `IPFIX` is unsupported (*).'
enum:
- KAFKA
- IPFIX
Expand All @@ -3393,8 +3391,7 @@ spec:
description: Address of the Kafka server
type: string
sasl:
description: SASL authentication configuration. <i>Unsupported
(*)</i>
description: SASL authentication configuration. [Unsupported (*)].
properties:
clientIDKey:
description: Key for client ID within the provided `reference`
Expand Down Expand Up @@ -3534,9 +3531,9 @@ spec:
description: '`authToken` describes the way to get a token to
authenticate to Loki.<br> - `DISABLED` will not send any token
with the request.<br> - `FORWARD` will forward the user token
for authorization.<br> - `HOST` - <i>deprecated (*)</i> - will
use the local pod service account to authenticate to Loki.<br>
When using the Loki Operator, this must be set to `FORWARD`.'
for authorization.<br> - `HOST` [deprecated (*)] - will use
the local pod service account to authenticate to Loki.<br> When
using the Loki Operator, this must be set to `FORWARD`.'
enum:
- DISABLED
- HOST
Expand Down
45 changes: 21 additions & 24 deletions config/crd/bases/flows.netobserv.io_flowcollectors.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2234,12 +2234,12 @@ spec:
type: object
spec:
description: 'Defines the desired state of the FlowCollector resource.
<br><br> *: the mention of <i>"unsupported"</i>, or <i>"deprecated"</i>
for a feature throughout this document means that this feature is not
officially supported by Red Hat. It might have been, for instance, contributed
by the community and accepted without a formal agreement for maintenance.
The product maintainers might provide some support for these features
as a best effort only.'
<br><br> *: the mention of "unsupported", or "deprecated" for a feature
throughout this document means that this feature is not officially supported
by Red Hat. It might have been, for instance, contributed by the community
and accepted without a formal agreement for maintenance. The product
maintainers might provide some support for these features as a best
effort only.'
properties:
agent:
description: Agent configuration for flows extraction.
Expand Down Expand Up @@ -2402,8 +2402,8 @@ spec:
type: integer
type: object
ipfix:
description: '`ipfix` - <i>deprecated (*)</i> - describes the
settings related to the IPFIX-based flow reporter when `spec.agent.type`
description: '`ipfix` [deprecated (*)] - describes the settings
related to the IPFIX-based flow reporter when `spec.agent.type`
is set to `IPFIX`.'
properties:
cacheActiveTimeout:
Expand Down Expand Up @@ -2477,12 +2477,11 @@ spec:
default: EBPF
description: '`type` selects the flows tracing agent. Possible
values are:<br> - `EBPF` (default) to use NetObserv eBPF agent.<br>
- `IPFIX` - <i>deprecated (*)</i> - to use the legacy IPFIX
collector.<br> `EBPF` is recommended as it offers better performances
and should work regardless of the CNI installed on the cluster.
`IPFIX` works with OVN-Kubernetes CNI (other CNIs could work
if they support exporting IPFIX, but they would require manual
configuration).'
- `IPFIX` [deprecated (*)] - to use the legacy IPFIX collector.<br>
`EBPF` is recommended as it offers better performances and should
work regardless of the CNI installed on the cluster. `IPFIX`
works with OVN-Kubernetes CNI (other CNIs could work if they
support exporting IPFIX, but they would require manual configuration).'
enum:
- EBPF
- IPFIX
Expand Down Expand Up @@ -3189,7 +3188,7 @@ spec:
properties:
ipfix:
description: IPFIX configuration, such as the IP address and
port to send enriched IPFIX flows to. <i>Unsupported (*)</i>.
port to send enriched IPFIX flows to. [Unsupported (*)].
properties:
targetHost:
default: ""
Expand Down Expand Up @@ -3218,8 +3217,8 @@ spec:
description: Address of the Kafka server
type: string
sasl:
description: SASL authentication configuration. <i>Unsupported
(*)</i>
description: SASL authentication configuration. [Unsupported
(*)].
properties:
clientIDKey:
description: Key for client ID within the provided `reference`
Expand Down Expand Up @@ -3360,8 +3359,7 @@ spec:
type: object
type:
description: '`type` selects the type of exporters. The available
options are `KAFKA` and `IPFIX`. `IPFIX` is <i>unsupported
(*)</i>.'
options are `KAFKA` and `IPFIX`. `IPFIX` is unsupported (*).'
enum:
- KAFKA
- IPFIX
Expand All @@ -3380,8 +3378,7 @@ spec:
description: Address of the Kafka server
type: string
sasl:
description: SASL authentication configuration. <i>Unsupported
(*)</i>
description: SASL authentication configuration. [Unsupported (*)].
properties:
clientIDKey:
description: Key for client ID within the provided `reference`
Expand Down Expand Up @@ -3521,9 +3518,9 @@ spec:
description: '`authToken` describes the way to get a token to
authenticate to Loki.<br> - `DISABLED` will not send any token
with the request.<br> - `FORWARD` will forward the user token
for authorization.<br> - `HOST` - <i>deprecated (*)</i> - will
use the local pod service account to authenticate to Loki.<br>
When using the Loki Operator, this must be set to `FORWARD`.'
for authorization.<br> - `HOST` [deprecated (*)] - will use
the local pod service account to authenticate to Loki.<br> When
using the Loki Operator, this must be set to `FORWARD`.'
enum:
- DISABLED
- HOST
Expand Down
Loading

0 comments on commit 5e28ebf

Please sign in to comment.