Skip to main content
Version: v3

Developing with .NET

Step 0. Creating the initial source code (optional)​

We will create the example source code by using some popular frameworks.

Before we begin, we will create a new directory and cd into it.

mkdir quickstart-demo && cd quickstart-demo

This is optional and you may use an existing project instead (make sure you cd into the project directory before running any odo commands) or a starter project from odo init.

For .NET we will use the ASP.NET Core MVC example.

ASP.NET MVC is a web application framework that implements the model-view-controller (MVC) pattern.

  1. Generate an example project:
dotnet new mvc --name app --output .
Example
$ dotnet new mvc --name app --output .
Welcome to .NET 6.0!
---------------------
SDK Version: 6.0.104

...

The template "ASP.NET Core Web App (Model-View-Controller)" was created successfully.
This template contains technologies from parties other than Microsoft, see https://aka.ms/aspnetcore/6.0-third-party-notices for details.

Processing post-creation actions...
Running 'dotnet restore' on /home/user/quickstart-demo/app.csproj...
  Determining projects to restore...
  Restored /home/user/quickstart-demo/app.csproj (in 96 ms).
Restore succeeded.

Your source code has now been generated and created in the directory.

Step 1. Connect to your cluster and create a new namespace or project​

Before starting you should make sure that odo is connected to your cluster and that you have created a new namespace.

Creating a new namespace​

If you are using Kubernetes, you can create a new namespace with the odo create namespace command.

odo create namespace odo-dev
Sample Output
$ odo create namespace odo-dev
 ✓  Namespace "odo-dev" is ready for use
 ✓  New namespace created and now using namespace: odo-dev

Step 2. Initializing your application (odo init)​

Now we'll initialize your application by creating a devfile.yaml to be deployed.

odo handles this automatically with the odo init command by autodetecting your source code and downloading the appropriate Devfile.

Note: If you skipped Step 0, select a "starter project" when running odo init.

Let's run odo init and select .NET:

odo init
Sample Output
$ odo init
  __
 /  \__     Initializing a new component
 \__/  \    Files: Source code detected, a Devfile will be determined based upon source code autodetection
 /  \__/    odo version: v3.10.0
 \__/

Interactive mode enabled, please answer the following questions:
Based on the files in the current directory odo detected
Language: .NET
Project type: dotnet
The devfile "dotnet50:1.0.3" from the registry "DefaultDevfileRegistry" will be downloaded.
? Is this correct? No
? Select language: .NET
? Select project type: .NET 6.0
 ✓  Downloading devfile "dotnet60" from registry "DefaultDevfileRegistry" [3s]

↪ Container Configuration "dotnet":
  OPEN PORTS:
    - 8080
  ENVIRONMENT VARIABLES:
    - ASPNETCORE_ENVIRONMENT = Development
    - ASPNETCORE_URLS = http://*:8080
    - CONFIGURATION = Debug
    - STARTUP_PROJECT = app.csproj

? Select container for which you want to change configuration? NONE - configuration is correct
? Enter component name: my-dotnet-app

You can automate this command by executing:
   odo init --name my-dotnet-app --devfile dotnet60 --devfile-registry DefaultDevfileRegistry

Your new component 'my-dotnet-app' is ready in the current directory.
To start editing your component, use 'odo dev' and open this folder in your favorite IDE.
Changes will be directly reflected on the cluster.
note

If you skipped Step 0 and selected "starter project", your output will be slightly different.

note

When you first run odo init, it will detect the required devfile to be 'dotnet50', if this happens to you, please select No when asked Is this correct? and then select .NET 6.0 when asked for Select project type:. Take a look at the sample output for a reference.

Step 3. Developing your application continuously (odo dev)​

Now that we've generated our code as well as our Devfile, let's start on development.

odo uses inner loop development and allows you to code, build, run and test the application in a continuous workflow.

Once you run odo dev, you can freely edit code in your favourite IDE and watch as odo rebuilds and redeploys it.

Let's run odo dev to start development on your .NET application:

odo dev

Then wait a few seconds until odo dev displays Forwarding from 127.0.0.1:... in its output, meaning that odo has successfully set up the port forwarding to reach the application running in the container.

Sample Output
$ odo dev
  __
 /  \__     Developing using the "my-dotnet-app" Devfile
 \__/  \    Namespace: odo-dev
 /  \__/    odo version: v3.10.0
 \__/

↪ Running on the cluster in Dev mode
 •  Waiting for Kubernetes resources  ...
 ⚠  Pod is Pending
 ✓  Pod is Running
 ✓  Syncing files into the container [171ms]
 ✓  Building your application in container (command: build) [7s]
 •  Executing the application (command: run)  ...
 ✓  Waiting for the application to be ready [1s]
 -  Forwarding from 127.0.0.1:20001 -> 8080


↪ Dev mode
 Status:
 Watching for changes in the current directory /home/user/quickstart-demo

 Keyboard Commands:
[Ctrl+c] - Exit and delete resources from the cluster
     [p] - Manually apply local changes to the application on the cluster

You can now access the application via the local port displayed by odo dev (127.0.0.1:20001 in the sample output above) and start your development loop. odo will watch for changes and push the code for real-time updates.

You can now follow the advanced guide to deploy the application to production.