Merge pull request #364 from Azure/ipam-3.6.0

Azure IPAM v3.6.0 Release

Author: DCMattyG

.dockerignore

@@ -19,7 +19,7 @@ tools/
 LICENSE
 
 # IPAM UI
-node_modules
+**/node_modules
 build
 dist
 

.github/workflows/azure-ipam-assets.yml

@@ -17,19 +17,20 @@ jobs:
       - run: echo "Job triggered by a ${{ github.event_name }} event."
       - run: echo "Release Tag - ${{ github.event.release.tag_name }}."
 
-      - name: "Setup NodeJS v18"
+      - name: "Setup NodeJS v22"
         id: setupNode
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
 
-      - name: "Setup Python v3.9"
+      - name: "Setup Python v3.11"
         id: setupPython
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.11'
 
       - name: Checkout Azure IPAM Code
+        id: checkoutRepo
         uses: actions/checkout@v4
 
       - name: Install NPM Packages

.github/workflows/azure-ipam-build.yml

@@ -39,6 +39,7 @@ jobs:
     needs: [ init ]
     steps:
       - name: Azure Login
+        id: azureLogin
         uses: azure/login@v2
         with:
           client-id: ${{ secrets.AZURE_CLIENT_ID }}
@@ -47,13 +48,15 @@ jobs:
           enable-AzPSSession: true
 
       - name: Checkout Azure IPAM Code
+        id: checkoutRepo
         uses: actions/checkout@v4
         with:
           sparse-checkout: |
             engine
             ui
 
       - name: Build Azure IPAM Containers
+        id: buildContainers
         env:
           IPAM_VERSION: ${{ needs.init.outputs.ipamVersion }}
         run: |
@@ -67,6 +70,7 @@ jobs:
     needs: [ init ]
     steps:
       - name: Azure Login
+        id: azureLogin
         uses: azure/login@v2
         with:
           client-id: ${{ secrets.AZURE_CLIENT_ID }}
@@ -75,6 +79,7 @@ jobs:
           enable-AzPSSession: true
 
       - name: Checkout Azure IPAM Code
+        id: checkoutRepo
         uses: actions/checkout@v4
         with:
           sparse-checkout: |
@@ -83,6 +88,7 @@ jobs:
             lb
 
       - name: Build Legacy Azure IPAM Containers
+        id: buildLegacyContainers
         env:
           IPAM_VERSION: ${{ needs.init.outputs.ipamVersion }}
         run: |

.github/workflows/azure-ipam-testing.yml

@@ -24,18 +24,21 @@ jobs:
       ipamResourceGroup: ${{ steps.deployScript.outputs.ipamResourceGroup }}
     steps:
       - name: Install Deployment Prerequisites
+        id: installPrerequisites
         shell: pwsh
         run: |
           Set-PSRepository PSGallery -InstallationPolicy Trusted
           Install-Module Az, Microsoft.Graph -AllowClobber -Force
 
       - name: Azure Login
+        id: azureLogin
         uses: azure/login@v2
         with:
           creds: ${{ secrets.AZURE_CREDENTIALS }}
           enable-AzPSSession: true
 
       - name: Checkout Azure IPAM Code
+        id: checkoutRepo
         uses: actions/checkout@v4
         with:
           sparse-checkout: |
@@ -44,10 +47,12 @@ jobs:
             ui
 
       - name: Build Azure IPAM Container
+        id: buildContainer
         run: |
           az acr build -r $ACR_NAME -t ipam:${{ github.run_id }}-${{ github.run_attempt }} -f ./Dockerfile.deb .
 
       - name: Update Bicep File
+        id: updateBicep
         working-directory: deploy
         shell: pwsh
         run: |
@@ -62,14 +67,14 @@ jobs:
           $bicepFile | Out-File -FilePath ./modules/appService.bicep -Force
 
       - name: Deploy Azure IPAM
-        working-directory: deploy
         id: deployScript
+        working-directory: deploy
         shell: pwsh
         run: ./deploy.ps1 -Location "westus3" -UIAppName $env:IPAM_UI_NAME -EngineAppName $env:IPAM_ENGINE_NAME
 
       - name: "Upload Logs"
