Manage NSG for Deployments

This GitHub action allows a hosted(public) runner image to access resources secured by an Azure Network Security Group (NSG) by creating an allow rule picking the current IP address of the hosted runner, also the same task can be used to remove existing NSG rules allowing the cleanup of the created rules.

E.g. Web Deploy to a WebApp inside an Azure Application Service Environment (ASE)

Inputs

azure-credentials

• Required SPN details as secrets.AZURE_CREDENTIALS, Refer Configure Azure Credentials on how to.
• Default "N/A".

  rule-priority-start:

• Optional Start value for the priority range to be used.
• Default "300".

  rule-priority-range:

• Optional range of the NSG priority values to be used when multiple agents are deploying sharing the same NSG.
• Default "100".

  rule-inbound-port:

• Optional Port for the inbound rule’.
• Default "443".

  rule-id-for-removal:

• Optional rule id to remove. If this value is defined the action will default to deleteing.
• Default "".

  rule-nsg-resource-group-name:

• Required Resource Group of the NSG.
• Default "N/A".

  rule-nsg-name:

• Required Name of the NSG.
• Default "N/A".

Outputs

rule_name

Created or Deleted NSG Rule Name

Example usage

#File: .github/workflows/deploy_action.yml
name: deploy_to_azure_resource_behind_nsg
on:
  push:
    branches:
      - master
jobs:
  deploy:
    runs-on: ubuntu-latest
    name: Deploying to Azure
    steps:
      - name: dig +short myip.opendns.com @resolver1.opendns.com
        run: dig +short myip.opendns.com @resolver1.opendns.com
      - name: Add NSG Rule
        uses: venura9/manage-nsg@master
        id: rule
        with:
          azure-credentials: ${{ secrets.AZURE_CREDENTIALS }}
          rule-nsg-resource-group-name: ManageNsg
          rule-nsg-name: ManageNsg
      - name: Print Created NSG Rule Name
        run: echo "Rule Name ${{ steps.rule.outputs.rule_name }}"
      - name: Remove NSG Rule
        uses: venura9/manage-nsg@master
        with:
          azure-credentials: ${{ secrets.AZURE_CREDENTIALS }}
          rule-id-for-removal: ${{ steps.rule.outputs.rule_name }}
          rule-nsg-resource-group-name: ManageNsg
          rule-nsg-name: ManageNsg

Configure Azure credentials:

To fetch the credentials required to authenticate with Azure, run the following command to generate an Azure Service Principal (SPN) with Contributor permissions:

az ad sp create-for-rbac --name "myApp" --role contributor \
                         --scopes /subscriptions/{subscription-id}/resourceGroups/{resource-group} \
                         --sdk-auth
# Replace {subscription-id}, {resource-group} with yout subscription, resource group details
# The command should output a JSON object similar to this:
{
  "clientId": "<GUID>",
  "clientSecret": "<GUID>",
  "subscriptionId": "<GUID>",
  "tenantId": "<GUID>",
  (...)
}
# Note: You can always create the json string manually and add as a secret

Add the json output as a secret (let’s say with the name AZURE_CREDENTIALS) in the GitHub repository.