blobstore

Description

Venue	Equivalent Concept(s)
	S3 Bucket
	Blob Storage

Object-based storage where the contents are addressed by a key. Some venues have additional naming restrictions on blobstores, for example Azure does not allow dashes. In this case, we will coerce the name (unless the namepolicy says otherwise) and issue a warning, and the actual name used will be present in the inventory.

Venue-Specific Properties

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

Azure

venue:
  azure:
    storage_account_name:
        Sets the storage account name.  Storage account is unique to Azure and
        defines the leading URL name.  AWS and GCP have a single blobstore
        concept that does not require this additional configuration level.
        Storage account names are globally unique (similar to a domain name)
        on Azure.  The `namepolicy` of the blobstore applies to this name.

Required Properties

This object has no required properties, but it likely requires a combination of optional properties to be useful.

Optional Properties

namepolicy (string)

The blobstore namespace is shared globally or throughout a region with all venue customers, similar to domain names. This means the name you choose for your blobstore may already be taken. We will attempt to use an available name starting with the blobstore name by default, however if the exact option is chosen then the job will fail if it cannot secure the exact name. If the name is modified by to make it compatible with the venue, a coercion warning will be issued and the actual name will be available in the inventory following a successful apply.

Allowed Values:

• auto

• exact

The default value if not specified is auto.

public_auth (boolean)

Indicates if authentication is required in order for a user to read something from this blob store. This setting is only meaningful when public_read is true.

The default value if not specified is True.

public_read (boolean)

Indicates if the blobstore is publicly readable. Use public_auth to indicate if authentication is required to read the contents of the blobstore.

The default value if not specified is False.

Common Properties

count (integer)

Indicates how many of this blobstore 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 blobstore 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 blobstore. If this is not specified and there is only one folder defined, that folder is used automatically.

name (string)

The name of this blobstore. 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 blobstore is read-only. If so, we verify only the existence and correctness of this blobstore 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 blobstore. 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.

durability (string)

Durability characteristics of this blobstore. This is expressed as the type of failure that can be tolerated without loss of availability.

local

Allows the data to remain available even if a storage failure occurs within a zone. Local durability is managed by the venue automatically. The durability is synchronous, meaning the loss of a component locally will not cause data loss.

zone

Allows the data to remain available even if a zone failure occurs. This disk would be made available in another zone in the same region without loss of data. Zone durability requires a specification of multiple zones that the disk is then replicated to. This durability is synchronous, meaning the loss of a zone will not cause data loss.

region

Allows the data to remain available even if a region failure occurs. Region durability requires a specification of zones in different regions. This durability is asynchronous, meaning the loss of a region may cause data loss.

On AWS, standard S3 buckets are used, giving zone durability.

On Azure, you can control the durability by first creating your own storage account and then specifying the storage_account_name venue overridei, otherwise if we create a storage account it will have local durability.

Allowed Values:

• local

• zone

• region

id (string)

The venue-specific identifier of this blobstore.

url (url)

The URL for accessing the blobstore.

Examples

Define a blobstore that is publicly readable:

location:
  folder:
    example-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA
storage:
  blobstore:
    my-public-bucket:
      public_read: true

Define a blobstore that is only privately accessible (the default):

location:
  folder:
    example-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA
storage:
  blobstore:
    my-private-bucket: {}