Property and Template References

Page last updated:

This topic describes the product template of your tile and how to modify it to include different properties.

Overview

The metadata subdirectory of a tile contains a product template file in .yml format. The product template file specifies how the tile interface collects configurable properties from the user, and how Ops Manager incorporates these properties into its deployment manifest.

You can modify your tile’s product template in many different ways. The sections below describe what the product template contains and how to modify it to include different properties.

Product Template Contents

The product template, a .yml file in the tile’s metadata subdirectory, includes or points to:

• Metadata: High-level information about your tile.

• Dependencies: Specifies tile dependencies.

• Property blueprints: Templates to represent values.

• Form types: Exposes property blueprints to generated forms.

• Job types: Configuration properties for jobs defined in the BOSH release.

• Runtime configs: Specifies the manifest for any number of global deployment configurations.

Examples in this topic that refer to the product template use the Ops Manager example tile, a functional tile provided by the Ops Manager engineering team that deploys the NGINX web server.

For more information about product template configuration, see Top-Level Properties.

To learn how to configure your tile’s forms, see Form Properties.

Modifying the Product Template

You can modify the product template to designate property values.

Within the product template, there are two sections with manifest snippets:

• form_types: This defines the tile interface, or how users of your tile view and interact with different tile features.

• job_types: This defines the jobs that the manifest deploys, or what the tile does in response to user input, developer input, or at set intervals.

You can use special expressions in these snippets to include property values that the tile would otherwise not use, such as user-provided configurable properties or dynamically generated system properties.

These special expressions take two forms: double parentheses expressions and triple parentheses expressions.

Double Parentheses Expressions

Double parentheses expressions, such as (( PROPERTY-VALUE )), designate property values that Ops Manager fills in when it generates the deployment manifest. This occurs after the user clicks Apply Changes.

These values include configurable properties and properties supplied by Ops Manager.

To include these properties in a manifest snippet, use “double-parens” syntax, which consists of a variable name surrounded by two sets of parentheses, as shown in the following example:

manifest: |
  pizza_toppings:
    peppers: (( .properties.example_selector.pizza_option.peppers.value ))

Triple Parentheses Expressions

Triple-parentheses expressions, such as ((( PROPERTY-VALUE ))), designate property values that BOSH supplies when it deploys instances of the tile service. For example, CredHub credentials are designated in triple parentheses.

To include these BOSH deploy-time properties in a manifest snippet, use “triple-parens” notation, as shown in the following example:

manifest: |
  credhub:
    concatenated_password: prefix-((( credhub-password )))-suffix
    password: ((( credhub-password )))

When Ops Manager parses a product template and BOSH parses a manifest, they both fill in properties designated by double-parens syntax.

Some property values in a product template, such as CredHub credentials, must be filled in by BOSH on the BOSH Director VM, rather than by Ops Manager.

Ops Manager strips the outer parentheses from these expressions and includes the resulting double-parens expressions in the manifest it generates, for BOSH to evaluate at deploy time.

For more information about tile properties, see Referencing Properties.

Referencing Properties

Each property is represented by two segments:

• The location of the property.
• The information from the property you want to access, commonly known as accessors.

Using these two segments, you can write an expression as:

(( PROPERTY-LOCATION.ACCESSOR ))

Where:

• PROPERTY-LOCATION is the location of the property.
• ACCESSOR is the accessor.

Referencing a Location

The method of referencing the location of the property varies. The following table describes the different methods of referencing a property:

Referencing an Accessor

Accessors vary between property blueprint types. The following example uses the property blueprint type string with its one accessor, value:

(( .properties.example-string.value ))

Ops Manager allows empty arrays in double-parentheses expressions. For example:

(( .properties.example-string.value || [] ))

For more information about the available properties and their accessors, see Property Blueprint Reference.

Product Context

Product context is useful for accessing information about a tile. It can be used in a manifest using this syntax:

(( ..TILE-NAME.accessor ))

Where TILE-NAME is the name of the tile.

These are the allowed accessors:

Dollar Contexts

Outside of properties, you can also retrieve information about various configuration details of your tile and Ops Manager.

• $ops_manager: Any tile can use this to obtain information about specific Ops Manager deployments.

• $director: Any tile can use this to obtain information about the BOSH Director.

• $runtime: Any tile can use this to obtain information about the VMware Tanzu Application Service for VMs tile.

• $self: Your own tile uses this to obtain information about its configuration.

$ops_manager

The table below describes the accessors you can use to retrieve information about an Ops Manager deployment:

$director

The table below describes the accessors you can use to retrieve information about your BOSH Director:

$runtime

The table below describes the accessors you can use to retrieve information about your TAS for VMs tile:

$self

The table below describes the accessors you can use to retrieve information about your own tile:

Complex Properties: Selectors and Collections

Most properties are simple values such as strings, integers, URL addresses, or IP addresses. Others are complex, such as selectors or collections.

• Selectors: Give the user a choice of a set of inputs.
• Collections: Give the user the ability to enter an array of values to create a hash.

Selectors appear as follows:

Collections appear as follows:

The selector and collections inputs are referenced by their selector and collection property blueprints.

Most properties are simple values such as strings, integers, URL addresses, or IP addresses. Selectors and collections are more complicated than simple properties because they contain manifest snippets, which are further referenced in other manifest snippets. Selectors and collections can exist alone, or nest within each other or within different parts of the manifest.

Top-Level Properties

The exerpt below is an example of the properties that appear at the top of a product template. Definitions of each property follow this example.

---
name: example-tile
product_version: "1.0-build.0"
minimum_version_for_upgrade: "1.7.0"
pivnet_filename_regex: "tile-*.pivotal"
metadata_version: "1.11"
opsmanager_syslog: true
label: 'Ops Manager: Example Tile'
description: An example tile to demonstrate Ops Manager tile author features
rank: 1
service_broker: false # Default value
stemcell_criteria:
  os: ubuntu-xenial
  version: "97.0"

  enable_patch_security_updates: true

requires_product_versions:
  - name: p-mysql
    version: '~> 2.4'

releases:
  - name: example-release
    file: "example-release.tgz"
    version: "15"

variables:
  - name: credhub-password
    type: password

post_deploy_errands:
  - name: example-errand

pre_delete_errands:
  - name: example-errand

runtime_configs:
  - name: example-runtime-config
  runtime_config: |
    releases:
    - name: os-conf
      version: 15
    addons:
    - name: login
      jobs:
      - name: login-banner
        release: os-conf
      properties:
        login_banner:
          text: |
            (( .properties.example_string.value )).

name

• Format: String
• Type: Required

The internal name of the tile. You must keep the name of your tile consistent for migrations to function properly. Changing the name indicates the installation of a completely different tile.

product_version

• Format: String
• Type: Required

The version of the tile.

You can only import this version into Ops Manager once. If you want to import the same tile or version, you must delete the existing one from the /metadata folder and delete the installation files from Ops Manager’s disk.

The version number is important for migrations. For more information, see Upgrading Tiles.

minimum_version_for_upgrade

• Format: String
• Type: Required

You must set a minimum version for upgrading to your current tile version. This example shows a current tile version of v1.7 that only upgrades from a v1.6.x version of the same tile:

- product_version:  1.7.0.0
  minimum_version_for_upgrade:  1.6.0.0

