f5 orchestration templates for openstack heat documentation · f5 orchestration templates for...

F5 Orchestration Templates forOpenStack Heat Documentation

Release 9.0.1

F5 Networks

Aug 08, 2017

Contents

1 version 9.0.1 3

2 Guides 5

3 Heat Orchestration Template index 7

4 Configuration 21

5 F5 Plugins for OpenStack Heat 23

i

F5 Orchestration Templates for OpenStack Heat Documentation, Release 9.0.1

OpenStack version:

mitaka

Contents 1


2 Contents

CHAPTER 1

version 9.0.1

F5’s orchestration template library for OpenStack Heat (f5-openstack-heat) is a set of Heat Orchestration Tem-plates (HOT) that let you deploy and/or configure a BIG-IP device/cluster from your OpenStack cloud.

3


4 Chapter 1. version 9.0.1

CHAPTER 2

Guides

See the F5 Integration for OpenStack Heat user documentation.

5


6 Chapter 2. Guides

CHAPTER 3

Heat Orchestration Template index

The f5-openstack-heat template library contains two groups of Heat orchestration templates: F5-supported andUnsupported.

3.1 F5-Supported Heat templates

The F5 support policy for GitHub software applies to the F5-supported templates listed below.

3.1.1 Deploy Basic Load Balancer

Overview

This template deploys a basic load balancing scenario on a BIG-IP device (hardware or virtual edition). The stackincludes the following resources:

• one (1) client virtual machine (VM);

• one (1) server VM;

• one (1) virtual server, one (1) pool, and one (1) pool member created on the BIG-IP device for the server VM.

Prerequisites

• Licensed, operational BIG-IP device (hardware or VE) accessible to the OpenStack cloud.

• Glance image for the OS of your choice, to use for the VMs.

• BIG-IP security groups configured in OpenStack.

• SSH key(s) configured in OpenStack; to use for authentication to the VM instances launched by this template.

• F5 Plugins for OpenStack Heat installed on the Neutron controller.

7

https://support.f5.com/csp/article/K80012344

https://docs.openstack.org/image-guide/obtain-images.html

/products/openstack/heat-plugins/mitaka/install-f5-heat-plugins.html


• At least two (2) VLANs configured in Neutron – ‘mgmt’ and ‘data’ – to use for BIG-IP system managementand client-server data traffic, respectively.

Caveats

None.

Configuration Parameters

Table 3.1: Configuration ParametersParameter Type Description DefaultClient/Server Glance Image string Image to use for VMs N/AClient/Server Nova Flavor string Nova Compute flavor to use for VMs N/AKey name string ssh key to use for authentication to VMs N/ASecurity Group string security group to assign to VMs N/AClient Network string Client traffic network N/AServer Network string Server traffic network N/ABIG-IP Login Username string BIG-IP device username N/ABIG-IP Login Password string BIG-IP device password N/AVirtual Server Name string Name to assign to the virtual server virtual_server1Pool Name string Name to assign to the pool pool1BIG-IP Floating IP (bigip_fip) string The BIG-IP device’s floating IP address N/AVirtual Server VIP string Virtual IP address to assign to the virtual server N/AVirtual Server Port integer Port the virtual server should listen on 443Pool Member Port integer Port the pool member can receive traffic on 8080

Deployment

See the F5 HOT deployment instructions.

Download

Click the link below to download the template.

Download

3.1.2 F5 BIG-IP VE: Active-Standby Pair

Overview

The active-standby cluster template configures two (2) BIG-IP devices as an “active-standby” sync-failover devicegroup.

Prerequisites


• Three (3) VLANs configured in Neutron – ‘mgmt’, ‘control’, and ‘data’ – to use for system management, highavailability, and data traffic, respectively.

8 Chapter 3. Heat Orchestration Template index

/cloud/openstack/latest/support/openstack_big-ip_flavors.html

/cloud/openstack/latest/heat/deploy-heat-templates.html

https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/bigip-system-device-service-clustering-administration-13-0-0/4.html

https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/bigip-system-device-service-clustering-administration-13-0-0/4.html



• Two (2) licensed, operational BIG-IP devices (hardware or Virtual Edition), connected to the ‘control’ VLAN.

• Login credentials for user with permission to configure the BIG-IP devices.

• Basic understanding of BIG-IP device service clustering.

Caveats

None.


Parameter Type Description De-fault

