Support running native Ollama #978

cdschneider · 2025-11-18T05:08:17Z

Closes #608

Adds OllamaExecutableResource to the CommunityToolkit.Aspire.Hosting.Ollama hosting integration for running ollama natively as Aspire resources

PR Checklist

Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
Based off latest main branch of toolkit
PR doesn't include merge commits (always rebase on top of our main, if needed)entire description over that)
Tests for the changes have been added (for bug fixes / features) (if applicable)
Contains NO breaking changes ⚠️
Every new API (including internal ones) has full XML docs
Code follows all style conventions

Breaking changes are here mainly in updating OllamaResource properties and generic constraints to use a new IOllamaResource interface

Other information

Includes Github action/runtime setup to install ollama (using the ai-action/setup-ollama action)
Updated Ollama/AppHostTests to use examples/ollama apphost project; from the looks of it, it appeared Ollama AppHost tests were the only one not using an examples/ project

Copilot

Pull Request Overview

This PR adds support for running Ollama natively as an executable resource in addition to the existing container-based approach. It introduces OllamaExecutableResource alongside a new IOllamaResource interface to support both execution modes uniformly.

Key changes:

Introduced IOllamaResource interface to abstract common Ollama resource functionality
Added OllamaExecutableResource for running Ollama as a native executable process
Updated extension methods and tests to work with both container and executable resources

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests.csproj	Updated project reference to use example AppHost instead of test-specific AppHost
tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests/AppHostTests.cs	Refactored tests to validate both container and executable Ollama resources using `IOllamaResource`
tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests/AddOllamaTests.cs	Removed extraneous blank line
tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests/AddOllamaLocalTests.cs	Added comprehensive test coverage for `AddOllamaLocal` functionality
src/CommunityToolkit.Aspire.Hosting.Ollama/OpenWebUIResource.cs	Updated to use `IOllamaResource` interface instead of concrete `OllamaResource` type
src/CommunityToolkit.Aspire.Hosting.Ollama/OllamaResourceBuilderExtensions.cs	Added `AddOllamaLocal` method and refactored shared command logic to support both resource types
src/CommunityToolkit.Aspire.Hosting.Ollama/OllamaResourceBuilderExtensions.OpenWebUI.cs	Fixed Open WebUI URL generation to properly handle both resource types using `ReferenceExpressionBuilder`
src/CommunityToolkit.Aspire.Hosting.Ollama/OllamaResourceBuilderExtensions.Model.cs	Updated model extension methods to accept `IOllamaResource` instead of concrete type
src/CommunityToolkit.Aspire.Hosting.Ollama/OllamaResource.cs	Implements `IOllamaResource` interface with inherited documentation
src/CommunityToolkit.Aspire.Hosting.Ollama/OllamaModelResource.cs	Updated to reference `IOllamaResource` as parent type
src/CommunityToolkit.Aspire.Hosting.Ollama/OllamaExecutableResource.cs	New executable resource implementation for running Ollama natively
src/CommunityToolkit.Aspire.Hosting.Ollama/IOllamaResource.cs	New interface defining common Ollama resource contract
examples/ollama/CommunityToolkit.Aspire.Hosting.Ollama.AppHost/Program.cs	Updated example to demonstrate `AddOllamaLocal` usage
.github/actions/setup-runtimes-caching/action.yml	Added Ollama installation step to CI workflow

tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests/AddOllamaLocalTests.cs

cdschneider · 2025-11-18T05:16:44Z

@dotnet-policy-service agree

aaronpowell

Some API changes/suggestions and it looks like we have test failures going on

aaronpowell · 2025-11-19T21:40:01Z

.github/actions/setup-runtimes-caching/action.yml

+    - uses: ai-action/setup-ollama@v1
+      name: Setup Ollama
+      if: ${{ inputs.name == 'Full' || contains(inputs.name, 'Hosting.Ollama') }}
+      with:
+        version: 0.11.8


I think it's best that we set it up on all Ollama tests runs, as we should do CI on both the container and non-container versions of Ollama

I agree, to avoid any extra workflow/actions setup on non-ollama tests I felt like this was as specific as I could get. The AppHostTests that test both container/non-container versions live in a single test project (CommunityToolkit.Aspire.Hosting.Ollama.Tests)