-        working-directory: logs
         id: uploadLogs
+        working-directory: logs
         env:
           AZURE_IPAM_SUFFIX: ${{ steps.deployScript.outputs.ipamSuffix }}
           STORAGE_ACCT_RG: ${{ vars.LOGGING_STORAGE_RG }}
@@ -97,6 +102,7 @@ jobs:
           Write-Output "logFile=$archiveName" >> $Env:GITHUB_OUTPUT
 
       - name: "Output Azure IPAM Deployment Details"
+        id: deploymentDetails
         env:
           DEPLOYMENT_DETAILS: ${{ steps.uploadLogs.outputs.deployDetails }}
         shell: pwsh
@@ -117,6 +123,7 @@ jobs:
           Write-Host "-------------------"
 
       - name: "Sleep for 5 Minutes"
+        id: sleep
         shell: pwsh
         run: Start-Sleep -s 300
 
@@ -126,24 +133,28 @@ jobs:
     needs: [ deploy ]
     steps:
       - name: Install Testing Prerequisites
+        id: installPrerequisites
         shell: pwsh
         run: |
           Set-PSRepository PSGallery -InstallationPolicy Trusted
           Install-Module Az, Pester -AllowClobber -Force
 
       - name: Azure Login
+        id: azureLogin
         uses: azure/login@v2
         with:
           creds: ${{ secrets.AZURE_CREDENTIALS }}
           enable-AzPSSession: true
 
       - name: Checkout Azure IPAM Code
+        id: checkoutRepo
         uses: actions/checkout@v4
         with:
           sparse-checkout: |
             tests
 
       - name: Test Azure IPAM w/ Pester
+        id: ipamTesting
         working-directory: tests
         env:
           IPAM_RESOURCE_GROUP: ${{ needs.deploy.outputs.ipamResourceGroup }}
@@ -174,23 +185,27 @@ jobs:
     needs: [ deploy, test ]
     steps:
       - name: Install Cleanup Prerequisites
+        id: installPrerequisites
         shell: pwsh
         run: |
           Set-PSRepository PSGallery -InstallationPolicy Trusted
           Install-Module Az -AllowClobber -Force
 
       - name: Azure Login
+        id: azureLogin
         uses: azure/login@v2
         with:
           creds: ${{ secrets.AZURE_CREDENTIALS }}
           enable-AzPSSession: true
 
       - name : Remove Azure IPAM Resources
+        id: cleanupResources
         shell: pwsh
         run: |
           Remove-AzResourceGroup -Name ${{ needs.deploy.outputs.ipamResourceGroup }} -Force
 
       - name : Remove Azure IPAM Identities
+        id: cleanupIdentities
         shell: pwsh
         run: |
           $tenantId = (Get-AzContext).Tenant.Id
@@ -207,5 +222,6 @@ jobs:
           $engineApp | Remove-AzADApplication
 
       - name: "Remove Azure IPAM Container"
+        id: cleanupContainer
         run: |
           az acr repository delete --name $ACR_NAME --repository ipam --yes

.github/workflows/azure-ipam-version.yml

@@ -23,17 +23,17 @@ jobs:
     steps:
       - run: echo "Job triggered by a ${{ github.event_name }} event to main."
 
-      - name: "Setup NodeJS v18"
+      - name: "Setup NodeJS v22"
         id: setupNode
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
 
-      - name: "Setup Python v3.9"
+      - name: "Setup Python v3.11"
         id: setupPython
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.11'
 
       - name: "Extract Pull Request Details"
         id: getPullRequestData
@@ -48,10 +48,19 @@ jobs:
               })
             ).data[0];
 
+      - name: "Create GitHub App Token"
+        id: appToken
+        uses: actions/create-github-app-token@v2
+        with:
+          app-id: ${{ vars.IPAM_GITHUB_APP_ID }}
+          private-key: ${{ secrets.IPAM_GITHUB_APP_KEY }}
+
       - name: Checkout Azure IPAM Code
+        id: checkoutRepo
         uses: actions/checkout@v4
         with:
-          token: ${{ secrets.PAT_TOKEN }}
+          token: ${{ steps.appToken.outputs.token }}
+          persist-credentials: false
 
       - name: Configure Git
         id: configureGit
