WARNING: You are looking at unreleased Cilium documentation.
Please use the official rendered version released here:
https://docs.cilium.io

.. group-tab:: GKE

   The following commands create a Kubernetes cluster using `Google
   Kubernetes Engine <https://cloud.google.com/kubernetes-engine>`_.  See
   `Installing Google Cloud SDK <https://cloud.google.com/sdk/install>`_
   for instructions on how to install ``gcloud`` and prepare your
   account.

   .. code-block:: bash

       export NAME="$(whoami)-$RANDOM"
       # Create the node pool with the following taint to guarantee that
       # Pods are only scheduled/executed in the node when Cilium is ready.
       # Alternatively, see the note below.
       gcloud container clusters create "${NAME}" \
        --node-taints node.cilium.io/agent-not-ready=true:NoExecute \
        --zone us-west2-a
       gcloud container clusters get-credentials "${NAME}" --zone us-west2-a

   .. note::

      Please make sure to read and understand the documentation page on :ref:`taint effects and unmanaged pods<taint_effects>`.

.. group-tab:: AKS

   The following commands create a Kubernetes cluster using `Azure
   Kubernetes Service <https://docs.microsoft.com/en-us/azure/aks/>`_ with
   no CNI plugin pre-installed (BYOCNI). See `Azure Cloud CLI
   <https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest>`_
   for instructions on how to install ``az`` and prepare your account, and
   the `Bring your own CNI documentation
   <https://docs.microsoft.com/en-us/azure/aks/use-byo-cni?tabs=azure-cli>`_
   for more details about BYOCNI prerequisites / implications.

   .. code-block:: bash

       export NAME="$(whoami)-$RANDOM"
       export AZURE_RESOURCE_GROUP="${NAME}-group"
       az group create --name "${AZURE_RESOURCE_GROUP}" -l westus2

       # Create AKS cluster
       az aks create \
         --resource-group "${AZURE_RESOURCE_GROUP}" \
         --name "${NAME}" \
         --network-plugin none \
         --generate-ssh-keys

       # Get the credentials to access the cluster with kubectl
       az aks get-credentials --resource-group "${AZURE_RESOURCE_GROUP}" --name "${NAME}"

.. group-tab:: EKS

   The following commands create a Kubernetes cluster with ``eksctl``
   using `Amazon Elastic Kubernetes Service
   <https://aws.amazon.com/eks/>`_.  See `eksctl Installation
   <https://github.com/weaveworks/eksctl>`_ for instructions on how to
   install ``eksctl`` and prepare your account.

   .. code-block:: none

       export NAME="$(whoami)-$RANDOM"
       cat <<EOF >eks-config.yaml
       apiVersion: eksctl.io/v1alpha5
       kind: ClusterConfig

       metadata:
         name: ${NAME}
         region: eu-west-1

       managedNodeGroups:
       - name: ng-1
         desiredCapacity: 2
         privateNetworking: true
         # taint nodes so that application pods are
         # not scheduled/executed until Cilium is deployed.
         # Alternatively, see the note below.
         taints:
          - key: "node.cilium.io/agent-not-ready"
            value: "true"
            effect: "NoExecute"
       EOF
       eksctl create cluster -f ./eks-config.yaml

   .. note::

      Please make sure to read and understand the documentation page on :ref:`taint effects and unmanaged pods<taint_effects>`.

.. group-tab:: kind

   Install ``kind`` >= v0.7.0 per kind documentation:
   `Installation and Usage <https://kind.sigs.k8s.io/#installation-and-usage>`_

   .. parsed-literal::

      curl -LO \ |SCM_WEB|\/Documentation/installation/kind-config.yaml
      kind create cluster --config=kind-config.yaml

   .. note::

     Cilium may fail to deploy due to too many open files in one or more
     of the agent pods. If you notice this error, you can increase the
     ``inotify`` resource limits on your host machine (see
     `Pod errors due to "too many open files" <https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files>`__).

.. group-tab:: minikube

   Install minikube ≥ v1.28.0 as per minikube documentation:
   `Install Minikube <https://kubernetes.io/docs/tasks/tools/install-minikube/>`_.
   The following command will bring up a single node minikube cluster prepared for installing cilium.

   .. code-block:: shell-session

      minikube start --cni=cilium

   .. note::

      - This may not install the latest version of cilium.
      - It might be necessary to add ``--host-dns-resolver=false`` if using the Virtualbox provider,
        otherwise DNS resolution may not work after Cilium installation.

.. group-tab:: Kubespray

   `Kubespray <https://github.com/kubernetes-sigs/kubespray>`_ requires Python ≥ 3.10 for recent versions. 
   For environment setup and dependencies installation, see the `Kubespray Ansible documentation <https://github.com/kubernetes-sigs/kubespray/blob/master/docs/ansible/ansible.md#installing-ansible>`_.

   **Configure cluster:**

   .. code-block:: bash

       # Enter the already cloned kubespray directory
       cd kubespray/
       
       # Copy sample inventory
       cp -rfp inventory/sample inventory/mycluster
       
       # Configure your inventory
       vi inventory/mycluster/inventory.ini
       
       # Configure Kubernetes networking:
       # Use CNI without any network plugin
       sed -e 's/^kube_network_plugin:.*$/kube_network_plugin: cni/' \
           -e 's/^kube_owner:.*$/kube_owner: root/' \
           inventory/mycluster/group_vars/k8s_cluster/k8s-cluster.yml > k8s-cluster.tmp
       mv k8s-cluster.tmp inventory/mycluster/group_vars/k8s_cluster/k8s-cluster.yml

   Setting ``kube_network_plugin: cni`` ensures the cluster deploys without any network plugin, allowing Cilium to be installed separately afterward.

   **Deploy cluster:**

   .. code-block:: bash

       ansible-playbook -i inventory/mycluster/inventory.ini cluster.yml -b -v \
         --private-key=~/.ssh/private_key

   (Adjust the path to your private SSH key.)

   .. note::

      For more detailed configuration options, refer to the `Kubespray documentation <https://github.com/kubernetes-sigs/kubespray/blob/master/docs/ansible/vars.md>`_.

.. group-tab:: Rancher Desktop

   Install Rancher Desktop >= v1.1.0 as per Rancher Desktop documentation:
   `Install Rancher Desktop <https://docs.rancherdesktop.io/getting-started/installation>`_.

   Next you need to configure Rancher Desktop to disable the built-in CNI so you can install Cilium.

   .. include:: ../installation/rancher-desktop-configure.rst

.. group-tab:: Alibaba ACK

    .. include:: ../beta.rst

    .. note::

        The AlibabaCloud ENI integration with Cilium is subject to the following limitations:

        - It is currently only enabled for IPv4.
        - It only works with instances supporting ENI. Refer to `Instance families <https://www.alibabacloud.com/help/doc-detail/25378.htm>`_ for details.

    Setup a Kubernetes on AlibabaCloud. You can use any method you prefer.
    The quickest way is to create an ACK (Alibaba Cloud Container Service for
    Kubernetes) cluster and to replace the CNI plugin with Cilium.
    For more details on how to set up an ACK cluster please follow
    the `official documentation <https://www.alibabacloud.com/help/doc-detail/86745.htm>`_.

.. group-tab:: Generic

   These are the generic instructions on how to install Cilium into any
   Kubernetes cluster. The installer will attempt to automatically pick the
   best configuration options for you. Please see the other tabs for
   distribution/platform specific instructions which also list the ideal
   default configuration for particular platforms.

   .. include:: ../installation/requirements-generic.rst

   **Install Cilium**

   Install Cilium into the Kubernetes cluster pointed to by your current kubectl context:

   .. parsed-literal::

      cilium install |CHART_VERSION|

.. group-tab:: GKE

   .. include:: ../installation/requirements-gke.rst

   **Install Cilium:**

   Install Cilium into the GKE cluster:

   .. parsed-literal::

       cilium install |CHART_VERSION|

.. group-tab:: AKS
   
   .. include:: ../installation/requirements-aks.rst

   **Install Cilium:**

   Install Cilium into the AKS cluster:

   .. parsed-literal::

       cilium install |CHART_VERSION| --set azure.resourceGroup="${AZURE_RESOURCE_GROUP}"
       
.. group-tab:: EKS

   .. include:: ../installation/requirements-eks.rst

   **Install Cilium:**

   Install Cilium into the EKS cluster.

   .. parsed-literal::

       cilium install |CHART_VERSION|
       cilium status --wait

   .. note::

       If you have to uninstall Cilium and later install it again, that could cause
       connectivity issues due to ``aws-node`` DaemonSet flushing Linux routing tables.
       The issues can be fixed by restarting all pods, alternatively to avoid such issues
       you can delete ``aws-node`` DaemonSet prior to installing Cilium.

.. group-tab:: OpenShift

   .. include:: ../installation/requirements-openshift.rst

   **Install Cilium:**

   Cilium is a `Certified OpenShift CNI Plugin <https://access.redhat.com/articles/5436171>`_
   and is best installed when an OpenShift cluster is created using the OpenShift
   installer. Please refer to :ref:`k8s_install_openshift_okd` for more information.

.. group-tab:: RKE

   .. include:: ../installation/requirements-rke.rst

   **Install Cilium:**

   Install Cilium into your newly created RKE cluster:

   .. parsed-literal::

       cilium install |CHART_VERSION|

.. group-tab:: k3s

   .. include:: ../installation/requirements-k3s.rst

   **Install Cilium:**

   Install Cilium into your newly created Kubernetes cluster:

   .. parsed-literal::

       cilium install |CHART_VERSION|

.. group-tab:: Alibaba ACK

   You can install Cilium using Helm on Alibaba ACK, refer to `k8s_install_helm` for details.

   ♻️  Restarted unmanaged pod kube-system/event-exporter-gke-564fb97f9-rv8hg
   ♻️  Restarted unmanaged pod kube-system/kube-dns-6465f78586-hlcrz
   ♻️  Restarted unmanaged pod kube-system/kube-dns-autoscaler-7f89fb6b79-fsmsg
   ♻️  Restarted unmanaged pod kube-system/l7-default-backend-7fd66b8b88-qqhh5
   ♻️  Restarted unmanaged pod kube-system/metrics-server-v0.3.6-7b5cdbcbb8-kjl65
   ♻️  Restarted unmanaged pod kube-system/stackdriver-metadata-agent-cluster-level-6cc964cddf-8n2rt