Skip to content

Commit

Permalink
chore(docs): Update examples and descriptions of capture create (#968)
Browse files Browse the repository at this point in the history
# Description

Small change to simplify descriptions and examples of capture create
command to match with the latest documentation.

## Related Issue

na

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

## Screenshots

Before:
<img width="1367" alt="{B708D263-A154-4AD3-A1F2-557841965925}"
src="https://github.com/user-attachments/assets/e489032a-7720-4624-967f-52d472379ddb">

After:
<img width="1251" alt="{7A5EFCDE-56FB-4145-9673-A6302F104551}"
src="https://github.com/user-attachments/assets/270ab69e-1392-4fee-b9ba-7e2527a98cd8">



---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.

Signed-off-by: Kamil Przepiorowski <kamil.prz@gmail.com>
  • Loading branch information
kamilprz authored Nov 13, 2024
1 parent af10489 commit df6c470
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions cli/cmd/capture/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,29 +76,29 @@ const (
)

var createExample = templates.Examples(i18n.T(`
# Capture network packets on the node selected by node names and copy the artifacts to the node host path /mnt/capture
kubectl retina capture create --host-path /mnt/capture --namespace capture --node-names "aks-nodepool1-41844487-vmss000000,aks-nodepool1-41844487-vmss000001"
# Select nodes by node name and copy the artifacts to the node host path
kubectl retina capture create --host-path /mnt/retina/testcapture --node-names "<nodename1>,<nodename2>"
# Capture network packets on the coredns pods determined by pod-selectors and namespace-selectors
kubectl retina capture create --host-path /mnt/capture --namespace capture --pod-selectors="k8s-app=kube-dns" --namespace-selectors="kubernetes.io/metadata.name=kube-system"
# Select pods determined by pod-selectors and namespace-selectors
kubectl retina capture create --namespace capture --pod-selectors="k8s-app=kube-dns" --namespace-selectors="kubernetes.io/metadata.name=kube-system"
# Capture network packets on nodes with label "agentpool=agentpool" and "version:v20"
kubectl retina capture create --host-path /mnt/capture --node-selectors="agentpool=agentpool,version:v20"
# Select nodes with label "agentpool=agentpool" and "version:v20"
kubectl retina capture create --node-selectors="agentpool=agentpool,version:v20"
# Capture network packets on nodes using node-selector with duration 10s
kubectl retina capture create --host-path=/mnt/capture --node-selectors="agentpool=agentpool" --duration=10s
# Select nodes using node-selector and set duration to 10s
kubectl retina capture create --node-selectors="agentpool=agentpool" --duration=10s
# Capture network packets on nodes using node-selector and upload the artifacts to blob storage with SAS URL https://testaccount.blob.core.windows.net/<token>
# Select nodes using node-selector and upload the artifacts to blob storage with SAS URL https://testaccount.blob.core.windows.net/<token>
kubectl retina capture create --node-selectors="agentpool=agentpool" --blob-upload=https://testaccount.blob.core.windows.net/<token>
# Capture network packets on nodes using node-selector and upload the artifacts to AWS S3
# Select nodes using node-selector and upload the artifacts to AWS S3
kubectl retina capture create --node-selectors="agentpool=agentpool" \
--s3-bucket "your-bucket-name" \
--s3-region "eu-central-1"\
--s3-access-key-id "your-access-key-id" \
--s3-secret-access-key "your-secret-access-key"
# Capture network packets on nodes using node-selector and upload the artifacts to S3-compatible service (like MinIO)
# Select nodes using node-selector and upload the artifacts to S3-compatible service (like MinIO)
kubectl retina capture create --node-selectors="agentpool=agentpool" \
--s3-bucket "your-bucket-name" \
--s3-endpoint "https://play.min.io:9000" \
Expand Down

0 comments on commit df6c470

Please sign in to comment.