-
Notifications
You must be signed in to change notification settings - Fork 451
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enable devcontainers in repo. (#6491)
Enable the use of DevContainers in the dotnet/aspire repository. This change includes the .devcontainer file optimized for use with our repo including some initial port forwards for demonstration purposes. From where we can enable pre-builds so we can more easily start using Codespaces to help trash out issues as are improving support for some of the various remote dev scenarios.
- Loading branch information
1 parent
af83cc5
commit 9336436
Showing
8 changed files
with
186 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the | ||
// README at: https://github.com/devcontainers/templates/tree/main/src/dotnet | ||
{ | ||
"name": "C# (.NET)", | ||
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile | ||
"image": "mcr.microsoft.com/devcontainers/dotnet:1-9.0", | ||
"features": { | ||
"ghcr.io/devcontainers/features/azure-cli:1": {}, | ||
"ghcr.io/azure/azure-dev/azd:0": {}, | ||
"ghcr.io/devcontainers/features/docker-in-docker": {}, | ||
"ghcr.io/devcontainers/features/dotnet": { | ||
"additionalVersions": [ | ||
"8.0.403" | ||
] | ||
} | ||
}, | ||
|
||
"hostRequirements": { | ||
"cpus": 8, | ||
"memory": "32gb", | ||
"storage": "64gb" | ||
}, | ||
|
||
// Features to add to the dev container. More info: https://containers.dev/features. | ||
// "features": {}, | ||
|
||
// Use 'forwardPorts' to make a list of ports inside the container available locally. | ||
"forwardPorts": [ | ||
15887, | ||
5180, | ||
7024, | ||
15551, | ||
33803, | ||
5350, | ||
41567, | ||
15306 | ||
], | ||
"portsAttributes": { | ||
"5180": { | ||
"label": "WaitFor Playground: ApiService", | ||
"protocol": "http" | ||
}, | ||
"5350": { | ||
"label": "Redis Playground: Api Service" | ||
}, | ||
"7024": { | ||
"label": "WaitFor Playground: Frontend", | ||
"protocol": "https" | ||
}, | ||
"15306": { | ||
"label": "Redis Playground: App Host" | ||
}, | ||
"15551": { | ||
"label": "WaitFor Playground: PGAdmin", | ||
"protocol": "http" | ||
}, | ||
"15887": { | ||
"label": "WaitFor Playground: AppHost", | ||
"protocol": "https" | ||
}, | ||
"33803": { | ||
"label": "Redis Playground: Redis Commander" | ||
}, | ||
"41567": { | ||
"label": "Redis Playground: Redis Insight" | ||
} | ||
}, | ||
"otherPortsAttributes": { | ||
"onAutoForward": "ignore" | ||
}, | ||
|
||
// Use 'postCreateCommand' to run commands after the container is created. | ||
"customizations": { | ||
"vscode": { | ||
"extensions": [ | ||
"ms-dotnettools.csdevkit", | ||
"ms-azuretools.vscode-bicep", | ||
"ms-azuretools.azure-dev" | ||
], | ||
"settings": { | ||
"remote.autoForwardPorts": false, | ||
"dotnet.defaultSolution": "Aspire.sln" | ||
} | ||
} | ||
}, | ||
"onCreateCommand": "dotnet restore", | ||
"postStartCommand": "dotnet dev-certs https --trust" | ||
|
||
// Configure tool-specific properties. | ||
// "customizations": {}, | ||
|
||
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. | ||
// "remoteUser": "root" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
using System.Diagnostics.CodeAnalysis; | ||
using Microsoft.Extensions.Configuration; | ||
using Microsoft.Extensions.Options; | ||
|
||
namespace Aspire.Hosting.Codespaces; | ||
|
||
/// <summary> | ||
/// GitHub Codespaces configuration values. | ||
/// </summary> | ||
internal class CodespacesOptions | ||
{ | ||
/// <summary> | ||
/// When set to true, the app host is running in a GitHub Codespace. | ||
/// </summary> | ||
/// <remarks> | ||
/// Maps to the CODESPACE environment variable. | ||
/// </remarks> | ||
public bool IsCodespace { get; set; } | ||
|
||
/// <summary> | ||
/// When set it is the domain suffix used when port forwarding services hosted on the Codespace. | ||
/// </summary> | ||
/// <remarks> | ||
/// Maps to the GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN environment variable. | ||
/// </remarks> | ||
[MemberNotNullWhen(true, nameof(IsCodespace))] | ||
public string? PortForwardingDomain { get; set; } | ||
|
||
/// <summary> | ||
/// When set it is the name of the GitHub Codespace in which the app host is running. | ||
/// </summary> | ||
/// <remarks> | ||
/// Maps to the CODESPACE_NAME environment variable. | ||
/// </remarks> | ||
[MemberNotNullWhen(true, nameof(IsCodespace))] | ||
public string? CodespaceName { get; set; } | ||
} | ||
|
||
internal class ConfigureCodespacesOptions(IConfiguration configuration) : IConfigureOptions<CodespacesOptions> | ||
{ | ||
private const string CodespacesEnvironmentVariable = "CODESPACES"; | ||
private const string CodespaceNameEnvironmentVariable = "CODESPACE_NAME"; | ||
private const string GitHubCodespacesPortForwardingDomain = "GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN"; | ||
|
||
private string GetRequiredCodespacesConfigurationValue(string key) | ||
{ | ||
ArgumentNullException.ThrowIfNullOrEmpty(key); | ||
return configuration.GetValue<string>(key) ?? throw new DistributedApplicationException($"Codespaces was detected but {key} environment missing."); | ||
} | ||
|
||
public void Configure(CodespacesOptions options) | ||
{ | ||
if (!configuration.GetValue<bool>(CodespacesEnvironmentVariable, false)) | ||
{ | ||
options.IsCodespace = false; | ||
return; | ||
} | ||
|
||
options.IsCodespace = true; | ||
options.PortForwardingDomain = GetRequiredCodespacesConfigurationValue(GitHubCodespacesPortForwardingDomain); | ||
options.CodespaceName = GetRequiredCodespacesConfigurationValue(CodespaceNameEnvironmentVariable); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters