Linux Apache Web ServerΒΆ

This is an example of a template which launches a stack and deploys an Apache Web Server using Chef. You can download it at this link apache_web_server_with_chef.yaml. Refer to the Linux Apache Web Server (Chef) tutorial in this document for a detailed step by step hands on tutorial which uses this template.

####################################################################################################################################################
# This sample deploys a stack with an Apache Web Server, installs the DCM agent and performs a Chef run to install Apache.
####################################################################################################################################################
#
# This sample is intended for demonstrating the Blueprint function. It is not intended for "production" use and is unsupported.
# Use it at your own risk.
#
# Note: This Blueprint launches servers from public Ubuntu machine images. You should verify that the machine images still exist before launching.
#
# To run this sample you will need a Chef Account. That Chef Account must be configured in Dell Cloud Manager and the name you defined to it in
# Dell Cloud Manager must match the "chefServer:" value defined in this template.
#
# Refer to the Dell Cloud Manager Blueprint Designer Guide for more details.
# http://blueprint-designer-guide.enstratius.com/tutorials/chef/tutorial1/overview.html
#
####################################################################################################################################################
template_name: "Apache Web Server on Linux using Chef"
template_author: "Gary Forghetti"
template_version: "1.00"
description: "Deploys an Apache Web Server single server stack using Chef"
long_description: "Deploys an Apache Web Server single server stack using Chef."

imports:
  - base_types.yaml                                                   # Import the DCM base type definitions that are referenced in this template