aaronpowell · 2025-11-19T21:40:59Z

examples/ollama/CommunityToolkit.Aspire.Hosting.Ollama.AppHost/Program.cs


-var ollama = builder.AddOllama("ollama")
-    .WithDataVolume()
+var ollama = builder.AddOllamaLocal("ollama", targetPort: 11435)


Can you make this a separate resource in the app host so we can have both resources demoed

Both Ollama and Ollama local resources exist in this example AppHost (ollama2-named resource is added to builder on line 9). This example previously registered two Ollama (container) resource, I just made one now use local.

Is there another way you want this example modified to demo both container and local options?

Sorry, you're right, I totally forgot that was the case

aaronpowell · 2025-11-19T21:43:28Z

src/CommunityToolkit.Aspire.Hosting.Ollama/OllamaExecutableResource.cs

+/// </remarks>
+/// <param name="name">The name of the resource.</param>
+/// <param name="command">The command to execute.</param>
+public class OllamaExecutableResource(string name, string command) : ExecutableResource(name, command, string.Empty), IOllamaResource


Shouldn't command be hard coded?

Sure thing! Mainly I was following how other executable resources (like Java) were setup where the command name was passed in from the builder/extension method:

Aspire/src/CommunityToolkit.Aspire.Hosting.Java/JavaAppHostingExtension.Executable.cs

Line 42 in ca68bd4

var resource = new JavaAppExecutableResource(name, "java", workingDirectory);

Ah right - I wouldn't follow the Java one, it was one of the first ones and the patterns have a evolved since then

src/CommunityToolkit.Aspire.Hosting.Ollama/OllamaResourceBuilderExtensions.cs

aaronpowell · 2025-11-19T21:51:45Z

...unityToolkit.Aspire.Hosting.Ollama.Tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests.csproj

    <ProjectReference Include="..\..\src\CommunityToolkit.Aspire.OllamaSharp\CommunityToolkit.Aspire.OllamaSharp.csproj" />
    <ProjectReference Include="..\CommunityToolkit.Aspire.Testing\CommunityToolkit.Aspire.Testing.csproj" />
-    <ProjectReference Include="..\..\tests-app-hosts\Ollama.AppHost\Ollama.AppHost.csproj" />
+    <ProjectReference Include="..\..\examples\ollama\CommunityToolkit.Aspire.Hosting.Ollama.AppHost\CommunityToolkit.Aspire.Hosting.Ollama.AppHost.csproj" />


We need to use the custom app host because running on the github actions infra keeps causing memory issues.

…ama command in resource and exclude ollama local from manifest

cdschneider · 2025-11-21T21:29:52Z

Some API changes/suggestions and it looks like we have test failures going on

Thanks for taking a look @aaronpowell! I've updated this with some of your feedback suggestions, including switching the Hosting.Ollama.Tests to point back to that tests-app-hosts/Ollama.AppHost to help with addressing the CI failures (the previous run looked like it was a runner resource-related issue preventing healthy startups).

feat: OllamaExecutableResource

a81ac9c

Copilot AI review requested due to automatic review settings November 18, 2025 05:08

Copilot AI reviewed Nov 18, 2025

View reviewed changes

tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests/AddOllamaLocalTests.cs Outdated Show resolved Hide resolved

tests/CommunityToolkit.Aspire.Hosting.Ollama.Tests/AddOllamaLocalTests.cs Outdated Show resolved Hide resolved

fix: assertion display descriptions on shraed commands

2ed5ef0

aaronpowell requested changes Nov 19, 2025

View reviewed changes

addressing PR comments: apphost tests use test-app-host, hardcode oll…

39562a7

…ama command in resource and exclude ollama local from manifest

cdschneider requested a review from aaronpowell November 21, 2025 21:30

aaronpowell approved these changes Nov 22, 2025

View reviewed changes

aaronpowell merged commit f6bc304 into CommunityToolkit:main Nov 22, 2025
107 checks passed

aaronpowell added this to the 13 milestone Nov 22, 2025

Support running native Ollama #978

Support running native Ollama #978

Uh oh!

Conversation

cdschneider commented Nov 18, 2025

PR Checklist

Other information

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

cdschneider commented Nov 18, 2025

Uh oh!

aaronpowell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cdschneider commented Nov 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants