Skip to content

Latest commit

 

History

History
107 lines (83 loc) · 4.86 KB

app-azurevote-helmruncmd.md

File metadata and controls

107 lines (83 loc) · 4.86 KB
Raw

Azure Vote - Helm Run Command Scenario

Overview

This sample leverages the AKS Run Command (aks command invoke) and performs comprehensive validation steps to ensure the application has been deployed properly.

The application is the AKS Voting App, which is used in the AKS Getting Started Guide. It is a 2 container application that allows the user to use a Web UI to vote between Cats/Dogs, the votes are recorded in a Redis cache.

Workflow steps

%%{init:
{
  "theme": "default",
  "themeVariables": {
    "nodeBorder" : "#004990",
    "mainBkg" : "#c9d7e4",
    "actorBkg" : "#01A6F0",
    "signalColor" : "#F34F1C",
    "textColor" : "#747474",
    "loopTextColor" : "#C7C7C7",
    "labelTextColor" : "#C7C7C7",
    "labelBoxBorderColor" : "#7FBC00",
    "labelBoxBkgColor" : "#7FBC00",
    "noteBkgColor" : "#FFBA01",
    "noteBorderColor": "#FFBA01",
    "fontFamily": "Inter",
    "fontSize": "13px"
 }
}
}%%
sequenceDiagram
    participant GitHub Runner
    participant Azure
    participant AKS
    participant MCR
    participant Voting App
    GitHub Runner->>Azure: Login
    Azure-->>GitHub Runner: Token
    GitHub Runner->>AKS: RunCmd: Check for existing install
    Note right of AKS: Conditionally<br/>Force Uninstall
    GitHub Runner->>AKS: RunCmd: Helm Install dry run
    GitHub Runner->>AKS: RunCmd: Helm Install
    AKS-->>MCR: Retrieve Container Images
    AKS->>Voting App: Application Creation

    GitHub Runner->>AKS: RunCmd: Check deployment
    loop WaitForIP
        GitHub Runner->>AKS: Wait for IP Address
    end
    loop WaitFor200
        GitHub Runner->>Voting App: Verify app reachable

    end
    GitHub Runner->>Voting App: Run Playwright UI tests
    GitHub Runner->>AKS: (optionally) RunCmd: Helm UnInstall App
    GitHub Runner->>GitHub Runner: Store logs as artifacts
Loading

Sample info

This sample is a GitHub Reusable Workflow, as an asset in a public repository it can be targeted directly or simply copied into your own repo.

The Azure Credentials required are that of OpenID Connect (OIDC) based Federated Identity Credentials, please see here for more information.

The reusable workflow file is located here. To call it from your own workflow, use the code snippet below or just run the workflow App-Test-All.yml:

  #Here's how to call the reusable workflow from your workflow file
  deploy-azure-vote-app:
    uses: Azure/aks-baseline-automation/.github/workflows/App-AzureVote-HelmRunCmd.yml@main
    with:
      ENVIRONMENT: MyGitHubEnvironmentName
      RG: ResourceGroupToDeployTo
      AKSNAME: MyAksCluster
      APPNAME: azure-vote-public
      INGRESSTYPE: "PublicLoadBalancer"
    secrets:
      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}

This sample is directly leveraged in the AKS Deployment Helper for smoke-testing new Kubernetes clusters.

Scenario Components

Helm

Helm is a package manager for Kubernetes, used to package and deploy applications with ease. The Helm chart is written using subcharts for the deployments, whilst the parent Helm chart creates the Ingress and NetworkPolicy resources.

The helm charts are packaged as AzureVote-helm.tgz and placed under the .\workloads\azure-vote folder of this repo. For information about how to create the helm charts for this application, refer to this article.

AKS Run Command

The AKS Run Command allows you to remotely invoke commands in an AKS cluster through the AKS API. This can greatly assist with access to a private cluster when the client is not on the cluster private network while still retaining and enforcing full RBAC controls.

Key Steps in the Action Workflow

Verifying

After creating the application, it can be useful to check that the application is serving content. Steps in this workflow wait for an IP address to be allocated, which is then tested to ensure content is returned.

Playwright

Playwright is a web testing framework which is used to interact with a web application to mimic user input. Its use in this workflow is a single test to verify that communication between pods is successful by voting (calling redis) and asserting the vote balance is correct.