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

CLI blog article #69

Merged
merged 24 commits into from
Jul 25, 2024
Merged

CLI blog article #69

merged 24 commits into from
Jul 25, 2024

Conversation

jpinsonneau
Copy link
Contributor

@jpinsonneau jpinsonneau commented Jun 11, 2024

@jpinsonneau jpinsonneau changed the title WIP CLI blog article CLI blog article Jun 13, 2024
@jpinsonneau jpinsonneau marked this pull request as ready for review June 13, 2024 13:38
You should now have access to decrypted packets !

What about a secure connection between two pods ?
For these cases, you need to have a good understanding of what's involved behind the scene. If your application rely on OpenSSL, GnuTLS or NSS TLS library, you should be able to set the `SSLKEYLOGFILE` enviroment variable and extract the result.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does someone knows if we can do that on ingress pods ? 👼

That could be awesome to decrypt cluster incoming traffic. The collector pod could even decrypt the pcap before exporting it.

blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
Copy link
Member

@jotak jotak left a comment

Choose a reason for hiding this comment

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

thanks @jpinsonneau ! I've a bunch of comments but it's mostly just typos
it would be nice if our native English speakers could review as well :) (@stleerh ? @skrthomas ? ... )

blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
Follow the instructions on [https://krew.sigs.k8s.io/docs/user-guide/setup/install/](krew.sigs.k8s.io) official website.
Once installed, run the following command to install netobserv:
```
oc krew install netobserv
Copy link
Member

Choose a reason for hiding this comment

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

honestly ... this looks so much simpler than shipping the tgz, I wonder if we should keep only this way (and productize only the CLI container) ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that's the final goal but for now krew with oc is tech preview
https://docs.openshift.com/container-platform/4.16/cli_reference/openshift_cli/managing-cli-plugins-krew.html

CLI manager is supposed to provide oc and krew out of the box in the future
https://issues.redhat.com/browse/WRKLDS-863

blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
jpinsonneau and others added 10 commits July 17, 2024 16:28
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
Co-authored-by: Joel Takvorian <joel.takvorian@homeblocks.net>
@jpinsonneau
Copy link
Contributor Author

thanks @jpinsonneau ! I've a bunch of comments but it's mostly just typos it would be nice if our native English speakers could review as well :) (@stleerh ? @skrthomas ? ... )

Thanks for your feedback ! I took all your suggestions and suggested something for the support part.

blogs/cli/index.md Outdated Show resolved Hide resolved
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.

Mostly copy edits :) this is really great Julien! I enjoyed reading this a lot.

blogs/cli/index.md Outdated Show resolved Hide resolved

By: Julien Pinsonneau

Installing an entire observability stack may be hard to handle and not worth in some cases. That's why we are introducing Network Observability CLI as a technical preview !
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
Installing an entire observability stack may be hard to handle and not worth in some cases. That's why we are introducing Network Observability CLI as a technical preview !
Installing an entire observability stack may be hard to handle and not worth in some cases. That's why we are introducing Network Observability CLI as a technical preview!

blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved

## A different approach for each scenario

Let's first compare which deployment methods of the Network Observability stack best fit with these example scenarios:
Copy link
Contributor

Choose a reason for hiding this comment

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

Love this comp!! We may want something like this in the docs when the CLI is a GA feature.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we could add such in the official doc, in About Network Observability section when CLI will be GA 👼

blogs/cli/index.md Outdated Show resolved Hide resolved

## Future improvements

For now, the Network Observability CLI is only providing `capture commands` such as [many other observability projects](https://github.com/collabnix/kubetools?tab=readme-ov-file#observability) but it will improve to embed tools to facilitate your life as much as possible.
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
For now, the Network Observability CLI is only providing `capture commands` such as [many other observability projects](https://github.com/collabnix/kubetools?tab=readme-ov-file#observability) but it will improve to embed tools to facilitate your life as much as possible.
For now, the Network Observability CLI is only providing `capture commands` such as [many other observability projects](https://github.com/collabnix/kubetools?tab=readme-ov-file#observability). There are planned improvements to embed tools to facilitate your life as much as possible.

Copy link
Contributor

Choose a reason for hiding this comment

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

Just a more legally-sound future plan. I wonder about "facilitate your life"...like "improve" your life? Just wondering if there's more we can unpack here. It is a big statement! And in what ways 🤔 I guess, when I think of something facilitating another thing, I think of it as something that moves something along. Maybe "facilitate ease in observing network traffic" or something like that 😆

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed, here I have in mind observing, identifying and debugging network but honnestly I don't know where the CLI will end in next years. It could become even more than that !

blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
jpinsonneau and others added 3 commits July 19, 2024 07:36
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
jpinsonneau and others added 5 commits July 19, 2024 07:39
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
blogs/cli/index.md Outdated Show resolved Hide resolved
@jpinsonneau jpinsonneau merged commit 6e0cfcc into netobserv:main Jul 25, 2024
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