database

Description

Venue	Equivalent Concept(s)
	Relational Database Service (RDS)
	SQL Managed Instance, SQL Database

A managed database. You can connect a pre-existing managed database to your virtual machine(s) using this resource. There is limited support for managing (create/destroy) of database instances.

Database	AWS	Azure	Notes
aurora	Attach	N/A
cassandra	Future	Future
cosmos	N/A	Future
dynamo	Future	N/A
mariadb	Attach	Future
mssql	Attach	Manage	Either Azure SQL Database or Azure SQL Managed Instance
mysql	Attach	Future
oracle	Attach	Future
postgres	Attach	Future
synapse	N/A	Future

The key for the above table:

• N/A: Does not apply to this venue.

• Future: Nothing supported at the current time.

• Attach: Can connect to the service, but service cannot be created/destroyed.

• Manage: The infrastructure can be created/destroyed, or Attach to it.

Venue-Specific Properties

These fields are subject to change in the future. They allow for venue- specific behavior.

Azure

mssql

Either an Azure SQL Database or Azure SQL Managed Instance can be used, controlled by venue.azure.type. Users can attach to, or create/destroy either type.

Naming for an Azure SQL Database must be unique globally. If you set the name property, and it is different than the blueprint object name, we will honor that name. If someone else has already deployed a database with that name in the region your provisioning will fail. If you do not specify a name, we will pick one for you that is not in use based on your subscription, folder name, and blueprint object name. For example a blueprint object called managed.database.finance may become finance-a1b2c.database.windows.net in one folder, and finance-d7e42.database.windows.net in another.

venue:
  azure:
    database: A database instance that can be created/destroyed, or verified
              is present.
    password: The database administrator password. It is required if creating
              either type of database is created.
    subnet: Reference to the 'managed-instance' subnet. It is only required if
            creating a 'managed-instance'.
    type: The database infrastructure instance type. The default is 'sql-server'
          for an Azure SQL Database, and also supports 'managed-instance' for an
          Azure SQL Managed Instance.
    username: The database administrator name. It is required if creating either
              type of database is created.

Attempts to create/destroy a managed-instance type may timeout due to long-duration Azure operations (some take multiple hours).

Features

Database Types

Feature	AWS	Azure
aurora - Attach	✔️
aurora - Manage
cassandra - Attach
cassandra - Manage
cosmos - Attach
cosmos - Manage
dynamo - Attach
dynamo - Manage
mariadb - Attach	✔️
mariadb - Manage
mssql - Attach	✔️	✔️
mssql - Manage		✔️
mysql - Attach	✔️
mysql - Manage
oracle - Attach	✔️
oracle - Manage
postgres - Attach	✔️
postgres - Manage
synapse - Attach
synapse - Manage

Required Properties

provides (⏩ networking.protocol)

One or more protocols that this database provides as a server. This is used to manipulate firewalls as well as establish a dependency for any consuming network interface.

Optional Properties

This object has no optional properties.

Common Properties

count (integer)

Indicates how many of this database should exist. When count is specified the name of the given resource will have a hyphen and numeric suffix added automatically, unless the count variable is referenced in the blueprint object name.

depends_on (⏩ any)

This property can be used to declare a dependency from this database to any other object in the blueprint. This is not necessary for dependencies generated normally by the schema.

folder (▶ location.folder)

The folder containing this database. If this is not specified and there is only one folder defined, that folder is used automatically.

name (string)

The name of this database. The name can be different than the blueprint object name. When the name property is not present we apply automatic naming strategies to make resources easier to identify in each venue's management console. When the name property is specified we will use it exactly as specified.

readonly (boolean)

Indicates whether or not this database is read-only. If so, we verify only the existence and correctness of this database to its specification rather than creating or modifying it.

The default value if not specified is false.

tags (dict)

The tags to place on this database. Tags are metadata stored in (key = value, ...) form. Consumers are not allowed to use tags that begin with _tuono as those are reserved.

Discovered Properties

These properties are populated and available in the inventory following a successful apply.

id (string)

The venue-specific identifier of this database.

Examples

Define a mssql managed database that already exists:

location:
  folder:
    example-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA
managed:
  database:
    mssql-finance:
      provides: mssql
      readonly: true
networking:
  protocol:
    mssql:
      ports:
        - description: MSSQL
          port: 1433
          proto: tcp
        - description: MSSQL Discovery
          port: 1434
          proto: udp
        - description: MSSQL Management
          port: 1434
          proto: tcp