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

docs: HOWTO run cilium-cli e2e connectivity tests #25217

Merged
merged 3 commits into from Jul 7, 2023
Merged

Conversation

brb
Copy link
Member

@brb brb commented May 1, 2023

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.

@brb brb added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/CI-improvement Topic or proposal to improve the Continuous Integration workflow release-note/misc This PR makes changes that have no direct user impact. labels May 1, 2023
@brb brb force-pushed the pr/brb/docs-ci-e2e branch 6 times, most recently from 07db998 to 3848338 Compare May 24, 2023 18:57
@brb brb marked this pull request as ready for review May 24, 2023 19:05
@brb brb requested review from a team as code owners May 24, 2023 19:05
@brb brb requested review from bimmlerd and zacharysarah May 24, 2023 19:05
Copy link
Member

@bimmlerd bimmlerd left a 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

Documentation/contributing/testing/e2e.rst Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@zacharysarah zacharysarah left a 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.

Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
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>`_.
Copy link
Contributor

Choose a reason for hiding this comment

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

clarity

Suggested change
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>`_.

Comment on lines +33 to +34
Alternatively, ``Cilium CLI`` can be manually built and installed by fetching
``https://github.com/cilium/cilium-cli``, and then running ``make install``.
Copy link
Contributor

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

Suggested change
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``.

Comment on lines +51 to +55
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).
Copy link
Contributor

Choose a reason for hiding this comment

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

Clarity, no Latin abbreviations

Suggested change
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:
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
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 |
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
| 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 |
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
| 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 |
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
| 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
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
testing infrastructure for Cilium? Hop on over to the
testing infrastructure for Cilium? Join the

Copy link
Contributor

@zacharysarah zacharysarah left a 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.

@brb
Copy link
Member Author

brb commented May 30, 2023

This was quite a large PR to review for documentation. In the future, you can please add smaller sections in smaller commits?

@zacharysarah Hey, thanks a lot for the extensive review! I should have mentioned in the PR description that e2e_legacy.rst is an old doc page, and my PR just renamed it from e2e.rst to e2e_legacy.rst. Ideally, I'd like to phase it out, and do not touch it. However, considering that you put a lot of effort in reviewing it, I think I need to address your comments.

@zacharysarah
Copy link
Contributor

zacharysarah commented Jun 6, 2023

@brb

However, considering that you put a lot of effort in reviewing it, I think I need to address your comments.

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.

Copy link
Contributor

@zacharysarah zacharysarah left a 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.

@brb brb added the needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch label Jun 30, 2023
@brb brb force-pushed the pr/brb/docs-ci-e2e branch 2 times, most recently from 82abeb7 to 0e8450b Compare June 30, 2023 14:23
@brb
Copy link
Member Author

brb commented Jun 30, 2023

Addressed the feedback. The e2e_legacy.rst will be removed once we convert all ginkgo tests (expected to happen in v1.15). Marking as ready-to-merge.

@brb brb added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jun 30, 2023
@aanm
Copy link
Member

aanm commented Jul 7, 2023

@brb needs rebase

@aanm aanm added dont-merge/needs-rebase This PR needs to be rebased because it has merge conflicts. and removed ready-to-merge This PR has passed all tests and received consensus from code owners to merge. labels Jul 7, 2023
brb added 3 commits July 7, 2023 13:14
Signed-off-by: Martynas Pumputis <m@lambda.lt>
Signed-off-by: Martynas Pumputis <m@lambda.lt>
Signed-off-by: Martynas Pumputis <m@lambda.lt>
@brb brb removed the dont-merge/needs-rebase This PR needs to be rebased because it has merge conflicts. label Jul 7, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.14.0 Jul 7, 2023
@brb
Copy link
Member Author

brb commented Jul 7, 2023

@aanm Rebased. Could you merge it?

@aanm aanm merged commit 16ef64b into main Jul 7, 2023
40 checks passed
@aanm aanm deleted the pr/brb/docs-ci-e2e branch July 7, 2023 13:29
@jibi jibi mentioned this pull request Jul 10, 2023
19 tasks
@jibi jibi added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Jul 10, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from main to Backport pending to v1.14 in 1.14.0 Jul 10, 2023
@julianwiedmann julianwiedmann added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Jul 11, 2023
@aanm aanm moved this from Backport pending to v1.14 to Backport done to v1.14 in 1.14.0 Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/CI-improvement Topic or proposal to improve the Continuous Integration workflow area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.14.0
Backport done to v1.14
Development

Successfully merging this pull request may close these issues.

None yet

6 participants