metadata_version

• Format: String
• Type: Required

The version of the schema of the product template, the file that this documentation describes.

Bumping the version number enables new properties that are not present in an older metadata_version but may also require restructuring of the product template to conform to the new metadata_version.

The metadata_version corresponds to a major or minor release of Ops Manager. Ops Manager can accept a tile with a metadata_version that is older than the Ops Manager version, but Ops Manager cannot accept a tile with a metadata_version that is newer than the Ops Manager version. It is therefore best practice to set the metadata_version to be the same as the oldest version of Ops Manager that the tile version supports.

label

• Format: String
• Type: Optional

The label that appears in the tile when it displays in the Ops Manager Dashboard.

description

• Format: String
• Type: Optional

A description of the tile.

rank

• Format: Integer
• Type: Optional

The order in which a tile appears on the dashboard. The BOSH Director always appears at rank 100.

For your tile to appear to the right of BOSH Director, you must set this value to an integer less than 100.

VMware recommends that you set it to 1.

If all tiles have the same rank, Ops Manager sorts them alphabetically.

pivnet_filename_regex

• Format: String
• Type: Optional

This regular expression allows Ops Manager’s VMware Tanzu Network integration to pull a specific tile file. You must do this when there are multiple tiles with the same product slug.

service_broker

• Format: Boolean
• Type: Optional, default false

Set service_broker to true for on-demand service brokers. Setting service_broker to true:

• Enables the service network selector property type.

• Requires the operator to select a service network during tile configuration. Tile authors can reference the selected service network with (( $self.service_network )).

• Includes a UAA client for the service to use. Tile authors can reference the UAA client credentials with (( $self.uaa_client_name )) and (( $self.uaa_client_secret )).

stemcell_criteria

• Format: Hash
• Type: Required

enable_patch_security_updates enables you to automatically use the latest patched version of a stemcell. This key is set to true by default. For tiles using static compilations, you can disable this feature. This feature increases security by automatically using the latest patched version of a stemcell. However, operators might experience longer than expected upgrade times.

For example:

stemcell_criteria
  os: ubuntu-xenial
  version: "97.0"
  enable_patch_security_updates: false

VMware recommends setting the enable_patch_security_updates property to true. If you set the property to false, your tile does not receive security patches through automatic stemcell updates.

You do not specify which IaaS the stemcell targets. This keeps your product template IaaS agnostic so that one product template can be deployed on any IaaS.

For a list of stemcells, including OS and version, see the BOSH website.

For more information, see Floating Stemcells.

additional_stemcells_criteria

• Format: Array of hashes
• Type: Optional

A list of stemcell criteria that can be selected using the stemcell_selector property type. These stemcells are listed in addition to the stemcell configured with stemcell_criteria. After an operator has selected a stemcell, it becomes required.

For more information about the stemcell_selector property type, see stemcell_selector.

For example:

additional_stemcells_criteria:
  - os: ubuntu-xenial
    version: 97.0
    enable_patch_security_updates: false
  - os: windows2016
    version: 1709.1

requires_product_versions

• Format: Array of hashes
• Type: Optional

A list of tile dependencies. If the required tile is not present in the Ops Manager installation, Ops Manager lists the needed dependencies and does not install your tile until the dependencies are satisfied.

Supported restriction operators are =, !=, >, <, >=, <=, and ~>.

The following keys are supported:

• name: The name of the tile required by your tile. This is a required key.
• version: The version range required by your tile. This is a required key.
• optional: Whether or not this dependency is optional. This is an optional key that defaults to false.

  Warning: The optional key was introduced in Ops Manager v2.8. It is ignored in earlier versions. This means that declared dependencies are required in Ops Manager v2.7 and earlier.

For example:

 requires_product_versions:
  - name: tile-one
    version: '> 1.2'
  - name: tile-two
    version: '~> 2.3.4'
    optional: true

For more information about required and optional dependencies, see Dependencies in How Tiles Work.

releases

• Format: Array of hashes
• Type: Required

The list of releases contained in your tile’s releases directory.

The version of the release must be exactly the same as the version contained in the release.

Each release requires the following keys:

• name
• file
• version

variables

• Format: Array of hashes
• Type: Optional

A list of variables, that are generated after a deploy succeeds.

You can reference variables in a manifest snippet using triple-parentheses expressions.

Each release requires the following keys:

• name
• type

post_deploy_errands

• Format: Array of hashes
• Type: Optional

A list of errands that run after a deploy succeeds.

Set the run_post_deploy_errand_default: property to on or off to set the default for the errand’s run rule selector in Ops Manager.

For more information, see Errands. If this property is not supplied, the selector defaults to On.

pre_delete_errands

• Format: Array of hashes
• Type: Optional

A list of errands that run before a deployment is deleted.

Set the run_pre_delete_errand_default: property to on or off to set the default for the errand’s run rule selector in Ops Manager. If you do not specify this property, the selector defaults to On.

For more information, see Errands.

runtime_configs

• Format: Array of hashes
• Type: Optional

These are keys that define global deployment configurations. For more information, see Managing Runtime Configs.

install_time_verifiers

• Format: Array of hashes
• Type: Optional

Install-time verifiers confirm that properties for external services are set correctly. Install-time verifiers run in Ops Manager before changes are applied. This enables operators to correct invalid properties before deploying.

For example, Verifiers::MysqlDatabaseVerifier checks that MySQL database properties are valid by using the properties to connect to the MySQL database. If the properties are invalid, the install-time verifier informs the operator.

Each install-time verifier supports the following keys:

• name: The type of verifier. The value must be one of the verifiers listed in the table below.

• properties: A mapping of verifier inputs to either property references or static values. The required properties for each verifier are listed in the table below.

• ignorable: If this key is set to false, an operator cannot Apply Changes until the verification errors are resolved. If this key is set to true, an operator can ignore the warning message and Apply Changes. This key is set to false by default.

• run_on: Determines when to run the verifier. Valid values include 'always' and 'major_or_minor_upgrades'. Defaults to 'always'.

For information about how operators manage and view verifiers, see Managing Ops Manager Verifiers.

The following table lists the available install-time verifiers:

The following is an example of a install_time_verifiers section:

install_time_verifiers:
- ignorable: true
  name: Verifiers::WildcardDomainVerifier
  properties:
    domain: .cloud_controller.system_domain
- name: Verifiers::SsoUrlVerifier
  properties:
    url: .properties.uaa.saml.sso_url
- ignorable: true
  name: Verifiers::BlobstoreVerifier
  properties:
    access_key_id: .properties.system_blobstore.external.access_key
    bucket_name: .properties.system_blobstore.external.buildpacks_bucket
    endpoint: .properties.system_blobstore.external.endpoint # Optional. Defaults to AWS
    region: .properties.system_blobstore.external.region # Optional. Defaults to default IaaS setting
    secret_access_key: .properties.system_blobstore.external.secret_key
    signature_version: .properties.system_blobstore.external.signature_version
    use_path_style: .properties.system_blobstore.external.use_path_style # Optional. Defaults to false
- ignorable: true
  name: Verifiers::MysqlDatabaseVerifier
  properties:
    database: "static-database-name"
    host: .properties.system_database.external.host
    password: .properties.system_database.external.account_password
    port: 1234
    username: example-dbuser
