Tutorial: Scale a container app

Azure Container Apps manages automatic horizontal scaling through a set of declarative scaling rules. As a container app scales out, new instances of the container app are created on-demand. These instances are known as replicas.

In this tutorial, you add an HTTP scale rule to your container app and observe how your application scales.

Prerequisites

Requirement	Instructions
Azure account	If you don't have an Azure account, you can create one for free. You need the Contributor permission on the Azure subscription to proceed. Refer to Assign Azure roles using the Azure portal for details.
GitHub Account	Get one for free.
Azure CLI	Install the Azure CLI.

Setup

To sign in to Azure from the CLI, run the following command and follow the prompts to complete the authentication process.

Bash

az login

Azure PowerShell

Connect-AzAccount

To ensure you're running the latest version of the CLI, run the upgrade command.

Bash

az upgrade

Azure PowerShell

Install-Module -Name Az -Scope CurrentUser -Repository PSGallery -Force

Ignore any warnings about modules currently in use.

Next, install or update the Azure Container Apps extension for the CLI.

If you receive errors about missing parameters when you run az containerapp commands in Azure CLI or cmdlets from the Az.App module in Azure PowerShell, be sure you have the latest version of the Azure Container Apps extension installed.

Bash

az extension add --name containerapp --upgrade

Note

Starting in May 2024, Azure CLI extensions no longer enable preview features by default. To access Container Apps preview features, install the Container Apps extension with --allow-preview true.

az extension add --name containerapp --upgrade --allow-preview true

Azure PowerShell

Install-Module -Name Az.App

Make sure to update the Az.App module to the latest version.

Update-Module -Name Az.App

Now that the current extension or module is installed, register the Microsoft.App and Microsoft.OperationalInsights namespaces.

Bash

az provider register --namespace Microsoft.App

az provider register --namespace Microsoft.OperationalInsights

Azure PowerShell

Register-AzResourceProvider -ProviderNamespace Microsoft.App

Register-AzResourceProvider -ProviderNamespace Microsoft.OperationalInsights

Create and deploy the container app

Create and deploy your container app with the containerapp up command. This command creates a:

• Resource group
• Container Apps environment
• Log Analytics workspace

If any of these resources already exist, the command uses the existing resources rather than creating new ones.

Lastly, the command creates and deploys the container app using a public container image.

Bash

az containerapp up \
  --name my-container-app \
  --resource-group my-container-apps \
  --location centralus \
  --environment 'my-container-apps' \
  --image mcr.microsoft.com/k8se/quickstart:latest \
  --target-port 8080 \
  --ingress external \
  --query properties.configuration.ingress.fqdn \

Azure PowerShell

