Just Your Commands
#infrastructureascode#azure#bicep#shell
Dariusz Parys

Dariusz Parys @dariuszparys

About: I like to code.

Location:
Germany
Joined:
Feb 14, 2020

Just Your Commands

Publish Date: Mar 31
0 0

Just is a simple command runner. You can get if from https://just.systems. I use it meanwhile regularly, and it improves consistency between my local environment and my CI/CD pipelines. Let me explain this with a trivial walkthrough.

Deploying Infrastructure

A common task is to deploy infrastructure. As I use mostly Azure for infrastructure deployments, I use bicep to do them. For this scenario a simple storage deployment will act as the canonical Hello, World. example. You can find the code for the scripts at my GitHub.

GitHub logo dariuszparys / just-your-commands

Sample source code for the blog post https://www.dariuszparys.com/just-your-commands/

Azure Bicep Deployment with Just

This project uses Just as a command runner to manage Azure Bicep deployments.

Prerequisites

  1. Install Just

  2. Install Azure CLI

  3. Install PowerShell

  4. Log in to Azure CLI:

    az login
    Enter fullscreen mode Exit fullscreen mode

Environment Variables

Set the following environment variables before running the deployment:

export AZURE_SUBSCRIPTION_ID="your-subscription-id"
export DEPLOYMENT_ENVIRONMENT="dev"  # Optional, defaults to "dev"
export AZURE_LOCATION="northeurope"  # Optional, defaults to "northeurope"
export DEPLOYMENT_NAME="just-demo"   # Optional, defaults to "just-demo"
export RESOURCE_GROUP_NAME="rg-just-demo"  # Optional, defaults to "rg-just-demo"
Enter fullscreen mode Exit fullscreen mode

Available Commands

Validate Deployment

To validate the Bicep template and see what changes would be made:

just validate-all
Enter fullscreen mode Exit fullscreen mode

This command will:

  1. Lint the Bicep files
  2. Validate the deployment
  3. Show what-if changes

Deploy

To deploy the infrastructure:

just deploy
Enter fullscreen mode Exit fullscreen mode

Clean Up

To delete the deployment and resource group:

just destroy
Enter fullscreen mode Exit fullscreen mode

Additional Commands

  • just help - Lists all available commands
  • just lint -…
View on GitHub

The workflow usually consists of these steps to make the deployment

  1. Lint the file az bicep lint --file main.bicep
  2. Validate the script az deployment sub validate --template-file main.bicep --parameters environments/dev.bicepparam
  3. Make a what-if analysis az deployment sub what-if --template-file main.bicep --parameters environments/dev.bicepparam
  4. Deploy to Infrastructure az deployment sub create --template-file main.bicep --parameters environments/dev.bicepparam

This can now be scripted or in this case I use just so I will write recipes to execute those steps.

Simple Just Anatomy

I don't want to explain things that are already explained in the Just manuals, but it helps to have a quick context without digging into this.

environment := env("DEPLOYMENT_ENVIRONMENT", "dev")

# Lists all available recipies
help:
  @just --list

_hello name="world":
  @echo "Hello, {{name}}"

# Deploys infrastructure to defined environment
deploy: _hello
  @echo "Deploying to {{environment}}"
Enter fullscreen mode Exit fullscreen mode

A lot happens here

First, the variable environment gets either assigned an available environment variable called DEPLOYMENT_ENVIRONMENT or if not available, the value dev. So just has functions that can be used in recipes

Second, the first function will be executed when no parameter is applied to the just command. Therefore, I often use help as my first recipe.

❯ just 
Available recipes:
    deploy # Deploys infrastructure to defined environment
    help   # Lists all available recipies
Enter fullscreen mode Exit fullscreen mode

Third, just can have private recipes like _hello which also contains a parameter with a default value

Fourth, deploy leverages the private recipe when called and executes it first without providing any parameter. Therefore, the default is taken.

Please note that comments applied before recipes are used as description in the --list parameter of just and private recipes are not listed.

Calling now just deploy outputs

❯ just deploy
Hello, world
Deploying to dev
Enter fullscreen mode Exit fullscreen mode

My Just Approach

In my working environment and especially in the teams I am working with a lot of people still use Windows. PowerShell is set as the de-facto shell across all operating systems.

PowerShell Shebang

To enable just now to execute all commands using PowerShell I always define at the very top of my justfile

shebang := if os() == 'windows' {
  'pwsh.exe'
} else {
  '/usr/bin/env pwsh'
}
set shell := ["pwsh", "-c"]
set windows-shell := ["pwsh.exe", "-NoProfile", "-Command"]
Enter fullscreen mode Exit fullscreen mode

This will instruct the execution engine to use PowerShell as the execution shell. There are two variables depending on the environment shell and windows-shell that are used for that.

The shebang is used when a recipe will spawn multiple lines and needs to keep the context. If you don't specify this, the commands will be executed in their own environment without knowing anything about the previous line.

# Test without
without:
  Write-Host "Without"
  $some_var = "Without"
  Write-Host $some_var
Enter fullscreen mode Exit fullscreen mode

When executing without you see in the output that the variable is set, but it is not available when writing to console anymore, as each line is in its own context

❯ just without
Write-Host "Without"
Without
$some_var = "Without"
Write-Host $some_var
Enter fullscreen mode Exit fullscreen mode

Using now the shebang defined above, it works

# Test with
with:
  #!{{shebang}}
  Set-PSDebug -Trace 1
  Write-Host "With"
  $some_var = "With"
  Write-Host $some_var
  Set-PSDebug -Off
Enter fullscreen mode Exit fullscreen mode

The output does keep the variable because it executes it with the defined shell environment in one context

 just with
DEBUG:   32+  >>>> Write-Host "With"

With
DEBUG:   33+  >>>> $some_var = "With"

DEBUG:   34+  >>>> Write-Host $some_var

With
DEBUG:   35+  >>>> Set-PSDebug -Off
Enter fullscreen mode Exit fullscreen mode

The First Recipe is Help

I always define this as my very first recipe

# Lists all available recipies
help:
  @just --list
Enter fullscreen mode Exit fullscreen mode

So, when I invoke just every recipe is listed.

❯ just
Available recipes:
    deploy  # Deploys infrastructure to defined environment
    help    # Lists all available recipies
    with    # Test with
    without # Test without
Enter fullscreen mode Exit fullscreen mode

Use Short Recipe Scripts

Using a shebang allows writing scripts as complex as you want. Usually if I tend to use more than one branching path in my script, I extract them into my own PowerShell modules. I invoke them e.g.

module_path := "path/to/psmd"

# Install k3s using Ansible
k3s-install:
  #!{{ shebang }}
  Import-Module "./{{module_path}}" -Force
  Install-K3sCluster -Verbose
Enter fullscreen mode Exit fullscreen mode

No Here Strings

I haven't found a way to use here strings with just. test. For instance, if I have a recipe like this

# Initializes the configuration toml
init:
  #!{{shebang}}
  $toml = @"
[package]
name = "my-project"
version = "0.1.0"
edition = "2021"

[dependencies]
serde = { version = "1.0", features = ["derive"] }
toml = "0.7"
"@

  $toml | Out-File -FilePath "Cargo.toml"
  Write-Host "Created Cargo.toml"
Enter fullscreen mode Exit fullscreen mode

It would just complain about the content inside the here string.

❯ just --list
error: Unknown attribute `package`
 ——▶ justfile:5:2
  │
5 │ [package]
  │  ^^^^^^^
Enter fullscreen mode Exit fullscreen mode

So, I put things like this in an external PowerShell function.

Use Just Recipes in CI/CD

I aim to have my recipes agnostic to the environment. That said, I use them as well in the CI/CD environment. One drawback to using just is that the current GitHub runners or Azure DevOps agent don't have just pre-configure on their environments. So before using them, e.g. in Azure DevOps I have a task installing just

  - task: Bash@3
    inputs:
      targetType: 'inline'
      script: |
        wget -qO - 'https://proget.makedeb.org/debian-feeds/prebuilt-mpr.pub' | gpg --dearmor | sudo tee /usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg 1> /dev/null
        echo "deb [arch=all,$(dpkg --print-architecture) signed-by=/usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg] https://proget.makedeb.org prebuilt-mpr $(lsb_release -cs)" | sudo tee /etc/apt/sources.list.d/prebuilt-mpr.list
        sudo apt update
        sudo apt install -y just
    displayName: 'Install just'
Enter fullscreen mode Exit fullscreen mode

I also only use either AzureCLI@2 or Bash@3 tasks in my piplines (on Azure DevOps). To invoke a recipe e.g.

  - task: Bash@3
    displayName: 'Build APIs'
    inputs:
      targetType: 'inline'
      script: |
        just containerize-apis
    env:
      REGISTRY: $(registry)
      TAG: $(buildTag)
Enter fullscreen mode Exit fullscreen mode

The recipe (simplified version) looks like this

targetRegistry := env("REGISTRY", "localhost:5050")
buildTag := env("TAG", "latest-dev")

# Build all API containers
containerize-apis: (containerize-facilitymanagement targetRegistry) (containerize-storymanagement targetRegistry) (containerize-queuemanagement targetRegistry) (containerize-videostreaming targetRegistry)

# Build Docker container for Queue Management API
containerize-queuemanagement registry:
  #!{{ shebang }}
  docker build `
    --tag {{registry}}/api-queuemanagement:{{buildTag}} `
    --file src/Api.QueueManagement/Dockerfile `
    .
Enter fullscreen mode Exit fullscreen mode

Back Deploying Infrastructure

I started to discuss how I deploy infrastructure using just. When you have a look at the sample justfile I published, you will see that my approach is applied to this. You could argue that destroy is too many lines of code. Yes, this can be extracted to an external script or module. I usually like to use PowerShell modules, but one function is not enough for me to consider this.

shebang := if os() == 'windows' {
  'pwsh.exe'
} else {
  '/usr/bin/env pwsh'
}
set shell := ["pwsh", "-c"]
set windows-shell := ["pwsh.exe", "-NoProfile", "-Command"]

subscription-id := env("AZURE_SUBSCRIPTION_ID")
environment := env("DEPLOYMENT_ENVIRONMENT", "dev")
location := env("AZURE_LOCATION", "northeurope")
deployment-name := env("DEPLOYMENT_NAME", "just-demo")
resourceGroupName := env("RESOURCE_GROUP_NAME", "rg-just-demo")

# Lists all available recipies
help:
    @just --list

# Lint the bicep files
lint:
    az bicep lint --file main.bicep

# Validates the bicep deployment
validate: _ensure-subscription
    #!{{ shebang }}
    az deployment sub validate `
        --name {{deployment-name}} `
        --location {{location}} `
        --template-file main.bicep `
        --parameters environments/{{environment}}.bicepparam `
        --parameters resourceGroupName={{resourceGroupName}}

# Shows what changes would be made by the deployment
what-if: _ensure-subscription
    #!{{ shebang }}
    az deployment sub what-if `
        --name {{deployment-name}} `
        --location {{location}} `
        --template-file main.bicep `
        --parameters environments/{{environment}}.bicepparam `
        --parameters resourceGroupName={{resourceGroupName}}

# Validates and shows what changes would be made by the deployment
validate-all: lint validate what-if

_ensure-subscription:
    az account set --subscription {{subscription-id}}

# Deploys the bicep deployment
deploy: _ensure-subscription
    #!{{ shebang }}
    az deployment sub create `
        --name {{deployment-name}} `
        --location {{location}} `
        --template-file main.bicep `
        --parameters environments/{{environment}}.bicepparam `
        --parameters resourceGroupName={{resourceGroupName}}

# Deletes the deployment and the resource group
destroy: _ensure-subscription
    #!{{ shebang }}
    Write-Host "Deleting deployment..."
    az deployment sub delete `
        --name {{deployment-name}} `
        --no-wait
    Write-Host "Checking if resource group exists..."
    $rgExists = az group exists --resource-group {{resourceGroupName}}
    if ($rgExists -eq "true") {
        Write-Host "Resource group '{{resourceGroupName}}' exists. Deleting..."
        az group delete --resource-group {{resourceGroupName}} --yes --no-wait
        Write-Host "Resource group deletion initiated"
    } else {
        Write-Host "Resource group '{{resourceGroupName}}' does not exist"
    }
Enter fullscreen mode Exit fullscreen mode

The only environment variable you have to provide is AZURE_SUBSCRIPTION_ID and you are good to execute the commands. I assume that you have subscription ownership, else you have to tweak the bicep scripts.

❯ just
Available recipes:
    deploy       # Deploys the bicep deployment
    destroy      # Deletes the deployment and the resource group
    help         # Lists all available recipies
    lint         # Lint the bicep files
    validate     # Validates the bicep deployment
    validate-all # Validates and shows what changes would be made by the deployment
    what-if      # Shows what changes would be made by the deployment
Enter fullscreen mode Exit fullscreen mode

Conclusion

There are many other runners you could use, starting from good old make to a python-based one like tox and many others out there. You can achieve similar things with all of them, I stick to Just. I like it.

Comments 0 total

    Add comment