- ignorable: true
  name: Verifiers::HttpSuccessVerifier
  run_on: major_or_minor_upgrades
  properties:
    host: .properties.external_host
    scheme: https
    port: 443
    path: /verify

icon_image

• Format: Base64 Image
• Type: Required

This is the icon that displays on the tile in the Ops Manager Installation Dashboard.

base_releases_url

• Format: String
• Type: Optional

A publicly available URL that is passed to BOSH in order to download your releases during installation. If you use this field, BOSH Director must have internet connectivity. This allows you to package your tile without releases, decreasing the tile size.

opsmanager_syslog

• Format: Boolean
• Type: Optional, default false

Set opsmanager_syslog to true to opt in to the Ops Manager provided syslog form. If you opt in, you do not need provide the Syslog BOSH release for your tile.

For more information about the Syslog BOSH release, see the Syslog BOSH Release repository on GitHub.

For more information about migrating an existing form to the Ops Manager provided syslog form, see Migrating Existing Syslog Configuration to Ops Manager.

Form Properties

Each form type you write is composed of form properties. Form properties dictate the structure of the form fields that appear in the Ops Manager UI. The name of each form appears on the left-hand side as navigational tabs.

Form properties reference property_blueprints. Property blueprints define each field’s data type. For a corresponding example to the form_types example below, see property_blueprints.

The following is an example of the properties that appear in the form_types section of a product template:

form_types:
  - name: example-form
    label: Configurable Properties
    description: All the properties that you can configure!
    markdown: |
      ## I am markdown, hear me _roar_.

      ![Alt text](http://placekitten.com/g/400/200)

      Things to do:

      1. Learn [markdown](https://daringfireball.net/projects/markdown/).
      1. ...
      1. Profit!
    property_inputs:
      - reference: .web_server.example_string
        label: Example string
        description: 'Configure a property of type string'
      - reference: .web_server.example_string_with_placeholder
        label: Example string containing Placeholder text
        description: 'Optional field. Configuration not necessary'
        placeholder: 'Ghost text. Spooky!'
      - reference: .web_server.example_migrated_integer
        label: Example integer
        description: 'Configure a property of type integer'
      - reference: .web_server.example_boolean
        label: Example boolean
        description: 'Configure a property of type boolean'
      - reference: .web_server.example_dropdown
        label: Example dropdown
        description: 'Configure a property of type dropdown'
      - reference: .web_server.example_domain
        label: Example domain
        description: 'Configure a property of type domain'
      - reference: .web_server.example_wildcard_domain
        label: Example wildcard_domain
        description: 'Configure a property of type wildcard_domain'
      - reference: .web_server.example_string_list
        label: Example string_list
        description: 'Configure a property of type string_list'
      - reference: .web_server.example_text
        label: Example text
        description: 'Configure a property of type text (setting to "magic value" causes the web server job instance count to go to 0)'
      - reference: .web_server.example_ldap_url
        label: Example ldap_url
        description: 'Configure a property of type ldap_url'
      - reference: .web_server.example_email
        label: Example email
        description: 'Configure a property of type email'
      - reference: .web_server.example_http_url
        label: Example http_url
        description: 'Configure a property of type http_url'
      - reference: .web_server.example_ip_address
        label: Example ip_address
        description: 'Configure a property of type ip_address'
      - reference: .web_server.example_ip_ranges
        label: Example ip_ranges
        description: 'Configure a property of type ip_ranges'
      - reference: .web_server.example_multi_select_options
        label: Example multi_select_options
        description: 'Configure a property of type multi_select_options'
      - reference: .web_server.example_network_address_list
        label: Example network_address_list
        description: 'Configure a property of type network_address_list (this property was marked with freeze_on_deploy, and so cannot be edited after changes are first applied)'
      - reference: .web_server.example_network_address
        label: Example network_address
        description: 'Configure a property of type network_address'
      - reference: .web_server.example_port
        label: Example port
        description: 'Configure a property of type port'
      - reference: .web_server.example_smtp_authentication
        label: Example smtp_authentication
        description: 'Configure a property of type smtp_authentication'
      - reference: .web_server.client_certificate
        label: Example certificate
        description: 'Configure a certificate'
    verifiers:
      - name: Verifiers::WildcardDomainVerifier
        properties:
          domain: .web_server.example_wildcard_domain
      - name: Verifiers::StaticIpsVerifier
        properties:
          domain: .web_server.example_ip_address

name

• Format: String
• Type: Required

The internal name of the form.

label

• Format: String
• Type: Required

The label of the form as it appears as a link on the left hand side of each form.

description

• Format: String
• Type: Optional

The description of the form. Appears at the top of the form as a header.

markdown

• Format: Markdown
• Type: Optional

Provide a block of markdown to display at the top of the form, including image support. Use this property to document the tile and provide explanations or references.

property_inputs

• Format: Array of hashes
• Type: Required

References to properties defined in the property_blueprints section of the product template.

verifiers

Verifiers confirm that properties are set correctly in forms. If a verifier displays a warning, the form can still be saved and the warning can be ignored.

Verifiers are similar to install-time verifiers except that they run after a form is saved and not before Apply Changes. Verifiers do not block deployments and only inform operators that set properties are invalid.

If you want to have a verifier run when a form is saved and before Apply Changes, add the verifier to both the verifiers and install_time_verifiers sections.

For information about how operators manage and view verifiers, see Managing Ops Manager Verifiers.

For information about how verifiers are configured, see install_time_verifiers.

The following is an example of a verifiers section:

form_types:
  - name: example-form
    label: Configurable Properties
    description: All the properties that you can configure!
    property_inputs:
      - reference: .web_server.example_wildcard_domain
        label: Example wildcard_domain
        description: 'Configure a property of type wildcard_domain'
      - reference: .web_server.static_ips
        label: Example ip_address
        description: 'Configure a property of type ip_address'
    verifiers:
      - name: Verifiers::WildcardDomainVerifier
        properties:
          domain: .web_server.example_wildcard_domain
      - name: Verifiers::StaticIpsVerifier
      - name: Verifiers::MysqlDatabaseVerifier
        properties:
          database: "static-database-name"
          host: .properties.example-database-host
          port: 1234
          username: example-dbuser

You can specify either a tile property reference or a static value for a form verifier. In the example above, Verifiers::MysqlDatabaseVerifier uses a tile property reference for the database host and static values for the database name, port number, and username.

placeholder

• Format: String
• Type: Optional

Specify placeholder text for a field. The text appears in light gray to show an example value for the user. The text disappears when the user types in the field and reappears if the user leaves the field empty.

The placeholder attribute displays for the following form types:

• string
• integer
• domain
• wildcard_domain
• string_list
• text
• ldap_url
• email
• http_url
• ip_address
• ip_ranges
• network_address_list
• network_address
• port

Job Types

The following is an example of the job_types section that appears in a product template.

This section defines the jobs that end up in a BOSH manifest. Those jobs are defined in your BOSH release.

Jobs require many different settings in order to function properly. That is the core of what Ops Manager does for you: Ops Manager asks a user to designate values for those settings and generates a manifest based on what the user specifies.

Ops Manager does not require tile authors to provide vm_credentials in the property_blueprints for each job_type. This is because vm_credentials are generated automatically. You can find them in the release manifest.

Note: Ops Manager ignores static_ip and dynamic_ip keys. To configure the static IPs of a job_type, create a property blueprint with name: static_ips and type: ip_ranges.
static_ips is a special keyword that Ops Manager uses to find static IPs and pass them to the BOSH manifest. For more information about ip_ranges, see ip_ranges.

  job_types:
    - name: web_server
      resource_label: Web Server
      templates:
        - name: web_server
          release: example-release
        - name: time_logger
          release: example-release
      release: example-release
      static_ip: 1
      dynamic_ip: 0
      single_az_only: true
      use_stemcell: ubuntu-xenial
      max_in_flight: 1
      resource_definitions:
        - name: ram
          type: integer
          configurable: true
          default: 1024
        - name: ephemeral_disk
          type: integer
          configurable: true
          default: 2048
        - name: persistent_disk
          type: integer
          configurable: true
          default: 1024
          constraints:
            min: 1024
        - name: cpu
          type: integer
          configurable: true
          default: 1
      instance_definition:
        name: instances
        type: integer
        configurable: true
        default: 1
        constraints:
          max: 1
        zero_if:
          property_reference: '.web_server.example_text'
          property_value: 'magic value'
          allow_manual_selection_of_zero: false
      manifest: |
        generated:
          root_rsa_certificate: (( $ops_manager.ca_certificate ))
          rsa_cert_credentials:
            public_key_pem: (( generated_rsa_cert_credentials.public_key_pem ))
            cert_and_private_key_pems: (( generated_rsa_cert_credentials.cert_and_private_key_pems ))
          rsa_pkey_credentials:
            public_key_pem: (( generated_rsa_pkey_credentials.public_key_pem ))
            private_key_pem: (( generated_rsa_pkey_credentials.private_key_pem ))
            public_key_openssh: (( generated_rsa_pkey_credentials.public_key_openssh ))
            public_key_fingerprint: (( generated_rsa_pkey_credentials.public_key_fingerprint ))
          salted_credentials:
            sha512_hashed_password: (( generated_salted_credentials.sha512_hashed_password ))
            identity: (( generated_salted_credentials.identity ))
            salt: (( generated_salted_credentials.salt ))
            password: (( generated_salted_credentials.password ))
          simple_credentials:
            identity: (( generated_simple_credentials.identity ))
            password: (( generated_simple_credentials.password ))
          secret: (( generated_secret.value ))
          uuid: (( generated_uuid.value ))
        configured:
          string: (( example_string.value ))
          integer: (( example_migrated_integer.value ))
          ...
          record_collection: (( .properties.example_collection.value || [] ))
          selector: (( .properties.example_selector.selected_option.parsed_manifest(my_snippet) ))
        ops_manager_provided_accessors:
          name: (( name ))
          cpu: (( cpu ))
          ram: (( ram ))
          ephemeral_disk: (( ephemeral_disk ))
          persistent_disk: (( persistent_disk ))
          instances: (( instances ))
          any_instances: (( any_instances ))
          subnet_cidrs: (( subnet_cidrs ))
      property_blueprints:
      - name: static_ips
        type: ip_ranges
        configurable: true
        optional: true
      - name: generated_rsa_cert_credentials
        type: rsa_cert_credentials
      - name: generated_rsa_pkey_credentials
        type: rsa_pkey_credentials
      - name: generated_salted_credentials
        type: salted_credentials
      - name: generated_simple_credentials
        type: simple_credentials
      - name: generated_secret
        type: secret
      - name: generated_uuid
        type: uuid
      - name: example_string_with_placeholder
        type: string
        configurable: true
        optional: true
        placeholder: 'Configure me!'
      - name: example_string
        type: string
        configurable: true
        default: 'Hello world'
        constraints:
        - must_match_regex: '^[^!@#$%^&*()]*$'
          error_message: 'This name cannot contain capital digits.'
        - must_match_regex: '^[^0-9]*$'
          error_message: 'This name cannot contain digits.'
      - name: example_migrated_integer
        type: integer
        configurable: true
        default: 1
      - name: example_boolean
        type: boolean
        configurable: true
        default: true
      - name: example_dropdown
        type: dropdown_select
        configurable: true
        default: kiwi
        options:
          - name: kiwi
            label: 'label for kiwi'
          - name: lime
            label: 'label for lime'
          - name: avocado
            label: 'label for avocado'
      - name: example_domain
        type: domain
        configurable: true
        default: www.example.com
      - name: example_wildcard_domain
        type: wildcard_domain
        configurable: true
        default: 'example.com'
      - name: example_string_list
        type: string_list
        configurable: true
        default: 'a,list,of,strings'
      - name: example_text
        type: text
        configurable: true
        default: 'some_text'
      - name: example_ldap_url
        type: ldap_url
        configurable: true
        default: 'ldap://example.com'
      - name: example_email
        type: email
        configurable: true
        default: foo@example.com
      - name: example_http_url
        type: http_url
        configurable: true
        default: 'http://www.example.com'
      - name: example_ip_address
        type: ip_address
        configurable: true
        default: '192.168.0.1'
      - name: example_ip_ranges
        type: ip_ranges
        configurable: true
        default: '1.1.1.1-1.1.1.4,2.2.2.1-2.2.2.4'
      - name: example_multi_select_options
        type: multi_select_options
        configurable: true
        default: ['earth', 'jupiter']
        options:
          - name: mercury
            label: 'label for mercury'
          - name: venus
            label: 'label for venus'
          - name: earth
            label: 'label for earth'
          - name: mars
            label: 'label for mars'
          - name: jupiter
            label: 'label for jupiter'
          - name: saturn
            label: 'label for saturn'
          - name: uranus
            label: 'label for uranus'
          - name: neptune
            label: 'label for neptune'
      - name: example_network_address_list
        type: network_address_list
        configurable: true
        default: '1.1.1.1,example.com,foo.bar.example.com'
      - name: example_network_address
        type: network_address
        configurable: true
        default: '1.1.1.1'
      - name: example_port
        type: port
        configurable: true
        default: 1111
      - name: example_smtp_authentication
        type: smtp_authentication
        configurable: true
        default: plain
      - name: client_certificate
        type: ca_certificate
        configurable: true
        optional: true

name

• Format: String
• Type: Required

The name of the job as it is to be created in the Ops Manager generated BOSH manifest.

resource_label

• Format: String
• Type: Required

The label of the job as it is to appear in the resources page of the tile.

templates

• Format: Array of hashes
• Type: Required

Each element has the following fields:

• name
• release
• consumes
• provides

name

• Format: Name of the job template to use
• Type: Required

release

• Format: Name of the release the template is from
• Type: Required

consumes

• Format: YAML string defining BOSH links that this job consumes
• Type: Optional

For more information about BOSH links, see Links in the BOSH documentation.

provides

• Format: YAML string defining BOSH links that this job provides
• Type: Optional

For more information about BOSH links, see Links in the BOSH documentation.

release

• Format: String
• Type: Required

The name of the BOSH release contained in your tile archive, which is the .pivotal file.

single_az_only

• Format: Boolean
• Type: Required

You can give users control of balancing jobs across availability zones (AZs) by setting single_az_only to false.

To limit a job to a single AZ, set single_az_only to true.

Warning: If you change the single_az_only setting, your VMs may switch AZs. This change can cause an orphaned disk.

max_in_flight

• Format: Integer
• Type: Required

A BOSH setting that controls the number of instances of this job that BOSH deploys in parallel.

use_stemcell

• Format: String
• Type: Optional

The stemcell operating system for this job. You must set use_stemcell to the value of an os key configured in stemcell_criteria or additional_stemcell_criteria.

You can configure use_stemcell to enable jobs to run on different operating systems. For example, you can configure one job to run on Linux and configure a different job to run on Windows. If the instance count of a job is 0, the configured stemcell operating system is not required to deploy the tile.

If a job does not have a use_stemcell property, the job uses the stemcell operating system configured in stemcell_criteria. For more information, see stemcell_criteria and additional_stemcell_criteria.

resource_definitions

• Format: Array of hashes
• Type: Required

A set of resource settings for the job along with maximum and minimum constraints, defaults, and enabled or disabled configurability.

The resources you can set are:

• ram
• ephemeral_disk
• persistent_disk
• cpu

For examples of supported constraint types, see integer.

Note: If you set the default property for persistent_disk to 0, users cannot edit this value and the Resource Config pane in the Ops Manager tile displays None under the persistent disk field.

instance_definition

• Format: Hash
• Type: Required

The number of default instances for a job, including maximum, minimum, odd, and the ability to decrease sizing after deploy.

If your tile uses an external service that performs the same job as a service in TAS for VMs, you can reduce resource usage by setting the instance count of a job to 0 with the zero_if property.

When zero_if is not active for an instance group, you cannot set the instance count to 0. You can override this by setting allow_manual_selection_of_zero to true. By default, it is set to false.

For example, your tile uses Amazon Relational Database Service (RDS) instead of MySQL, which is the default system database for TAS for VMs. Remove all instance counts of MySQL by setting property reference to .properties.system.database and property value to magic value.

For examples of supported constraint types, see integer.

Note: If you are using the zero_if property, you should not set the may_only_increase constraint to true.

manifest

• Format: Text snippet, prefaced by pipe symbol: |
• Type: Optional

Ops Manager generates a BOSH manifest that defines properties for each job the manifest deploys. Some of these properties are not set until the user clicks Apply Changes, because the user configures them in the tile or because Ops Manager has to generate them.

For more information about referencing these properties, see Referencing Properties.

Job Accessors

The table below describes the double parentheses expressions Ops Manager provides to access information about the jobs that the manifest deploys:

Property Blueprint Reference

Common Property Blueprint Attributes

All property blueprints can have the following attributes:

• name: Required. The name of the property. The name is used to reference a property in form_types and in (( )) accessors.

• type: Required. The type of property. Must be one of the property types listed in this topic.

• optional: Optional. Default: false. When set to true, Ops Manager does not require this property to be set in order to deploy, nor does it validate that this field has a value when saving a form with this property. optional cannot be set to true if a default value is set. For more information about which types support default, see All Property Blueprint Types. optional cannot be set to true if the property also has configurable: false.

• configurable: Optional. Default: false. When set to true for property types that support operator configuration, the operator is not allowed to configure this value. Do not set configurable: true for property types that do not support operator configuration. When set to false, Ops Manager does not render this property in any form, even if it is specified in a form_type, nor does it allow the property to be updated via the API. For property types that support auto-generation of values, when configurable is set to false, Ops Manager generates and saves a value for this property when the tile this property belongs to is deployed for the first time.

• freeze_on_deploy: Optional. Default: false. When set to true, Ops Manager does not allow this property to be changed after the tile this property belongs to is successfully deployed.

• conditional_default: Optional. Accepts two nested keys: dependency_present and value. The conditional_default key overrides the default value specified in the property blueprint only when that tile dependency is present. Otherwise, the default value is used. The conditional_default key is evaluated when the specified tile dependency is imported. It is reevaluated only when that tile dependency is staged or deleted. For example:

  - name: example_selector
    type: selector
    default: Yes
    conditional_default:
      dependency_present: cf
      value: No
    option_templates:
      - name: yes_option
        select_value: Yes
        named_manifests:
          - name: my_snippet
            manifest: |
              ...
      - name: no_option
        select_value: No
        named_manifests:
          - name: my_other_snippet
            manifest: |
              ...
  

Configurable and Auto-Generated Properties

When a property has configurable: true and is added to a form_type, the operator can configure the value of that property.

Alternatively, a property with configurable: false gets a value auto-generated by Ops Manager. For which property types support each of these usages, see the sections below.

Properties with configurable set to false:

• Cannot be edited by the operator.
• Do not show up in forms, even if added under form_types.
• Get auto-generated values filled in by Ops Manager if that specific type of property supports auto-generation of values.

named_manifest for Selector and Collection Type Properties

Specify a property for collection within the named_manifest section of the metadata, as in the example below:

- name: certificate_collection
  type: collection
  configurable: true
  property_blueprints:
    - name: some_cert_name
      type: string
    - name: some_cert
      type: rsa_cert_credentials
  named_manifests:
  - name: for_routing
    manifest: |
      name:  (( current_record.some_cert_name.value ))
      private_key:  (( current_record.some_cert.private_key_pem ))
      public_key:  (( current_record.some_cert.public_key_pem ))
      certificate: (( current_record.some_cert.cert_pem ))

Use the current_record property within a collection record to refer to other properties in the same record.

For example, the properties in the for_routing named manifest refer to the values for name, private_key, public_key, and certificate within this record only.

Note: The current_record property is reserved. You cannot create a new property named current_record.

After defining a named manifest, you can reference it using a manifest snippet in the following format:

routing_certificates: (( .properties.certificate_collection.parsed_manifest(for_routing) ))

Ops Manager renders the following manifest from this example:

routing_certificates:
  - name: foo_cert
    private_key: PRIVATE-KEY
    public_key: PUBLIC-KEY
    certificate: CERTIFICATE
  - name: bar_cert
    private_key: PRIVATE-KEY
    public_key: PUBLIC-KEY
    certificate: CERTIFICATE

For more information, see Selector and Collection Types.

All Property Blueprint Types

These sections describe every property blueprint type.

boolean

This holds a single boolean value.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_boolean
    type: boolean
    configurable: true
    default: false

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_boolean
        label: 'Example checkbox'
        description: 'This is an example checkbox'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
    templates:
      - name: user_add
        release: os-conf
        manifest: |
          persistent_homes: (( .properties.example_boolean.value ))

ca_certificate

This holds a string value

Property Blueprint Attributes

Accessors

Example

property_blueprints:
- name: ca_cert
  type: ca_certificate
  configurable: true

form_types:
- name: example_form
  label: 'Example form'
  description: 'An example form'
  property_inputs:
    - reference: .properties.ca_cert
      label: 'Trusted CA certs'
      description: 'These certificates will be trusted by the deployed VM'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: ca_certs
      release: os-conf
      manifest: |
        certs: (( .properties.ca_cert.value ))

collection

This holds multiple records of a group of custom defined properties.

Property Blueprint Attributes

default:
  - name: sam
    public_key: ssh-rsa AAAAB3NzaC1yc2EAAAAD...
    sudo: true

Accessors

[
  {title: 'album-one', explicit: true},
  {title: 'album-two', explicit: false}
]

Example using .value accessor

property_blueprints:
  - name: users_to_add
    type: collection
    configurable: true
    property_blueprints:
      - name: name
        type: string
        configurable: true
      - name: public_key
        type: string
        configurable: true
      - name: sudo
        type: boolean
        configurable: true

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.users_to_add
        label: 'Users to add'
        description: 'will added to deployed VM'
        property_inputs:
          - reference: name
            label: Username
            description: username of the added user
          - reference: public_key
            label: Public key
            description: RSA public key used to SSH onto the VM
          - reference: sudo
            label: make sudoer
            description: if checked, user will be able to sudo

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
      - name: user_add
        release: os-conf
        manifest: |
          users: ((.properties.users_to_add.value))

Resulting manifest snippet

...
instance_groups:
- name: example-job
  jobs:
  - name: user_add
    release: os-conf
    ...
    properties:
      users:
      - name: tom
        public_key: ssh-rsa MFwwDQYJKoZIhvcNAQEBBQ...
        sudo: false
      - name: sameer
        public_key: ssh-rsa MFwwDQYJKoZIhvcNAQEBBQ...
        sudo: true
...

Example with .parsed_manifest(name)

property_blueprints:
  - name: sysctls
    type: collection
    configurable: true
    property_blueprints:
      - name: setting_name
        type: string
        configurable: true
      - name: setting_value
        type: string
        configurable: true
    named_manifests:
      - name: name_value_format
        manifest: (( current_record.setting_name.value ))=(( current_record.setting_value.value ))

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.sysctls
        label: 'Custom sysctls'
        description: 'sysctl configuration settings to be placed in /etc/sysctl.d'
        property_inputs:
          - reference: setting_name
            label: Setting name
            description: the sysctl setting name, e.g. net.core.somaxconn
          - reference: setting_value
            label: Setting value
            description: value for this sysctl setting

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
      - name: sysctl
        release: os-conf
        manifest: |
          sysctl: (( .properties.sysctls.parsed_manifest(name_value_format) ))

Resulting manifest snippet

...
instance_groups:
- name: example-job
  jobs:
  - name: sysctl
    release: os-conf
    ...
    properties:
      sysctl:
      - foo=bar
      - fooz=baz
...

disk_type_dropdown

This holds a single string value selected from allowed disk types.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_disk_type_dropdown
    type: disk_type_dropdown
    configurable: true
    resource_definitions:
      - name: persistent_disk
        default: 4096
        constraints:
          min: 2048

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_disk_type_dropdown
        label: 'Example disk_type_dropdown'
        description: 'This is an example'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: "Hello user, I see that your favorite disk size greater than 2 Gb is: (( .properties.example_disk_type_dropdown.value ))."

domain

This holds a string value that is a valid domain (e.g. example.com or x.example.com:80/a/b).

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_domain
    type: domain
    configurable: true

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_domain
        label: 'Example domain'
        description: 'This is an example'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello, user. I see your favorite domain is (( .properties.example_domain.value )).

dropdown_select

This holds an array of strings selected string values.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
- name: example_dropdown_select
  type: dropdown_select
  default: kiwi
  configurable: true
  options:
  - name: kiwi
    label: 'Kiwi'
  - name: lime
    label: 'Lime'
  - name: tomato
    label: 'Tomato'

form_types:
- name: example_dropdown
  label: 'Example form'
  description: 'An example form'
  property_inputs:
  - reference: .properties.example_dropdown_select
    label: Favorite fruit
    description: 'What is your favorite fruit?'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
  - name: login_banner
    release: os-conf
    manifest: |
      login_banner:
        text: Hello, user. I see your favorite fruit is (( .properties.example_dropdown_select.value )).

email

This ensures the string value is formatted as an email address.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
- name: example_email
  type: email
  configurable: true

form_types:
- name: example_dropdown
  label: 'Example form'
  description: 'An example form'
  property_inputs:
  - reference: .properties.example_email
    label: User email
    description: 'What is your email?'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
  - name: login_banner
    release: os-conf
    manifest: |
      login_banner:
        text: Hello, user. Your email is (( .properties.example_email.value )).

http_url

This holds an HTTP URL.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_http_url
    type: http_url
    configurable: true
    default: 'http://example.com'

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_http_url
        label: Example http_url
        description: 'Configure a property of type http_url'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
  - name: login_banner
    release: os-conf
    manifest: |
      login_banner:
        text: Hello, user. For fun, please visit (( .properties.example_http_url.value )).

integer

This holds a single integer value.

Property Blueprint Attributes

Supported Constraints

Accessors

Example

property_blueprints:
  - name: example_integer1
    type: integer
    configurable: true
    default: 9
    constraints: # the following constraints allow the values 9, 15, and 21
      min: 8
      max: 21
      may_only_increase: true
      may_only_be_odd_or_zero: true
      modulo: 3
  - name: example_integer2 # the following constraints allow the values 8 and 16
    type: integer
    configurable: true
    optional: true
    constraints:
      zero_or_min: 5
      max: 20
      power_of_two: true

form_types:
  - name: example_integer
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_integer1
        label: Example Integer 1
        description: 'Configure a property of type integer'
      - reference: .properties.example_integer2
        label: Example Integer 2
        description: 'Configure another property of type integer'

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
    - name: tcp_keepalive
      release: os-conf
      manifest: |
        tcp_keepalive:
          time: (( .properties.example_integer1.value ))
          interval: (( .properties.example_integer2.value ))

ip_address

Ensures the string value is an IP address.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_ip_address
    type: ip_address
    configurable: true
    default: 192.168.0.1

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_ip_address
        label: Example IP Address
        description: 'Configure a property of type ip_address'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello, user. I see your favorite IP Address is (( .properties.example_ip_address.value )).

ip_ranges

This holds a string that is a comma-separated list of IP addresses and IP address ranges.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_ip_ranges
    type: ip_ranges
    configurable: true
    default: 1.1.1.1-1.1.1.4,2.2.2.1-2.2.2.4,3.3.3.3

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_ip_ranges
        label: Example IP Ranges
        description: 'Configure a property of type ip_ranges'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello, user. I see your favorite IP ranges are (( .properties.example_ip_ranges.value )).

ldap_url

Ensures the inputted string matches a URL of the LDAP protocol, or a space-separated list of LDAP protocol URLs.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_ldap_url
    type: ldap_url
    configurable: true
    default: 'ldap://example.com'

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_ldap_url
        label: Example ldap_url
        description: 'Configure a property of type ldap_url'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
  - name: login_banner
    release: os-conf
    manifest: |
      login_banner:
        text: Hello, user. I see your favorite LDAP URL is (( .properties.example_ldap_url.value )).

multi_select_options

This holds an array of selected string values. Must be an array of non-blank strings.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_multi_select_options
    type: multi_select_options
    configurable: true
    default: ['earth', 'mercury']
    options:
    - name: mercury
      label: 'label for mercury'
    - name: venus
      label: 'label for venus'
    - name: earth
      label: 'label for earth'

form_types:
  - name: example_multi_select_options
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_multi_select_options
        label: Example Multi-Select Options
        description: 'Configure a property of type multi_select_options'

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
    - name: modprobe
      release: os-conf
      manifest: |
        # the value at the 'modules' key will render as an array of strings
        modules: (( .properties.example_multi_select_options.value ))

network_address

This holds a string which is a hostname, domain name, or IP addresses.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_network_address
    type: network_address
    configurable: true
    default: 'localhost'

form_types:
  - name: example_network_address
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_network_address
        label: Example Network Address
        description: 'Configure a property of type network_address'

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello, user. I see your favorite network address is (( .properties.example_network_address.value )).

network_address_list

This holds a string which is a comma-separated list of hostnames and IP addresses.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_network_address_list
    type: network_address_list
    configurable: true
    default: 'localhost,8.8.8.8'

form_types:
  - name: example_network_address_list
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_network_address_list
        label: Example Network Address List
        description: 'Configure a property of type network_address_list'

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello, user. I see your favorite network addresses are (( .properties.example_network_address_list.value )).
          an_ignored_array_of_network_addresses: (( .properties.example_network_address_list.parsed_network_addresses ))

port

This holds a single integer value. Allowed values are 0 through 65535 and null.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_port
    type: port
    configurable: true
    default: 3000

form_types:
  - name: example_port
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_port
        label: Example Port
        description: 'Configure a property of type port'

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello, user. I see your favorite network port is (( .properties.example_port.value )).

rsa_cert_credentials

This holds SSL certificate generated from root CA

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  # This is configurable by the operator and appears in the form_types section
  - name: example_configurable_rsa_cert_credentials
    type: rsa_cert_credentials
    configurable: true
    optional: true
  # This is not configurable by the operator and is auto-generated
  - name: example_non_configurable_rsa_cert_credentials
    type: rsa_cert_credentials
    configurable: false
    default:
      domains:
        - 'cell.service.cf.internal'
        - '*cell.service.cf.internal'
form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_configurable_rsa_cert_credentials
        label: Example configurable rsa_cert_credentials
        description: 'Configure a property of type rsa_cert_credentials'

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: |
            Hello, user.
            Here is your public_key_pem
            (( .properties.example_non_configurable_rsa_cert_credentials.public_key_pem ))
            Here is your private_key_pem
            (( .properties.example_non_configurable_rsa_cert_credentials.private_key_pem ))
            Here is your cert_pem
            (( .properties.example_non_configurable_rsa_cert_credentials.cert_pem ))
            Here is your cert_and_private_key_pems
            (( .properties.example_non_configurable_rsa_cert_credentials.cert_and_private_key_pems ))

rsa_pkey_credentials

This holds RSA public and private keys. This is a non-configurable property.

Accessors

Example

property_blueprints:
  - name: example_rsa_pkey_credentials
    type: rsa_pkey_credentials
    configurable: false

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
      - name: user_add
        release: os-conf
        manifest: |
          users:
            - name: nick
              public_key: ((.properties.example_rsa_pkey_credentials.public_key_pem))

salted_credentials

This holds credentials with salted and hashed passwords. This is a non-configurable property.

Property Blueprint Attributes

default:
  - identity: ryan

Accessors

Example

property_blueprints:
  # Example without defaults
  - name: example_salted_credentials
    type: salted_credentials
  # Example with default identity
  - name: example_salted_credentials_with_default
    type: salted_credentials
    default:
      identity: vcap

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
      - name: user_add
        release: os-conf
        manifest: |
          users:
            - name: vcap
              crypted_password: ((.properties.example_salted_credentials.sha512_hashed_password))

secret

This holds a single string value for a secret. Adding display_type: text_area to the property inputs creates a multi-line credential.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_secret
    type: secret
    configurable: true
    constraints:
      - must_match_regex: '^[a-zA-Z]{20,}$'
        error_message: 'This password must be at least 20 alphabetic characters '

form_types:
  - name: example_secret
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_secret
        label: Example Secret
        description: 'Configure a property of type secret'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Shh, today's secret is (( .properties.example_secret.value )).

Example of a multi-line credential

form_types:
  - name: example_secret
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_secret
        label: Example Secret
        description: 'Configure a property of type secret'
        display_type: text_area

selector

Provides the ability to switch between groups of properties. Shows in the UI as a radio button group, potentially with additional options nested under each radio button.

Selectors are unique in the way that property information is accessed. Ops Manager provides accessors available at the top-level selector property, accessors for retrieving a specific property in an option group, and the ability to provide manifest snippets for a selector option group.

Each selector group may provide manifest snippets. This is because Ops Manager does not support conditionally adding manifest snippets. A manifest snippet should be present within all option groups, and can be used to create a simple kind of branching logic in manifest generation. Only one of these sets is evaluated and inserted into the job’s manifest.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_selector
    type: selector
    configurable: true
    default: Pizza
    freeze_on_deploy: true
    option_templates:
      - name: pizza_option
        select_value: Pizza
        named_manifests:
          - name: my_snippet
            manifest: |
              pizza_toppings:
                pepperoni: (( .properties.example_selector.pizza_option.pepperoni.value ))
                other: (( .properties.example_selector.pizza_option.other_toppings.value ))
        property_blueprints:
          - name: pepperoni
            type: boolean
            configurable: true
            freeze_on_deploy: true
          - name: other_toppings
            type: string
            configurable: true
            optional: true
      - name: filet_mignon_option
        select_value: Filet Mignon
        named_manifests:
          - name: my_snippet
            manifest: |
              rarity: (( .properties.example_selector.filet_mignon_option.rarity_dropdown.value ))
              review: (( .properties.example_selector.filet_mignon_option.review.value ))
        property_blueprints:
          - name: rarity_dropdown
            type: dropdown_select
            configurable: true
            default: rare
            options:
              - name: rare
                label: 'Rare'
              - name: medium
                label: 'Medium'
              - name: well-done
                label: 'Well done'
          - name: review
            type: string
            configurable: true
            default: A+ power seller of mail order steak
            optional: false

form_types:
  - name: example_selector_form
    label: 'Selector Example'
    description: 'A selector example form'
    property_inputs:
      - reference: .properties.example_selector
        label: 'Food Choices'
        selector_property_inputs:
          - reference: .properties.example_selector.pizza_option
            label: 'Pizza'
            property_inputs:
              - reference: .properties.example_selector.pizza_option.pepperoni
                label: 'Add Pepperoni'
                description: 'Yum!'
              - reference: .properties.example_selector.pizza_option.other_toppings
                label: 'Other toppings'
          - reference: .properties.example_selector.filet_mignon_option
            label: 'Filet Mignon'
            property_inputs:
              - reference: .properties.example_selector.filet_mignon_option.rarity_dropdown
                label: 'How rare?'
                description: 'Extinct.'
              - reference: .properties.example_selector.filet_mignon_option.review
                label: 'Write your review'
                description: '"E.g. Would not buy again"'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: |
            Would you like some (( .properties.example_selector.value ))?
            I'm asking because you mentioned (( .properties.example_selector.pizza_option.other_toppings.value ))
          more_manifest_ignored_by_os_conf: (( .properties.example_selector.selected_option.parsed_manifest(my_snippet) ))

service_network_az_multi_select

This holds an arrays of string value selected from allowed availability zones (AZs).

Accessors

Example

service_broker: true

property_blueprints:
  - name: service_instance_azs
    type: service_network_az_multi_select
    configurable: true
    optional: false

form_types:
  - name: example_service_network_az_multi_select
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.service_instance_azs
        label: Example Service Network AZ Multi-Select
        description: 'Configure a property of type service_network_az_multi_select'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: "Hello, user. Here is an array of AZ names: (( .properties.service_instance_azs.value ))"

service_network_az_single_select

This holds a single string value selected from allowed azs. Appears as a radio button group in the UI.

Accessors

Example

service_broker: true

property_blueprints:
  - name: example_service_network_az_single_select
    type: service_network_az_single_select
    configurable: true
    optional: false

form_types:
  - name: example_service_network_az_single_select
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_service_network_az_single_select
        label: Example Service Network AZ Single-Select
        description: 'Configure a property of type service_network_az_single_select'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: "Hello, user. Here is a single AZ name: (( .properties.example_service_network_az_single_select.value ))"

simple_credentials

This holds an identity and password.

Property Blueprint Attributes

default:
  - identity: ryan

Accessors

Example

property_blueprints:
  - name: example_configurable_simple_credentials
    type: simple_credentials
    configurable: true
  - name: example_non_configurable_simple_credentials
    type: simple_credentials
    configurable: false
    default:
      identity: vcap
form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_configurable_simple_credentials
        label: Example configurable simple_credentials
        description: 'Configure a property of type simple_credentials'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: |
            Shh, today's secret password is (( .properties.example_non_configurable_simple_credentials.password ))
            And the username is (( .properties.example_non_configurable_simple_credentials.identity ))

smtp_authentication

This holds string with a possible value of plain, login, or cram_md5.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_smtp_authentication
    type: smtp_authentication
    configurable: true
    default: plain

form_types:
  - name: example_text
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_smtp_authentication
        label: Example SMTP Authentication
        description: 'Configure a property of type smtp_authentication'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello. The SMTP auth type is (( .properties.example_smtp_authentication.value ))

stemcell_selector

Provides the ability to select between all available stemcell criteria. The stemcell selector is automatically populated with a list of all stemcell operating systems that are listed in the stemcell_criteria and additional_stemcells_criteria top-level properties.

After an operator has selected a stemcell listed in stemcell_selector, that stemcell is required to deploy the product.

For more information about the stemcell_criteria top-level property, see stemcell_criteria above.

For more information about the additional_stemcells_criteria top-level property, see additional_stemcells_criteria above.

Property Blueprint Attributes

Accessors

Example

stemcell_criteria:
  os: ubuntu-xenial
  version: 1.0.0
additional_stemcells_criteria:
  os: windows2016
  version: 1.0.0

property_blueprints:
  - name: example_stemcell_selector
    type: stemcell_selector
    configurable: true
    optional: true
form_types:
  - name: example_stemcell_selector_form
    label: 'Stemcell Selector Example'
    description: 'A stemcell selector example form'
    property_inputs:
      - reference: .properties.example_stemcell_selector
        label: 'Example stemcell selector'
        description: 'Select which stemcell you want to use'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: |
            Stemcell Assigned?: (( .properties.example_stemcell_selector.assigned? ))
            Assigned stemcell OS: (( .properties.example_stemcell_selector.os ))
            Assigned stemcell version: (( .properties.example_stemcell_selector.version ))
            Selected stemcell?: (( .properties.example_stemcell_selector.value_present? ))
            Selected stemcell OS: (( .properties.example_stemcell_selector.value ))

string_list

This holds an array of strings.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_string_list
    type: string_list
    configurable: true
    default: foo,bar,baz

form_types:
  - name: example_string_list
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_string_list
        label: Example String List
        description: 'Configure a property of type string_list'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello. Your array of strings is (( .properties.example_string_list.value ))

string

This holds a single string value.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_string
    type: string
    configurable: true
    default: 'Karl'
    constraints:
    - must_match_regex: 'A[^!@#$%^&*()]*z'
      error_message: 'This name cannot contain special characters.'
    - must_match_regex: 'A[^0-9]*z'
      error_message: 'This name cannot contain digits.'
    - must_be_cron_schedule: true
      error_message: 'This must be a valid cron schedule expression.'

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_string
        label: 'Example string'
        description: 'This is an example'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello, (( .properties.example_string.value ))! Welcome.

text

This holds a string value. For configurable properties of this type, the UI allows multi-line strings to be entered.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_text
    type: text
    configurable: true
    default: |
      Example
      Text

form_types:
  - name: example_text
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_text
        label: Example Text
        description: 'Configure a property of type text'

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: |
            Hello. Check out all this text!
            (( .properties.example_text.value ))

uuid

This holds a string uuid value.

Accessors

Example

property_blueprints:
  - name: example_uuid
    type: uuid
    configurable: false

job_types:
- name: example-job
  resource_label: An Example Job
  <<: *job_type_boilerplate
  templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello. Your UUID is (( .properties.example_uuid.value ))

vm_type_dropdown

This holds single string value selected from allowed vm_types.

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_vm_type_dropdown
    type: vm_type_dropdown
    configurable: true
    resource_definitions:
    - name: ram
      default: 4096
    - name: cpu
      default: 1
    - name: ephemeral_disk
      default: 4096
      constraints:
        min: 2048

form_types:
  - name: example_vm_type_dropdown
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_vm_type_dropdown
        label: Example VM Type Dropdown
        description: 'Configure a property of type vm_type_dropdown'

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
      - name: login_banner
        release: os-conf
        manifest: |
          login_banner:
            text: Hello. Your chosen VM Type is (( .properties.example_vm_type_dropdown.value )).

wildcard_domain

Ensures the string value is a domain prefixed with *..

Property Blueprint Attributes

Accessors

Example

property_blueprints:
  - name: example_wildcard_domain
    type: wildcard_domain
    configurable: true
    default: 'example.com'

form_types:
  - name: example_form
    label: 'Example form'
    description: 'An example form'
    property_inputs:
      - reference: .properties.example_wildcard_domain
        label: Example Wildcard Domain
        description: 'Configure a property of type wildcard_domain'

job_types:
  - name: example-job
    resource_label: An Example Job
    <<: *job_type_boilerplate
    templates:
    - name: login_banner
      release: os-conf
      manifest: |
        login_banner:
          text: Hello. Your wildcard domain is (( .properties.example_wildcard_domain.value )).

Use the Examples Provided

You can copy each example into the metadata.yml template below and package it together along with the os-conf release as a .pivotal file to make a working tile.

---
name: p-example
label: Example Tile
description: An example tile
product_version: '1.1'
minimum_version_for_upgrade: '1.0'
metadata_version: '2.2'
rank: 1
 stemcell_criteria:
  os: ubuntu-xenial
  version: '97.3'
 releases:
  - name: os-conf
    file: os-conf
    version: '15'
 # a base 64 encoded PNG with a teal square
icon_image: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQI12NgaC8BAAGGAPwUz8ygAAAAAElFTkSuQmCC

 includes: # This top-level key is ignored by Ops Manager.
  # This anchor is only to make the examples below more terse and is not required.
  job_type_boilerplate: &job_type_boilerplate
    max_in_flight: 1
    single_az_only: true
    resource_definitions:
      - name: ram
        configurable: true
        default: 1024
       - name: ephemeral_disk
         configurable: true
         default: 1024
       - name: persistent_disk
         configurable: true
         default: 1024
         constraints:
           min: 1024
       - name: cpu
         configurable: true
         default: 1
     instance_definition:
      name: instances
      configurable: true
      default: 1