Skip to content

Deployment Scripts

Among all the deployment scripts stand out the two main entrypoints for the deployment: the initialization script and the orchestration script.

Initialization script

This script creates all the Azure Active Directory applications needed by Core and the resource groups with its related roles. It must be executed once before the first deployment.

Orchestration script

The orchestration script contains the parametrization and deploying order of all the resources to be deployed and will use a different set of configuration parameters which are stored in an environment configuration file. The parameters included in the environment configuration file can be modified to tune to the deployment. Depending on the size (S, M, L, XL), the orchestration script will use a different set of size parameters which are stored in a size configuration file.

The orchestration script receives several parameters, including:

Environment parameter

The environment parameter allows to select the deployment environment, some samples are Dev, Test, Prod... The environment parameter is used for:

  • Naming resources in Azure. Some of the resources will include the environment in theirs names.
  • Selecting the configuration file. Since it is specific for each environment it is called the environment configuration file.

The environment configuration file contains a set of parameters with the configuration for that specific environment. The filename must be {environment}Data.psd1, e.g. DevData.psd1, TestData.psd1, ProdData.psd1... The parameters included in the environment configuration file can be modified to tune to the deployment.

Installation size parameter

The installation size parameter allows to select the size of the deployment. The supported values are: S, M, L and XL. Depending on the size, the orchestration script will use a different size configuration file:

  • SCore.psd1, MCore.psd1, LCore.psd1, XLCore.psd1 are the filenames for the size configuration files used in the deployment of Sidra Core.
  • SClient.psd1, MClient.psd1, LClient.psd1, XLClient.psd1 are the filenames for the size configuration files used in the deployment of a Client app.

Note

Each size configuration file contains a set of predefined size parameters. The parameters included in the size configuration file must not be modified since those files are included in a NuGet package and any change will be overwritten each time the package is updated.

How to override the parameters of a size configuration file

In order to override the value of a size parameter, it is necessary to include a parameter with the same name in the appropriate environment configuration file.

For example, it is been used the S size parameter in the deployment of Core. These are the size parameters for Databricks in the SCore.psd1:

# Databricks 
# ...
DatabricksClusterMinWorkers = 1
DatabricksClusterMaxWorkers = 4
#...

But in the Test environment, it is required to increase the cluster workers, so the following parameters are added to the TestData.psd1:

DatabricksClusterMinWorkers = 2
DatabricksClusterMaxWorkers = 8

Last update: 2022-04-05
Back to top