Add Documentation for deploying Antrea with Rancher cluster

Signed-off-by: Pulkit Jain <[email protected]>
antrea-io · Mar 31, 2023 · c88683b · c88683b
1 parent d7ffc85
commit c88683b
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 0 deletions.
diff --git a/docs/assets/rancher_cluster.png b/docs/assets/rancher_cluster.png
diff --git a/docs/assets/rancher_cluster_management.png b/docs/assets/rancher_cluster_management.png
diff --git a/docs/assets/rancher_create.png b/docs/assets/rancher_create.png
diff --git a/docs/assets/rancher_node.png b/docs/assets/rancher_node.png
diff --git a/docs/assets/rancher_node_template.png b/docs/assets/rancher_node_template.png
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -161,6 +161,11 @@ please refer to this [guide](kind.md).
 To deploy Antrea in a [Minikube](https://github.com/kubernetes/minikube) cluster,
 please refer to this [guide](minikube.md).
 
+### Deploying Antrea in Rancher Cluster
+
+To deploy Antrea in a [Rancher](https://github.com/rancher/rancher) cluster,
+please refer to this [guide](./rancher.md).
+
 ### Deploying Antrea in AKS, EKS, and GKE
 
 Antrea can work with cloud managed Kubernetes services, and can be deployed to

diff --git a/docs/rancher.md b/docs/rancher.md
@@ -0,0 +1,34 @@
+# Deploying Antrea on Rancher Managed Cluster
+
+<!-- toc -->
+- [Deploy Rancher Server](#deploy-rancher-server)
+- [Deploy Antrea Using Rancher UI](#deploy-antrea-using-rancher-ui)
+<!-- /toc -->
+
+## Deploy Rancher Server
+
+Follow these [steps](https://rancher.com/docs/rancher/v1.6/en/installing-rancher/installing-server/) to deploy rancher server ui dashboard.
+
+## Deploy Antrea Using Rancher UI
+
+* Sign-in to the UI dashboard, and switch to cluster management.
+
+![rancher_cluster_management](./assets/rancher_cluster_management.png)
+
+* Create new Node template there under the RKE configuration section.
+
+![rancher_node_template](./assets/rancher_node_template.png)
+
+* After saving the template, proceed with creating new cluster, under the clusters tab click on create button, then enter the name, and number of worker and controlplane Nodes respectively.
+
+![rancher_create](./assets/rancher_create.png)
+
+* click on "Edit as YAML", and set the network plugin to null, and add an addon for antrea, in the following manner:
+addons_include:
+  -<link of the antrea.yml file>
+
+You can find a few screenshots for validation after following the above steps:
+![rancher_cluster](./assets/rancher_cluster.png)
+![rancher_node](./assets/rancher_node.png)
+
+Note: Antrea(since v1.10.0) is supported on Rancher version v2.7.0+.