Regenerate API reference asciidoc #412

jotak · 2023-09-11T08:27:45Z

Description

Dependencies

n/a

Checklist

If you are not familiar with our processes or don't know what to answer in the list below, let us know in a comment: the maintainers will take care of that.

codecov · 2023-09-11T08:31:54Z

Codecov Report

Patch coverage has no change and project coverage change: +0.06% 🎉

Comparison is base (623a3b2) 55.70% compared to head (b1c886d) 55.77%.
Report is 2 commits behind head on main.

❗ Current head b1c886d differs from pull request most recent head f1ffd94. Consider uploading reports for the commit f1ffd94 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #412      +/-   ##
==========================================
+ Coverage   55.70%   55.77%   +0.06%     
==========================================
  Files          46       46              
  Lines        5960     5960              
==========================================
+ Hits         3320     3324       +4     
+ Misses       2410     2408       -2     
+ Partials      230      228       -2

Flag	Coverage Δ
unittests	`55.77% <ø> (+0.06%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

skrthomas

A few comments :)

skrthomas · 2023-09-11T20:46:00Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

+
+| `namespace`
+| `string`
+| Namespace of the config map or secret containing the file. If omitted, assumes same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret will be copied so that it can be mounted as required.


Suggested change

| Namespace of the config map or secret containing the file. If omitted, assumes same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret will be copied so that it can be mounted as required.

| Namespace of the config map or secret containing the file. If omitted, the default is to the same namespace as where Network Observability Operator is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required.

skrthomas · 2023-09-11T20:46:56Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

+
+| `namespace`
+| `string`
+| Namespace of the config map or secret containing the file. If omitted, assumes same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret will be copied so that it can be mounted as required.


Same as previous comment

skrthomas · 2023-09-11T20:50:07Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

+
+| `namespace`
+| `string`
+| Namespace of the config map or secret containing the file. If omitted, assumes same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret will be copied so that it can be mounted as required.


same namespace comment as previous

skrthomas · 2023-09-11T20:50:26Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

+
+| `namespace`
+| `string`
+| Namespace of the config map or secret containing the file. If omitted, assumes same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret will be copied so that it can be mounted as required.


Same namespace comment as previous

skrthomas · 2023-09-11T20:50:53Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

@@ -901,7 +1112,7 @@ Type::
 | `authToken` describes the way to get a token to authenticate to Loki. +
 - `DISABLED` will not send any token with the request. +
 - `FORWARD` will forward the user token for authorization. +
- - `HOST` - _deprecated (*)_ - will use the local pod service account to authenticate to Loki. +
+ - `HOST` [deprecated (*)] - will use the local pod service account to authenticate to Loki. +


Suggested change

- `HOST` [deprecated (*)] - will use the local pod service account to authenticate to Loki. +

- `HOST` [deprecated (*)] - uses the local pod service account to authenticate to Loki. +

skrthomas · 2023-09-11T20:54:56Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

@@ -1383,10 +1602,18 @@ Type::
 |===
 | Property | Type | Description

+| `insecureSkipVerify`
+| `boolean`
+| insecureSkipVerify allows skipping client-side verification of the provided certificate If set to true, ProvidedCaFile field will be ignored


Suggested change

| insecureSkipVerify allows skipping client-side verification of the provided certificate If set to true, ProvidedCaFile field will be ignored

| insecureSkipVerify allows skipping client-side verification of the provided certificate. If set to true, the `ProvidedCaFile` field is ignored.

skrthomas · 2023-09-11T20:56:40Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

 | `provided`
 | `object`
 | TLS configuration when `type` is set to `PROVIDED`.

+| `providedCaFile`
+| `object`
+| Reference to the CA file will be ignored


Suggested change

| Reference to the CA file will be ignored

| Reference to the CA file is ignored.

skrthomas · 2023-09-11T20:57:19Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

+Description::
+
+--
+Reference to the CA file will be ignored


Suggested change

Reference to the CA file will be ignored

Reference to the CA file is ignored.

skrthomas · 2023-09-11T20:58:27Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

+
+| `namespace`
+| `string`
+| Namespace of the config map or secret containing the file. If omitted, assumes same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret will be copied so that it can be mounted as required.


Same namespace comment as previous.

jotak · 2023-09-12T09:02:22Z

@skrthomas : two commits added with your feedback - I also reviewed & changed other places where we were still using future tense
And also we didn't write "Network Observability" instead of "NetObserv" in that doc, until now: I've added a command to automatically do that translation when generating asciidoc

skrthomas

/lgtm

jotak · 2023-09-12T16:45:58Z

thanks!
/approve

openshift-ci · 2023-09-12T16:46:03Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jotak

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [jotak]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

skrthomas · 2023-09-18T20:55:43Z

docs/flowcollector-flows-netobserv-io-v1beta1.adoc

@@ -136,13 +131,13 @@ Required::

 | `ipfix`
 | `object`
-| `ipfix` - _deprecated (*)_ - describes the settings related to the IPFIX-based flow reporter when `spec.agent.type` is set to `IPFIX`.
+| `ipfix` [deprecated (*)] - describes the settings related to the IPFIX-based flow reporter when `spec.agent.type` is set to `IPFIX`.


@jotak I think this option is no longer deprecated? Since we are supporting in the 1.4 release? I noted this in my PR too, but I think this needs updating. Apologies for missing it before.

Be carefull, the agent.type IPFIX is still deprecated since it's ingestion from OVN flows.

However the one we are supporting on 1.4 is IPFIX export.type:
https://issues.redhat.com/browse/NETOBSERV-962

The unsupported mention should me removed there:

IPFIX configuration, such as the IP address and port to send enriched IPFIX flows to. Unsupported (*).

https://github.com/netobserv/network-observability-operator/blob/release-1.4/docs/flowcollector-flows-netobserv-io-v1beta1.adoc#specexporters

https://github.com/netobserv/network-observability-operator/blob/release-1.4/api/v1beta1/flowcollector_types.go#L819-L823

Ohhhh okay, thank you for clarifying that it isn't IPFIX type generally supported now, its specifically the export.type. I didn't realize the distinction.

Regenerate API reference asciidoc

b1c886d

jotak requested review from msherif1234, OlivierCazade, skrthomas and jpinsonneau September 11, 2023 08:28

skrthomas reviewed Sep 11, 2023

View reviewed changes

jotak added 2 commits September 12, 2023 10:58

Address feedback; don't use 'will'

e960585

sed netobserv=>network observability

f1ffd94

OlivierCazade approved these changes Sep 12, 2023

View reviewed changes

openshift-ci bot assigned OlivierCazade Sep 12, 2023

openshift-ci bot added the lgtm label Sep 12, 2023

skrthomas approved these changes Sep 12, 2023

View reviewed changes

openshift-ci bot assigned skrthomas Sep 12, 2023

openshift-ci bot added the approved label Sep 12, 2023

openshift-merge-robot merged commit 0a0f617 into netobserv:main Sep 12, 2023
6 checks passed

skrthomas mentioned this pull request Sep 14, 2023

Network Observability FlowCollector API doc updates openshift/openshift-docs#64761

Merged

1 task

skrthomas reviewed Sep 18, 2023

View reviewed changes

jotak deleted the update-doc branch September 28, 2023 07:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Regenerate API reference asciidoc #412

Regenerate API reference asciidoc #412

jotak commented Sep 11, 2023

codecov bot commented Sep 11, 2023 •

edited

Loading

skrthomas left a comment

skrthomas Sep 11, 2023

skrthomas Sep 11, 2023

skrthomas Sep 11, 2023

skrthomas Sep 11, 2023

skrthomas Sep 11, 2023

skrthomas Sep 11, 2023

skrthomas Sep 11, 2023

skrthomas Sep 11, 2023

skrthomas Sep 11, 2023

jotak commented Sep 12, 2023

skrthomas left a comment

jotak commented Sep 12, 2023

openshift-ci bot commented Sep 12, 2023

skrthomas Sep 18, 2023

jpinsonneau Sep 19, 2023

skrthomas Sep 19, 2023 •

edited

Loading

	\| Namespace of the config map or secret containing the file. If omitted, assumes same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret will be copied so that it can be mounted as required.
	\| Namespace of the config map or secret containing the file. If omitted, the default is to the same namespace as where Network Observability Operator is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required.

	- `HOST` [deprecated (*)] - will use the local pod service account to authenticate to Loki. +
	- `HOST` [deprecated (*)] - uses the local pod service account to authenticate to Loki. +

	\| insecureSkipVerify allows skipping client-side verification of the provided certificate If set to true, ProvidedCaFile field will be ignored
	\| insecureSkipVerify allows skipping client-side verification of the provided certificate. If set to true, the `ProvidedCaFile` field is ignored.

	\| Reference to the CA file will be ignored
	\| Reference to the CA file is ignored.

	Reference to the CA file will be ignored
	Reference to the CA file is ignored.

Regenerate API reference asciidoc #412

Regenerate API reference asciidoc #412

Conversation

jotak commented Sep 11, 2023

Description

Dependencies

Checklist

codecov bot commented Sep 11, 2023 • edited Loading

Codecov Report

skrthomas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jotak commented Sep 12, 2023

skrthomas left a comment

Choose a reason for hiding this comment

jotak commented Sep 12, 2023

openshift-ci bot commented Sep 12, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skrthomas Sep 19, 2023 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Sep 11, 2023 •

edited

Loading

skrthomas Sep 19, 2023 •

edited

Loading