Add new unified Helm guide

Consolidate most separate installation guides covering Helm-based installation into a single guide with tabs for the different platforms. Some guides are left intact which are either quite special or relatively uncommon. Signed-off-by: Thomas Graf <thomas@cilium.io>
cilium · Apr 19, 2021 · b6ec84c · b6ec84c
1 parent 4991138
commit b6ec84c
Show file tree

Hide file tree

Showing 33 changed files with 527 additions and 781 deletions.
diff --git a/.github/ISSUE_TEMPLATE/release_template.md b/.github/ISSUE_TEMPLATE/release_template.md
@@ -55,7 +55,7 @@ assignees: ''
         generated helm charts point to the commit that contains the image
         digests.
 - [ ] Run sanity check of Helm install using connectivity-check script.
-      Suggested approach: Follow the full [GKE getting started guide].
+      Suggested approach: Follow the full [Quick Install]
 - [ ] Check draft release from [releases] page
   - [ ] Update the text at the top with 2-3 highlights of the release
   - [ ] Copy the text from `digest-vX.Y.Z.txt` (previously generated with
@@ -85,5 +85,5 @@ assignees: ''
 [kops]: https://github.com/kubernetes/kops/
 [kubespray]: https://github.com/kubernetes-sigs/kubespray/
 [cilium helm release tool]: https://github.com/cilium/charts/blob/master/prepare_artifacts.sh
-[GKE getting started guide]: https://docs.cilium.io/en/stable/gettingstarted/k8s-install-gke/
+[Quick Instsall]: https://docs.cilium.io/en/stable/gettingstarted/k8s-install-default.html
 [cilium-runtime images]: https://quay.io/repository/cilium/cilium-runtime
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -105,9 +105,6 @@ Makefile* @cilium/build
 /Documentation/gettingstarted/hubble* @cilium/hubble @cilium/docs-structure
 /Documentation/gettingstarted/index.rst @cilium/docs-structure
 /Documentation/gettingstarted/ipam.rst @cilium/ipam @cilium/docs-structure
-/Documentation/gettingstarted/k8s-install-eks.rst @cilium/aws @cilium/docs-structure
-/Documentation/gettingstarted/k8s-install-remove-aws-node.rst @cilium/aws @cilium/docs-structure
-/Documentation/gettingstarted/k8s-install-aks* @cilium/azure @cilium/docs-structure
 /Documentation/gettingstarted/kind-configure.rst @cilium/docs-structure
 /Documentation/gettingstarted/kubeproxy-free.rst @cilium/loadbalancer @cilium/docs-structure
 /Documentation/gettingstarted/policy-creation.rst @cilium/policy @cilium/docs-structure

diff --git a/Documentation/concepts/networking/ipam/eni.rst b/Documentation/concepts/networking/ipam/eni.rst
@@ -74,6 +74,62 @@ Configuration
   additional information how to install and run Prometheus including the
   Grafana dashboard.
 
+Custom ENI Configuration
+========================
+
+Custom ENI configuration can be defined with a custom CNI configuration
+``ConfigMap``:
+
+Create a CNI configuration
+--------------------------
+
+Create a ``cni-config.yaml`` file based on the template below. Fill in the
+``subnet-tags`` field, assuming that the subnets in AWS have the tags applied
+to them:
+
+.. code-block:: yaml
+
+   apiVersion: v1
+   kind: ConfigMap
+   metadata:
+     name: cni-configuration
+     namespace: kube-system
+   data:
+     cni-config: |-
+       {
+         "cniVersion":"0.3.1",
+         "name":"cilium",
+         "plugins": [
+           {
+             "cniVersion":"0.3.1",
+             "type":"cilium-cni",
+             "eni": {
+               "subnet-tags":{
+                 "foo":"true"
+               }
+             }
+           }
+         ]
+       }
+
+Deploy the ``ConfigMap``:
+
+.. code-block:: shell-session
+
+   kubectl apply -f cni-config.yaml
+
+Configure Cilium with subnet-tags-filter
+----------------------------------------
+
+Using the instructions above to deploy Cilium, specify the following additional
+arguments to Helm:
+
+.. code-block:: shell-session
+
+   --set cni.customConf=true \
+   --set cni.configMap=cni-configuration \
+   --set eni.subnetTagsFilter="foo=true"
+
 ENI Allocation Parameters
 =========================
 

diff --git a/Documentation/concepts/networking/ipam/gke.rst b/Documentation/concepts/networking/ipam/gke.rst
@@ -10,9 +10,8 @@
 Google Kubernetes Engine
 ########################
 
-When running Cilium on Google GKE following the :ref:`k8s_install_gke` guide,
-the native networking layer of Google Cloud will be utilized for address
-management and IP forwarding.
+When running Cilium on Google GKE, the native networking layer of Google Cloud
+will be utilized for address management and IP forwarding.
 
 ************
 Architecture
@@ -29,7 +28,7 @@ additional details of this IPAM mode.
 
 The corresponding datapath is described in section :ref:`gke_datapath`.
 
-See the getting started guide :ref:`k8s_install_gke` to install Cilium Google
+See the getting started guide :ref:`k8s_install_quick` to install Cilium Google
 Kubernetes Engine (GKE).
 
 *************

diff --git a/Documentation/concepts/networking/routing.rst b/Documentation/concepts/networking/routing.rst
@@ -307,5 +307,5 @@ The following configuration options must be set to run the datapath on GKE:
 * ``native-routing-cidr: x.x.x.x/y``: Set the CIDR in which native routing
   is supported.
 
-See the getting started guide :ref:`k8s_install_gke` to install Cilium on
+See the getting started guide :ref:`k8s_install_quick` to install Cilium on
 Google Kubernetes Engine (GKE).
diff --git a/Documentation/contributing/testing/e2e.rst b/Documentation/contributing/testing/e2e.rst
@@ -486,7 +486,7 @@ An example invocation is
 Running in GKE
 ^^^^^^^^^^^^^^
 
-1- Setup a cluster as in :ref:`k8s_install_gke` or utilize an existing
+1- Setup a cluster as in :ref:`k8s_install_quick` or utilize an existing
 cluster.
 
 .. note:: You do not need to deploy Cilium in this step, as the End-To-End
@@ -525,7 +525,7 @@ AWS EKS (experimental)
 Not all tests can succeed on EKS. Many do, however and may be useful. This `GH issue
 <https://github.com/cilium/cilium/issues/9678#issuecomment-749350425>`_ contains a list of tests that are still failing.
 
-1- Setup a cluster as in :ref:`k8s_install_eks` or utilize an existing
+1- Setup a cluster as in :ref:`k8s_install_quick` or utilize an existing
 cluster.
 
 2- Source the testing integration script from ``cilium/contrib/testing/integrations.sh``.

diff --git a/Documentation/gettingstarted/aws-create-nodegroup.rst b/Documentation/gettingstarted/aws-create-nodegroup.rst
diff --git a/Documentation/gettingstarted/aws-eni.rst b/Documentation/gettingstarted/aws-eni.rst
diff --git a/Documentation/gettingstarted/aws.rst b/Documentation/gettingstarted/aws.rst
@@ -22,7 +22,7 @@ Setup Cilium
 This guide will work with any approach to installing Cilium, including minikube,
 as long as the cilium-operator pod in the deployment can reach the AWS API server
 However, since the most common use of this mechanism is for Kubernetes clusters
-running in AWS, we recommend trying it out along with the guide: :ref:`k8s_install_eks` .
+running in AWS, we recommend trying it out along with the guide: :ref:`k8s_install_quick` .
 
 Create AWS secrets
 ==================

diff --git a/Documentation/gettingstarted/cni-chaining-aws-cni.rst b/Documentation/gettingstarted/cni-chaining-aws-cni.rst
@@ -31,7 +31,7 @@ load-balancing, and encryption.
 Setup Cluster on AWS
 ====================
 
-Follow the instructions in the :ref:`k8s_install_eks` guide to set up an EKS
+Follow the instructions in the :ref:`k8s_install_quick` guide to set up an EKS
 cluster or use any other method of your preference to set up a Kubernetes
 cluster.
 

diff --git a/Documentation/gettingstarted/cni-chaining-azure-cni.rst b/Documentation/gettingstarted/cni-chaining-azure-cni.rst
@@ -13,7 +13,7 @@ Azure CNI
 .. note::
 
    This is not the best option to run Cilium on AKS or Azure. Please refer to
-   :ref:`k8s_install_aks` for the best guide to run Cilium in Azure Cloud.
+   :ref:`k8s_install_quick` for the best guide to run Cilium in Azure Cloud.
    Follow this guide if you specifically want to run Cilium in combination with
    the Azure CNI in a chaining configuration.