Skip to content

Regenerate doc#1071

Merged
jotak merged 5 commits intonetobserv:mainfrom
jotak:regen-doc
Feb 11, 2025
Merged

Regenerate doc#1071
jotak merged 5 commits intonetobserv:mainfrom
jotak:regen-doc

Conversation

@jotak
Copy link
Member

@jotak jotak commented Jan 28, 2025

@openshift-ci
Copy link

openshift-ci bot commented Jan 28, 2025

[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 Code Review Process.

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

Details Needs approval from an approver in each of these files:

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

@jotak
Copy link
Member Author

jotak commented Jan 28, 2025

I have a couple of issues that must be fixed:

missing cardinality for field DstK8S_NetworkName
missing cardinality for field SrcK8S_NetworkName
missing cardinality for field Udns

@codecov
Copy link

codecov bot commented Jan 28, 2025

Codecov Report

Attention: Patch coverage is 20.00000% with 8 lines in your changes missing coverage. Please review.

Project coverage is 62.46%. Comparing base (5d32870) to head (63b67ec).
Report is 14 commits behind head on main.

Files with missing lines Patch % Lines
...s/flowcollector/v1beta1/zz_generated.conversion.go 0.00% 2 Missing ⚠️
...pis/flowcollector/v1beta1/zz_generated.deepcopy.go 0.00% 2 Missing ⚠️
...pis/flowcollector/v1beta2/zz_generated.deepcopy.go 0.00% 2 Missing ⚠️
controllers/ebpf/agent_controller.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1071   +/-   ##
=======================================
  Coverage   62.46%   62.46%           
=======================================
  Files          77       77           
  Lines       11581    11581           
=======================================
  Hits         7234     7234           
  Misses       3889     3889           
  Partials      458      458           
Flag Coverage Δ
unittests 62.46% <20.00%> (ø)

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

Files with missing lines Coverage Δ
apis/flowcollector/v1beta1/flowcollector_types.go 100.00% <ø> (ø)
apis/flowcollector/v1beta2/flowcollector_types.go 100.00% <ø> (ø)
...lector/v1beta2/flowcollector_validation_webhook.go 70.55% <100.00%> (ø)
apis/flowmetrics/v1alpha1/flowmetric_types.go 100.00% <ø> (ø)
...s/flowcollector/v1beta1/zz_generated.conversion.go 33.09% <0.00%> (ø)
...pis/flowcollector/v1beta1/zz_generated.deepcopy.go 0.00% <0.00%> (ø)
...pis/flowcollector/v1beta2/zz_generated.deepcopy.go 39.58% <0.00%> (ø)
controllers/ebpf/agent_controller.go 45.96% <0.00%> (ø)

@msherif1234
Copy link
Contributor

/ok-to-test

@openshift-ci openshift-ci bot added the ok-to-test To set manually when a PR is safe to test. Triggers image build on PR. label Jan 31, 2025
@github-actions
Copy link

New images:

  • quay.io/netobserv/network-observability-operator:c9e12b3
  • quay.io/netobserv/network-observability-operator-bundle:v0.0.0-c9e12b3
  • quay.io/netobserv/network-observability-operator-catalog:v0.0.0-c9e12b3

They will expire after two weeks.

To deploy this build:

# Direct deployment, from operator repo
IMAGE=quay.io/netobserv/network-observability-operator:c9e12b3 make deploy

# Or using operator-sdk
operator-sdk run bundle quay.io/netobserv/network-observability-operator-bundle:v0.0.0-c9e12b3

Or as a Catalog Source:

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: netobserv-dev
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: quay.io/netobserv/network-observability-operator-catalog:v0.0.0-c9e12b3
  displayName: NetObserv development catalog
  publisher: Me
  updateStrategy:
    registryPoll:
      interval: 1m

@github-actions github-actions bot removed the ok-to-test To set manually when a PR is safe to test. Triggers image build on PR. label Feb 3, 2025
- bpfman: mention prereq on bpfman operator
- filters: mention important information on default behaviour, how to
  change it, and sampling
- tail filters: mention how they compare with bpf filters
- a few docs style nits
- rename Go field FlowFilterRules=>Rules to match the json name
Copy link
Contributor

@skrthomas skrthomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few review comments for Flows Format reference. on the flows-format.adoc, one out of scope comment I notice is line 468, the specs don't have backticks, so they aren't formatting correctly:

| Type of record: 'flowLog' for regular flow logs, or 'newConnection', 'heartbeat', 'endConnection' for conversation tracking

Should be:

| Type of record: flowLog for regular flow logs, or newConnection, heartbeat, endConnection for conversation tracking


- Use `Drop` to drop every flow considered as duplicates, allowing saving more on resource usage but potentially loosing some information such as the network interfaces used from peer, or network events. +

- Use `Sample` to randomly keep only 1 flow on 50 (by default) among the ones considered as duplicates. This is a compromise between dropping every duplicates or keeping every duplicates. This sampling action comes in addition to the Agent-based sampling. If both Agent and Processor sampling are 50, the combined sampling is 1:2500. +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Use `Sample` to randomly keep only 1 flow on 50 (by default) among the ones considered as duplicates. This is a compromise between dropping every duplicates or keeping every duplicates. This sampling action comes in addition to the Agent-based sampling. If both Agent and Processor sampling are 50, the combined sampling is 1:2500. +
- Use `Sample` to randomly keep only 1 flow on 50, which is the default, among the ones considered as duplicates. This is a compromise between dropping every duplicates or keeping every duplicates. This sampling action comes in addition to the Agent-based sampling. If both Agent and Processor sampling values are 50, the combined sampling is 1:2500. +

Description::
+
--
`FLPFilterSet` defines the desired configuration for FLP-based filtering satisfying all conditions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`FLPFilterSet` defines the desired configuration for FLP-based filtering satisfying all conditions
`FLPFilterSet` defines the desired configuration for FLP-based filtering satisfying all conditions.

Description::
+
--
`FLPSingleFilter` defines the desired configuration for a single FLP-based filter
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`FLPSingleFilter` defines the desired configuration for a single FLP-based filter
`FLPSingleFilter` defines the desired configuration for a single FLP-based filter.


| `matchType`
| `string`
| Type of matching to apply
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Type of matching to apply
| Type of matching to apply.

Comment on lines +231 to +237
| Network events, such as network policy actions, composed of nested fields: +
- Feature (such as "acl" for network policies) +
- Type (such as an "AdminNetworkPolicy") +
- Namespace (namespace where the event applies, if any) +
- Name (name of the resource that triggered the event) +
- Action (such as "allow" or "drop") +
- Direction (Ingress or Egress)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jotak can we add a Note to this that Network Events is only available in 4.17 and 4.18 versions of OpenShift Container Platform?

Comment on lines 426 to 451
| packet translation dst address
| `xlat_dst_address`
| no
| avoid
| n/a
| `XlatDstPort`
| number
| packet translation dst port
| `xlat_dst_port`
| no
| careful
| n/a
| `XlatSrcAddr`
| string
| packet translation src address
| `xlat_src_address`
| no
| avoid
| n/a
| `XlatSrcPort`
| number
| packet translation src port
| `xlat_src_port`
| no
| careful
| n/a
Copy link
Contributor

@skrthomas skrthomas Feb 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to spell out "source" and "destination" in the description and begin with a capital P

Comment on lines +419 to +421
| List of User Defined Networks
| `udns`
| no
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, should we note that UDN is dev preview?

It requires using the OVN-Kubernetes network plugin with the Observability feature.
IMPORTANT: This feature is available as a Developer Preview. +

- `PacketTranslation`: enable enriching flows with packet translation information, such as Service NAT. +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commenting here but this comment is for line 218, I think we can remove Developer Preview for this and mention that its now Technology Preview instead.

@openshift-ci openshift-ci bot removed the lgtm label Feb 10, 2025
@openshift-ci
Copy link

openshift-ci bot commented Feb 10, 2025

New changes are detected. LGTM label has been removed.

@jotak
Copy link
Member Author

jotak commented Feb 10, 2025

@skrthomas I'm not sure about mentioning tech/dev preview in the flow-format doc, as these texts also end up in the app

@jotak jotak merged commit a9c75f4 into netobserv:main Feb 11, 2025
13 of 14 checks passed
jotak added a commit to jotak/network-observability-operator that referenced this pull request Feb 11, 2025
* Regenerate doc

* Add missing cardinality

* Improve docs on newly added features

- bpfman: mention prereq on bpfman operator
- filters: mention important information on default behaviour, how to
  change it, and sampling
- tail filters: mention how they compare with bpf filters
- a few docs style nits
- rename Go field FlowFilterRules=>Rules to match the json name

* doc feedback

* doc feedback
jotak added a commit that referenced this pull request Feb 11, 2025
* Regenerate doc (#1071)

* Regenerate doc

* Add missing cardinality

* Improve docs on newly added features

- bpfman: mention prereq on bpfman operator
- filters: mention important information on default behaviour, how to
  change it, and sampling
- tail filters: mention how they compare with bpf filters
- a few docs style nits
- rename Go field FlowFilterRules=>Rules to match the json name

* doc feedback

* doc feedback

* Update links for 1.8
@jotak jotak deleted the regen-doc branch June 2, 2025 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants