Skip to content
/ ci-cd-glue Public
forked from libre-devops/ci-cd

A repo used to store a CI/CD glue script for terraform in PowerShell 🚀

License

MIT license
0 stars 1 fork Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

cyber-scot/ci-cd-glue

BranchesTags
 
 

Repository files navigation

Packer Script Execution Guide

This guide provides instructions on setting up environment variables and running the Run-Packer.ps1 PowerShell script for Packer operations.

Setting Environment Variables

Environment variables are used to pass configuration options and settings to the PowerShell script. These variables can be set both locally (for the current PowerShell session) and system-wide.

Prerequisites

  • Administrative privileges are required to set system environment variables.
  • PowerShell must be run as an administrator to execute these scripts.

Populate Environment Variables for local env - Populate-LocalVars.ps1

Run this PowerShell script to set the required environment variables.

You can run this script in a limited configuration, for example:

# PowerShell script to set user-level environment variables with predefined values for Linux
# Define a hashtable with key-value pairs for environment variables
$predefinedVariableValues = @{
    "WORKING_DIRECTORY" = "example_working_directory"
    "RUN_PACKER_BUILD" = "true"
    "RUN_PACKER_VALIDATE" = "true"
    "RUN_PACKER_INIT" = "true"
    "ENABLE_DEBUG_MODE" = "true"
    "PACKER_VERSION" = "latest"
    "PKR_VAR_registry_username" = "example"
    "PKR_VAR_registry_password" = "example"
}

# Set each predefined variable
foreach ($varName in $predefinedVariableValues.Keys) {
    $value = $predefinedVariableValues[$varName]

    if ($isLinux) {
        # Ensure the PowerShell profile directory exists
        $profileDirectory = [System.IO.Path]::GetDirectoryName($PROFILE)
        if (-not (Test-Path $profileDirectory)) {
            New-Item -ItemType Directory -Path $profileDirectory -Force
        }

        # Ensure the PowerShell profile file exists
        if (-not (Test-Path $PROFILE)) {
            New-Item -ItemType File -Path $PROFILE -Force
        }

        # Append to PowerShell profile and set in current session
        $exportCommand = "`n`$Env:$varName = `"$value`""
        Add-Content -Path $PROFILE -Value $exportCommand
        Set-Variable -Name $varName -Value $value -Scope Global
    }
    elseif ($IsMacOS)
    {
        # Ensure the PowerShell profile directory exists
        $profileDirectory = [System.IO.Path]::GetDirectoryName($PROFILE)
        if (-not (Test-Path $profileDirectory)) {
            New-Item -ItemType Directory -Path $profileDirectory -Force
        }

        # Ensure the PowerShell profile file exists
        if (-not (Test-Path $PROFILE)) {
            New-Item -ItemType File -Path $PROFILE -Force
        }

        # Append to PowerShell profile and set in current session
        $exportCommand = "`n`$Env:$varName = `"$value`""
        Add-Content -Path $PROFILE -Value $exportCommand
        Set-Variable -Name $varName -Value $value -Scope Global
    }
    else {
        # On other systems, set user environment variable
        [System.Environment]::SetEnvironmentVariable($varName, $value, [System.EnvironmentVariableTarget]::User)
    }
}

Write-Host "User-level environment variables have been set."
Write-Host "Please close your powershell window and reopen to refresh environment" -ForegroundColor Yellow

Running the Script

To run the Run-Packer.ps1 script with the environment variables, use the following command in PowerShell:

.\Run-Packer.ps1 `
-WorkingDirectory "foo/bar" `
-RunPackerInit "true" `
-RunPackerValidate "true"`
-RunPackerBuild "true" `
-DebugMode "true" `
-PackerVersion "latest"`
-PackerFileName "packer.pkr.hcl `

Post-Execution

  • After running the script, the Packer operations as specified by the parameters will be executed.
  • Remember that changes to system environment variables might require a system restart to be recognized by all applications.

Terraform Script Execution Guide

This guide provides instructions on setting up environment variables and running the Run-Terraform.ps1 PowerShell script for Terraform operations.

Setting Environment Variables

Environment variables are used to pass configuration options and settings to the PowerShell script. These variables can be set both locally (for the current PowerShell session) and system-wide.

Prerequisites

  • Administrative privileges are required to set system environment variables.
  • PowerShell must be run as an administrator to execute these scripts.

Populate Environment Variables for local env - Populate-LocalVars.ps1

Run this PowerShell script to set the required environment variables.

You can run this script in a limited configuration, for example:

# PowerShell script to set user-level environment variables with predefined values for Linux
# Define a hashtable with key-value pairs for environment variables
$predefinedVariableValues = @{
    "BACKEND_STORAGE_SUBSCRIPTION_ID" = "example_subscription_id"
    "BACKEND_STORAGE_USES_AZURE_AD" = "true"
    "BACKEND_STORAGE_RESOURCE_GROUP_NAME" = "example_resource_group_name"
    "BACKEND_STORAGE_ACCOUNT_NAME" = "example_account_name"
    "BACKEND_STORAGE_ACCOUNT_BLOB_CONTAINER_NAME" = "example_blob_container_name"
    "ARM_CLIENT_ID" = "example"
    "ARM_CLIENT_SECRET" = "example"
    "ARM_SUBSCRIPTION_ID" = "example"
    "ARM_TENANT_ID" = "example"
    "ARM_USE_AZUREAD" = "example"
}

# Set each predefined variable
foreach ($varName in $predefinedVariableValues.Keys) {
    $value = $predefinedVariableValues[$varName]

    if ($isLinux) {
        # Ensure the PowerShell profile directory exists
        $profileDirectory = [System.IO.Path]::GetDirectoryName($PROFILE)
        if (-not (Test-Path $profileDirectory)) {
            New-Item -ItemType Directory -Path $profileDirectory -Force
        }

        # Ensure the PowerShell profile file exists
        if (-not (Test-Path $PROFILE)) {
            New-Item -ItemType File -Path $PROFILE -Force
        }

        # Append to PowerShell profile and set in current session
        $exportCommand = "`n`$Env:$varName = `"$value`""
        Add-Content -Path $PROFILE -Value $exportCommand
        Set-Variable -Name $varName -Value $value -Scope Global
    }
    elseif ($IsMacOS)
    {
        # Ensure the PowerShell profile directory exists
        $profileDirectory = [System.IO.Path]::GetDirectoryName($PROFILE)
        if (-not (Test-Path $profileDirectory)) {
            New-Item -ItemType Directory -Path $profileDirectory -Force
        }

        # Ensure the PowerShell profile file exists
        if (-not (Test-Path $PROFILE)) {
            New-Item -ItemType File -Path $PROFILE -Force
        }

        # Append to PowerShell profile and set in current session
        $exportCommand = "`n`$Env:$varName = `"$value`""
        Add-Content -Path $PROFILE -Value $exportCommand
        Set-Variable -Name $varName -Value $value -Scope Global
    }
    else {
        # On other systems, set user environment variable
        [System.Environment]::SetEnvironmentVariable($varName, $value, [System.EnvironmentVariableTarget]::User)
    }
}

Write-Host "User-level environment variables have been set."
Write-Host "Please close your powershell window and reopen to refresh environment" -ForegroundColor Yellow

Running the Script

To run the Run-Terraform.ps1 script with the environment variables, use the following command in PowerShell:

.\Run-Terraform.ps1 `
  -WorkingDirectory $Env:WORKING_DIRECTORY `
  -RunTerraformInit $Env:RUN_TERRAFORM_INIT `
  -RunTerraformPlan $Env:RUN_TERRAFORM_PLAN `
  -RunTerraformPlanDestroy $Env:RUN_TERRAFORM_PLAN_DESTROY `
  -RunTerraformApply $Env:RUN_TERRAFORM_APPLY `
  -RunTerraformDestroy $Env:RUN_TERRAFORM_DESTROY `
  -DebugMode $Env:ENABLE_DEBUG_MODE `
  -DeletePlanFiles $Env:DELETE_PLAN_FILES `
  -TerraformVersion $Env:TERRAFORM_VERSION `
  -BackendStorageSubscriptionId $Env:BACKEND_STORAGE_SUBSCRIPTION_ID `
  -BackendStorageUsesAzureAD $Env:BACKEND_STORAGE_USES_AZURE_AD `
  -BackendStorageResourceGroupName $Env:BACKEND_STORAGE_RESOURCE_GROUP_NAME `
  -BackendStorageAccountName $Env:BACKEND_STORAGE_ACCOUNT_NAME `
  -BackendStorageAccountBlobContainerName $Env:BACKEND_STORAGE_ACCOUNT_BLOB_CONTAINER_NAME `
  -TerraformStateName $Env:TERRAFORM_STATE_NAME

Alternatively, you can just hard code the values you want:

.\Run-Terraform.ps1 `
  -RunTerraformInit true `
  -RunTerraformPlan true `
  -BackendStorageSubscriptionId "foo" `
  -BackendStorageResourceGroupName "bar" `
  -BackendStorageAccountName "example" `
  -BackendStorageAccountBlobContainerName "icecream" `
  -TerraformStateName "example.terraform.tfstate"

Or a mixture

.\Run-Terraform.ps1 `
  -RunTerraformInit true `
  -RunTerraformPlan true `
  -BackendStorageSubscriptionId $Env:BACKEND_STORAGE_SUBSCRIPTION_ID `
  -BackendStorageResourceGroupName $Env:BACKEND_STORAGE_RESOURCE_GROUP_NAME `
  -BackendStorageAccountName $Env:BACKEND_STORAGE_ACCOUNT_NAME `
  -BackendStorageAccountBlobContainerName $Env:BACKEND_STORAGE_ACCOUNT_BLOB_CONTAINER_NAME `
  -TerraformStateName "cscot-dev.terraform.tfstate"

Post-Execution

  • After running the script, the Terraform operations as specified by the parameters will be executed.
  • Remember that changes to system environment variables might require a system restart to be recognized by all applications.
module "rg" {
  source = "registry.terraform.io/libre-devops/rg/azurerm"

  rg_name  = "rg-${var.short}-${var.loc}-build"
  location = local.location
  tags     = local.tags
}

Requirements

No requirements.

Providers

No providers.

Modules

Name Source Version
rg registry.terraform.io/libre-devops/rg/azurerm n/a

Resources

No resources.

Inputs

Name Description Type Default Required
Regions Converts shorthand name to longhand name via lookup on map list map(string) 
{
  "eus": "East US",
  "euw": "West Europe",
  "uks": "UK South",
  "ukw": "UK West"
}
 no
env The env variable, for example - prd for production. normally passed via TF_VAR. string "dev" no
loc The loc variable, for the shorthand location, e.g. uks for UK South. Normally passed via TF_VAR. string "uks" no
short The shorthand name of to be used in the build, e.g. cscot for CyberScot. Normally passed via TF_VAR. string "ldo" no
static_tags The tags variable map(string) 
{
  "Contact": "info@cyber.scot",
  "CostCentre": "671888",
  "ManagedBy": "Terraform"
}
 no

Outputs

Name Description
rg_name The mame for the resource group

About

A repo used to store a CI/CD glue script for terraform in PowerShell 🚀

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Languages

  • PowerShell 93.4%
  • Groovy 6.6%