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
docs: HOWTO run cilium-cli e2e connectivity tests #25217
Conversation
07db998
to
3848338
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Added some nits, but overall lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@brb 👋🏻 This was quite a large PR to review for documentation. In the future, you can please add smaller sections in smaller commits?
Extensive changes required.
To run all of the runtime tests, execute the following command from the ``test`` directory: | ||
|
||
.. code-block:: shell-session | ||
Before running the connectivity tests you need to install `Cilium CLI <https://github.com/cilium/cilium-cli#installation>`_. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
clarity
Before running the connectivity tests you need to install `Cilium CLI <https://github.com/cilium/cilium-cli#installation>`_. | |
Before running the connectivity tests, you must install `Cilium CLI <https://github.com/cilium/cilium-cli#installation>`_. |
Alternatively, ``Cilium CLI`` can be manually built and installed by fetching | ||
``https://github.com/cilium/cilium-cli``, and then running ``make install``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use active voice, comma nit, clarity
Alternatively, ``Cilium CLI`` can be manually built and installed by fetching | |
``https://github.com/cilium/cilium-cli``, and then running ``make install``. | |
Alternatively, you can manually build and install ``Cilium CLI`` by fetching | |
``https://github.com/cilium/cilium-cli`` and running ``make install``. |
Afterwards, you need to install Cilium. The preferred way is to use | ||
`cilium-cli install <https://github.com/cilium/cilium-cli/#install-cilium>`_, | ||
as it is able to automate some steps (e.g., detecting ``kube-apiserver`` endpoint | ||
address which otherwise needs to be specified when running w/o ``kube-proxy``, or | ||
set an annotation to a K8s worker node to prevent Cilium from being scheduled on it). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarity, no Latin abbreviations
Afterwards, you need to install Cilium. The preferred way is to use | |
`cilium-cli install <https://github.com/cilium/cilium-cli/#install-cilium>`_, | |
as it is able to automate some steps (e.g., detecting ``kube-apiserver`` endpoint | |
address which otherwise needs to be specified when running w/o ``kube-proxy``, or | |
set an annotation to a K8s worker node to prevent Cilium from being scheduled on it). | |
After installing kind, the next step is to install Cilium. The preferred installation method is to use | |
`cilium-cli install <https://github.com/cilium/cilium-cli/#install-cilium>`_, | |
which can automate some steps (for example, detecting a ``kube-apiserver`` endpoint | |
address which otherwise needs to be specified when running without ``kube-proxy``; or | |
setting an annotation to a Kubernetes worker node to prevent Cilium from being scheduled on it). |
IdentitiesOnly yes | ||
LogLevel FATAL | ||
|
||
To run this you can use the following command: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To run this you can use the following command: | |
To run this ssh-config you can use the following command: |
+----------------------+-------------------+--------------+------------------------------------------------------------------+ | ||
| NFS | 0 | 1 | If Cilium folder needs to be shared using NFS | | ||
+----------------------+-------------------+--------------+------------------------------------------------------------------+ | ||
| IPv6 | 0 | 0-1 | If 1 the Kubernetes cluster will use IPv6 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| IPv6 | 0 | 0-1 | If 1 the Kubernetes cluster will use IPv6 | | |
| IPv6 | 0 | 0-1 | If 1 the Kubernetes cluster uses IPv6 | |
+----------------------+-------------------+--------------+------------------------------------------------------------------+ | ||
| IPv6 | 0 | 0-1 | If 1 the Kubernetes cluster will use IPv6 | | ||
+----------------------+-------------------+--------------+------------------------------------------------------------------+ | ||
| CONTAINER\_RUNTIME | docker | containerd | To set the default container runtime in the Kubernetes cluster | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| CONTAINER\_RUNTIME | docker | containerd | To set the default container runtime in the Kubernetes cluster | | |
| CONTAINER\_RUNTIME | docker | containerd | Set the default container runtime in the Kubernetes cluster | |
+----------------------+-------------------+--------------+------------------------------------------------------------------+ | ||
| K8S\_VERSION | 1.18 | 1.\*\* | Kubernetes version to install | | ||
+----------------------+-------------------+--------------+------------------------------------------------------------------+ | ||
| KUBEPROXY | 1 | 0-1 | If 0 the Kubernetes' kube-proxy won't be installed | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| KUBEPROXY | 1 | 0-1 | If 0 the Kubernetes' kube-proxy won't be installed | | |
| KUBEPROXY | 1 | 0-1 | If 0 the Kubernetes kube-proxy doesn't install | |
~~~~~~~~~~~~~~~~~~ | ||
|
||
Have a question about how the tests work or want to chat more about improving the | ||
testing infrastructure for Cilium? Hop on over to the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
testing infrastructure for Cilium? Hop on over to the | |
testing infrastructure for Cilium? Join the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@brb 👋🏻 This was quite a large PR to review for documentation. In the future, you can please add smaller sections in smaller commits?
Extensive changes required.
@zacharysarah Hey, thanks a lot for the extensive review! I should have mentioned in the PR description that |
Ah sorry, my bad, I should have looked more closely at the changes to file structure. If the content is deprecated, then let's leave it alone and not touch it. Out of curiosity though, if the content is deprecated, is there a reason to keep it in the current release as legacy and not just delete it while leaving it intact in previous release branches? EDIT: Whatever you choose, I'm approving to unblock this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving to unblock, with notes about options in the comments.
82abeb7
to
0e8450b
Compare
Addressed the feedback. The |
@brb needs rebase |
Signed-off-by: Martynas Pumputis <m@lambda.lt>
Signed-off-by: Martynas Pumputis <m@lambda.lt>
Signed-off-by: Martynas Pumputis <m@lambda.lt>
@aanm Rebased. Could you merge it? |
This PR adds instructions how to run e2e conformance tests locally and on LVH VMs.
A follow-up PR will add info about
ci-e2e
and some tips how to develop those tests.