Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.84 KB

getting_started.md

File metadata and controls

73 lines (52 loc) · 2.84 KB

Getting Started

Tye is a tool that makes developing, testing, and deploying microservices and distributed applications easier. Project Tye includes a local orchestrator to make developing microservices easier and the ability to deploy microservices to Kubernetes with minimal configuration.

Installing Tye

  1. Install .NET Core 3.1.

    .NET Core 3.1 is required for the current release of Tye (0.10.0). Going forward, both recent CI builds as well as future releases of Tye will require .NET 6.

  2. Install tye via the following command:

    dotnet tool install -g Microsoft.Tye --version "0.10.0-alpha.21420.1"

    OR if you already have Tye installed and want to update:

    dotnet tool update -g Microsoft.Tye --version "0.10.0-alpha.21420.1"

    If using Mac with both arm64 and x64 .NET SDKs, you may need to supply the -a x64 parameter when installing Tye as it requires the x64 version of .NET Core 3.1.

    Example:

    dotnet tool install -a x64 -g Microsoft.Tye --version "0.10.0-alpha.21420.1"

    If using Mac and, if getting "command not found" errors when running tye, you may need to ensure that the $HOME/.dotnet/tools directory has been added to PATH.

    For example, add the following to the end of your ~/.zshrc or ~/.zprofile:

    # Add .NET global tools (like Tye) to PATH.
export PATH=$HOME/.dotnet/tools:$PATH

Next steps

  1. Once tye is installed, continue to the Basic Tutorial.
  2. Check out additional samples for more advanced concepts, such as using redis, rabbitmq, and service discovery.

Working with CI builds

This will install the newest available build from our CI.

dotnet tool install -g Microsoft.Tye --version "0.11.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json

If you already have a build installed and you want to update, replace install with update:

dotnet tool update -g Microsoft.Tye --version "0.11.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json

💡 Note that the version numbers for our CI builds and released packages will usually be different.

If you are using CI builds of Tye we also recommend using CI builds of our libraries as well with the matching version. To add the dotnet-core package source add a NuGet.config to your repository or solution directory.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear />
    <add key="dotnet5" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json" />
    <add key="nuget" value="https://api.nuget.org/v3/index.json" />
  </packageSources>
</configuration>