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 to set up the prerequisites.
• Download and extract the artifacts from the GitHub repository into a particular folder.

Note

You can reuse the global variables defined in Prepare the basics to run workload orchestration and the resource variables defined in 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.

Note

Check out Configuration template and Configuration schema 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

# 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

# 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.
• 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.

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

1. Create the shared solution schema. The following command takes version input from CLI argument:

   # 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"
   

2. You can provide version on file instead of as a CLI argument. Add below section to the shared-schema.yaml file.

   metadata:
       name: <name> [optional]
       version: <version> [optional]
   

3. Run the same CLI command without --version argument. The service takes version input from file.

   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

1. Create the shared solution schema. The following command takes version input from CLI argument:

   # 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
   

2. You can provide version on file instead of as a CLI argument. Add below section to the shared-schema.yaml file.

   metadata:
       name: <name> [optional]
       version: <version> [optional]
   

3. Run the same CLI command without --version argument. The service takes version input from file.

   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

1. Create a specs.json file by referring to specs.json in the compressed folder from the GitHub repository.

2. 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.

3. Create the Helm solution. The following command takes version input from CLI argument:

   az workload-orchestration solution-template create --resource-group "$rg" --location "$l" --solution-template-name "$appName1" --description "$desc" --capabilities "$appCapList1" --config-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:

   metadata:
     name: <name> [optional]
     version: <version> [optional]
   

   Run the same CLI command without --version argument. The service takes version input from file.

   az workload-orchestration solution-template create --resource-group "$rg" --location "$l" --solution-template-name "$appName1" --description "$desc" --capabilities "$appCapList1" --config-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

1. Create a specs.json file by referring to specs.json in the compressed folder from the GitHub repository.

2. 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.

3. Create the Helm solution. The following command takes version input from CLI argument:

   az workload-orchestration solution-template create --resource-group $rg --location $l --solution-template-name $appName1 --description $desc --capabilities $appCapList1 --config-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:

   metadata:
     name: <name> [optional]
     version: <version> [optional]
   

   Run the same CLI command without --version argument. The service takes version input from file.

   az workload-orchestration solution-template create --resource-group $rg --location $l --solution-template-name $appName1 --description $desc --capabilities $appCapList1 --config-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

1. View parameters at parent level, for example, Contoso factory.

   az workload-orchestration configuration show --resource-group "$rg" --target-name "$parentName" --solution-template-name "$appName1"
   

2. Edit parameters at parent level.

   az workload-orchestration configuration set --resource-group "$rg" --target-name "$parentName" --solution-template-name "$appName1"
   

3. View parameters at child level

   az workload-orchestration configuration show --resource-group "$rg" --target-name "$childName" --solution-template-name "$appName1"
   

4. Edit parameters of child level

   az workload-orchestration configuration set --resource-group "$rg" --target-name "$childName" --solution-template-name "$appName1"
   

PowerShell

1. View parameters at parent level, for example, Contoso factory.

   az workload-orchestration configuration show --resource-group $rg --target-name $parentName --solution-template-name $appName1
   

2. Edit parameters at parent level.

   az workload-orchestration configuration set --resource-group $rg --target-name $parentName --solution-template-name $appName1
   

3. View parameters at child level.

   az workload-orchestration configuration show --resource-group $rg --target-name $childName --solution-template-name $appName1
   

4. Edit parameters at child level.

   az workload-orchestration configuration set --resource-group $rg --target-name $childName --solution-template-name $appName1
   

Tip

You can also set the configuration values for the solution using the Configure tab in Workload orchestration portal

Deploy the solution

Bash

1. Resolve the configurations for a particular target.

   az workload-orchestration target resolve --resource-group "$rg" --solution-name "$appName1" --solution-version "$appVersion" --target-name "$childName"
   

2. Review the configurations for a particular target. In the CLI output, check reviewId and name values. The name displays the new solution template version.

   az workload-orchestration target review --resource-group "$rg" --solution-name "$appName1" --solution-version "$appVersion" --target-name "$childName"
   

3. Run target publish to publish the solution. Enter reviewId from the previous command response.

   reviewId="<reviewId>"
   az workload-orchestration target publish --resource-group "$rg" --target-name "$childName" --solution-version-id /subscriptions/$subId/resourceGroups/$rg/providers/private.edge/targets/$childName/solutions/$appName1/versions/$appVersion
   

4. Run the target install command to deploy the solution.

   az workload-orchestration target install --resource-group "$rg" --target-name "$childName" --solution-version-id /subscriptions/$subId/resourceGroups/$rg/providers/private.edge/targets/$childName/solutions/$appName1/versions/$appVersion
   

PowerShell

1. Resolve the configurations for a particular target.

   az workload-orchestration target resolve --resource-group $rg --solution-name $appName1 --solution-version $appVersion --target-name $childName
   

2. Review the configurations for a particular target. In the CLI output, check reviewId and name values. The name displays the new solution template version.

   az workload-orchestration target review --resource-group $rg --solution-name $appName1 --solution-version $appVersion --target-name $childName
   

3. Run target publish to publish the solution. Enter reviewId from the previous command response.

   $reviewId = "<reviewId>"
   az workload-orchestration target publish --resource-group $rg --target-name $childName --solution-version-id /subscriptions/$subId/resourceGroups/$rg/providers/private.edge/targets/$childName/solutions/$appName1/versions/$appVersion
   

4. Run the target install command to deploy the solution.

   az workload-orchestration target install --resource-group $rg --target-name $childName --solution-version-id /subscriptions/$subId/resourceGroups/$rg/providers/private.edge/targets/$childName/solutions/$appName1/versions/$appVersion
   

Tip

You can also deploy the solution using the Deploy tab in Workload orchestration portal

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, which is an extension of this quickstart.