Adding documentation for minikube #3391

jainpulkit22 · 2022-03-03T13:25:18Z

This PR updates the kubernetes-installer documentation
and adds a minikube to the list, also supporting documentation
to deploy antrea in minikube is added.

Signed-off-by: Pulkit Jain jainpu@vmware.com

codecov-commenter · 2022-03-03T13:34:15Z

Codecov Report

Merging #3391 (b2e85a4) into main (fc2e855) will decrease coverage by 20.74%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             main    #3391       +/-   ##
===========================================
- Coverage   60.68%   39.94%   -20.75%     
===========================================
  Files         268      306       +38     
  Lines       26853    38849    +11996     
===========================================
- Hits        16296    15517      -779     
- Misses       8751    21781    +13030     
+ Partials     1806     1551      -255

Flag	Coverage Δ
integration-tests	`35.80% <ø> (?)`
kind-e2e-tests	`?`
unit-tests	`42.41% <ø> (+0.08%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
pkg/ovs/openflow/default.go	`0.00% <0.00%> (-100.00%)`	⬇️
pkg/util/runtime/runtime.go	`0.00% <0.00%> (-100.00%)`	⬇️
pkg/agent/openflow/groups.go	`0.00% <0.00%> (-100.00%)`	⬇️
pkg/agent/nodeportlocal/k8s/annotations.go	`0.00% <0.00%> (-93.55%)`	⬇️
pkg/ovs/openflow/logs.go	`9.52% <0.00%> (-90.48%)`	⬇️
pkg/apis/controlplane/register.go	`0.00% <0.00%> (-90.00%)`	⬇️
pkg/agent/controller/networkpolicy/reject.go	`0.00% <0.00%> (-78.23%)`	⬇️
pkg/agent/client.go	`0.00% <0.00%> (-77.42%)`	⬇️
pkg/flowaggregator/certificate.go	`0.00% <0.00%> (-76.58%)`	⬇️
...agent/controller/traceflow/traceflow_controller.go	`0.00% <0.00%> (-69.86%)`	⬇️
... and 289 more

antoninbas · 2022-03-03T18:00:19Z

docs/minikube.md

+### Deploy Antrea to your Minikube cluster
+
+```bash
+minikube start --cni=antrea/build/yamls/antrea.yml --network-plugin=cni


