summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/include-documentation.rst
AgeCommit message (Expand)AuthorFilesLines
2017-07-13Correction, documentation guide2017-05-08Add infra submoduleagardner1-0/+15
2017-03-08Fixed warningsSofia Wallin1-10/+10
2017-02-21Update OPNFVDocs documentationShubhamRathi1-2/+20
2017-02-13Merge "Added steps to build documentation"Sofia Wallin1-0/+83
2017-02-11Added steps to build documentationShubhamRathi1-0/+83
2017-02-08Documentation guide ported from wikiShubhamRathi1-1/+1
2017-01-31New docs for 'How to include documentation'ShubhamRathi1-37/+98
2017-01-24Original 'Including your Documentation'ShubhamRathi1-0/+66
font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ }
heat_template_version: ocata

description: >
  Returns an IP from a network mapped list of IPs

parameters:
  TenantNetName:
    description: Name of the tenant network
    default: tenant
    type: string
  PortName:
    description: Name of the port
    default: ''
    type: string
  ControlPlaneIP: # Here for compatibility with noop.yaml
    description: IP address on the control plane
    default: ''
    type: string
  IPPool:
    default: {}
    description: A network mapped list of IPs
    type: json
  NodeIndex:
    default: 0
    description: Index of the IP to get from Pool
    type: number
  TenantNetCidr:
    default: '172.16.0.0/24'
    description: Cidr for the tenant network.
    type: string

outputs:
  ip_address:
    description: tenant network IP
    value: {get_param: [IPPool, {get_param: TenantNetName}, {get_param: NodeIndex}]}
  ip_address_uri:
    description: tenant network IP (for compatibility with tenant_v6.yaml)
    value: {get_param: [IPPool, {get_param: TenantNetName}, {get_param: NodeIndex}]}
  ip_subnet:
    description: IP/Subnet CIDR for the tenant network IP
    value:
      list_join:
      - ''
      - - {get_param: [IPPool, {get_param: TenantNetName}, {get_param: NodeIndex}]}
        - '/'
        - {str_split: ['/', {get_param: TenantNetCidr}, 1]}