Skip to content

Update Keycloak Hosting Integration to work with Azure Container Apps #8476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Update Keycloak Hosting Integration to work with Azure Container Apps #8476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80be0f0
Update KeycloakResourceBuilderEdtensions.cs to work with Azure Contai…
anderly Apr 1, 2025
51cb8f2
Use DefaultContainerPort and specify culture.
anderly Apr 1, 2025
1c61495
Update tests.
anderly Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

using Aspire.Hosting.ApplicationModel;
using Aspire.Hosting.Keycloak;
using System.Globalization;

namespace Aspire.Hosting;

Expand All @@ -14,8 +15,16 @@ public static class KeycloakResourceBuilderExtensions
private const string AdminEnvVarName = "KC_BOOTSTRAP_ADMIN_USERNAME";
private const string AdminPasswordEnvVarName = "KC_BOOTSTRAP_ADMIN_PASSWORD";
private const string HealthCheckEnvVarName = "KC_HEALTH_ENABLED"; // As per https://www.keycloak.org/observability/health

private const int DefaultContainerPort = 8080;
private const string ProxyEdgeEnvVarName = "KC_PROXY";
private const string HttpPortEnvVarName = "KC_HTTP_PORT";
private const string HttpEnabledEnvVarName = "KC_HTTP_ENABLED";
private const string HostNamePortEnvVarName = "KC_HOSTNAME_PORT";
private const string HostNameStrictBackchannelEnvVarName = "KC_HOSTNAME_STRICT_BACKCHANNEL";
private const string ProxyHeadersEnvVarName = "KC_PROXY_HEADERS";
private const string HostNameStrictEnvVarName = "KC_HOSTNAME_STRICT";
private const string HostNameStrictHttpsEnvVarName = "KC_HOSTNAME_STRICT_HTTPS";

private const int DefaultContainerPort = 8443;
private const int ManagementInterfaceContainerPort = 9000; // As per https://www.keycloak.org/server/management-interface
private const string ManagementEndpointName = "management";
private const string RealmImportDirectory = "/opt/keycloak/data/import";
Expand Down Expand Up @@ -69,6 +78,14 @@ public static IResourceBuilder<KeycloakResource> AddKeycloak(
context.EnvironmentVariables[AdminEnvVarName] = resource.AdminReference;
context.EnvironmentVariables[AdminPasswordEnvVarName] = resource.AdminPasswordParameter;
context.EnvironmentVariables[HealthCheckEnvVarName] = "true";
context.EnvironmentVariables[ProxyEdgeEnvVarName] = "edge";
context.EnvironmentVariables[HttpPortEnvVarName] = DefaultContainerPort.ToString(CultureInfo.InvariantCulture);
context.EnvironmentVariables[HttpEnabledEnvVarName] = "true";
context.EnvironmentVariables[HostNamePortEnvVarName] = DefaultContainerPort.ToString(CultureInfo.InvariantCulture);
context.EnvironmentVariables[HostNameStrictBackchannelEnvVarName] = "false";
context.EnvironmentVariables[ProxyHeadersEnvVarName] = "xforwarded";
context.EnvironmentVariables[HostNameStrictEnvVarName] = "false";
context.EnvironmentVariables[HostNameStrictHttpsEnvVarName] = "false";
});

if (builder.ExecutionContext.IsRunMode)
Expand Down
14 changes: 11 additions & 3 deletions tests/Aspire.Hosting.Keycloak.Tests/KeycloakResourceBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public void AddKeycloakWithDefaultsAddsAnnotationMetadata()
const string defaultEndpointName = "http";

var endpoint = Assert.Single(containerResource.Annotations.OfType<EndpointAnnotation>().Where(e => e.Name == defaultEndpointName));
Assert.Equal(8080, endpoint.TargetPort);
Assert.Equal(8443, endpoint.TargetPort);
Assert.False(endpoint.IsExternal);
Assert.Equal(defaultEndpointName, endpoint.Name);
Assert.Null(endpoint.Port);
Expand Down Expand Up @@ -125,14 +125,22 @@ public async Task VerifyManifest()
"env": {
"KC_BOOTSTRAP_ADMIN_USERNAME": "admin",
"KC_BOOTSTRAP_ADMIN_PASSWORD": "{keycloak-password.value}",
"KC_HEALTH_ENABLED": "true"
"KC_HEALTH_ENABLED": "true",
"KC_PROXY": "edge",
"KC_HTTP_PORT": "8443",
"KC_HTTP_ENABLED": "true",
"KC_HOSTNAME_PORT": "8443",
"KC_HOSTNAME_STRICT_BACKCHANNEL": "false",
"KC_PROXY_HEADERS": "xforwarded",
"KC_HOSTNAME_STRICT": "false",
"KC_HOSTNAME_STRICT_HTTPS": "false"
},
"bindings": {
"http": {
"scheme": "http",
"protocol": "tcp",
"transport": "http",
"targetPort": 8080
"targetPort": 8443
},
"management": {
"scheme": "http",
Expand Down