Fogg

Fogg is a PowerShell tool to simplify the creation, deployment and provisioning of infrastructure (IaaS) in Azure using Azure Resource Manager (does not support Classic).

Installing

Fogg can be installed via Chocolatey:

choco install fogg

Requirements

PowerShell v4.0+
AzureRM module v5.3+ (installed via PowerShellGet: Install-Module AzureRM)

Features

Deploy and provision Virtual Machines in Azure using Resource Manager
Supports unmanaged and managed disks
Ability to spin-up VMs using existing Images or VHDs
Spin-up multiple Resource Groups at once using a Foggfile
Has inbuilt provisioning scripts, with more that can be added on request
Inbuilt firewall ports for quicker allow/deny of in/outbound rules
Provision using:
- PowerShell Desired State Configuration (DSC)
- Custom Scripts (ps1/bat)
- Chocolatey to install software
Deploy:
- Resource Groups
- Storage Accounts
- Virtual Networks
- Subnets
- Network Security Groups with firewall rules
- Availability Sets and Load Balancers
- Public IP addresses for your VMs/Load Balancers
- VPN Gateways for site-to-site and point-to-site connections
Immediate feedback if your template is about to exceed the core limit in a location
Returns an object containing the information of what was deployed
Ability to append new VMs rather than always creating and updating the same ones
Add additional data drives to VMs and add them as new partitions
Add tags onto all resources

Description

Fogg is a PowerShell tool to simplify the creation, deployment and provisioning of infrastructure (IaaS) in Azure.

Fogg uses a JSON template file to determine what needs to be created and deployed (but don't worry, the JSON file is far, far smaller than Azure's ARM template files!). Furthermore, Fogg also accepts a few parameters for things like Resource Group Name, Subscription Name, VM Credentials and others. While these are to be passed in via command line, I'd recommend using a Foggfile to version control your deployments (more later).

Example

For more examples, please see the examples folder in the repo (a more advanced example can be found in the wiki)

This simple example will just spin-up one VM. The first thing you will need is a template file, which will look as follows:

{
    "template": [
        {
            "type": "vm",
            "role": "test",
            "count": 1,
            "os": {
                "type": "Windows",
                "size": "Standard_DS1_v2",
                "publisher": "MicrosoftWindowsServer",
                "offer": "WindowsServer",
                "skus": "2016-Datacenter"
            },
            "publicIp": true
        }
    ]
}

The above template will be used by Fogg to deploy one public Windows 2016 VM. You will notice the count value, changing this to 2, 3 or more will deploy 2, 3 or more of this VM type. If you don't supply the count value then just 1 VM will be deployed

Note: if you deploy a VM type with a count > 1, Fogg will automatically load balance your VMs for you, this can be disabled via: "loadBalancer": false, though you will still get an availability set

The role and type values for template objects are mandatory. the role can be any unique alphanumeric string, and the type value can only be one of either vm, vpn, vnet or sa.

Note, try and keep the role value short for Azure naming restrictions - roles like web, file, or data are good

To use Fogg and the template file above, you will need an Azure Subscription. In general, the call to Fogg would look as follows:

fogg -sub "AzureSubName" -rg "basic-rg" -loc "westeurope" -vnetaddr "10.1.0.0/16" -snets @{"vm"="10.1.0.0/24"} -tp "<path_to_above_template>"

This will tell Fogg to use the above template against your Subscription in Azure. Fogg will then:

Validate the template file
Request for you Azure Subscription credentials (though you can pass these on the cli)
Request for administrator credentials to deploy the VMs (again, can be supplied on the cli)
Create a Resource Group called basic-rg in Location westeurope
Create a Storage Account called euwbasicgblsa (or eu-w-basic-gbl-sa for for the globally used storage account for Fogg)
Create a Virtual Network called basic-vnet for address 10.1.0.0/16
Create a Subnet under the Virtual Network called test-snet for address 10.1.0.0/24
Create a Network Security Group called test-nsg
Create an Availability Set called test-as
A Virtual Machine called test-vm1 will then be deployed under the test-snet Subnet

To create a Foggfile of the above, stored at the root of the repo (can be else where as a -FoggfilePath can be supplied on cli), would look like the following:

{
    "Groups": [
        {
            "ResourceGroupName": "basic-rg",
            "Location": "westeurope",
            "TemplatePath": "<path_to_above_template>",
            "VNetAddress": "10.1.0.0/16",
            "SubnetAddresses": {
                "test": "10.1.0.0/24"
            }
        }
    ]
}

Note that the above leaves out the SubscriptionName, this is because the Foggfile at the root of a repo will mostly be used by your devs/QAs/etc. to spin-up the infrastructure in their MSDN Azure subscriptions. If the subscription name is the same for all, then you could add in the "SubscriptionName": "<name>" to the Foggfile (as a part of the main JSON object, not within the Groups objects); if left out Fogg will request it when called.

Also note that if the path used for the TemplatePath is relative, it must be relative to the Foggfile's location.

If you are using a Foggfile at the root, then the call to use Fogg would simply be:

fogg

If you pass in the parameters on the cli while using a Foggfile, the parameters from the cli have higher precedence and will override the Foggfile's values. (ie: passing -SubscriptionName will override the "SubscriptionName" in the Foggfile)

On a successful deployment, Fogg will return a resultant object that contains the information of the infrastructure that was just deployed. This will contain the names of resources like the VNETs, Subnets and VMs; to the IPs of them, and Ports of Load Balancer. For the above example:

'basic-rg' = @{
    'Location' = 'westeurope';
    'VirtualNetwork' = @{
        'Name' = 'basic-vnet';
        'ResourceGroupName' = 'basic-rg';
        'Address' = '10.1.0.0/16';
    };
    'StorageAccount' = @{
        'Name' = 'euwbasicgblsa'
    };
    'VirtualMachineInfo' = @{
        'test' = @{
            'Subnet' = @{ 
                'Name' = 'test-snet';
                'Address' = '10.1.0.0/24';
            };
            'AvailabilitySet' = 'test-as';
            'LoadBalancer' = @{};
            'VirtualMachines' = @(
                @{
                    'Name' = 'test-vm1';
                    'PrivateIP' = '10.1.0.1';
                    'PublicIP' = '52.139.128.96';
                };
            );
        };
    };
    'VPNInfo' = @{};
    'VirtualNetworkInfo' = @{};
}

TODO

SQL always-on clusters
Web Apps?
Possibility of Chef as a provisioner
Documentation

Bugs and Feature Requests

For any bugs you may find or features you wish to request, please create an issue in GitHub.

Badgerati / Fogg