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.

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

CRD doc update - simplified sample #224

Merged
merged 2 commits into from
Dec 13, 2022
Merged

Conversation

jotak
Copy link
Member

@jotak jotak commented Dec 13, 2022

  • add some explanation about agent's privileged mode
  • add some hints when configuring kafka & TLS
  • add some hints about mTLS
  • remove IPFIX from the sample CR (it still exists but wouldn't show up as the sample CR when installing from OLM console)
  • remove a couple of other much unused fields from the sample CR

@openshift-ci
Copy link

openshift-ci bot commented Dec 13, 2022

[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 by writing /assign @jotak in a comment. 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:

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 Dec 13, 2022

This is to be backported to 4.12

// privileged mode for the eBPF Agent container. If false, the operator will add the following
// capabilities to the container, to enable its correct operation:
// BPF, PERFMON, NET_ADMIN, SYS_RESOURCE.
// privileged mode for the eBPF Agent container. In general this setting can be ignored or set to false:
Copy link
Member Author

Choose a reason for hiding this comment

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

@mariomac can you take a look at this description in particular?

Copy link
Contributor

Choose a reason for hiding this comment

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

Much clearer, thanks for adding context to this!

- add some explanation about agent's privileged mode
- add some hints when configuring kafka & TLS
- add some hints about mTLS
- remove IPFIX from the sample CR (it still exists but wouldn't show up
  as the sample CR when installing from OLM console)
- remove a couple of other much unused fields from the sample CR
@@ -7,7 +7,7 @@ LABEL operators.operatorframework.io.bundle.metadata.v1=metadata/
LABEL operators.operatorframework.io.bundle.package.v1=netobserv-operator
LABEL operators.operatorframework.io.bundle.channels.v1=v0.2.x
LABEL operators.operatorframework.io.bundle.channel.default.v1=v0.2.x
LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.25.2
LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.25.3
Copy link
Contributor

Choose a reason for hiding this comment

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

Makefile is still downloading v1.25.2. Maybe you'd need to update also the downloaded version in the makefile

Copy link
Member Author

Choose a reason for hiding this comment

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

ah yes

ovnKubernetes:
namespace: ovn-kubernetes
daemonSetName: ovnkube-node
containerName: ovnkube-node
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought this file was automatically generated but it seems not. Good to know!

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, in general I want to have all exposed config in this file so it also serves as a reference, however for stuff that are deprecated or that for some reason we don't want to advertise on, it's probably better to not have them here

@openshift-ci openshift-ci bot removed the lgtm label Dec 13, 2022
@openshift-ci
Copy link

openshift-ci bot commented Dec 13, 2022

New changes are detected. LGTM label has been removed.

@jotak jotak merged commit a9dcc21 into netobserv:main Dec 13, 2022
jotak added a commit to jotak/network-observability-operator that referenced this pull request Dec 13, 2022
* CRD doc update - simplified sample

- add some explanation about agent's privileged mode
- add some hints when configuring kafka & TLS
- add some hints about mTLS
- remove IPFIX from the sample CR (it still exists but wouldn't show up
  as the sample CR when installing from OLM console)
- remove a couple of other much unused fields from the sample CR

* update operator-sdk default version
openshift-merge-robot pushed a commit that referenced this pull request Dec 15, 2022
* CRD doc update - simplified sample

- add some explanation about agent's privileged mode
- add some hints when configuring kafka & TLS
- add some hints about mTLS
- remove IPFIX from the sample CR (it still exists but wouldn't show up
  as the sample CR when installing from OLM console)
- remove a couple of other much unused fields from the sample CR

* update operator-sdk default version
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.

None yet

3 participants