Stack Name string Name for the stack N/ACreation Timeout inte-

gerLength of time after which stack creation will time out (min-utes)

N/A

Password for user “<user-name>”

string The password for your OpenStack user account N/A

Cluster Name string Assign a name to the new cluster N/AFIP for first device string Floating IP address of the first BIG-IP device N/AFIP for second device string Floating IP address of the second BIG-IP device N/AUsername for first device string Username for the first BIG-IP device N/APassword for first device string Password for the first BIG-IP device N/AUsername for second device string Username for the second BIG-IP device N/APassword for second device string Password for the second BIG-IP device N/A

Deployment


Download


Download

3.1.3 F5 BIG-IP VE: Cluster-Ready, 4-nic

Overview

This template deploys a “cluster-ready” pair of BIG-IP Virtual Edition (VE) devices. Each device has four (4) networkinterfaces: management, control, and two (2) data interfaces. The control interface (“HA”) allows connection failovertraffic, configuration synchronization, and connection mirroring. Using a control interface allows for the separation ofcontrol traffic from client/user data.

3.1. F5-Supported Heat templates 9

https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/bigip-system-device-service-clustering-administration-13-0-0



Prerequisites



• SSH key(s) configured in OpenStack.

• BIG-IP VE image uploaded to Glance.

• BIG-IP license base key.



Caveats

• BIG-IP VE images come in different sizes. The Nova compute flavor you should use for your image dependson the image’s disk size requirements. See the F5 OpenStack BIG-IP flavor matrix for more information.







/cloud/openstack/support/openstack-bigip-flavors.html




Stack Name string Provide a name for the stack N/ACreation Timeout inte-


N/A



F5 VE Image string Choose a BIG-IP VE image from the dropdown list N/AF5 VE Flavor string Choose a flavor for the BIG-IP VE N/AUse Config Drive boolean Use config drive to provide meta and user data FalseF5 Root SSH Key Name string Choose an ssh key-pair; used for authentication to the BIG-IP

VE instancesN/A

F5 VE Admin User Password string Create a password for the BIG-IP VE ‘admin’ user account N/AF5 VE Root User Password string create a password for the BIG-IP VE ‘root’ user account N/ASecurity Group for the data net-work

string Enter the name of a security group N/A

Security Group for the controlnetwork


Security Group for the manage-ment network


Primary VE License Base Key string Enter your F5 license base registration key N/AExternal Network string Choose the external network from the list N/AVE Management Network string Assign a Neutron subnet to the management interface on the

BIG-IP VE instancesN/A

VE HA Network string Assign a Neutron subnet to the high availability interface onthe BIG-IP VE instances

N/A

VE Network for the 1.2 Inter-face

string Assign a Neutron network to the 1.2 interface on the BIG-IPVE instances

N/A

Name for Network 1.2 string Enter a name for the 1.2 network on the BIG-IP VE instances data1VE Network for the 1.3 Inter-face

string Assign a Neutron network to the 1.2 interface on the BIG-IPVE instances

N/A

Name for Network 1.3 string Enter a name for the 1.3 network on the BIG-IP VE instances data2Default Gateway IP string Enter the Gateway IP address to use for the BIG-IP VE in-

stancesnone

Deployment


Download


Download




3.1.4 F5 BIG-IP Virtual Edition: Image Patch & Upload

Overview

This template prepares a BIG-IP Virtual Edition (VE) image for use in OpenStack and imports the patched image toGlance. The template does the following:

1. launches an Ubuntu server;

2. downloads the BIG-IP VE image from the specified URL to the onboarding server;

3. patches the image for use in OpenStack;

4. uploads the patched BIG-IP VE image to Glance.

Prerequisites

• An external network with access to the internet.

• BIG-IP Virtual Edition image file in qcow.zip format.

• BIG-IP license provisioned appropriately for your environment.1


• Ubuntu image imported to Glance.2

• SSH key configured in OpenStack.

• One (1) VLAN configured in Neutron; must have access to the external network. The onboarding server usesthis network connection to import the BIG-IP VE image.

Caveats

• The Heat engine cannot retrieve image files via ‘https’; for this template, image file uploads are not supported.The BIG-IP image must be in a location accessible to the Heat engine via ‘http’.


Tip: If you see an unspecified error after launching this template in OpenStack Horizon, see OpenStack bug id1476770.

1 See Simplified Licensing.2 See the OpenStack Virtual Machine Image Guide for more information.


https://docs.openstack.org/developer/glance/





https://bugs.launchpad.net/glance/+bug/1476770

https://bugs.launchpad.net/glance/+bug/1476770

https://f5.com/products/how-to-buy/simplified-licensing

https://docs.openstack.org/image-guide/obtain-images.html



Parameter Type Description DefaultOnboard Ubuntu Image3 string An Ubuntu image to use for the onboarding server N/AF5 Onboard Server Fla-vor

string Nova compute flavor for the onboarding server m1.medium

Use Config Drive booleanUse config drive to provide meta and user data to theorchestration instance

False

F5 Onboard Server Man-agement Network

string Network you want to attach the onboarding server to;must have access to the internet

N/A

Keystone Auth URL string Keystone Authentication URL N/AImage Import Tenant string OpenStack project you want to import the image to adminImage Import User string User account you want to import the image to adminImage Prep URL string F5Networks GitHub repo where the image prep tools

resideDO NOT CHANGETHIS SETTING

F5 VE Image URL string URL for the BIG-IP VE image (must use http) N/AF5 VE Image Name string Name of the BIG-IP VE image in the qcow.zip file

example: BIGIP-11.6.0.6.0.442.qcow2N/A

SSH Key string SSH Key to use for authentication to the onboardingserver

N/A

Apt-cache URL4 string URL for your local apt-cache proxy None

Deployment


Download


Download

3.1.5 F5 BIG-IP VE: Cluster-Ready Resource Group

Overview

This template deploys two (2) BIG-IP Virtual Edition (VE) instances in OpenStack using the F5-supported cluster-ready 4nic Heat orchestration template.

Prerequisites





3 Import the image to Glance before you launch this template.4 Used by the F5 OpenStack development team for testing.






• BIG-IP license base key.



Caveats




Stack Name string Provide a name for the stack N/ACreation Timeout inte-


N/A



F5 VE Image string Choose a BIG-IP VE image from the dropdown list N/AF5 VE Flavor string Choose a flavor for the BIG-IP VE N/AUse Config Drive boolean Use config drive to provide meta and user data FalseF5 Root SSH Key Name string Choose an ssh key-pair; used for authentication to the BIG-IP

VE instancesN/A

F5 VE Admin User Password string Create a password for the BIG-IP VE ‘admin’ user account N/AF5 VE Root User Password string create a password for the BIG-IP VE ‘root’ user account N/ASecurity Group for the data net-work


Security Group for the controlnetwork


Security Group for the manage-ment network


Primary VE License Base Key string Enter your F5 license base registration key N/AExternal Network string Choose the external network from the list N/AVE Management Network string Choose a subnet from the list; used as the BIG-IP VE manage-

ment interface networkN/A

VE HA Network string Choose a subnet from the list; used as the BIG-IP VE highavailability interface network

N/A

VE Network for the 1.2 Inter-face

string Assign a network to the BIG-IP VE 1.2 TMM interface N/A

Name for Network 1.2 string Enter a name for the 1.2 network data1VE Network for the 1.3 Inter-face

string Assign a network to the BIG-IP VE 1.3 TMM interface N/A

Name for Network 1.3 string Enter a name for the 1.3 network data2Default Gateway IP string Enter the Gateway IP address to use for VE instances none

Deployment










Download


Download

3.1.6 F5 BIG-IP VE: Standalone, 2-nic

Overview

This template deploys a standalone, 2-nic F5 BIG-IP VE instance in OpenStack.

Prerequisites





• Two (2) VLANs configured in Neutron – ‘mgmt’ and ‘data’ – to use for system management and data traffic,respectively.

Caveats

• This template requires internet access to fetch dependent Heat templates from GitHub. (These add the necessaryBIG-IP security groups to OpenStack).

• This template deploys an unlicensed BIG-IP VE. Add your BIG-IP license base key when you log in for thefirst time.










Parameter Type Description DefaultStack Name string Provide a name for the stack N/ACreation Timeout inte-

gerLength of time after which stack creation will time out (minutes) N/A



F5 VE Image string Choose a BIG-IP VE image from the dropdown list N/AF5 VE Flavor string Choose a flavor for the BIG-IP VE instance N/AUse Config Drive boolean Use config drive to provide meta and user data FalseF5 Root SSH Key Name string Choose an ssh key-pair; used for authentication to the BIG-IP

VE instanceN/A

