Skip to content
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

NETOBSERV-1104: remove italic text in CRD doc #407

Merged
merged 1 commit into from
Aug 29, 2023
Merged

NETOBSERV-1104: remove italic text in CRD doc #407

merged 1 commit into from
Aug 29, 2023

Conversation

jotak
Copy link
Member

@jotak jotak commented Aug 29, 2023 •
edited

Description

The CRD doc displayed in the OLM console doesn't support italic text, so remove it from the doc (replaced with brackets)

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.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
    • If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
    • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
    • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
    • Standard QE validation, with pre-merge tests unless stated otherwise.
    • Regression tests only (e.g. refactoring with no user-facing change).
    • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Aug 29, 2023 •
edited by openshift-ci bot

@jotak: This pull request references NETOBSERV-1104 which is a valid jira issue.

In response to this:

Description

The CRD doc displayed in the OLM console doesn't support italic text, so remove it from the doc (replaced with brackets)

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.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
  • If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
  • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
  • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
  • Standard QE validation, with pre-merge tests unless stated otherwise.
  • Regression tests only (e.g. refactoring with no user-facing change).
  • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Aug 29, 2023 •
edited by openshift-ci bot

@jotak: This pull request references NETOBSERV-1104 which is a valid jira issue.

In response to this:

Description

The CRD doc displayed in the OLM console doesn't support italic text, so remove it from the doc (replaced with brackets)

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.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
  • If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
  • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
  • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
  • Standard QE validation, with pre-merge tests unless stated otherwise.
  • Regression tests only (e.g. refactoring with no user-facing change).
  • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Aug 29, 2023 •
edited by openshift-ci bot

@jotak: This pull request references NETOBSERV-1104 which is a valid jira issue.

In response to this:

Description

The CRD doc displayed in the OLM console doesn't support italic text, so remove it from the doc (replaced with brackets)

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.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
  • If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
  • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
  • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
  • Standard QE validation, with pre-merge tests unless stated otherwise.
  • Regression tests only (e.g. refactoring with no user-facing change).
  • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jotak
Copy link
Member Author

jotak commented Aug 29, 2023

@skrthomas this is a slight formatting change for the API reference: previously the mentions of "unsupported" or "deprecated" were in italic, which worked well in the generated asciidoc, but that doesn't work well for the doc displayed in the OLM form of the Console ... so removing italic in favor of brackets; does that sound good to you?

@jotak jotak added the ok-to-test To set manually when a PR is safe to test. Triggers image build on PR. label Aug 29, 2023
@codecov
Copy link

codecov bot commented Aug 29, 2023

Codecov Report

Merging #407 (a934a33) into main (3e5454d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #407   +/-   ##
=======================================
  Coverage   55.49%   55.49%           
=======================================
  Files          45       45           
  Lines        5874     5874           
=======================================
  Hits         3260     3260           
  Misses       2393     2393           
  Partials      221      221
Flag Coverage Δ
unittests 55.49% <ø> (ø)

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

Files Changed Coverage Δ
api/v1beta1/flowcollector_types.go 100.00% <ø> (ø)

@github-actions
Copy link

New images:

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

They will expire after two weeks.

To deploy this build:

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

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

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-037e152
  displayName: NetObserv development catalog
  publisher: Me
  updateStrategy:
    registryPoll:
      interval: 1m

@openshift-ci openshift-ci bot added the lgtm label Aug 29, 2023
jotak added a commit to dushyantbehl/network-observability-operator that referenced this pull request Aug 29, 2023
@jotak
Doc update
63bd6ae 
- Remove mention of INGRESS/EGRESS having to be enabled since it's not
  configurable
- Remove italic text (cf
  netobserv#407 )
- Update bundle
@Amoghrd
Copy link
Contributor

Amoghrd commented Aug 29, 2023

/label qe-approved

@openshift-ci openshift-ci bot added the qe-approved QE has approved this pull request label Aug 29, 2023
skrthomas
skrthomas approved these changes Aug 29, 2023
View reviewed changes
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.

/lgtm

@jotak
Copy link
Member Author

jotak commented Aug 29, 2023

/approve

@openshift-ci
Copy link

openshift-ci bot commented Aug 29, 2023

[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:

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

@openshift-merge-robot openshift-merge-robot merged commit 5e28ebf into netobserv:main Aug 29, 2023
11 checks passed
openshift-merge-robot pushed a commit that referenced this pull request Sep 5, 2023
@dushyantbehl @jotak @jpinsonneau
NETOBSERV-1110: Enable support for Flow RTT (#394)
51294b8 
* NETOBSERV-1110: Enable support for Flow RTT

Signed-off-by: Dushyant Behl <dushyantbehl@users.noreply.github.com>

* Convert ebpf operator types to enum instead of boolean.

Signed-off-by: Dushyant Behl <dushyantbehl@users.noreply.github.com>

* Use enum for agent features

Also a couple of fixes:
- In connection tracking, field "MaxTimeFlowRttNs" was wrongly bound to
  DNSTracking feature instead of FlowRTT
- Fixed regression on agent's AllowHostDirVolumePlugin SCC for DNS
- From a previous merged change mistake, in Agent controller, when drops/dns
  features were enabled without privileged mode, the corresponding error
message wasn't written anymore

* Update controllers/flowcollector_controller_iso_test.go

Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>

* Update api/v1beta1/flowcollector_types.go

Co-authored-by: Julien Pinsonneau <91894519+jpinsonneau@users.noreply.github.com>

* Doc update

- Remove mention of INGRESS/EGRESS having to be enabled since it's not
  configurable
- Remove italic text (cf
  #407 )
- Update bundle

* Address review comments

- Use PascalCase for enums
- Copy array in webhook
- Update bundle

* update doc

---------

Signed-off-by: Dushyant Behl <dushyantbehl@users.noreply.github.com>
Co-authored-by: Joel Takvorian <jtakvori@redhat.com>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Julien Pinsonneau <91894519+jpinsonneau@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skrthomas skrthomas skrthomas approved these changes

@jpinsonneau jpinsonneau jpinsonneau approved these changes

@Amoghrd Amoghrd Awaiting requested review from Amoghrd

Assignees

@skrthomas skrthomas

@jpinsonneau jpinsonneau

Labels
approved jira/valid-reference lgtm ok-to-test To set manually when a PR is safe to test. Triggers image build on PR. qe-approved QE has approved this pull request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@jotak @openshift-ci-robot @Amoghrd @skrthomas @jpinsonneau @openshift-merge-robot