Output display groups

Output display groups allow you to group and display related outputs on the Stack Overview page after a stack reaches the running state. Output display groups are defined with a section name, type, description and properties.

section name

Example: application_group:

type

  • type: dcm.outputs.DisplayGroup

description

The description is optional and is used to document additional information about the output display group. It is not currently displayed anywhere on the Dell Cloud Manager console.

properties

The properties define additional options for the output display group. One property is currently supported:

  • displayName - this is the “title” name displayed for the output display group.
Example: displayName: WordPress Application Information

Example

Here is an example of defining 2 output display groups to display information on a application server and a HaProxy load balancer.

Note

The output display groups are displayed on the Dell Cloud Manager console Stack Overview page in the same order they are defined in the template yaml file.

  • Application group
  • Output string for the application public ip address
  • Web URL for the application
  • HaProxy Load Balancer group
  • Web URL for the HaProxy statistics page
  • Output string to display the HaProxy user id
  • Output password to display the HaProxy password

Note

The outputs are defined with the displayGroup: property indicating what group they should be a member of. Refer to the outputs section in this document for more information on the outputs.

  outputs:                                                        # Define outputs

    application_group:                                            # Create a Group
      type: dcm.outputs.DisplayGroup                              # It's a displayGroup
      properties:
        displayName: "WordPress Application Information"          # Set the display name for the group containing the outputs which appear
                                                                  # on the Stack Overview page

    user_id:                                                      # Define another output for the WordPress Admin user id
      type: string                                                # It's a string output
      description: WordPress Admin User Id                        # Set the description for the string output
      value: admin                                                # Set the value to the constant string "admin"
      properties:
        displayName: User id                                      # Set the display name (label) for the string output to "User Id"
        displayGroup: application_group                           # Place this output in the displayGroup named application_group

    password:                                                     # Define another output 
      type: password                                              # It's a password output
      description: WordPress Admin password                       # Set the description for the string output
      value: password                                             # Set the value to the constant string "password"
      properties:
        displayName: Password                                     # Set the display name (label) for the string output to "Password"
        displayGroup: application_group                           # Place this output in the displayGroup named application_group        

    link:                                                         # Define another output
      type: dcm.outputs.Uri                                       # It's a URI output
      value: http://xxxxxxxxxxxxx/index.php                       # Set the initial value
      properties:
        host: {get_attribute: [web_vm, publicIpAddress]}          # Set the hostname/ipaddress of the URI to the public IP address of the Apache web server
        displayName: WordPress Application URL                    # Set the display name (label) for the URI output
        displayGroup: application_group                           # Place this output in the displayGroup named application_group

    tutorial_group:                                               # Create a Group
      type: dcm.outputs.DisplayGroup                              # It's a displayGroup
      properties:
        displayName: "Blueprint Designer Guide"                   # Set the display name for the group 

    tutorial_link:                                                # Define an output
      type: dcm.outputs.Uri                                       # It's a URI output
      value: "http://blueprint-designer-guide.enstratius.com/tutorials/chef/tutorial6/overview.html"
      properties:
        displayName: "Tutorial Link:"                             # Set the display name (label) for the URI output 
        displayGroup: tutorial_group                              # Place this output in the displayGroup named application_group

The Dell Cloud Manager console Stack Overview page showing the output display groups.

../../../_images/output_display_groups.png