can the --cni parameter take a URL so that we can point it to a released version of Antrea (typically users don't checkout the Antrea repository at all)?

No, it does not accept any url, I tried that, the cni must be set to path of some local file or directory.

Then I suggest something like:

curl -Lo https://github.com/antrea-io/antrea/releases/download/<TAG>/antrea.yml minikube start --cni=antrea.yml --network-plugin=cni

xliuxu · 2022-03-04T03:06:42Z

docs/minikube.md

+<!-- /toc -->
+
+### Install Minikube to your system
+Follow these [steps](https://minikube.sigs.k8s.io/docs/start) to install minikube and set its development environemnt. 


s/environemnt/environment

thanks for pointing it out.

luolanzone · 2022-03-04T05:54:44Z

docs/kubernetes-installers.md

@@ -57,6 +58,10 @@ cluster without deploying a specific network plugin.

 To deploy Antrea on Kind, please follow these [steps](kind.md).

+### minikube


s/minikube/Minikube

luolanzone · 2022-03-04T05:55:17Z

docs/kubernetes-installers.md

@@ -23,6 +23,7 @@ work with that Antrea version.
 | - | AKS, K8s v1.18.14 | Azure | Ubuntu 18.04, moby | Standard_DS2_v2 |  | Antrea CI |
 | - | AKS, K8s v1.19.9 | Azure | Ubuntu 18.04, containerd | Standard_DS2_v2 |  | Antrea CI |
 | - | Kind v0.9.0, K8s v1.19.1 | N/A | Ubuntu 20.10, containerd://1.4.0 | N/A |  | [Requirements for using Antrea on Kind](kind.md) |
+| - | minikube v1.25.0 | N/A | Ubuntu 20.04.2 LTS (5.10.76-linuxkit) arm64, docker://20.10.12 | 8GB RAM | | |


luolanzone · 2022-03-04T05:58:43Z

docs/minikube.md

+  - [Check that everything is working](#check-that-everything-is-working)
+<!-- /toc -->
+
+### Install Minikube to your system


maybe remove to your system

luolanzone · 2022-03-04T05:59:51Z

docs/minikube.md

+### Install Minikube to your system
+Follow these [steps](https://minikube.sigs.k8s.io/docs/start) to install minikube and set its development environment.
+
+### Deploy Antrea to your Minikube cluster


I don't think it's necessary to add your, you can remove it.

luolanzone · 2022-03-04T06:00:03Z

docs/minikube.md

+minikube start --cni=antrea.yml --network-plugin=cni
+```
+
+### Deploy a local build of Antrea to your Minikube cluster (for developers)


luolanzone · 2022-03-04T06:00:34Z

docs/minikube.md

+kubectl apply -f /antrea/build/yamls/antrea.yml
+```
+
+### Check that everything is working


maybe just use Verification as the title.

luolanzone · 2022-03-04T06:01:14Z

docs/minikube.md

+  - [Check that everything is working](#check-that-everything-is-working)
+<!-- /toc -->
+
+### Install Minikube to your system


I think the sub-title sign in this and following titles are not correct, you should use ## not ###.

luolanzone · 2022-03-04T06:03:44Z

docs/minikube.md

+### Deploy Antrea to your Minikube cluster
+
+```bash
+# curl is required because --cni flag, does not accept URL as a parameter


remove , after flag?

luolanzone · 2022-03-04T06:05:57Z

docs/minikube.md

+### Check that everything is working
+
+After a few seconds you should be able to observe the following when running
+`kubectl get -n kube-system pods -l app=antrea`:


even though this command is working, I would suggest to change it to following one:

kubectl get pods -l app=antrea -n kube-system

luolanzone · 2022-03-04T06:09:53Z

docs/minikube.md

+# load the Antrea Docker image in the minikube nodes
+minikube image load projects.registry.vmware.com/antrea/antrea-ubuntu:latest
+# deploy Antrea
+kubectl apply -f /antrea/build/yamls/antrea.yml


remove the first /?, this should be a relative path.

jainpulkit22 · 2022-03-07T08:34:44Z

/test-e2e

tnqn · 2022-03-08T13:52:42Z

docs/minikube.md

+<!-- toc -->
+- [Install Minikube](#install-minikube)
+  - [Deploy Antrea to Minikube cluster](#deploy-antrea-to-minikube-cluster)
+  - [Deploy a local build of Antrea to Minikube cluster (for developers)](#deploy-a-local-build-of-antrea-to-minikube-cluster-for-developers)


"Deploy Antrea" shouldn't be a subsection of "Install Minikube". Two deploy options could be under one section that is in parallel with "Install Minikube" and "Verification", for example:

Install Minikube

Deploy Antrea

Deploy a released version to Minikube cluster

Deploy a local build to Minikube cluster

Verification

thanks for suggestion, will make the necessary changes

tnqn

LGTM

tnqn · 2022-03-09T10:26:26Z

@antoninbas @xliuxu @luolanzone any more comments on this?

luolanzone · 2022-03-09T10:29:22Z

docs/minikube.md

+After a few seconds you should be able to observe the following when running
+`kubectl get pods -l app=antrea -n kube-system`:
+
+```bash


nit: remove bash or use txt

luolanzone

LGTM, one minor comment.

This commit updates the kubernetes-installer documentation and adds a minikube to the list, also supporting documentation to deploy antrea in minikube is added. Signed-off-by: Pulkit Jain <jainpu@vmware.com>

antoninbas · 2022-03-09T19:30:04Z

/skip-all

This commit updates the kubernetes-installer documentation and adds minikube to the list, and supporting documentation to deploy antrea in minikube is added. Signed-off-by: Pulkit Jain <jainpu@vmware.com>

antoninbas reviewed Mar 3, 2022

View reviewed changes

xliuxu reviewed Mar 4, 2022

View reviewed changes

jainpulkit22 force-pushed the minikube-docs branch from 1716693 to b2e85a4 Compare March 4, 2022 05:36

luolanzone reviewed Mar 4, 2022

View reviewed changes

jainpulkit22 force-pushed the minikube-docs branch from b2e85a4 to 9494665 Compare March 4, 2022 05:59

luolanzone reviewed Mar 4, 2022

View reviewed changes

jainpulkit22 force-pushed the minikube-docs branch from 9494665 to e5c358c Compare March 4, 2022 06:41

tnqn reviewed Mar 8, 2022

View reviewed changes

jainpulkit22 force-pushed the minikube-docs branch 2 times, most recently from 20af597 to bb701c9 Compare March 9, 2022 06:40

jainpulkit22 requested a review from tnqn March 9, 2022 09:57

tnqn previously approved these changes Mar 9, 2022

View reviewed changes

luolanzone reviewed Mar 9, 2022

View reviewed changes

luolanzone previously approved these changes Mar 9, 2022

View reviewed changes

Adding documentation for minikube

95a76ac

This commit updates the kubernetes-installer documentation and adds a minikube to the list, also supporting documentation to deploy antrea in minikube is added. Signed-off-by: Pulkit Jain <jainpu@vmware.com>

jainpulkit22 dismissed stale reviews from luolanzone and tnqn via 95a76ac March 9, 2022 10:36

jainpulkit22 force-pushed the minikube-docs branch from bb701c9 to 95a76ac Compare March 9, 2022 10:36

tnqn approved these changes Mar 9, 2022

View reviewed changes

tnqn added this to the Antrea v1.6 release milestone Mar 9, 2022

tnqn added the action/release-note Indicates a PR that should be included in release notes. label Mar 9, 2022

antoninbas approved these changes Mar 9, 2022

View reviewed changes

antoninbas merged commit a51003a into antrea-io:main Mar 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding documentation for minikube #3391

Adding documentation for minikube #3391

jainpulkit22 commented Mar 3, 2022

codecov-commenter commented Mar 3, 2022 •

edited

antoninbas Mar 3, 2022

jainpulkit22 Mar 3, 2022

antoninbas Mar 3, 2022 •

edited

xliuxu Mar 4, 2022

jainpulkit22 Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

luolanzone Mar 4, 2022

jainpulkit22 commented Mar 7, 2022

tnqn Mar 8, 2022

jainpulkit22 Mar 8, 2022

tnqn left a comment

tnqn commented Mar 9, 2022

luolanzone Mar 9, 2022

luolanzone left a comment

antoninbas commented Mar 9, 2022

		@@ -57,6 +58,10 @@ cluster without deploying a specific network plugin.

		To deploy Antrea on Kind, please follow these [steps](kind.md).

		### minikube

Adding documentation for minikube #3391

Adding documentation for minikube #3391

Conversation

jainpulkit22 commented Mar 3, 2022

codecov-commenter commented Mar 3, 2022 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antoninbas Mar 3, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jainpulkit22 commented Mar 7, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tnqn left a comment

Choose a reason for hiding this comment

tnqn commented Mar 9, 2022

Choose a reason for hiding this comment

luolanzone left a comment

Choose a reason for hiding this comment

antoninbas commented Mar 9, 2022

codecov-commenter commented Mar 3, 2022 •

edited

antoninbas Mar 3, 2022 •

edited