Getting started with .NET on OpenShift Container Platform
Installing and running .NET 9.0 on OpenShift Container Platform
Abstract
Providing feedback on Red Hat documentation Copy linkLink copied to clipboard!
We appreciate your feedback on our documentation. Let us know how we can improve it.
Submitting feedback through Jira (account required)
- Log in to the Jira website.
- Click Create in the top navigation bar
- Enter a descriptive title in the Summary field.
- Enter your suggestion for improvement in the Description field. Include links to the relevant parts of the documentation.
- Click Create at the bottom of the dialogue.
Chapter 1. Overview Copy linkLink copied to clipboard!
.NET images are added to OpenShift by importing image stream definitions from s2i-dotnetcore.
The image stream definitions include the dotnet image stream which contains sdk images for different supported versions of .NET. Life Cycle and Support Policies for the .NET Program provides an up-to-date overview of supported versions.
| Version | Tag | Alias |
|---|---|---|
| .NET 8.0 | dotnet:8.0-ubi8 | dotnet:8.0 |
| .NET 9.0 | dotnet:9.0-ubi8 | dotnet:9.0 |
The sdk images have corresponding runtime images which are defined under the dotnet-runtime image stream.
The container images work across different versions of Red Hat Enterprise Linux and OpenShift. The UBI-8 based images (suffix -ubi8) are hosted on the registry.access.redhat.com and do not require authentication.
Chapter 2. Installing .NET image streams Copy linkLink copied to clipboard!
To install .NET image streams, use image stream definitions from s2i-dotnetcore with the OpenShift Client (oc) binary. Image streams can be installed from Linux, Mac, and Windows.
You can define .NET image streams in the global openshift namespace or locally in a project namespace. Sufficient permissions are required to update the openshift namespace definitions.
Procedure
Install (or update) the image streams:
oc apply [-n namespace] -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/main/dotnet_imagestreams.json
$ oc apply [-n namespace] -f https://raw.githubusercontent.com/redhat-developer/s2i-dotnetcore/main/dotnet_imagestreams.jsonCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 3. Deploying applications with OpenShift Client Copy linkLink copied to clipboard!
You can use OpenShift Client (oc) for application deployment.
Procedure
Create a new OpenShift project:
oc new-project sample-project
$ oc new-project sample-projectCopy to Clipboard Copied! Toggle word wrap Toggle overflow Add the ASP.NET Core application:
oc new-app --name=example-app 'dotnet:9.0-ubi8~https://github.com/redhat-developer/s2i-dotnetcore-ex#dotnet-9.0' --build-env DOTNET_STARTUP_PROJECT=app
$ oc new-app --name=example-app 'dotnet:9.0-ubi8~https://github.com/redhat-developer/s2i-dotnetcore-ex#dotnet-9.0' --build-env DOTNET_STARTUP_PROJECT=appCopy to Clipboard Copied! Toggle word wrap Toggle overflow Track the progress of the build:
oc logs -f bc/example-app
$ oc logs -f bc/example-appCopy to Clipboard Copied! Toggle word wrap Toggle overflow View the deployed application once the build is finished:
oc logs -f dc/example-app
$ oc logs -f dc/example-appCopy to Clipboard Copied! Toggle word wrap Toggle overflow The application is now accessible within the project.
Optional: Make the project accessible externally:
oc expose svc/example-app
$ oc expose svc/example-appCopy to Clipboard Copied! Toggle word wrap Toggle overflow Obtain the shareable URL:
oc get routes
$ oc get routesCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 4. Environment variables for .NET 9.0 Copy linkLink copied to clipboard!
The .NET images support several environment variables to control the build behavior of your .NET application. You can set these variables as part of the build configuration, or add them to the .s2i/environment file in the application source code repository.
| Variable Name | Description | Default |
|---|---|---|
| DOTNET_STARTUP_PROJECT |
Selects the project to run. This must be a project file (for example, |
|
| DOTNET_ASSEMBLY_NAME |
Selects the assembly to run. This must not include the |
The name of the |
| DOTNET_PUBLISH_READYTORUN |
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_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 or HTTPS proxy used when building and running the application, respectively. | |
| DOTNET_RM_SRC |
When set to | |
| SSL_CERT_DIR |
Specifies a list of folders or 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 | |
| ASPNETCORE_URLS |
This variable is set to |
|
| DOTNET_RESTORE_DISABLE_PARALLEL |
When set to |
|
| DOTNET_INCREMENTAL |
When set to |
|
| DOTNET_PACK |
When set to |
Chapter 5. Creating sample applications with .NET 9.0 Copy linkLink copied to clipboard!
5.1. Creating the MVC sample application Copy linkLink copied to clipboard!
s2i-dotnetcore-ex is the default Model, View, Controller (MVC) template application for .NET.
This application is used as the example application by the .NET S2I image and can be created directly from the OpenShift UI using the Try Example link.
The application can also be created with the OpenShift client binary (oc).
Procedure
To create the sample application using oc:
Add the .NET application:
oc new-app dotnet:9.0-ubi8~https://github.com/redhat-developer/s2i-dotnetcore-ex#dotnet-9.0 --context-dir=app
$ oc new-app dotnet:9.0-ubi8~https://github.com/redhat-developer/s2i-dotnetcore-ex#dotnet-9.0 --context-dir=appCopy to Clipboard Copied! Toggle word wrap Toggle overflow Make the application accessible externally:
oc expose service s2i-dotnetcore-ex
$ oc expose service s2i-dotnetcore-exCopy to Clipboard Copied! Toggle word wrap Toggle overflow Obtain the sharable URL:
oc get route s2i-dotnetcore-ex
$ oc get route s2i-dotnetcore-exCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.2. Creating the CRUD sample application Copy linkLink copied to clipboard!
s2i-dotnetcore-persistent-ex is a simple Create, Read, Update, Delete (CRUD) .NET web application that stores data in a PostgreSQL database.
Procedure
To create the sample application using oc:
Add the database:
oc new-app postgresql-ephemeral
$ oc new-app postgresql-ephemeralCopy to Clipboard Copied! Toggle word wrap Toggle overflow Add the .NET application:
oc new-app dotnet:9.0-ubi8~https://github.com/redhat-developer/s2i-dotnetcore-persistent-ex#dotnet-9.0 --context-dir app
$ oc new-app dotnet:9.0-ubi8~https://github.com/redhat-developer/s2i-dotnetcore-persistent-ex#dotnet-9.0 --context-dir appCopy to Clipboard Copied! Toggle word wrap Toggle overflow Add environment variables from the
postgresqlsecret and database service name environment variable:oc set env dc/s2i-dotnetcore-persistent-ex --from=secret/postgresql -e database-service=postgresql
$ oc set env dc/s2i-dotnetcore-persistent-ex --from=secret/postgresql -e database-service=postgresqlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Make the application accessible externally:
oc expose service s2i-dotnetcore-persistent-ex
$ oc expose service s2i-dotnetcore-persistent-exCopy to Clipboard Copied! Toggle word wrap Toggle overflow Obtain the sharable URL:
oc get route s2i-dotnetcore-persistent-ex
$ oc get route s2i-dotnetcore-persistent-exCopy to Clipboard Copied! Toggle word wrap Toggle overflow