Getting Started Guide for RHEL 8
Abstract
- The ability to follow a microservices-based approach, where some components are built with .NET and others with Java, but all can run on a common, supported platform in Red Hat Enterprise Linux and OpenShift Container Platform.
- The capacity to more easily develop new .NET Core workloads on Microsoft Windows. Customers can deploy and run on either Red Hat Enterprise Linux or Windows Server.
- A heterogeneous data center, where the underlying infrastructure is capable of running .NET applications without having to rely solely on Windows Server.
Chapter 1. Using .NET Core 3.0 on Red Hat Enterprise Linux 8 Copy linkLink copied to clipboard!
This Getting Started Guide for RHEL 8 describes how to install .NET Core 3.0 on Red Hat Enterprise Linux (RHEL). See Red Hat Enterprise Linux documentation for more information about RHEL 8.
1.1. Install .NET Core Copy linkLink copied to clipboard!
.NET Core 3.0 is included in the AppStream repositories for RHEL 8. The AppStream repositories are enabled by default on RHEL 8 systems.
Install .NET Core 3.0 and all of its dependencies:
sudo yum install dotnet-sdk-3.0 -y
$ sudo yum install dotnet-sdk-3.0 -y
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Run the following command to verify the installation:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.2. Create an Application Copy linkLink copied to clipboard!
Create a new Console application in a directory called
hello-world
:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Run the project:
cd hello-world dotnet run
$ cd hello-world $ dotnet run Hello World!
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.3. Publish Applications Copy linkLink copied to clipboard!
The .NET Core 3.0 applications can be published to use a shared system-wide version of .NET Core or to include .NET Core. These two deployment types are called framework-dependent deployment (FDD) and self-contained deployment (SCD), respectively.
For RHEL, we recommend publishing by FDD. This method ensures the application is using an up-to-date version of .NET Core, built by Red Hat, that includes a specific set of native dependencies. On the other hand, SCD uses a runtime built by Microsoft.
Use the following command to publish a framework-dependent application.
dotnet publish -f netcoreapp3.0 -c Release
$ dotnet publish -f netcoreapp3.0 -c Release
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Optional: If the application is only for RHEL, trim out the dependencies needed for other platforms with these commands.
dotnet restore -r rhel.8-x64 dotnet publish -f netcoreapp3.0 -c Release -r rhel.8-x64 --self-contained false
$ dotnet restore -r rhel.8-x64 $ dotnet publish -f netcoreapp3.0 -c Release -r rhel.8-x64 --self-contained false
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.4. Run Applications on Linux Containers Copy linkLink copied to clipboard!
This section shows how to use the ubi8/dotnet-30-runtime
image to run a precompiled application inside a Linux container.
Create a new mvc project in a directory named
mvc_runtime_example
.dotnet new mvc -o mvc_runtime_example cd mvc_runtime_example
$ dotnet new mvc -o mvc_runtime_example $ cd mvc_runtime_example
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Publish the project.
dotnet publish -f netcoreapp3.0 -c Release
$ dotnet publish -f netcoreapp3.0 -c Release
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
Dockerfile
.Copy to Clipboard Copied! Toggle word wrap Toggle overflow Build your image.
podman build -t dotnet-30-runtime-example .
$ podman build -t dotnet-30-runtime-example .
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Run your image.
podman run -d -p8080:8080 dotnet-30-runtime-example
$ podman run -d -p8080:8080 dotnet-30-runtime-example
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
View the result in a browser:
http://127.0.0.1:8080
.
Chapter 2. Using .NET Core 3.0 on Red Hat OpenShift Container Platform Copy linkLink copied to clipboard!
2.1. Installing Image Streams Copy linkLink copied to clipboard!
The .NET Core image streams definition can be defined globally in the openshift
namespace or locally in your specific project.
If you are a system administrator or otherwise have sufficient permissions, change to the
openshift
project. Using theopenshift
project allows you to globally update the image stream definitions.oc project openshift
$ oc project openshift
Copy to Clipboard Copied! Toggle word wrap Toggle overflow If you do not have permissions to use the
openshift
project, you can still update your project definitions starting with Step 2.Run the following commands to list all available .NET Core image versions.
oc describe is dotnet -n openshift oc describe is dotnet
$ oc describe is dotnet -n openshift $ oc describe is dotnet
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The output shows installed images or the message
Error from server (NotFound)
if no images are installed.Enter the following command to import new image streams.
oc create -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/dotnet_imagestreams_rhel8.json
$ oc create -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/dotnet_imagestreams_rhel8.json
Copy to Clipboard Copied! Toggle word wrap Toggle overflow If image streams were already installed, use the
replace
command to update the image stream definitions.oc replace -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/dotnet_imagestreams_rhel8.json
$ oc replace -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/dotnet_imagestreams_rhel8.json
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.2. Deploying Applications from Source Copy linkLink copied to clipboard!
Run the following commands to deploy the ASP.NET Core application, which is in the
app
folder on thedotnetcore-3.0
branch of theredhat-developer/s2i-dotnetcore-ex
GitHub repository.oc new-app --name=exampleapp 'dotnet:3.0~https://github.com/redhat-developer/s2i-dotnetcore-ex#dotnetcore-3.0' --build-env DOTNET_STARTUP_PROJECT=app
$ oc new-app --name=exampleapp 'dotnet:3.0~https://github.com/redhat-developer/s2i-dotnetcore-ex#dotnetcore-3.0' --build-env DOTNET_STARTUP_PROJECT=app
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Use the
oc logs
command to track progress of the build.oc logs -f bc/exampleapp
$ oc logs -f bc/exampleapp
Copy to Clipboard Copied! Toggle word wrap Toggle overflow View the deployed application once the build is finished.
oc logs -f dc/exampleapp
$ oc logs -f dc/exampleapp
Copy to Clipboard Copied! Toggle word wrap Toggle overflow At this point, the application is accessible within the project. To make it accessible externally, use the
oc expose
command. You can then useoc get routes
to find the URL.oc expose svc/exampleapp oc get routes
$ oc expose svc/exampleapp $ oc get routes
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.3. Deploying Applications from Binary Artifacts Copy linkLink copied to clipboard!
The .NET Core S2I builder image can be used to build an application using binary artifacts that you provide.
Publish your application as described in Publish Applications. For example, the following commands create a new web application and publish it.
dotnet new web -o webapp cd webapp dotnet publish -c Release
$ dotnet new web -o webapp $ cd webapp $ dotnet publish -c Release
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new binary build using the
oc new-build
command.oc new-build --name=mywebapp dotnet:3.0 --binary=true
$ oc new-build --name=mywebapp dotnet:3.0 --binary=true
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Start a build using the
oc start-build
command, specifying the path to the binary artifacts on your local machine.oc start-build mywebapp --from-dir=bin/Release/netcoreapp3.0/publish
$ oc start-build mywebapp --from-dir=bin/Release/netcoreapp3.0/publish
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new application using the
oc new-app
command.oc new-app mywebapp
$ oc new-app mywebapp
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4. Environment Variables Copy linkLink copied to clipboard!
The .NET Core images support a number of environment variables to control the build behavior of your .NET Core application. These variables can be set as part of the build configuration, or they can be added to an .s2i/environment
file in the application source code repository.
Variable Name | Description | Default |
---|---|---|
DOTNET_STARTUP_PROJECT |
Selects project to run. This must be a project file (for example, |
|
DOTNET_ASSEMBLY_NAME |
Selects the assembly to run. This must not include the .dll extension. Set this to the output assembly name specified in |
The name of the |
DOTNET_PUBLISH_READRYTORUN |
When set to |
|
DOTNET_RESTORE_SOURCES |
Specifies the space-separated list of NuGet package sources used during the restore operation. This overrides all of the sources specified in the | |
DOTNET_RESTORE_CONFIGFILE |
Specifies a | |
DOTNET_TOOLS |
Specifies a list of .NET tools to install before building the app. It is possible to install a specific version by post pending the package name with | |
DOTNET_NPM_TOOLS | Specifies a list of NPM packages to install before building the application. | |
DOTNET_TEST_PROJECTS |
Specifies the list of test projects to test. This must be project files or folders containing a single project file. | |
DOTNET_CONFIGURATION |
Runs the application in Debug or Release mode. This value should be either |
|
DOTNET_VERBOSITY |
Specifies the verbosity of the | |
HTTP_PROXY, HTTPS_PROXY | Configures the HTTP/HTTPS proxy used when building and running the application. | |
DOTNET_RM_SRC |
When set to | |
DOTNET_SSL_DIRS |
Used to specify a list of folders/files with additional SSL certificates to trust. The certificates are trusted by each process that runs during the build and all processes that run in the image after the build (including the application that was built). The items can be absolute paths (starting with | |
NPM_MIRROR | Uses a custom NPM registry mirror to download packages during the build process. | |
ASPNETCORE_URLS |
This variable is set to | |
DOTNET_RESTORE_DISABLE_PARALLEL | When set to true, disables restoring multiple projects in parallel. This reduces restore timeout errors when the build container is running with low CPU limits. |
|
DOTNET_INCREMENTAL | When set to true, the NuGet packages will be kept so they can be re-used for an incremental build. |
|
DOTNET_PACK |
When set to true, creates a | |
DOTNET_STARTUP_ASSEMBLY | Used to specify the path of the entrypoint assembly within the source repository. When set, the source repository must contain a pre-built application. |
2.5. Sample Applications Copy linkLink copied to clipboard!
Three sample applications are available:
- dotnet-example: This is the default model–view–controller (MVC) application.
-
dotnet-runtime-example: This shows how to build an MVC application using a chained build. The application is built in
ubi8/dotnet-30
. The result is deployed inubi8/dotnet-30-runtime
. Note that chained builds are not supported on OpenShift Online. dotnet-pgsql-persistent: This is the Microsoft ASP.NET Core MusicStore sample application using a PostgreSQL backend.
NoteThis application uses .NET Core 2.1 LTS.
To add the samples using the OpenShift Web Console, browse to your project and click Add to project. You can filter for dotnet. If the samples do not show up, you can add them to your installation by running the following commands.
oc create -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/templates/dotnet-example.json oc create -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/templates/dotnet-runtime-example.json oc create -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/templates/dotnet-pgsql-persistent.json
$ oc create -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/templates/dotnet-example.json
$ oc create -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/templates/dotnet-runtime-example.json
$ oc create -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/master/templates/dotnet-pgsql-persistent.json
Chapter 3. Migrating to .NET Core 3.0 Copy linkLink copied to clipboard!
This chapter provides migration information for .NET Core 3.0.
3.1. Migrating from previous versions of .NET Core Copy linkLink copied to clipboard!
See the following Microsoft articles to migrate from previous versions of .NET Core to newer versions of .NET Core.
3.2. Migrating from .NET Framework to .NET Core 3.0 Copy linkLink copied to clipboard!
Review the following information to migrate from the .NET Framework.
3.2.1. Migration Considerations Copy linkLink copied to clipboard!
Several technologies and APIs present in the .NET Framework are not available in .NET Core. If your application or library requires these APIs, consider finding alternatives or continue using the .NET Framework. .NET Core does not support the following technologies and APIs:
- Windows Communication Foundation (WCF) servers (WCF clients are supported)
- .NET remoting
Additionally, a number of .NET APIs can only be used in Microsoft Windows environments. The following list shows a few examples of these Windows-specific APIs:
- Microsoft.Win32.Registry
- System.AppDomains
- System.Security.Principal.Windows
Consider using the .NET Portability Analyzer to identify API gaps and potential replacements. For example, enter the following command to find out how much of the API used by your .NET Framework 4.6 application is supported by .NET Core 2.1.
dotnet /path/to/ApiPort.dll analyze -f . -r html --target '.NET Framework,Version=4.6' --target '.NET Core,Version=2.1'
$ dotnet /path/to/ApiPort.dll analyze -f . -r html --target '.NET Framework,Version=4.6' --target '.NET Core,Version=2.1'
Several APIs that are not supported in the out-of-the-box version of .NET Core may be available from the Microsoft.Windows.Compatibility nuget package. Be careful when using this nuget package. Some of the APIs provided (such as Microsoft.Win32.Registry) only work on Windows, making your application incompatible with Red Hat Enterprise Linux.
3.2.2. .NET Framework Migration Articles Copy linkLink copied to clipboard!
Refer to the following Microsoft articles when migrating from .NET Framework.
- For general guidelines, see Porting to .NET Core from .NET Framework.
- For porting libraries, see Porting to .NET Core - Libraries.
- For migrating to ASP.NET Core, see Migrating to ASP.NET Core.
Appendix A. Revision History Copy linkLink copied to clipboard!
Date | Version | Author | Changes |
---|---|---|---|
08/21/2017 | 2.0 | Les Williams | Generally available |
08/30/2017 | 2.0 | Les Williams | Revised DOTNET_STARTUP_PROJECT and DOTNET_TEST_PROJECTS entries in Section 2.3 |
09/13/2017 | 2.0 | Les Williams | Revised Section 1.2 to include a note about how to permanently enable rh-dotnet20 |
02/14/2018 | 2.0 | Les Williams | Revised Section 2.2 to resolve BZ 1500230; added quoting for zsh and other shells |
02/28/2018 | 2.0.3 | Les Williams | Revised to include SDK 2.0 and 2.1 |
06/14/2018 | 2.1 | Les Williams | Generally available |
08/01/2018 | 2.1 | Toby Drake | Added Chapter 3 to provide migration instructions |
08/24/2018 | 2.1 | Toby Drake | Added steps to enable a user to get new image streams |
09/18/2018 | 2.1 | Toby Drake |
Revised Section 2.1 to include |
10/12/2018 | 2.1 | Toby Drake | Added DOTNET_SSL_DIRS and DOTNET_RM_SRC to Environment Variables. Added Deploy Applications from Binary Artifacts. |
11/08/2018 | 2.1 | Toby Drake |
Changed references from docker to podman. Changed registry server to |
12/04/2018 | 2.2 | Toby Drake | Generally available |
12/06/2018 | 2.2 | Les Williams | Added link for migrating from ASP.NET Core 2.1 to 2.2 |
04/16/2019 | 2.2 | Les Williams | Revised environment variables section for DOTNET_INCREMENTAL and DOTNET_PACK variables |