Bug 1393540

Summary: Issue in section 5.4 of partner integration guide
Product: Red Hat OpenStack Reporter: Andreas Karis <akaris>
Component: documentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED CURRENTRELEASE QA Contact: RHOS Documentation Team <rhos-docs>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 9.0 (Mitaka)CC: dcadzow, dmacpher, srevivo
Target Milestone: ---Keywords: Documentation
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-06-12 12:17:52 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Andreas Karis 2016-11-09 19:14:39 UTC
Description of problem:
The issues we encountered were caused by incorrect documentation.
We suggest that you forward the problem we faced to the appropriate people responsible for the documentation

We tried  the exact example described in section 5.4 of this document:
https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/partner-integration/partner-integration

There are two problems with that example
1) The problem you solved for us:
    the type of the server parameter should be "string" and not "json"
2) The identation of the properties field in the ExtraPreDeployment resource is incorrect
   This problem, we were able to solve ourselves

The correct documentation for this is in:

As outlined in our documentation:
https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/

The file needs to look like this:
------------------------------------------------------

[stack@undercloud-3 ~]$ cat templates/nameserver.yaml 
heat_template_version: 2014-10-16

parameters:
  server:
    type: string
  nameserver_ip:
    type: string

resources:
  ExtraPreConfig:
    type: OS::Heat::SoftwareConfig
    properties:
      group: script
      config:
        str_replace:
          template: |
            #!/bin/sh
            echo "nameserver _NAMESERVER_IP_" >> /etc/resolve.conf
          params:
            _NAMESERVER_IP_: {get_param: nameserver_ip}
  ExtraPreDeployment:
    type: OS::Heat::SoftwareDeployment
    properties:
      config: {get_resource: ExtraPreConfig}
      server: {get_param: server}
      actions: ['CREATE']

outputs:
  deploy_stdout:
    description: Deployment reference, used to trigger post-deploy on changes
    value: {get_attr: [ExtraPreDeployment, deploy_stdout]}


---------------