FVNever.Fabricator.Resources

Fabricator

Fabricator is a hackable DevOps platform, similar to PowerShell's Desired State Configuration in concept.

Core Concept

With Fabricator, the user describes the desired state of their environment, and Fabricator does its best to lead the configuration to this desired state, when asked to do so.

Fabricator's "script" is an F# .fsx script, where you may use all your favorite refactoring and code inspection tools; you may wrap or augment Fabricator calls with your code if you want to.

Fabricator offers a DSL and a set of basic tasks to configure the environment, everything is available via NuGet and easily extendable.

Also, Fabricator is portable across the platforms supported by .NET.

Basic Workflow

To start using Fabricator, you should:

1. Create a new F# script file, with contents similar to the example.
2. Run the script with dotnet fsi ./script.fsx check — this will check the environment and show the changes that are about to be performed (add --brief to only see which resources are not applied, without the change details).
3. If everything's alright, run the script via dotnet fsi ./script.fsx apply — this will apply the changes to the current environment.

Add --dry-run to either command (e.g. dotnet fsi ./script.fsx apply --dry-run) to only print the list of the checks and applications it would perform. No resource is checked or applied, and no secret store is opened, so no input is required. This is useful as a quick CI check that the script compiles and builds its resources. Since no resource is called, it doesn't verify that the checks or applications would succeed.

Quick script example:

#r "nuget: FVNever.Fabricator.Console, 0.6.0"
#r "nuget: FVNever.Fabricator.Resources, 0.6.0"

open System
open System.IO
open Fabricator.Console
open type Fabricator.Resources.Archive
open type Fabricator.Resources.Downloads
open type Fabricator.Resources.Files
open Fabricator.Resources.Hash
open TruePath

let shawlVersion = "1.7.0"
let shawlHash = Sha256 "EAA4FED710E844CC7968FDB82E816D406ED89C4486AB34C3E5DB2DA7E5927923"

let cacheDir = AbsolutePath @"T:\Temp\fabricator\download-cache"
let shawlUrl = Uri $"https://github.com/mtkennerly/shawl/releases/download/v{shawlVersion}/shawl-v{shawlVersion}-win64.zip"

let shawlDownloadCache = cacheDir / Path.GetFileName shawlUrl.LocalPath
let shawlExecutable = AbsolutePath @"C:\Programs\shawl\shawl.exe"

let downloadShawl = downloadFile(shawlUrl, shawlHash, shawlDownloadCache)
let unpackShawl =
    unpackArchive(shawlDownloadCache, shawlHash, shawlExecutable.Parent.Value, dependsOn = [ downloadShawl ])
let installShawl = ensureFileExists(shawlExecutable, dependsOn = [ unpackShawl ])

let resources = [
    installShawl
]

exit <| EntryPoint.main fsi.CommandLineArgs resources

This script will make sure there's an executable C:\Programs\shawl\shawl.exe downloaded from the specified URL. This executable might then be used for other resources' setup, e.g., for the Windows service resource.

Resources passed to EntryPoint.main are processed in parallel, and their order doesn't matter. If a resource requires another one to be applied first, declare that via Resource.DependsOn (e.g., using the dependsOn parameter of the bundled resources as in the example above). A resource's dependencies don't have to be passed to EntryPoint.main explicitly: they are always checked and, if required, applied before the resource itself.

Prerequisites

To work with Fabricator, you'll need .NET SDK 9.0 or later.

Documentation

• Project Documentation Site (API Reference)
• Changelog
• Contributor Guide
• Maintainer Guide

License

The project is distributed under the terms of the MIT license.

The license indication in the project's sources is compliant with the REUSE specification v3.3.