Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: Create a Basic Solution with Workload Orchestration description: Learn how to create a basic solution without common configurations using the workload orchestration via CLI. author: sethmanheim ms.author: sethm ms.topic: quickstart ms.date: 09/05/2025 ms.custom: - build-2025 # Customer intent: As a developer, I want to create a basic solution using workload orchestration via CLI without common configurations, so that I can deploy applications efficiently with minimal setup. --- # Quickstart: Create a basic solution In this quickstart, you create a basic solution using the workload orchestration via CLI. ## Prerequisites - Set up your environment for workload orchestration. If you haven't, go to [Prepare your environment for workload orchestration](initial-setup-environment.md) to set up the prerequisites. - Download and extract the artifacts from the [GitHub repository](https://github.com/Azure/workload-orchestration/blob/main/workload%20orchestration%20files.zip) into a particular folder. > [!NOTE] > You can reuse the global variables defined in [Prepare the basics to run workload orchestration](initial-setup-environment.md#prepare-the-basics-to-run-workload-orchestration) and the resource variables defined in [Set up the resources of workload orchestration](initial-setup-configuration.md#set-up-the-resources-of-workload-orchestration). ## Define the variables for solution templating Create the template and schema files by referring to *shared-schema.yaml* and *app-config-template.yaml* in the compressed folder from the [GitHub repository](https://github.com/Azure/workload-orchestration/blob/main/workload%20orchestration%20files.zip). >[!NOTE] > Check out [Configuration template](configuring-template.md) and [Configuration schema](configuring-schema.md) for the list of rules used to define the template and schema for configurations and details to write conditional or nested expressions in the schema for custom validations. ### [Bash](#tab/bash) ```bash # Set environment variables subId="<SUBSCRIPTION_ID>" rg="<RESOURCE_GROUP_NAME>" l="<LOCATION>" # Enter name of context contextName="redmondInstance" # Enter id of context contextId="/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/context/$contextName" # Enter name of site siteName="Site01" # Enter id of the site siteId="/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/sites/$sitename" # Create variables for schema # Enter schema name schemaName="Sharedschema" # Enter schema file name schemaFile="shared-schema.yaml" # Enter value in x.x.x format schemaVersion="1.0.0" # Create variables for application/solution # Enter name of application appName1="priceDetector" # Enter value in x.x.x format appVersion="1.0.0" # Enter description for application desc="To calculate total by detecting price of each item" # Enter capabilities of application appCapList1="[soap,conditioner]" # Enter configuration template file name for the application appConfig="app-config-template.yaml" helmurl="enter helm url of app e.g. contosocm.azurecr.io/helm/app" chartVersion="enter in this format x.x.x e.g. 0.8.0" ``` ### [PowerShell](#tab/powershell) ```powershell # Set environment variables $subId="<SUBSCRIPTION_ID>" $rg="<RESOURCE_GROUP_NAME>" $l="<LOCATION>" # Enter name of context $contextName="redmondInstance" # Enter id of context $contextId="/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/context/$contextName" # Enter name of site $siteName="Site01" # Enter id of the site $siteId="/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/sites/$sitename" # Enter name of target $childName="Line01" # Create variables for schema # Enter schema name $schemaName = "Sharedschema" # Enter schema file name $schemaFile = "shared-schema.yaml" # Enter value in x.x.x format $schemaVersion = "1.0.0" # Create variables for application/solution # Enter name of application $appName1 = "priceDetector" # Enter value in x.x.x format $appVersion = "1.0.0" # Enter description for application $desc = "To calculate total by detecting price of each item" # Enter capabilities of application $appCapList1 = "[soap,conditioner]" # Enter configuration template file name for the application $appConfig = "app-config-template.yaml" $helmurl = "enter helm url of app e.g. contosocm.azurecr.io/helm/app" $chartVersion = "enter in this format x.x.x e.g. 0.8.0" ``` *** > [!NOTE] > Variables need to be defined each time a new terminal is opened up. ## Create the solution template The solution template consists of a schema and a configuration template. Both are defined in YAML format. - **Schema template**: The schema represents the declaration of configurable attributes/properties of the solution and the associated permissions as it applies to hierarchies and personas. For more information, see [Configuring schema](configuring-schema.md). - **Configuration template**: The application configuration template represents associated configurations of the previously declared schema. These values can be modified as necessary. For more information, see [Configuring template](configuring-template.md). ### Create a shared schema In this quickstart you use a shared schema. Shared schemas comprise configurable attributes that can be used across hierarchies and solutions. ### [Bash](#tab/bash) 1. Create the shared solution schema. The following command takes version input from CLI argument: ```bash # Create Shared Solution Schema az workload-orchestration schema create --resource-group "$rg" --location "$l" --schema-name "$schemaName" --version "$schemaVersion" --schema-file "$schemaFile" # View Shared Schema az workload-orchestration schema version show --resource-group "$rg" --schema-name "$schemaName" --version "$schemaVersion" ``` 1. You can provide version on file instead of as a CLI argument. Add below section to the *shared-schema.yaml* file. ```yaml metadata: name: <name> [optional] version: <version> [optional] ``` 1. Run the same CLI command without `--version argument`. The service takes version input from file. ```bash az workload-orchestration schema create --resource-group "$rg" --location "$l" --schema-name "$schemaName" --schema-file "$schemaFile" ``` The name field is introduced for user to identify the resource name and its version the file refers to. If name is provided, then it should match `--schema-name` argument. ### [PowerShell](#tab/powershell) 1. Create the shared solution schema. The following command takes version input from CLI argument: ```powershell # Create Shared Solution Schema az workload-orchestration schema create --resource-group $rg --location $l --schema-name $schemaName --version $schemaVersion --schema-file $schemaFile # View Shared Schema az workload-orchestration schema version show --resource-group $rg --schema-name $schemaName --version $schemaVersion ``` 1. You can provide version on file instead of as a CLI argument. Add below section to the *shared-schema.yaml* file. ```yaml metadata: name: <name> [optional] version: <version> [optional] ``` 1. Run the same CLI command without `--version argument`. The service takes version input from file. ```powershell az workload-orchestration schema create --resource-group $rg --location $l --schema-name $schemaName --schema-file $schemaFile ``` The name field is introduced for user to identify the resource name and its version the file refers to. If name is provided, then it should match `--schema-name` argument. *** ### Create the solution #### [Bash](#tab/bash) 1. Create a *specs.json* file by referring to *specs.json* in the compressed folder from the [GitHub repository](https://github.com/Azure/workload-orchestration/blob/main/workload%20orchestration%20files.zip). 1. In your *specs.json* file, update the helm url, for example, *contosocm.azurecr.io/helm/app*, and chart version in x.x.x format, for example, *0.5.0*. Update the *app-config-template.yaml* file with proper reference to your schema which you created in the above step. 1. Create the Helm solution. The following command takes version input from CLI argument: ```bash az workload-orchestration solution-template create --resource-group "$rg" --location "$l" --solution-template-name "$appName1" --description "$desc" --capabilities "$appCapList1" --configuration-template-file "$appConfig" --specification "@specs.json" --version "$appVersion" ``` Version can be provided on file instead of as a CLI argument. Add the following section to the *app-config-template.yaml* file: ```yaml metadata: name: <name> [optional] version: <version> [optional] ``` Run the same CLI command without `--version` argument. The service takes version input from file. ```bash az workload-orchestration solution-template create --resource-group "$rg" --location "$l" --solution-template-name "$appName1" --description "$desc" --capabilities "$appCapList1" --configuration-template-file "$appConfig" --specification "@specs.json" ``` The name field is introduced for user to identify the resource name and its version the file refers to. If name is provided, then it should match `--solution-template-name` argument #### [PowerShell](#tab/powershell) 1. Create a *specs.json* file by referring to *specs.json* in the compressed folder from the [GitHub repository](https://github.com/Azure/workload-orchestration/blob/main/workload%20orchestration%20files.zip). 1. In your *specs.json* file, update the helm url, for example, *contosocm.azurecr.io/helm/app*, and chart version in x.x.x format, for example, *0.5.0*. Update the *app-config-template.yaml* file with proper reference to your schema which you created in the above step. 1. Create the Helm solution. The following command takes version input from CLI argument: ```powershell az workload-orchestration solution-template create --resource-group $rg --location $l --solution-template-name $appName1 --description $desc --capabilities $appCapList1 --configuration-template-file $appConfig --specification "@specs.json" --version $appVersion ``` Version can be provided on file instead of as a CLI argument. Add the following section to the *app-config-template.yaml* file: ```yaml metadata: name: <name> [optional] version: <version> [optional] ``` Run the same CLI command without `--version` argument. The service takes version input from file. ```powershell az workload-orchestration solution-template create --resource-group $rg --location $l --solution-template-name $appName1 --description $desc --capabilities $appCapList1 --configuration-template-file $appConfig --specification "@specs.json" ``` The name field is introduced for user to identify the resource name and its version the file refers to. If name is provided, then it should match `--solution-template-name` argument *** ### Set the configuration values for the solution #### [Bash](#tab/bash) 1. View solution parameters for your target. ```bash az workload-orchestration configuration show --template-rg "$rg" --hierarchy-id "/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/targets/$childName" --template-name "$appName1" --version $appVersion --solution ``` 1. You can choose to view schema rules for the template before setting configuration values. ```bash az workload-orchestration configuration schema show --template-rg "$rg" --template-name "$appName1" --version $appVersion --solution ``` 1. Edit solution parameters. ```bash az workload-orchestration configuration set --template-rg "$rg" --hierarchy-id "/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/targets/$childName" --template-name "$appName1" --version $appVersion --solution ``` #### [PowerShell](#tab/powershell) 1. View solution parameters for your target. ```powershell az workload-orchestration configuration show --template-rg "$rg" --hierarchy-id "/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/targets/$childName" --template-name "$appName1" --version $appVersion --solution ``` 1. You can choose to view schema rules for the template before setting configuration values. ```powershell az workload-orchestration configuration schema show --template-rg "$rg" --template-name "$appName1" --version $appVersion --solution ``` 1. Edit solution parameters. ```powershell az workload-orchestration configuration set --template-rg "$rg" --hierarchy-id "/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/targets/$childName" --template-name "$appName1" --version $appVersion --solution ``` *** > [!NOTE] > You can use the `--template-subscription` argument to set or show configurations for a template residing in an Azure subscription other than the current subscription. > [!TIP] > You can also set the configuration values for the solution using the [Configure tab in Workload orchestration portal](configure.md) ## Deploy the solution ### [Bash](#tab/bash) 1. Review the configurations for a particular target. In the CLI output, check `reviewId` and `name` values. The name displays the new solution template version. ```bash az workload-orchestration target review --resource-group "$rg" --target-name "$childName" --solution-template-version-id "/subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/solutionTemplates/$appName1/versions/$appVersion" ``` 1. Run `target publish` to publish the solution. Enter `reviewId` from the previous command response. ```bash reviewId="<reviewId>" az workload-orchestration target publish --resource-group "$rg" --target-name "$childName" --solution-version-id /subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/targets/$childName/solutions/$appName1/versions/$appVersion ``` 1. Run the `target install` command to deploy the solution. ```bash az workload-orchestration target install --resource-group "$rg" --target-name "$childName" --solution-version-id /subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/targets/$childName/solutions/$appName1/versions/$appVersion ``` 1. In case of multiple versions of a solution deployed, you can list all instances or revisions of a solution deployed on a target. ```bash # List all instances az workload-orchestration target solution-instance-list -g "$rg" --target-name "$childName" --solution "$appName1" # List all revisions az workload-orchestration target solution-revision-list -g "$rg" --target-name "$childName" --solution "$appName1" ``` ### [PowerShell](#tab/powershell) 1. Review the configurations for a particular target. In the CLI output, check `reviewId` and `name` values. The name displays the new solution template version. ```powershell az workload-orchestration target review --resource-group $rg --target-name $childName --solution-template-version-id /subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/solutionTemplates/$appName1/versions/$appVersion ``` 1. Run `target publish` to publish the solution. Enter `reviewId` from the previous command response. ```powershell $reviewId = "<reviewId>" az workload-orchestration target publish --resource-group $rg --target-name $childName --solution-version-id /subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/targets/$childName/solutions/$appName1/versions/$appVersion ``` 1. Run the `target install` command to deploy the solution. ```powershell az workload-orchestration target install --resource-group $rg --target-name $childName --solution-version-id /subscriptions/$subId/resourceGroups/$rg/providers/Microsoft.Edge/targets/$childName/solutions/$appName1/versions/$appVersion ``` 1. In case of multiple versions of a solution deployed, you can list all instances or revisions of a solution deployed on a target. ```powershell # List all instances az workload-orchestration target solution-instance-list -g $rg --target-name $childName --solution $appName1 # List all revisions az workload-orchestration target solution-revision-list -g $rg --target-name $childName --solution $appName1 ``` *** > [!TIP] > You can also deploy the solution using the [Deploy tab in Workload orchestration portal](deploy.md) ## Next steps Once you know how to create a basic solution, you can explore more advanced scenarios. For example, check out how to [Create a basic solution with common configurations](quickstart-solution-with-common-configuration.md), which is an extension of this quickstart.