External Network string Choose the external network from the list N/AVE Management Net-work

string Assign a Neutron subnet to the management interface on theBIG-IP VE instances

N/A

VE Network for the 1.1Interface

string Assign a Neutron network to the 1.1 interface on the BIG-IP VEinstance

N/A

Name for Network 1.1 string Enter a name for the 1.1 network on the BIG-IP VE instance network-1.1

Default Gateway IP string Enter the Gateway IP address to use for the BIG-IP VE instance none

Deployment


Download


Download

3.1.7 F5 BIG-IP VE: Standalone, 3-nic

Overview

This template deploys standalone, 3-nic F5 BIG-IP VE instance in OpenStack.

Prerequisites





• Two (2) VLANs configured in Neutron – ‘mgmt’ and ‘data’ – to use for system management and data traffic,respectively.





Caveats

• This template requires internet access to fetch dependent Heat templates from GitHub. (These add the necessaryBIG-IP security groups to OpenStack).

• This template deploys an unlicensed BIG-IP VE. Add your BIG-IP license base key when you log in for thefirst time.



Parameter Type Description DefaultStack Name string Provide a name for the stack N/ACreation Timeout inte-


N/A



F5 VE Image string Choose a BIG-IP VE image from the dropdown list N/AF5 VE Flavor string Choose a flavor for the BIG-IP VE instance N/AUse Config Drive boolean Use config drive to provide meta and user data FalseF5 Root SSH Key Name string Choose an ssh key-pair; used for authentication to the BIG-IP

VE instanceN/A

External Network string Choose the external network from the list N/AVE Management Network string Assign a Neutron subnet to the BIG-IP VE management in-

terfaceN/A

VE Network for the 1.1 In-terface

string Assign a Neutron network to the 1.1 interface on the BIG-IPVE instance

N/A


VE Network for the 1.2 In-terface

string Assign a Neutron network to the 1.2 interface on the BIG-IPVE instance

N/A


Default Gateway IP string Enter the Gateway IP address to use for the BIG-IP VE in-stance

none

Deployment


Download


Download








3.2 Unsupported Heat templates

The Heat orchestration templates below are not supported by F5. Use at your own risk.

3.2.1 Unsupported Heat Templates

Warning: Unsupported templates are experimental and should be used AT YOUR OWN RISK.

These templates may be under development by F5 or may have been contributed by other users (non-F5-employees).

F5 will not support templates that are in the unsupported state, regardless of a customer’s support contract status.

F5 plugins

The f5_plugins templates use F5 iApps and Heat templates in tandem to deploy BIG-IP resources in OpenStack.

• iapp_apic_service.yaml

• iapp_client.yaml

• iapp_env.yaml

• iapp_lb_deploy.yaml

• deploy_composite_iapp.yaml

• deploy_composite_iapp_with_get_file_answers.yaml

• pool.yaml

• virtual_server.yaml

Learning stacks

If you’re just starting out with OpenStack Heat, you can use the Learning Stacks template(s) to get an idea of how aHeat stack manages resources.

• ubuntu_classic_stack.yaml

VE

The ve templates prepare BIG-IP Virtual Edition (VE) images for use and launch VE instances in OpenStack.

Common

These templates are primarily used by other Heat templates to compose customized stacks.

• bigip_control_security_group.yaml

• bigip_data_security_group.yaml

• bigip_mgmt_security_group.yaml

• f5_ve_standalone_4_nic.yaml









Standalone

Each of the BIG-IP VE Standalone templates deploys a single VE instance; only the number of data interfaces differs.

• f5_base_instance_deploy_4_nic.yaml







3.2. Unsupported Heat templates 19

CHAPTER 4

Configuration

Each of the F5 Heat orchestration templates accepts a specific set of inputs, as described in the documentation for eachtemplate.1

Note: the unsupported template library includes the following templates that set up the required BIG-IP securitygroups:

• BIG-IP control security group

• BIG-IP data security group

• BIG-IP mgmt security group

1 F5-supported Heat orchestration templates only; unsupported templates are not documented.

21


22 Chapter 4. Configuration

CHAPTER 5

F5 Plugins for OpenStack Heat

Many of the F5-supported Heat templates require the F5 Plugins for OpenStack Heat. See the F5 Heat plugins docu-mentation for installation instructions.

23


f5 orchestration templates for openstack heat documentation · f5 orchestration templates for...

Documents