New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Regenerate docs #657

Merged

jotak merged 4 commits into netobserv:main from jotak:gen-docs

Jun 4, 2024

Member

jotak commented May 27, 2024

No description provided.

jotak requested review from msherif1234, skrthomas, memodi and jpinsonneau

May 27, 2024 08:22

openshift-ci bot commented May 27, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from jotak. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

jotak commented

View reviewed changes

docs/flows-format.adoc

               The "Loki label" column is useful when querying Loki directly: label fields need to be selected using link:https://grafana.com/docs/loki/latest/logql/log_queries/#log-stream-selector[stream selectors].
-              The "Cardinality" column gives information about the implied metric cardinality if this field is used as a Prometheus label with the `FlowMetrics` API. Refer to the `FlowMetrics` documentation for more information on using this API.
+              The "Cardinality" column gives information about the implied metric cardinality if this field was to be used as a Prometheus label with the `FlowMetrics` API. Refer to the `FlowMetrics` documentation for more information on using this API.

Member Author

jotak May 27, 2024

@skrthomas this change is not intentional from me, but happened when I regenerated the doc. I can't remember if the desired formulation is "is used" or "was to be used".

Side remark on the flows format reference: in the docs the page title is "Network flows format reference" but the menu item is "JSON flows format reference". Could we use the former only? It doesn't make much sense today to mention "JSON", because that's not only used in JSON but also in other formats such as prometheus labels and soon open telemetry

Contributor

skrthomas May 28, 2024

This is really minor, but "Is used" is preferable just because "was to be" is passive and past tense.

Contributor

skrthomas May 28, 2024

ACK, will make sure these match to the "Network flows format reference"

jotak force-pushed the gen-docs branch from 7f851cb to 03d8540 Compare

May 27, 2024 09:20

Contributor

msherif1234 commented May 28, 2024

/lgtm

openshift-ci bot assigned msherif1234

openshift-ci bot added the lgtm label

memodi approved these changes

View reviewed changes

Contributor

memodi left a comment

/label qe-approved

openshift-ci bot assigned memodi

openshift-ci bot added the qe-approved label

skrthomas reviewed

View reviewed changes

Contributor

skrthomas left a comment

Hey @jotak there were a few things I noticed in my review that need to be addressed. Thank you!

docs/flowcollector-flows-netobserv-io-v1beta2.adoc Outdated

