Requirements

Windows

Requirements for running the API locally

Mandatory

• .NET 8 SDK and Runtime 8.0.* or superior (for .NET 8 templates)
• CosmosDB Emulator 2.4.5+

Optional

• Visual Studio 2022
• Visual Studio Code 1.35+ with C# Extension from Microsoft (C# for Visual Studio Code (powered by OmniSharp))

Additional requirements for running the API in docker containers

Mandatory

• Docker Desktop(for Windows): Version 2.1.0.1 (37199) or superior

  • Enable:

    • Kubernetes 1.14+
    • Linux container (Not windows containers)
  • Docker Engine 19.03.1+ (provided with docker)

  • WSL (Windows Subsystem for Linux: recommended v1, v2 is still in preview and has not been tested) (provided with docker)

    • For running build, test and deployment scripts targeting Linux environment

  • kubectl v1.14+ (provided with docker)

    • Also downloaded from k8s.io

Additional requirements for running the API in a kubernetes cluster

• NGINX ingress controller

  • Install the ingress controller in you local cluster.
  • Make sure you follow the process for Bare Metal deployment described here.

macOS

Requirements for running the API locally

• homebrew
• azure-cli: brew install azure-cli
• .NET 8 SDK 8.0.* or superior: brew cask install dotnet-sdk

• CosmosDB Emulator 2.4.5+: Currently the Cosmos emulator can only be run on Windows. If you have an Azure subscription, you are able to use the Azure version instead

Additional requirements for running the API in docker containers

• Docker Desktop for Mac
• kubectl: docker run --name kubectl bitnami/kubectl:latest

note

The current version of Ensono Stacks are templates for .NET 8 (Current LTS, recommended).