Build and Run ASP.NET Core Application in Docker Container

In this article we will learn how to build and run ASP.NET core application in a docker container. The docker and containerization term is booming in the market and developer and IT professional curious to know and learn about the docker and containerization but due to lack of plain simple documentation people finds hard to understand about these terms and concepts, my intend to write this article is to clear the hype around these concepts and make understandable to everyone by explaining in the plain simple language.

Hype around the Docker Learning

Many documentation, articles and YouTube videos show lots of command line tools during building the docker application and often readers think that I need to learn these commands and due to this, they find it very difficult and complex to create the docker application but believe me you don't need all to remind and know the commands. Visual studio built in features for azure containers makes it very simple for you. You can first learn the docker concepts using the way which I am showing in this article, then once you are familiar with these terms and concepts, you can use advanced tools such as docker commands etc.

What is Docker?

Docker is the platform for deploying and building the applications which delivers the application in the packages over the operating system level virtualization. Docker requires the following components to run the application

  • Image 
  • Container

What is docker image?

Docker image is the set of configuration and instructions to create the docker container, an image is created during building the application based on steps defined in the docker file of your application. The docker image is the read-only file which cannot be modified once it's created, but we can delete the image from docker.

What is Container?

The Container is an independent isolated process of an operating system which has its own networking and file system to run the image or application. The container is created on the docker engine based on the image configuration.

What is difference between Virtual Machine and Docker Container?

The virtual machine (Linux, ubuntu) is installed on some other operating system (windows) which shares the same lifecycle such as running and shutting at the same time. Virtual machine acts as a real PC on an actual operating system which has full features such as RAM, Hard Disk, networking etc. In this case, often virtual machines are called guest PC and the actual PC which runs the VM is called host system machine.

The container is the minimal and smaller part of a virtual machine which does not use the entire operating system as a virtual machine. The container cuts the unnecessary components of the VM and creates the isolated virtualized environment called a container, which is faster than virtual machine. The container does not require the host system as a virtual machine instead, it works on the docker engine.

The preceding diagram gives more understanding about the virtual machine and docker container, now let's start building and running the ASP.NET Core application in docker step by step.

Step 1: Install Prerequisites

You need to install the docker desktop client based on your machine (PC) as per your operating system type. Use the following link to download the docker desktop client.
The installed docker desktop client looks like as follows.


I hope you installed the prerequisites.

Step 2 : Create the ASP.NET Core Application

  1. Open Visual Studio (I am using 2019)
  2. Once Visual studio open then click on continue without code(If you are using VS 2019)
  3. Then from Visual Studio Menu, click on File => New Project , as shown in the following image

After clicking on the New Project, following window will get appears, Choose the project template ASP.NET Core Web App as shown in the following image


After Choosing the project template click on next button, provide the project name and storage location of the project on your PC


After providing the required details, click on next button the following screen will get appears. Provide the additional information for your project such as target framework and other details, Just choose the latest .NET 5.0 and skip other details

 
Now providing the required details, click on create button it will create the ASP.NET Core web application and created ASP.NET Core web application looks like as follows in your visual studio.

Step 3: Add Docker Support

Docker support can be enabled in two ways from visual studio, at the time of creating the application and after creating the application. To make it easier to make understand for beginners, in this tutorial we will enable the docker support after creating the ASP.NET core application.
Right click on the solution explorer of your existing project and follow the steps which are shown in the following image.


Once you click on the Docker Support option, it will prompt the screen which is shown in the step 4.

Step 4: Choose the Container (Docker File)

Choose the target operating system on which type of container you want to run the application, and it will create the docker image. Let's choose the Linux option which creates the image size smaller than compared to the windows container image.


In the preceding image click on the OK button, it will create the Docker file in your project solution as shown in the following image.


Step 5: Open the Docker File

Double click on docker file in which you will see auto generated code from visual studio which has pre-configured steps to create and run the docker image in multiple stages.

The visual studio creates docker file in your project which has multi-stages build features which make sure the final image remain smaller in the size which helps to become container more efficient and faster. The container images created in the following stages
  • Base 
  • Build 
  • Publish
  • Final Image

We will learn more about the base image and docker file stages in a separate article.

Step 6:  Run the image in Docker Container

Choose the docker option to run the application as shown in the following image.


After clicking on the docker option, it will build code, create a docker image as well as a docker container and run the application inside the docker container without using the docker commands on the windows command prompt. The application opens the browser as follows.


In the preceding, our application is running inside the Linux Docker container instead of IIS express. We can view the created images by using the docker command or navigating to the docker desktop dashboard. Let's view images using the docker command. Open your windows command prompt and use the following command on the command prompt and press enter.

           Docker Images

The preceding docker command will display the list of available docker images as follows.


I hope from all the above-mentioned examples you have learned how to build and run the asp.net core application inside the docker container.

Note

  • This tutorial is for the beginner, so there is no command line tool used to build, run the docker container images. 
  • The intend of this tutorial is to make familiar to beginners about docker.
  • Next article we will learn how to build, run and create images using docker commands.