az containerapp up `
  --name my-container-app `
  --resource-group my-container-apps `
  --location centralus `
  --environment my-container-apps `
  --image mcr.microsoft.com/k8se/quickstart:latest `
  --target-port 8080 `
  --ingress external `
  --query properties.configuration.ingress.fqdn `

Note

Make sure the value for the --image parameter is in lower case.

By setting --ingress to external, you make the container app available to public requests.

The up command returns the fully qualified domain name (FQDN) for the container app. Copy this FQDN to a text file. You'll use it in the Send requests section. Your FQDN looks like the following example:

https://my-container-app.icydune-96848328.centralus.azurecontainerapps.io

Add scale rule

Add an HTTP scale rule to your container app by running the az containerapp update command.

Bash

az containerapp update \
	--name my-container-app \
	--resource-group my-container-apps \
    --scale-rule-name my-http-scale-rule \
    --scale-rule-http-concurrency 1

Azure PowerShell

az containerapp update `
	--name my-container-app `
	--resource-group my-container-apps `
    --scale-rule-name my-http-scale-rule `
    --scale-rule-http-concurrency 1

This command adds an HTTP scale rule to your container app with the name my-http-scale-rule and a concurrency setting of 1. If your app receives more than one concurrent HTTP request, the runtime creates replicas of your app to handle the requests.

The update command returns the new configuration as a JSON response to verify your request was a success.

Start log output

You can observe the effects of your application scaling by viewing the logs generated by the Container Apps runtime. Use the az containerapp logs show command to start listening for log entries.

Bash

az containerapp logs show \
	--name my-container-app \
	--resource-group my-container-apps \
	--type=system \
	--follow=true

Azure PowerShell

az containerapp logs show `
	--name my-container-app `
	--resource-group my-container-apps `
	--type=system `
	--follow=true

The show command returns entries from the system logs for your container app in real time. You can expect a response like the following example:

{
	"TimeStamp":"2023-08-01T16:49:03.02752",
	"Log":"Connecting to the container 'my-container-app'..."
}
{
	"TimeStamp":"2023-08-01T16:49:03.04437",
	"Log":"Successfully Connected to container:
	'my-container-app' [Revision: 'my-container-app--9uj51l6',
	Replica: 'my-container-app--9uj51l6-5f96557ffb-5khg9']"
}
{
	"TimeStamp":"2023-08-01T16:47:31.9480811+00:00",
	"Log":"Microsoft.Hosting.Lifetime[14]"
}
{
	"TimeStamp":"2023-08-01T16:47:31.9481264+00:00",
	"Log":"Now listening on: http://[::]:8080"
}
{
	"TimeStamp":"2023-08-01T16:47:31.9490917+00:00",
	"Log":"Microsoft.Hosting.Lifetime[0]"
}
{
	"TimeStamp":"2023-08-01T16:47:31.9491036+00:00",
	"Log":"Application started. Press Ctrl+C to shut down."
}
{
	"TimeStamp":"2023-08-01T16:47:31.949723+00:00",
	"Log":"Microsoft.Hosting.Lifetime[0]"
}
{
	"TimeStamp":"2023-08-01T16:47:31.9497292+00:00",
	"Log":"Hosting environment: Production"
}
{
	"TimeStamp":"2023-08-01T16:47:31.9497325+00:00",
	"Log":"Microsoft.Hosting.Lifetime[0]"
}
{
	"TimeStamp":"2023-08-01T16:47:31.9497367+00:00",
	"Log":"Content root path: /app/"
}

For more information, see az containerapp logs.

Send requests

Bash

Open a new bash shell. Run the following command, replacing <YOUR_CONTAINER_APP_FQDN> with the fully qualified domain name for your container app that you saved from the Create and deploy the container app section.

seq 1 50 | xargs -Iname -P10 curl "<YOUR_CONTAINER_APP_FQDN>"

These commands send 50 requests to your container app in concurrent batches of 10 requests each.

Command or argument	Description
seq 1 50	Generates a sequence of numbers from 1 to 50.
|	The pipe operator sends the sequence to the xargs command.
xargs	Runs curl with the specified URL
-Iname	Acts as a placeholder for the output of seq. This argument prevents the return value from being sent to the curl command.
curl	Calls the given URL.
-P10	Instructs xargs to run up to 10 processes at a time.

For more information, see the documentation for:

• seq
• xargs
• curl

Azure PowerShell

Open a new command prompt and enter PowerShell. Run the following commands, replacing <YOUR_CONTAINER_APP_FQDN> with the fully qualified domain name for your container app that you saved from the Create and deploy the container app section.

$url="<YOUR_CONTAINER_APP_FQDN>"
$Runspace = [runspacefactory]::CreateRunspacePool(1,10)
$Runspace.Open()
1..50 | % {
    $ps = [powershell]::Create()
    $ps.RunspacePool = $Runspace
    [void]$ps.AddCommand("Invoke-WebRequest").AddParameter("UseBasicParsing",$true).AddParameter("Uri",$url)
    [void]$ps.BeginInvoke()
}

These commands send 50 requests to your container app in asynchronous batches of 10 requests each.

Command or argument	Description
[runspacefactory]::CreateRunspacePool(1,10)	Creates a RunspacePool that allows up to 10 runspaces to run concurrently.
1..50 | % { }	Runs the code enclosed in the curly braces 50 times.
$ps = [powershell]::Create()	Creates a new PowerShell instance.
$ps.RunspacePool = $Runspace	Tells the PowerShell instance to run in the RunspacePool.
[void]$ps.AddCommand("Invoke-WebRequest")	Sends a request to your container app.
.AddParameter("UseBasicParsing", $true)	Sends a request to your container app.
.AddParameter("Uri", $url)	Sends a request to your container app.
[void]$ps.BeginInvoke()	Tells the PowerShell instance to run asynchronously.

For more information, see Beginning Use of PowerShell Runspaces

In the first shell, where you ran the az containerapp logs show command, the output now contains one or more log entries like the following.

{
	"TimeStamp":"2023-08-01 18:09:52 +0000 UTC",
	"Type":"Normal",
	"ContainerAppName":"my-container-app",
	"RevisionName":"my-container-app--9uj51l6",
	"ReplicaName":"my-container-app--9uj51l6-5f96557ffb-f795d",
	"Msg":"Replica 'my-container-app--9uj51l6-5f96557ffb-f795d' has been scheduled to run on a node.",
	"Reason":"AssigningReplica",
	"EventSource":"ContainerAppController",
	"Count":0
}

View scaling in Azure portal (optional)

1. Sign in to the Azure portal.
2. In the Search bar at the top, enter my-container-app.
3. In the search results, under Resources, select my-container-app.
4. In the navigation bar at the left, expand Application and select Scale and replicas.
5. In the Scale and Replicas page, select Replicas.
6. Your container app now has more than one replica running.

You may need to select Refresh to see the new replicas.

1. In the navigation bar at the left, expand Monitoring and select Metrics.

2. In the Metrics page, set Metric to Requests.

3. Select Apply splitting.

4. Expand the Values drop-down and check Replica.

5. Select the blue checkmark icon to finish editing the splitting.

6. The graph shows the requests received by your container app, split by replica.

   

7. By default, the graph scale is set to last 24 hours, with a time granularity of 15 minutes. Select the scale and change it to the last 30 minutes, with a time granularity of one minute. Select the Apply button.

8. Select on the graph and drag to highlight the recent increase in requests received by your container app.

The following screenshot shows a zoomed view of how the requests received by your container app are divided among replicas.

Clean up resources

If you're not going to continue to use this application, run the following command to delete the resource group along with all the resources created in this tutorial.

Caution

The following command deletes the specified resource group and all resources contained within it. If resources outside the scope of this tutorial exist in the specified resource group, they will also be deleted.

az group delete --name my-container-apps

Tip

Having issues? Let us know on GitHub by opening an issue in the Azure Container Apps repo.

Next steps

Set scaling rules in Azure Container Apps