diff --git a/README.md b/README.md index 1a0a840..2d12f3a 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,10 @@ To create a ASP.Net Core web application that host a demo WAGI Module: ***Note: nuget.org only contains (pre-)released versions of the packages, to install the latest versions follow the instructions [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry) to set up GitHub packages registry as a source for nuget packages.*** ``` Console -dotnet new -i Deislabs.WAGI.Templates::0.8.0-preview +dotnet new -i Deislabs.WAGI.Templates::0.9.0-preview ``` -This will add the dotnet wagi templates. To install pre-release versions of the templates the version of the template package must be provided as a suffix to the package name as show above `::0.8.0-preview`. - +This will add the dotnet wagi templates. To install pre-release versions of the templates the version of the template package must be provided as a suffix to the package name as show above `::0.9.0-preview`. ``` Console dotnet new wagi -n hello-wagi diff --git a/docs/installation.md b/docs/installation.md index 0df9d89..14d5d53 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -15,7 +15,7 @@ dotnet add package Deislabs.WAGI --prerelease info : Adding PackageReference for package 'Deislabs.WAGI' into project '/tmp/wagiproj/WagiTest.csproj'. info : Restoring packages for /tmp/wagiproj/WagiTest.csproj... info : Package 'Deislabs.WAGI' is compatible with all the specified frameworks in project '/tmp/wagiproj/WagiTest.csproj'. -info : PackageReference for package 'Deislabs.WAGI' version '0.8.0-preview' updated in file '/tmp/wagiproj/WagiTest.csproj'. +info : PackageReference for package 'Deislabs.WAGI' version '0.9.0-preview' updated in file '/tmp/wagiproj/WagiTest.csproj'. info : Committing restore... info : Writing assets file to disk. Path: /tmp/wagiproj/obj/project.assets.json log : Restored /tmp/wagiproj/WagiTest.csproj (in 155 ms). @@ -28,14 +28,31 @@ Only released versions of the WAGI extension are availble from nuget.org, more r ```console dotnet add package Deislabs.WAGI --prerelease -s https://nuget.pkg.github.com/deislabs/index.json ``` +## Use the wagi-dotnet templates -## Create a new ASP.Net application without using the wagi-donet templates. +### Create a project using a locally available WAGI module -To create a new, run the following command: +``` +$ dotnet new wagi +The template "ASP.NET WAGI Web App" was created successfully. +``` + +This will create an applciation configured to use a sample WAGI module. Run `dotnet new wagi --help` to see the available options for the template. + +### Create a project using a WAGI Module stored in a [bindle server](https://github.com/deislabs/bindle). + +``` +$ dotnet new wagi-bindle --bindle-server-url --bindle-name +The template "ASP.NET WAGI Bindle Web App" was created successfully. +``` + +## Use an ASP.Net application without using the wagi-dotnet templates. + +To create a new application, run the following command: ```console -$ dotnet new web - The template "ASP.NET Core Empty" was created successfully. +$ dotnet new wagi +The template "ASP.NET WAGI Web App" was created successfully. Processing post-creation actions... Running 'dotnet restore' on /tmp/wagitest/wagitest.csproj... @@ -44,8 +61,6 @@ Running 'dotnet restore' on /tmp/wagitest/wagitest.csproj... Restore succeeded. ``` -## Add Wagi endpoint configuration to your ASP.Net application - ### Modify `Startup.cs` to configure endpoints for WAGI modules. Add a constructor and property to your `Startup.cs` file: @@ -91,7 +106,6 @@ to this: Calling `MapWagiModules()` maps all configured wagi modules. - ## What's Next? Continue on to [Configuring and Running WAGI Modules](configuring_and_running.md) to learn about configuring the application. diff --git a/source/dotnettemplates/template.csproj b/source/dotnettemplates/template.csproj index 01d1869..4bc21fc 100644 --- a/source/dotnettemplates/template.csproj +++ b/source/dotnettemplates/template.csproj @@ -6,7 +6,7 @@ Deislabs.WAGI Templates Simon Davies Templates to use when creating a WASM/WAGI Applications using Deislabs.WAGI. - dotnet-new;templates;WASM;WAGI;WASI;WebAssembly;wasmtime; + dotnet-new;templates;WASM;WAGI;WASI;WebAssembly;wasmtime;Bindle net5.0 true CA1014;NU5105;NU5128;0419,0649 diff --git a/source/dotnettemplates/templates/wagi_bindle_project/.template.config/template.json b/source/dotnettemplates/templates/wagi_bindle_project/.template.config/template.json new file mode 100644 index 0000000..6235a57 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/.template.config/template.json @@ -0,0 +1,45 @@ +{ + "$schema": "http://json.schemastore.org/template", + "author": "Simon Davies", + "classifications": [ + "Web", + "ASP.NET", + "WASM", + "WAGI", + "Bindle" + ], + "identity": "Deislabs.WAGI.Templates.BindleWebApp", + "name": "ASP.NET WAGI Bindle Web App", + "shortName": "wagi-bindle", + "description": "Creates a new C# dotnet web app configured with the Deislabs wagi-dotnet extension configured to serve modules hosted in a bindle server.", + "tags": { + "language": "C#", + "type": "project" + }, + "sourceName": "Wagi.Project", + "preferNameDirectory": true, + "symbols": { + "os": { + "type": "bind", + "binding": "OS" + }, + "bindle-server-url": { + "type": "parameter", + "isRequired": true, + "replaces": "bindle_server_url", + "description": "This is URL that the bindle server is listening on" + }, + "base-path": { + "type": "parameter", + "defaultValue": "/", + "description": "This is the base path in that the server will prepend to the routes defined in the bindle", + "replaces":"base_route" + }, + "bindle-name": { + "type": "parameter", + "isRequired": true, + "replaces": "bindle_name", + "description": "This is name of the bindle to deploy." + } + } + } \ No newline at end of file diff --git a/source/dotnettemplates/templates/wagi_bindle_project/.vscode/launch.json b/source/dotnettemplates/templates/wagi_bindle_project/.vscode/launch.json new file mode 100644 index 0000000..6bbc6c7 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/.vscode/launch.json @@ -0,0 +1,44 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": ".NET Core Launch (web)", + "type": "coreclr", + "request": "launch", + "preLaunchTask": "build", + "program": "${workspaceFolder}/bin/Debug/net5.0/Wagi.Project.dll", + "args": [ ], + "cwd": "${workspaceFolder}", + "console": "internalConsole", + "env":{ + "WASMTIME_BACKTRACE_DETAILS":"1", + "ASPNETCORE_ENVIRONMENT": "Development" + }, + "stopAtEntry": false + }, + { + "name": ".NET Core Attach", + "type": "coreclr", + "request": "attach", + "processId": "${command:pickProcess}" + }, + { + "name": ".NET Core Launch (listen)", + "type": "coreclr", + "request": "launch", + "preLaunchTask": "build", + "env":{ + "WASMTIME_BACKTRACE_DETAILS":"1", + "ASPNETCORE_ENVIRONMENT": "Development" + }, + "program": "${workspaceFolder}/bin/Debug/net5.0/Wagi.Project.dll", + "args": [], + "cwd": "${workspaceFolder}", + "console": "internalConsole", + "stopAtEntry": false + } + ] +} \ No newline at end of file diff --git a/source/dotnettemplates/templates/wagi_bindle_project/.vscode/tasks.json b/source/dotnettemplates/templates/wagi_bindle_project/.vscode/tasks.json new file mode 100644 index 0000000..e937302 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/.vscode/tasks.json @@ -0,0 +1,42 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "build", + "command": "dotnet", + "type": "process", + "args": [ + "build", + "${workspaceFolder}/Wagi.Project.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + }, + { + "label": "publish", + "command": "dotnet", + "type": "process", + "args": [ + "publish", + "${workspaceFolder}/Wagi.Project.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + }, + { + "label": "watch", + "command": "dotnet", + "type": "process", + "args": [ + "watch", + "run", + "${workspaceFolder}/Wagi.Project.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + } + ] +} \ No newline at end of file diff --git a/source/dotnettemplates/templates/wagi_bindle_project/Program.cs b/source/dotnettemplates/templates/wagi_bindle_project/Program.cs new file mode 100644 index 0000000..6c2d187 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/Program.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Hosting; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; + +namespace Wagi.Project +{ + public class Program + { + public static void Main(string[] args) + { + CreateHostBuilder(args).Build().Run(); + } + + public static IHostBuilder CreateHostBuilder(string[] args) => + Host.CreateDefaultBuilder(args) + .ConfigureWebHostDefaults(webBuilder => + { + webBuilder.UseStartup(); + }); + } +} diff --git a/source/dotnettemplates/templates/wagi_bindle_project/Properties/launchSettings.json b/source/dotnettemplates/templates/wagi_bindle_project/Properties/launchSettings.json new file mode 100644 index 0000000..999c273 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/Properties/launchSettings.json @@ -0,0 +1,13 @@ +{ + "profiles": { + "wagi.project": { + "commandName": "Project", + "dotnetRunMessages": "true", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "WASMTIME_BACKTRACE_DETAILS":1 + } + } + } +} diff --git a/source/dotnettemplates/templates/wagi_bindle_project/Startup.cs b/source/dotnettemplates/templates/wagi_bindle_project/Startup.cs new file mode 100644 index 0000000..5dff786 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/Startup.cs @@ -0,0 +1,48 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; +using Deislabs.Wagi.Extensions; + +namespace Wagi.Project +{ + public class Startup + { + + public Startup(IConfiguration configuration) + { + Configuration = configuration; + } + + public IConfiguration Configuration { get; } + + // This method gets called by the runtime. Use this method to add services to the container. + // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940 + public void ConfigureServices(IServiceCollection services) + { + + // HTTP Client is required for wasi_experimentatl_http support. + services.AddHttpClient(); + // This adds the services required for using WAGI Modules, by default configuration is expected to be found in a section named Wagi, if the section is renamed then the name should be passed as the second argument. + services.AddWagi(Configuration); + } + + // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. + public void Configure(IApplicationBuilder app, IWebHostEnvironment env) + { + if (env.IsDevelopment()) + { + app.UseDeveloperExceptionPage(); + } + + app.UseRouting(); + + app.UseEndpoints(endpoints => + { + // This builds the routes defined by Wagi Modules, if configuration changes the endpoint routing will be automatically updated. + endpoints.MapWagiModules(); + }); + } + } +} diff --git a/source/dotnettemplates/templates/wagi_bindle_project/Wagi.Project.csproj b/source/dotnettemplates/templates/wagi_bindle_project/Wagi.Project.csproj new file mode 100644 index 0000000..64ab9c8 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/Wagi.Project.csproj @@ -0,0 +1,18 @@ + + + + net5.0 + + + + + + + + + PreserveNewest + PreserveNewest + + + + diff --git a/source/dotnettemplates/templates/wagi_bindle_project/appsettings.json b/source/dotnettemplates/templates/wagi_bindle_project/appsettings.json new file mode 100644 index 0000000..c63c675 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/appsettings.json @@ -0,0 +1,20 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft": "Warning", + "Microsoft.Hosting.Lifetime": "Information", + "Deislabs.WAGI": "Trace" + } + }, + "Wagi": { + "ModulePath": "modules", + "BindleServer": "bindle_server_url", + "Bindles": { + "BindleModule": { + "Name": "bindle_name", + "Route": "base_route" + } + } + } +} diff --git a/source/dotnettemplates/templates/wagi_bindle_project/gitignore b/source/dotnettemplates/templates/wagi_bindle_project/gitignore new file mode 100644 index 0000000..de03f94 --- /dev/null +++ b/source/dotnettemplates/templates/wagi_bindle_project/gitignore @@ -0,0 +1,448 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*[.json, .xml, .info] + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# Ionide - VsCode extension for F# Support +.ionide/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# JetBrains Rider +.idea/ +*.sln.iml + +## +## Visual Studio Code +## +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json diff --git a/source/dotnettemplates/templates/wagi_project/Wagi.Project.csproj b/source/dotnettemplates/templates/wagi_project/Wagi.Project.csproj index 2b6df2c..48d880f 100644 --- a/source/dotnettemplates/templates/wagi_project/Wagi.Project.csproj +++ b/source/dotnettemplates/templates/wagi_project/Wagi.Project.csproj @@ -5,7 +5,7 @@ - +