Summary

I hope the preceding article is useful to understand how to build and run ASP.NET core application in a docker container. You can support me by subscribing to my YouTube Channel and blog by using the following links.
Related articles

Disable Swagger Missing XML comment warnings in ASP.NET Web Api

Background

While working with swagger documentation in an API we have to enabled the XML file to be generated for documentation from project setting and due to this reason all the pubic members in the project solution start giving the warnings "CS1591 Missing XML comment for publicly visible type or member" and if we specify the XML comment for those members then the same warning will be get disappeared but what for those members which are not a part of swagger documentation, If its ignore then their will be lots of warnings in the code which looks very uglier in the code, So in this article we will discus how to resolve the "CS1591 missing XML comment for publicly visible type or member" warning



CS1591 Missing XML Comment  Solution

  • Define XML Comment for All Public Members

As per me the best way is to define the XML comment for all public members whether its part of swagger UI document or not because of comments our method become more meaningful which help new developer to know about the method by comments instead of going through the code & understand the logic



Another Advantage for defining the XML comment is, when developer implementing the any method in another class its show's the IntelliSense about the method which help developer to know what is the functionality of method without navigating to the method defined class.

  • Suppress Warning by Decorating each Public Member

Even though first approach has lots of advantages but you don't want to invest lots of time & increase the size of the project we can suppress the each public member by decorating with following line
#pragma warning disable CS1591

If you don't know the syntax then simply follow the visual studio suggestion by keeping the mouse on specific method or member






  • Suppress all Warnings at Project Level

The previous two approaches requires lots of time either defining the XML comment or  disabling the warning of each member in project.
To save the time & minimize the swagger comment related warnings we can disable these warning at project level itself with the just one line configuration, to achieve follows the following steps
Right click on api project solution & find the properties 

or just use Alt + Enter by putting control of project solution which opens the following window, find the options by following the below image & enter the 1591 in the suppress warnings text box & save it.



Now check any class file, you will not be see any warnings related to the swagger XML comment


Summary
Hope this article helped you to fix Warning CS1591 Missing XML comment for publicly visible type or member. If you like the contents the support by using the following way.
Don't Forget To 

Two Factor Authentication Using ASP.NET

This Video tutorial will introduce about two factor authentication in ASP.NET MVC which covers the following topics
  • What is Authentication?
  • Overview of Traditional authentication techniques.
  • Security threats of traditional authentication techniques.
  • What is two factor authentication?
  • Advantages of two factor authentication?
  • Two factor authentication providers
  • Registering for two factor authentication. 
Now Lets watch 


    Summary 
    I hope this video tutorial is useful for all viewers , If you like this video then , don't forget to subscribe compilemode.com YouTube Channel.

    Don't Forget To  

    Recap of My Speaking at National University of Singapore on Microsoft Azure IaaS Using ASP.NET Core

    I was recently visited to National University of Singapore on ‎January ‎07- 2017, NUS has very huge and world class campus with latest infrastructure, It was great pleasure to meet world class students from all over the world , Many students came up with great start up ideas and to boost their start up ideas I have extended my support to help them at free of cost to turn their ideas into reality .

    I was got opportunity to explain How Microsoft Azure helps startups to manage their application with less infrastructure cost without buying physical servers , I have explained real time example of Microsoft azure with ASP.NET Core


    Addressing group of students on Microsoft Azure Infrastructure as service (IaaS) using ASP.NET Core




     Following is the group photo with few students who led the event


    It was great and proud moment for me thanks to all my readers and community for great support. If you wants to invite to me to your any technical or career guidance related college event then you can contact me anytime , for my latest speaking visit Vithal Wadje Speaking  section
    Don't Forget To 

    Past User Group Speaking : Introduction To ASP.NET Core


    Speaking in C# Corner Mumbai Chapter event which is led by me on ASP.NET Core , If you wants to learn about ASP.NET core then join my interactive session on ASP.NET core.

    Agenda

     Date : 15-10-2016

    Vithal Wadje speaking on ASP.NET Core




    Introduction to ASP.NET Core

    • What is ASP.NET Core ?
    • What is .NET Core ?
    • Difference between .NET framework and .NET core Framework.
    • Difference between ASP.NET and ASP.NET core.
    • Building ASP.NET Core application .
    • Understanding the Folder structure of ASP.NET core.
    • Understanding Routing in ASP.NET core
    • What is wwwroot folder ?
    • What is Project.json ?
    • What is global.json
    • What is appsettings.json ?
    • Hosting ASP.NET core application on linux OS .
    • Q & A.


      Where:

      IBSAR Institute of Management and Studies 
      Sanjay Nagar, Karjat West
      Karjat Maharashtra INDIA


      Price: Free of cost

      Requirement: Optional to bring your laptop and internet card.

      Date : 15-10-2016
      Time : 10 AM To 4:30 PM

                                    Registration Closed


      www.CodeNirvana.in

      Protected by Copyscape
      Copyright © Compilemode