@@ -116,10 +125,17 @@ jobs:
     runs-on: ubuntu-latest
     needs: [ version ]
     steps:
+      - name: "Create GitHub App Token"
+        id: appToken
+        uses: actions/create-github-app-token@v2
+        with:
+          app-id: ${{ vars.IPAM_GITHUB_APP_ID }}
+          private-key: ${{ secrets.IPAM_GITHUB_APP_KEY }}
+
       - name: Publish Azure IPAM Release
         id: publishRelease
         env:
-          GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}
+          GITHUB_TOKEN: ${{ steps.appToken.outputs.token }}
           tagName: v${{ needs.version.outputs.ipamVersion }}
         run: |
           gh release create "$tagName" \

.vscode/settings.json

@@ -11,6 +11,8 @@
     "markdownlint.config": {
       "default": true,
       "MD024": { "siblings_only": true },
+      "MD028": false,
       "MD033": false
-  }
-}
+  },
+  "files.trimTrailingWhitespace": true
+}

Dockerfile.deb

@@ -1,10 +1,20 @@
-ARG BUILD_IMAGE=node:18-slim
-ARG SERVE_IMAGE=python:3.9-slim
+ARG BUILD_IMAGE=node:22-slim
+ARG SERVE_IMAGE=python:3.11-slim
 
+# Set Production Build Flag
+ARG PROD_BUILD=true
+
+# Set Default Port
 ARG PORT=8080
 
 FROM $BUILD_IMAGE AS builder
 
+# Production Build Flag
+ARG PROD_BUILD
+
+# Set Debian Frontend Flag
+ARG DEBIAN_FRONTEND=noninteractive
+
 # Disable NPM Update Notifications
 ENV NPM_CONFIG_UPDATE_NOTIFIER=false
 
@@ -15,16 +25,27 @@ WORKDIR /tmp
 COPY ./ui/. ./
 
 # Install UI Dependencies
-RUN npm ci
+RUN if [ "${PROD_BUILD}" = true ]; then \
+  npm ci; \
+else \
+  npm install; \
+fi
 RUN chmod 777 -R node_modules
 
 # Build IPAM UI
 RUN npm run build
 
 FROM $SERVE_IMAGE
 
+# Set Production Build Flag
+ARG PROD_BUILD
+
+# Port to Listen On
 ARG PORT
 
+# Set Debian Frontend to Non-Interactive
+ARG DEBIAN_FRONTEND=noninteractive
+
 # Set Environment Variable
 ENV PORT=${PORT}
 
@@ -37,28 +58,34 @@ WORKDIR /tmp
 # Install OpenSSH and set the password for root to "Docker!"
 RUN apt-get update
 RUN apt-get install -qq openssh-server -y \
-      && echo "root:Docker!" | chpasswd 
+      && echo "root:Docker!" | chpasswd
 
 # Enable SSH root login with Password Authentication
 # RUN sed -i 's/#PermitRootLogin prohibit-password/PermitRootLogin yes/g' /etc/ssh/sshd_config
 
 # Copy 'sshd_config File' to /etc/ssh/
 COPY sshd_config /etc/ssh/
 
+# Set SSH Key Permissions
 RUN ssh-keygen -A
-RUN mkdir /var/run/sshd
+RUN mkdir -p /var/run/sshd
 
 # Set Working Directory
 WORKDIR /ipam
 
 # Install Engine Dependencies
+COPY ./engine/requirements.txt /code/requirements.txt
 COPY ./engine/requirements.lock.txt /code/requirements.lock.txt
 
 # Upgrade PIP
 RUN pip install --upgrade pip --progress-bar off
 
 # Install Dependencies
-RUN pip install --no-cache-dir -r /code/requirements.lock.txt --progress-bar off
+RUN if [ "${PROD_BUILD}" = true ]; then \
+  pip install --no-cache-dir -r /code/requirements.lock.txt --progress-bar off; \
+else \
+  pip install --no-cache-dir -r /code/requirements.txt --progress-bar off; \
+fi
 
 # Copy Engine Code
 COPY ./engine/app ./app