Database installation¶

Database installation for Sequel Security components

Documentation automatically generated from DatabaseMetadata.xml

Products¶

This installation is organized around different product:

Sequel Security. Deploys the security databases. Modules in this product are:
- Sequel Security - MultiTenancy Database
- Sequel Security - Security Database
Setup Configuration. Deploys required configurations. Modules in this product are:
- Setup Configuration - Create Admin User

Global settings¶

Global settings allow to define values that are reused across the different modules of the installation.

Data Sources¶

Data sources for the applications. Below table summarizes the available parameters under this category.

Parameter	Description
`MultiTenancyDatabaseServer` MultiTenancy Server Instance	The instance of SQL Server hosting the multitenancy database.
`MultiTenancyDatabaseName`	The name of the MultiTenancy database on the SQL Server. Default value: Sequel.Security.Multitenancy.
`DatabaseServer` Security Database Server Instance	The instance of SQL Server hosting the application.
`DatabaseName` Security Database Name	The name of the Security database on the SQL Server. Default value: `Security`.
`DatabaseUser`	The name of the user owner of the Database. Not required. If not provided, the Windows user domain is used.
`DatabasePassword` Database User Password	Not required. The password for the database user.
`DatabaseServerIsAGListener`	Database server is a AlwaysOn Availability Group listener. Default value: `False`.

Security Configuration¶

Security endpoints and further configuration for databases. Below table summarizes the available parameters under this category.

Parameter	Description
`SecurityAdminUrl`	Administration endpoint. Default value: https://{var:CurrentMachine}.{var:USERDNSDOMAIN}/Administration.
`SkipImportSecuritySettings`	Skip the activity for importing security settings. Default value: False. Default value: `false`.
`SecurityAdminUrlExternal` Public Security Admin Url	Public Administration endpoint. Default value: https://{var:CurrentMachine}.{var:USERDNSDOMAIN}/Administration.
`SecurityApiUrl`	Security web api endpoint. Default value: https://{var:CurrentMachine}.{var:USERDNSDOMAIN}/SecurityApi.
`SecurityApiUrlExternal` Public Security Api Url	Public Security web api endpoint. Default value: https://{var:CurrentMachine}.{var:USERDNSDOMAIN}/SecurityApi.
`SecurityAuthorizationUrl`	Authorization endpoint. Default value: https://{var:CurrentMachine}.{var:USERDNSDOMAIN}/Authorization.
`SecurityAuthorizationUrlExternal` Public Security Authorization Url	Public Authorization endpoint. Default value: https://{var:CurrentMachine}.{var:USERDNSDOMAIN}/Authorization.

Modules¶

Sequel Security - MultiTenancy Database¶

Module Id: MultiTenancyDatabase

Deploys the multitenant database where all tenants are registered.

Parameter	Description
`MultitenancyConnectionString` Database connection string	Default value: Data Source={gs:DataSources.MultiTenancyDatabaseServer};Initial Catalog={gs:DataSources.MultiTenancyDatabaseName};Trusted_Connection=True;MultipleActiveResultSets=true. `Mandatory`
`ConnectionString` Database connection string	Default value: Data Source={gs:DataSources.DatabaseServer};Initial Catalog={gs:DataSources.DatabaseName};Trusted_Connection=True;MultipleActiveResultSets=true;MultiSubnetFailover={gs:DataSources.DatabaseServerIsAGListener}. `Mandatory`
`scriptDatabaseOptions` Allow DB settings deployment	This is recommended to be set as 'True' for the first installation or when a known change in the DB settings is required. Set to 'False' when using a database using AAG. Valid choices are: `True`, `False`. Default value: `True`. `Mandatory`

Sequel Security - Security Database¶

Module Id: SecurityDatabase

Deploys the security database for each tenant. For single tenant installation the multiTenancy database could be used also for the security database. Schemas deployed are: authorization and authentication.

Parameter	Description
`ConnectionString` Database connection string	Default value: Data Source={gs:DataSources.DatabaseServer};Initial Catalog={gs:DataSources.DatabaseName};Integrated Security=True;MultipleActiveResultSets=True. `Mandatory`
`scriptDatabaseOptions` Allow DB settings deployment	This is recommended to be set as 'True' for the first installation or when a known change in the DB settings is required. Set to 'False' when using a database using AAG. Valid choices are: `True`, `False`. Default value: `True`. `Mandatory`
`ConfigurationClientSecret` Security Api Client Secret	`Mandatory` `Encrypted` `Password`
`ConfigurationClientSecretConfirmation` Security Api Client Secret Confirmation	`Mandatory` `Encrypted` `Password`
`SecurityApiUrl`	Default value: {gs:SecurityConfiguration.SecurityApiUrl}. `Mandatory`
`SecurityApiUrlExternal` Public Security Api Url	Default value: {gs:SecurityConfiguration.SecurityApiUrlExternal}. `Mandatory`
`SecurityAdminUrl`	Default value: {gs:SecurityConfiguration.SecurityAdminUrl}. `Mandatory`
`SecurityAdminUrlExternal` Public Security Admin Url	Default value: {gs:SecurityConfiguration.SecurityAdminUrlExternal}. `Mandatory`
`SecurityAuthorizationUrl`	Default value: {gs:SecurityConfiguration.SecurityAuthorizationUrl}. `Mandatory`
`SecurityAuthorizationUrlExternal` Public Security Authorization Url	Default value: {gs:SecurityConfiguration.SecurityAuthorizationUrlExternal}. `Mandatory`

Setup Configuration - Create Admin User¶

Module Id: CreateAdminUser

Creates an admin user for the security database using the add-admin-user command from the sequel-security tool.

Parameter	Description
`Admin.Name` Admin User Name	Security administrator account user name. Default value: `admin`. `Mandatory`
`Admin.Email` Admin email	Security administrator account email address. `Mandatory`
`Admin.Password` Admin Password	Security administrator account password. `Mandatory` `Encrypted` `Password`
`Admin.PasswordConfirmation` Admin user password confirmation	Security administrator account password confirmation. `Mandatory` `Encrypted` `Password`
`ConnectionString` Security Database	Security database connection string. Default value: Data Source={gs:DataSources.DatabaseServer};Initial Catalog={gs:DataSources.DatabaseName};Integrated Security=True;MultipleActiveResultSets=True;MultiSubnetFailover={gs:DataSources.DatabaseServerIsAGListener}. `Mandatory`

Appendix¶

Global settings:

For accessing to previously defined global settings use the syntax: {gs:GLOBAL_SETTING_NAME}

Variables:

Deployment manager offer access to environment variable from the current process, like USERDNSDOMAIN. Also, other built-in variables are available like:

CurrentMachine: returns the machine name where the installation is executed.
RootFolder: returns the root folder where Deployment Manager is installed.

The syntax is {var:VARIABLE_NAME}. A sample of variable usage on attribute defaultValue:

<parameter xsi:type="Url" 
    name="Url"
    defaultValue="https://{var:CurrentMachine}.{var:USERDNSDOMAIN}/"
    />