-               - `IPFIX` [deprecated (*)] - to use the legacy IPFIX collector. +
-               `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).
+              | `type` [deprecated (*)] selects the flows tracing agent. Previously, this field allowed to select between `eBPF` or `IPFIX`.
+              Only `eBPF` is allowed now, so this field is deprecated and will be removed in a future version of the API.

Contributor

skrthomas May 28, 2024

Suggested change

      
            Only `eBPF` is allowed now, so this field is deprecated and will be removed in a future version of the API.
          
            Only `eBPF` is allowed now, so this field is deprecated and is planned for removal in a future version of the API.

Contributor

skrthomas May 28, 2024

The RH Style Guidelines ask us to talk about future releases as "planned" instead of as "will happen"

docs/flowcollector-flows-netobserv-io-v1beta2.adoc Outdated

               | `imagePullPolicy`
               | `string`
               | `imagePullPolicy` is the Kubernetes pull policy for the image defined above
               | `interfaces`
               | `array (string)`
-              | `interfaces` contains the interface names from where flows are collected. If empty, the agent fetches all the interfaces in the system, excepting the ones listed in ExcludeInterfaces. An entry enclosed by slashes, such as `/br-/`, is matched as a regular expression. Otherwise it is matched as a case-sensitive string.
+              | `interfaces` contains the interface names from where flows are collected. If empty, the agent
+              fetches all the interfaces in the system, excepting the ones listed in ExcludeInterfaces.

Contributor

skrthomas May 28, 2024

Suggested change

      
            fetches all the interfaces in the system, excepting the ones listed in ExcludeInterfaces.
          
            fetches all the interfaces in the system, excepting the ones listed in `excludeInterfaces`.

Contributor

skrthomas May 28, 2024

Since this references another parameter, can we put it in backticks? Also I notice the capitalization here is maybe needing a lowercase e.

docs/flowcollector-flows-netobserv-io-v1beta2.adoc Outdated

               | `integer`
-              | `cacheMaxFlows` is the max number of flows in an aggregate; when reached, the reporter sends the flows.
+              | The prometheus HTTP port

Contributor

skrthomas May 28, 2024

Suggested change

      
            | The prometheus HTTP port
          
            | The Prometheus HTTP port

Contributor

skrthomas May 28, 2024

I think Prometheus always be capitalized.

Member Author

jotak Jun 3, 2024

Actually changing this to "The metrics server HTTP port" , that's more correct

docs/flowcollector-flows-netobserv-io-v1beta2.adoc Outdated

               | `lokiStack`
               | `object`
-              | Loki configuration for `LokiStack` mode. This is useful for an easy loki-operator configuration. It is ignored for other modes.
+              | Loki configuration for `LokiStack` mode. This is useful for an easy loki-operator configuration.

Contributor

skrthomas May 28, 2024

Suggested change

      
            | Loki configuration for `LokiStack` mode. This is useful for an easy loki-operator configuration.
          
            | Loki configuration for `LokiStack` mode. This is useful for an easy Loki Operator configuration.

docs/flowcollector-flows-netobserv-io-v1beta2.adoc Outdated

@@ @@ -1225,7 +1613,8 @@ Type:: @@
               Description::
               +
               --
-              Loki configuration for `LokiStack` mode. This is useful for an easy loki-operator configuration. It is ignored for other modes.
+              Loki configuration for `LokiStack` mode. This is useful for an easy loki-operator configuration.

Contributor

skrthomas May 28, 2024

Suggested change

      
            Loki configuration for `LokiStack` mode. This is useful for an easy loki-operator configuration.
          
            Loki configuration for `LokiStack` mode. This is useful for an easy Loki Operator configuration.

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

               | `requests`
               | `integer-or-string`
-              | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+              | Requests describes the minimum amount of compute resources required.
+              If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,

Contributor

skrthomas May 28, 2024

Suggested change

      
            If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
          
            If Requests is omitted for a container, it defaults to `limits` if that is explicitly specified,

Member Author

jotak Jun 3, 2024

that one is not on us it's from the upstream k8s doc

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

-              | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+              | Requests describes the minimum amount of compute resources required.
+              If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+              otherwise to an implementation-defined value. Requests cannot exceed Limits.

Contributor

skrthomas May 28, 2024

Suggested change

      
            otherwise to an implementation-defined value. Requests cannot exceed Limits.
          
            otherwise to an implementation-defined value. The value of `requests` cannot exceed the value of `limits`.

Contributor

skrthomas May 28, 2024

Can we add backticks and a tiny amount of clarifying text?

Member Author

jotak Jun 3, 2024

same here, that's upstream k8s

skrthomas mentioned this pull request

Netobserv API doc regeneration openshift/openshift-docs#76593

Merged

1 task

openshift-ci bot removed the lgtm label

openshift-ci bot commented May 30, 2024

New changes are detected. LGTM label has been removed.

codecov bot commented May 30, 2024 •

edited

Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.53%. Comparing base (1ac0142) to head (583efdc).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #657   +/-   ##
=======================================
  Coverage   66.53%   66.53%           
=======================================
  Files          70       70           
  Lines        8095     8095           
=======================================
  Hits         5386     5386           
  Misses       2315     2315           
  Partials      394      394

Flag	Coverage Δ
unittests	`66.53% <ø> (ø)`

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

Files	Coverage Δ
apis/flowcollector/v1beta2/flowcollector_types.go	`100.00% <ø> (ø)`
apis/flowmetrics/v1alpha1/flowmetric_types.go	`100.00% <ø> (ø)`

jotak added 3 commits

June 3, 2024 13:08


          Regenerate docs

2e32952


          Add flowmetrics doc

2b16fc4


          address feedback

3e03604

jotak force-pushed the gen-docs branch from 513f4a2 to 3e03604 Compare

June 3, 2024 11:16

Member Author

jotak commented Jun 3, 2024

@skrthomas last commit should address your comments; except for what is in the upstream k8s doc


          Update flowmetrics desc

583efdc

Contributor

skrthomas commented Jun 4, 2024

/lgtm thank you, @jotak

jotak merged commit c1b4ee0 into netobserv:main

9 of 10 checks passed

jotak added a commit to jotak/network-observability-operator that referenced this pull request


          Regenerate docs (netobserv#657)

c2edee0

* Regenerate docs

* Add flowmetrics doc

* address feedback

* Update flowmetrics desc

jotak added a commit that referenced this pull request


          Regenerate docs (#657) (#667)

a8a5ea1

* Regenerate docs

* Add flowmetrics doc

* address feedback

* Update flowmetrics desc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment