> For the complete documentation index, see [llms.txt](https://mojaloop.gitbook.io/mojaloop/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mojaloop.gitbook.io/mojaloop/legacy/deployment-guide/local-setup-windows.md).

# Mojaloop local environment setup for Windows

Local setup on a Laptop or Desktop to run the Mojaloop project.

## Setup Introduction

This document will provide guidelines to a technical capable resources to setup, deploy and configure the Mojaloop applications on a local environment, utilizing Docker, Kubernetes and HELM charts.

At this point the reader/implementer should be familiar with [Mojaloop's deployment guide](/mojaloop/legacy/deployment-guide.md). Imported information is contained in that document and as such a prerequisite to this document.

* [Mojaloop local environment setup for Windows](#mojaloop-local-environment-setup-for-windows)
  * [Setup Introduction](#setup-introduction)
  * [1. Kubernetes](#1-kubernetes)
    * [1.1 Kubernetes Installation with Docker](#11-kubernetes-installation-with-docker)
    * [1.2 Kubernetes environment setup](#12-kubernetes-environment-setup)
  * [2. Continue with Deployment](#2-continue-with-deployment)

## 1. Kubernetes

This section will guide the reader through the deployment process to setup Kubernetes within Docker.

> RECOMMENDATIONS - Aug 2022
>
> We recommend installing Kubernetes using either [minikube](https://minikube.sigs.k8s.io/docs/start) or [microk8s](https://microk8s.io/docs/install-alternatives) instead, as this will allow you to easily specify your desired Kubernetes version (i.e. either v1.20 or v1.21).
>
> Alternatively, a specific version of Docker-desktop that includes a supported target Kubernetes version as specified in the [Deployment Guide (1. Pre-requisites)](/mojaloop/legacy/deployment-guide.md#1-pre-requisites) can be installed. See [Installing Docker for Windows](#11-kubernetes-installation-with-docker) section for more information.

### 1.1 Kubernetes Installation with Docker

* **kubectl** is part of the installation package when installing Docker Desktop for Windows.

  Please note the minimum system and operation requirements;

  * Docker Desktop for Windows require Microsoft Hyper-V to run. Hyper-V will be enable as part of the installation process,
  * Windows 10 64bit: Pro, Enterprise, Education (1607 Anniversary Update, Build 14393 or later),
  * CPU SLAT-capable feature,
  * At least 4GB of RAM. (At least 16GB will be required to run the Mojaloop project).

1. Installing Docker for Windows:

   > RECOMMENDATIONS - Aug 2022
   >
   > For Windows/MacOS, version [Docker Desktop v4.2.0](https://docs.docker.com/desktop/release-notes/#docker-desktop-420) comes packaged with Kubernetes v1.21.5 which meets the current requirements.

   You will require Docker Desktop for Windows 18.02 Edge (win50) and higher, or 18.06 Stable (win 70) and higher. Kubernetes on Docker Desktop for Windows is available on these versions and higher. They are downloadable from:

   ```url
   https://docs.docker.com/docker-for-windows/install/
   ```

   Once download is completed, the downloaded file can normally be found in your Download folder. Installation is as per normal installations for windows. A restart will be required after this step.
2. Enable visualization:

   Docker Desktop for Windows requires Microsoft Hyper-V to run. The Docker Desktop installer enables Hyper-V for you.

   If Hyper-V is not enabled, A pop-up messages will request if you would like to turn this on. Read the messages and select 'Ok' if appropriate.

   You need to insure that **VT-X/AMD-v** is enabled from `cmd.exe`:

   ```bash
   systeminfo
   ```

   If not, from `cmd.exe` run as Administrator and execute:

   ```bash
   bcdedit /set hypervisorlaunchtype auto
   ```

   A reboot would be required again for the updates to take effect.
3. Start Docker Desktop for Windows:

   Docker does not start automatically after installation. To start it, select **Docker Desktop** and click on it (or hit Enter).

   When the *whale* in the status bar stays steady, **Docker Desktop** is up-and-running, and accessible from any terminal window. Note - if the *whale* is not on the status bar, it will be in the **hidden icon** notifications area, click the up arrow on the taskbar to show it.

   ![Docker is Running](https://960632945-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LXhOIEoqtInj89WmQ_Q%2F-Lddg8kVrLqncpXFXldC%2F-LddgBAzJZ4BK01JC8p5%2FDockerIsRunning.png?generation=1556551354863449\&alt=media)

### 1.2 Kubernetes environment setup

1. Setting up the Kubernetes runtime environment within Docker Desktop:

   * Open the Docker Desktop for Windows menu by right-clicking the Docker icon.
     * Select **Settings** to open the settings dialog.
     * Under the **General** tab you can configure when to start and update Docker.
   * Go to **Advanced** tab
     * Increase the CPU allocation to at least 4
     * Increase the Memory allocation to at least 8.0 GiB

   (If your system resource allow, more can be allocated as indicated below.)

   ![Docker Advance Settings](https://960632945-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LXhOIEoqtInj89WmQ_Q%2F-Lddg8kVrLqncpXFXldC%2F-LddgBB0Iw2ufmLYVmBA%2FDockerAdvanceSettings.png?generation=1556551354865112\&alt=media)

   Kubernetes on Docker Desktop for Windows is available in 18.02 Edge (win50) and higher, and in 18.06 Stable (win 70) and higher.

   * go to **Kubernetes** tab
     * Select **Enable Kubernetes**
     * Select **Show system container (advanced)**

   ![Enable Kubernetes](https://960632945-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LXhOIEoqtInj89WmQ_Q%2F-Lddg8kVrLqncpXFXldC%2F-LddgBB2fEkH9HZgZYA2%2FEnableKubernetes.png?generation=1556551355284233\&alt=media)
2. Set the context to be used.

   As mentioned, the Kubernetes client command, `kubectl` is included and configured to connect to the local Kubernetes server. If you have `kubectl` already installed, be sure to change context to point to **docker-for-desktop**;

   Through `cmd.exe`:

   ```bash
   kubectl config get-contexts
   kubectl config use-context docker-for-desktop
   ```

   Or through the Docker Desktop for Windows menu:

   * right-clicking the Docker icon
     * Select **Kubernetes**
     * Select **docker-for-desktop**

   ![Docker For Desktop](https://960632945-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LXhOIEoqtInj89WmQ_Q%2F-Lddg8kVrLqncpXFXldC%2F-LddgBB4V6He2bOctAIo%2FDockerForDesktop.png?generation=1556551354919660\&alt=media)

## 2. Continue with Deployment

1. Continue setup and configuration from the [Mojaloop's deployment guide - 3.1. Kubernetes Ingress Controller](/mojaloop/legacy/deployment-guide.md#31-kubernetes-ingress-controller) document.