This project is still a work in progress.
With the establishment of the IL6 cloud region, we now have access to the services necessary for hosting capabilities in the cloud environment. In order to leverage these services, we still need to establish the underlying infrastructure needed to develop and deploy these capabilities. This repository is an effort to identify this needed infrastructure, and identify strategies for standardizing their use in an environment without access to the internet.
All of the resources and dependencies specified in this documentation can be retrieved and bundled together into a single directory by executing the Build-DevResources.ps1 script and passing in a config JSON file. It aggregates the execution of the scripts specified in the sections of this documentation based on the requirements specified in the provided configuration. These resources can then be transported to a disconnected network and used to establish or update their related features.
For a comprehensive set of configuration examples, see the scripts/config directory in the project repository.
Specifies where to store the cached resources (target) and provides metadata to the executed sub-scripts (each base property apart from target, i.e. - linux for caching Ubuntu resources, npm for caching npm projects with their dependencies, etc.).
The sub-script base properties are optional. If a sub-script base property is provided, all of the properties within its schema are required unless specified below. You should provide at least one sub-script base property.
Each target within a sub-script base property will be joined with the root target property. For instance:
{
"target": "..\\bundle",
"wsl": {
"target": "wsl",
"arch": "x64"
}
}
The runtime target for wsl.target will be ..\bundle\wsl.
The schema is as follows:
{
// the root cache directory
"target": "..\\bundle",
// Build-AdsExtensions.ps1
"ads": {
// cache directory for Azure Data Studio extensions
"target": "extensions\\ads",
// list of extensions
"data": [
{
// extension name
"name": "Admin Pack for SQL Server",
// generated file name
"file": "admin-pack-sql-server.vsix",
// download URI
"source": "https://go.microsoft.com/fwlink/?linkid=2099889"
}
]
},
// Build-CodeExtensions.ps1
"vscode": {
// cache directory for Visual Studio Code extensions
"target": "extensions\\vscode",
// list of extensions
"data": [
{
// registered publisher
"publisher": "angular",
// registered name
"name": "ng-template",
// user friendly name
"display": "Angular Language Service"
}
]
},
// Build-DockerCache.ps1
"docker": {
// cache directory for Docker images
"target": "docker",
// list of images
"data": [
{
// image repository
"repository": "mcr.microsoft.com/dotnet/sdk",
// cached image file name
"name": "mcr.microsoft.com-dotnet-sdk",
// image tag
"tag": "latest",
// if true, remove the image after caching
"clear": false
}
]
},
// Build-DotnetCache.ps1
"dotnet": {
// cache directory for the .NET SDK
"target": "dotnet",
// OPTIONAL: .NET SDK metadata
// options correspond with .NET install script options
// see https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-install-script#options
"sdk": {
// see --architecture
"arch": "x64",
// see -channel
"channel": "STS",
// see --os
"os": "win"
},
// OPTIONAL: .NET CLI tools
// see https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
"tools": {
// sub-directory to store cached tools
"target": "tools",
// list of tools to cache
//
"data": [
"dotnet-ef",
// can specify a specific version
"dotnet-serve@1.10.172",
// ending in ! indicates --prerelease
"dotnetsay!"
]
}
}
// Build-LinuxCache.ps1
"linux": {
// cache directory for Linux resources
"target": "linux",
// script metadata options
"data": {
// apt packages to cache
"apt": [
"apt-offline",
"git",
"jq"
],
// OPTIONAL: .NET SDK metadata
// options correspond with .NET install script options
// see https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-install-script#options
"dotnet": {
// see --architecture
"arch": "x64",
// see --channel
"channel": "STS",
// see --os
"os": "linux",
// extract the retrieved .tar.gz into a .dotnet directory
"extract": false
}
}
},
// Build-NpmCache.ps1
"npm": {
// cache directory for generated Node.js projects
"target": "npm",
// specifies details for caching global npm packages
"global": {
// cache directory for global npm packages
"target": "global",
// list of environment variables to set
// while generating the global npm cache
"environment": [
{
// the environment variable to set
"key": "CYPRESS_INSTALL_BINARY",
// the environment variable value
"value": 0
}
],
// the global npm packages to cache
"packages": [
"cypress"
],
// list of external binaries associated with
// the npm packages being cached
"binaries": [
{
// cache directory for the binary
"target": "cypress_cache",
// file name for the downloaded binary
"file": "cypress.zip",
// download URI for the binary
"source": "https://download.cypress.io/desktop?platform=win32&arch=x64"
}
]
},
// Node.js project configurations
"projects": [
{
// package.json name
"name": "cache",
// package.json version
"version": "0.0.1",
// project dependency cache set in .npmrc
"cache": "node_cache",
// all dependency objects and their dependencies
// see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies
"packages": {
// package.json dependencies
"dependencies": {
"@microsoft/signalr": "^7.0.7"
},
// package.json devDependencies
"devDependencies": {
"typescript": "^5.1.3"
}
}
}
]
},
// Build-NugetCache.ps1
"nuget": {
// cache directory for generated NuGet packages
"target": "nuget",
// script metadata options
"data": {
// directory to host the generated solution
"solution": ".solution",
// if true, keep the solution after generating the cache
"keep": false,
// if true, clean the NuGet cache before caching dependencies
"clean": true,
// dotnet new projects to generate in the solution
"projects": [
{
// project name
"name": "Core",
// dotnet new <template>
"template": "classlib",
// dotnet new <template> -f <framework>
"framework": "net7.0",
// NuGet package dependencies
"dependencies": [
"Microsoft.AspNetCore.SignalR.Client",
// ending in ! indicates --prerelease
"System.CommandLine!",
// can specify a specific version
"System.CommandLine@2.0.0-beta4.22272.1"
]
}
]
}
},
// Build-ResourcesCache.ps1
"resources": {
// cache directory for generated binaries
"target": "resources",
// OPTIONAL: list of files for this directory
"files": [
{
// resource name
"name": "Visual Studio Code",
// cached binary name
"file": "vscode.exe",
// download URI
"source": "https://code.visualstudio.com/sha/download?build=stable&os=win32-x64-user"
}
],
// OPTIONAL: list of sub-directories for this directory
// each object in this array has the same schema as the root "resources" object
"folders": [
{
// cache directory for the files within this folder
//
// note that you can lift directory by using relative
// directory paths. For instance, if you wanted to lift
// "fonts" to directly within the generated "bundle"
// directory, you could define it as follows:
//
// "target": "../fonts"
//
// this will generate the following directory structure:
//
// * bundle
// * fonts
// * resources
"target": "fonts",
"files": [
{
"name": "Cascadia Code",
"file": "cascadia-code.zip",
"source": "https://github.com/microsoft/cascadia-code/releases/download/v2111.01/CascadiaCode-2111.01.zip"
}
]
}
]
},
// Build-WslCache.ps1
"wsl": {
// cache directory for generated Kernel and Ubuntu app package
"target": "wsl",
// system architecture - x64 or arm64
"arch": "x64"
}
}