topology_template:

  inputs:                                                             # Define the inputs
    ################################################################################################################################################
    # This defines the AccountRegionSelector which allows the user to select the Cloud, Region and Datacenter
    ################################################################################################################################################
    account_region_zone_selector:                                     # Define the section for the Cloud, Region and Datacenter selection boxes
      type: dcm.inputs.AccountRegionSelector                          # Input type is dcm.inputs.accountRegionSelector
      properties:
        regions:                                                      # Define the Cloud and Regions
          "Amazon":                                                   # Amazon
            "us-east-1": [ ]                                          # All data centers for the us-east-1 region
            "us-west-1": ["us-west-1a", "us-west-1c"]
            "us-west-2": ["us-west-2a", "us-west-2b", "us-west-2c"]
            "eu-west-1": ["eu-west-1a", "eu-west-1c"]
          "Azure":                                                    # Azure
            "East US": ["East US"]
          "DigitalOcean":                                             # Digital Ocean
            "nyc1": ["nyc1"]
          "Google":                                                   # Google
            "us-east1": ["us-east1-b"]
            "us-central1": ["us-central1-a"]
          "Joyent":                                                   # Joyent
            "us-east-1": ["us-east-1a"]

    ################################################################################################################################################
    # This defines the Product selector which allows the user to select the server product size
    ################################################################################################################################################
    product_selector:                                                 # Define the product selector so the user can select the cloud and region
      type: dcm.inputs.Product                                        # Input type is dcm.inputs.Product
      properties:
        accountRegionSelector: account_region_zone_selector           # This connects the AccountRegionSelector to the Product selector
        platform: UNIX                                                # Virtual machine images are Linux
        architecture: I64                                             # 64 bit images
        productMappings:
          "Amazon":                                                   # Amazon cloud
            "us-east-1":                                              # us-east-1 Region
              image: "ami-c4edc0d3"                                   # Machine image identifier for an Ubuntu image in this region
              products: ['t1.micro', 'm1.small', 'm1.medium']         # The virtual machine product sizes for this region
            "us-west-1":                                              # us-west-1 Region
              image: "ami-e7035687"                                   # Machine image identifier for an Ubuntu image in this region
              products: ['t1.micro', 'm1.small', 'm1.medium']         # The virtual machine product sizes for this region
            "us-west-2":                                              # us-west-2 Region
              image: "ami-578c2f37"                                   # Machine image identifier for an Ubuntu image in this region
              products: ['t1.micro', 'm1.small', 'm1.medium']         # The virtual machine product sizes for this region
            "eu-west-1":                                              # eu-west-1 Region
              image: "ami-e6a1f795"                                   # Machine image identifier for an Ubuntu image in this region
              products: ['t1.micro', 'm1.small', 'm1.medium']         # The virtual machine product sizes for this region

          "Azure":                                                    # Azure cloud
            "East US":                                                # East US Region
              # Machine image identifier in this region
              image: "b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu-14_04_4-LTS-amd64-server-20160406-en-us-30GB"
              products: ['Basic_A1', 'Medium', 'Standard_D1']         # The virtual machine product sizes for this region

          "DigitalOcean":                                             # DigitalOcean Cloud
            "nyc1":                                                   # New York City 1 region
              image: "18173769"                                       # Machine image identifier for an Ubuntu image in this region
              products: ['1gb', '4gb', '8gb']                         # The virtual machine product sizes for this region

          "Google":                                                   # Google cloud
            "us-east1":                                               # us-east1 Region
              image: "ubuntu-os-cloud_ubuntu-1404-trusty-v20160516"   # Machine image identifier for an Ubuntu image in this region
              products: ['g1-small', 'n1-standard-4', 'n1-highmem-4'] # The virtual machine product sizes for this region
            "us-central1":                                            # us-central1 Region
              image: "ubuntu-os-cloud_ubuntu-1404-trusty-v20160516"   # Machine image identifier for an Ubuntu image in this region
              products: ['g1-small', 'n1-standard-4', 'n1-highmem-4'] # The virtual machine product sizes for this region

          "Joyent":                                                   # Joyent cloud
            "us-east-1":                                              # us-east-1 Region
              image: "c864f104-624c-43d2-835e-b49a39709b6b"           # Machine image identifier for an Ubuntu image in this region
              products: ['Medium 4GB', 'Large 8GB']                   # The virtual machine product sizes for this region

  ##################################################################################################################################################
  # This defines the two outputs to appear on the DCM console Stack overview page (IP address and URL of the Apache Web Server)
  ##################################################################################################################################################
  outputs:                                                        # Define outputs

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

    vm_ip:                                                        # Define an output
      type: string                                                # It's a string output
      description: IP of the server                               # Set the description for the string output
      value: {get_attribute: [web_vm, publicIpAddress]}           # Set the value to the public IP address of the server running in the stack
      properties:
        displayName: IP address                                   # Set the display name (label) for the string output
        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.html                      # 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 server running in the stack
        displayName: Apache Server 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/tutorial1/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

  node_templates:

    ##################################################################################################################################################
    # This node_template defines a virtual machine named "web_vm" which will host the Apache Web Server
    ##################################################################################################################################################
    web_vm:
      type: dcm.nodes.Server                                                     # This is a Server node
      properties:
        name: "apache-server"
        cloud: { get_input: [account_region_zone_selector, cloud] }              # Retrieve cloud from the AccountRegionSelector
        cloudAccountId: { get_input: [account_region_zone_selector, accountId] } # Retrieve the cloud account ID from the AccountRegionSelector
        region: { get_input: [account_region_zone_selector, region] }            # Retrieve region from the AccountRegionSelector
        zone: { get_input: [account_region_zone_selector, zone] }                # Retrieve zone from the AccountRegionSelector
        platform: { get_input: [product_selector, platform] }                    # Retrieve platform from the Product selector
        architecture: { get_input: [product_selector, architecture] }            # Retrieve architecture from the Product selector
        product: { get_input: [product_selector, product] }                      # Retrieve product from the Product selector
        image: { get_input: [product_selector, image] }                          # Retrieve machine from the Product selector
        serverProductId: { get_input: [product_selector, serverProductId] }      # Retrieve server product id from the Product selector

        startupScript:  |                                                    # Startup script with commands to install and start the dcm agent
          #!/bin/bash
          ##########################################################################################################################################
          # Install curl on Debian/Ubuntu if necessary
          ##########################################################################################################################################
          which apt-get && apt-get update -qq && (which curl || apt-get install curl -y)

          ##########################################################################################################################################
          # Install curl on RHEL/CentOS if necessary
          ##########################################################################################################################################
          which yum && yum -q makecache && (which curl || yum install curl -y)

          ##########################################################################################################################################
          # Get the latest Chef Client version
          ##########################################################################################################################################
          export chef_client_version=$(curl -s --retry 10 https://downloads.chef.io/chef-client/ubuntu/ | grep -m1 -o '<option value=".*"' | cut -d'"' -f2)

          ##########################################################################################################################################
          # Install the Dell Cloud Manager agent, point it to the Dell Cloud Manager server and configure it to startup at boot time.
          ##########################################################################################################################################
          export DCM_URL=${dcm.callback.url}

          ##########################################################################################################################################
          # The -Z argument configures the Dell Cloud Manager agent and allows it to accept unknown certificates.
          # This is only recommended for testing and should not be done in a production environment.
          # The -o argument will install the Chef Client
          # The --chef-client-version argument specifies the Chef Client version
          ##########################################################################################################################################
          curl -L --retry 10 https://linux-stable-agent.enstratius.com/installer.sh | bash -s - --url $DCM_URL -o --on-boot -Z \
          --chef-client-version $chef_client_version

          ##########################################################################################################################################
          # Start the Dell Cloud Manager agent.
          ##########################################################################################################################################
          /etc/init.d/dcm-agent start

      requirements:                                                   # This virtual machine node has a requirement on a firewall
        - firewall: vm_firewall_rules                                 # The firewall statement is named "vm_firewall_rules"
          relationship_type: tosca.relationships.DependsOn

    ###################################################################################################################################################
    # This node_template defines a firewall which opens the HTTP port 80 for the Apache Web server
    ###################################################################################################################################################
    vm_firewall_rules:
      type: dcm.nodes.FirewallGroup                                              # This is a firewall
      properties:                                                                # Retrieve the cloud properties from the "inputs"
        name: "fw-apache-server"                                                 # Define a name for the firewall (it will get prefixed with the stack name)
        cloud: { get_input: [account_region_zone_selector, cloud] }              # Retrieve the cloud from the AccountRegionSelector
        cloudAccountId: { get_input: [account_region_zone_selector, accountId] } # Retrieve the cloud account ID from the AccountRegionSelector
        region: { get_input: [account_region_zone_selector, region] }            # Retrieve the region from the AccountRegionSelector
        zone: { get_input: [account_region_zone_selector, zone] }                # Retrieve the zone from the AccountRegionSelector
        rules:
          - remote_ip_prefix: 0.0.0.0/0
            port: 80                                                             # Define a rule to open port 80  (HTTP)

    ###################################################################################################################################################
    # This node_template will result in Chef installing the Apache Web Server on the launched virtual machine named "web_vm"
    ###################################################################################################################################################
    chef_apache:
      type: dcm.nodes.Chef                                            # This is a Chef node
      properties:
        chefServer: "ACME Chef"                                       # Name of the Chef Server Account defined to the Dell Cloud Manager Server
        environment: "_default"                                       # Chef environment
        roles: ['ACME-Webserver']                                     # Chef role which contains the cookbooks and recipes to install Apache
      requirements:
        - host: web_vm                                                # This requires (is "HostedOn") the Server defined in the template named "web_vm"
          relationship_type: tosca.relationships.HostedOn