diff --git a/docs/conf.py b/docs/conf.py index 4824776..9143a07 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,10 +22,6 @@ sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('.')) -from version import OPENSTACK_RELEASE -from version import VERSION - - # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -38,6 +34,7 @@ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', + 'sphinx.ext.doctest', ] # Add any paths that contain templates here, relative to this directory. @@ -64,9 +61,9 @@ # built documents. # # The short X.Y version. -version = '1.0' +version = '7.0' # The full version, including alpha/beta/rc tags. -release = '1.0.1' +release = 'v7.0.1' # OpenStack release openstack_release = "Kilo" @@ -302,4 +299,4 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +# intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/f5-supported-index.rst b/docs/f5-supported-index.rst new file mode 100644 index 0000000..10af634 --- /dev/null +++ b/docs/f5-supported-index.rst @@ -0,0 +1,17 @@ +.. _f5-supported_home: + +F5®-Supported Heat Templates +============================ + +.. include:: ../f5_supported/README.rst + :start-line: 3 + + +The following templates are supported by F5®: + +.. toctree:: + :titlesonly: + :glob: + + templates/supported/* + diff --git a/docs/f5-supported/f5-supported-index.rst b/docs/f5-supported/f5-supported-index.rst deleted file mode 100644 index 2fef6e7..0000000 --- a/docs/f5-supported/f5-supported-index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _f5-supported_home: - -.. toctree:: - :hidden: - :maxdepth: 2 - -F5®-Supported Heat Templates -=========================== - -.. include:: ../../f5_supported/README.rst - :start-line: 3 - diff --git a/docs/how-to_launch-bigip-standalone-2nic.rst b/docs/how-to_launch-bigip-standalone-2nic.rst new file mode 100644 index 0000000..66fc22f --- /dev/null +++ b/docs/how-to_launch-bigip-standalone-2nic.rst @@ -0,0 +1,65 @@ +.. _how-to_launch-standalone-bigip-2nic: + +Launch a Standalone, 2-NIC BIG-IP® VE Using Heat +------------------------------------------------ + +The standalone, 2-nic deployment template uses an existing BIG-IP® VE image to launch and configure a standalone VE. This template requires an external (physical) network and one internal network. The BIG-IP® receives a floating IP address from the external network; traffic from the insternal network passes through the BIG-IP®, allowing `LTM® `_ services to be applied. + +Deploy BIG-IP® VE using the standalone, 2-nic template +`````````````````````````````````````````````````````` + +1. In Horizon, go to :guilabel:`Orchestration` --> :guilabel:`Stacks`. + +2. Click :guilabel:`Launch Stack`. + +3. Choose the :guilabel:`Template File` -- :file:`f5_ve_standalone_3_nics.yaml` -- from its location on your machine, then click :guilabel:`Next`. + + .. note:: + + You will not be able to use the template by entering its GitHub URL because GitHub uses https. You must save the file locally and upload it. + +4. Next, you will need to provide the necessary information for the Heat engine to build your stack. You can use the table below as a worksheet to gather all of the necessary information ahead of time. + + + .. list-table:: Configuration Items + :widths: 30, 30 + :header-rows: 1 + + * - Configuration Item + - Entry/Description + * - Stack Name + - big-ip_ve_standalone_3_nic + * - Creation Timeout (minutes) + - 60 + * - Password for user "admin" + - + * - F5 VE Image + - select the VE image + * - F5 VE Flavor + - select the appropriate flavor (default is m1.medium) + * - F5 FW Root SSH Key Name + - select the appropriate SSH key + * - F5 VE Admin User Password + - assing a password for the VE's admin user + * - F5 VE Root User Password + - assign a password for the VE's root user + * - Primary VE License Base Key + - the license Base Key sent to you by F5 support + * - External Network Name + - select the external network + * - VE Management Network + - select the name of the management network to be used by the VE + * - VE Network for the 1.1 Interface + - select an internal network (e.g., client) + * - VE Network Name for the 1.1 Interface + - enter a name for the network (e.g., 'network-1.1') + * - Default Gateway IP + - enter the IP address of your physical network's default gateway (if applicable) + +5. Click :guilabel:`Launch`. The Heat engine then creates your stack; the status changes to :guilabel:`Create complete` when it is finished. + +Caveats +``````` + +VE images come in 3 different sizes: LTM, ALL, and 1SLOT. Each has its own size requirements; see the F5® OpenStack `BIG-IP® flavor matrix `_ for more information. To create a new image in Horizon, go to :guilabel:`System` --> :guilabel:`Flavors` and click :guilabel:`Create Flavor`. + diff --git a/docs/how-to_launch-bigip-standalone-3nic.rst b/docs/how-to_launch-bigip-standalone-3nic.rst new file mode 100644 index 0000000..c398534 --- /dev/null +++ b/docs/how-to_launch-bigip-standalone-3nic.rst @@ -0,0 +1,83 @@ +.. _how-to_launch-standalone-bigip-3nic: + +Launch a Standalone, 3-NIC BIG-IP® VE Using Heat +------------------------------------------------ + +The standalone, 3-nic deployment template uses an existing BIG-IP® VE image to launch and configure a standalone VE. This template requires an external (physical) network and two internal networks (ours are called 'client' and 'server'). The BIG-IP® receives a floating IP address from the external network; traffic from the client and server networks passes through the BIG-IP®, allowing `LTM® `_ services to be applied. The client and server networks do not need to be able to communicate with each other; they just need to be able to communicate with the BIG-IP®. + +Deploy BIG-IP® VE using the standalone, 3-nic template +`````````````````````````````````````````````````````` + +1. In Horizon, go to :guilabel:`Orchestration` --> :guilabel:`Stacks`. + +2. Click :guilabel:`Launch Stack`. + +3. Choose the :guilabel:`Template File` -- :file:`f5_ve_standalone_3_nics.yaml` -- from its location on your machine, then click :guilabel:`Next`. + + .. note:: + + You will not be able to use the template by entering its GitHub URL because GitHub uses https. You must save the file locally and upload it. + +4. Next, you will need to provide the necessary information for the Heat engine to build your stack. You can use the table below as a worksheet to gather all of the necessary information ahead of time. + + + .. list-table:: Configuration Items + :widths: 30, 30 + :header-rows: 1 + + * - Configuration Item + - Entry/Description + * - Stack Name + - big-ip_ve_standalone_3_nic + * - Creation Timeout (minutes) + - 60 + * - Password for user "admin" + - + * - F5 VE Image + - select the VE image + * - F5 VE Flavor + - select the appropriate flavor (default is m1.medium) + * - F5 FW Root SSH Key Name + - select the appropriate SSH key + * - F5 VE Admin User Password + - + * - F5 VE Root User Password + - + * - Primary VE License Base Key + - the license Base Key sent to you by F5 support + * - External Network Name + - select the external network + * - VE Management Network + - select the name of the management network to be used by the VE + * - VE Network for the 1.1 Interface + - select an internal network (e.g., client) + * - VE Network Name for the 1.1 Interface + - enter a name for the network (e.g., 'network-1.1') + * - VE Network for the 1.2 Interface + - select an internal network (e.g., server) + * - VE Network Name for the 1.2 Interface + - enter a name for the network (e.g., 'network-1.2') + * - Default Gateway IP + - enter the IP address of your physical network's default gateway (if applicable) + +5. Click :guilabel:`Launch`. The Heat engine then creates your stack; the status changes to :guilabel:`Create complete` when it is finished. + +Caveats +``````` + +VE images come in 3 different sizes: LTM, ALL, and 1SLOT. Each has its own size requirements; see the F5® OpenStack `BIG-IP® flavor matrix `_ for more information. To create a new image in Horizon, go to :guilabel:`System` --> :guilabel:`Flavors` and click :guilabel:`Create Flavor`. + + + + +.. the following items are being removed from the template: + * - HTTP proxy Host to use to acquire resources + - ??? + * - HTTP proxy Port to use to acquire resources + - default is 8080 + * - HTTP Proxy Script URL for F5 License Client + - ??? + * - License Activation Host + - ??? + * - License Activation Port + - default is 443 diff --git a/docs/how-to_onboard-ve-image.rst b/docs/how-to_onboard-ve-image.rst new file mode 100644 index 0000000..d2316ac --- /dev/null +++ b/docs/how-to_onboard-ve-image.rst @@ -0,0 +1,76 @@ +.. _how-to_onboard-ve: + +Onboarding a VE Image in OpenStack +---------------------------------- + +In order to use a BIG-IP® VE image in OpenStack, it first has to be made 'OpenStack-ready'. The VE image patch template (:file:`patch_upload_ve_image.yaml`) uses a Ubuntu image as a TMOS VE image onboarding server to convert the image for use in OpenStack. You will need to use an SSH key for authentication. + +.. seealso:: + + :ref:`Add a Ubuntu image to Glance ` + + :ref:`Add an SSH key to Horizon ` + + +Import the VE Image +``````````````````` + +Follow the steps below to launch a Heat stack to import the VE image. Once the VE image appears in :guilabel:`Images`, you can safely delete the stack. + +1. In Horizon, go to :guilabel:`Orchestration` --> :guilabel:`Stacks`. + +2. Click :guilabel:`Launch Stack`. + +3. Choose the :guilabel:`Template File` -- :file:`patch_upload_ve_image.yaml` from its location on your machine, then click :guilabel:`Next`. + + .. note:: + + You will not be able to use the template by entering its GitHub URL because GitHub uses https. You must save the file locally and upload it. + +4. Next, you will need to provide the necessary information for the Heat engine to build your stack. + + .. list-table:: Configuration Items + :widths: 30, 30 + :header-rows: 1 + + * - Configuration Item + - Entry/Description + * - Stack Name + - big-ip_ve_11.6_LTM + * - Creation Timeout (minutes) + - 60 + * - Password for user "admin" + - + * - Onboard Ubuntu Image + - select the image you created + * - F5 Onboard Server Flavor + - default: m1.medium + * - F5 Onboard Server Management Network + - choose any network from the drop-down + * - SSH Key + - select an SSH key pair + * - Keystone Auth URL + - enter your Keystone authentication URL; usually, this uses the same IP address at which you log in to Horizon + * - Image Import Tenant + - the project into which you want to import the VE image; it will be imported into your current project by default + * - Image Import User + - defaults to the user account you are logged in to + * - Image Import User Password + - the password for the user into whose account the image will be imported + * - Image Prep URL + - automatically populated with the URL of the F5 Networks® image prep GitHub repo + * - F5 VE Image URL + - must be a publicly-accessible (i.e., ``http``) URL from which the F5 VE image can be downloaded + * - F5 VE Image Name + - the VE file name (e.g., :file:`BIGIP-11.6.0.6.0.442.qcow2`) + +5. Click :guilabel:`Launch`. + + +The Heat engine will create your stack; the status changes to :guilabel:`Create complete` when it is finished. + +Caveats +``````` + +There is a `known issue `_ with ``python-glanceclient`` that returns in an unspecified error after you click :guilabel:`Launch`. You may need to upgrade in order to resolve this issue. + diff --git a/docs/includes/concept_f5-bigip-ve-templates.rst b/docs/includes/concept_f5-bigip-ve-templates.rst new file mode 100644 index 0000000..1672254 --- /dev/null +++ b/docs/includes/concept_f5-bigip-ve-templates.rst @@ -0,0 +1,21 @@ +.. _ve_home: + +F5® BIG-IP® VE Templates +======================== + +Overview +-------- + +The templates within the VE directory can be used to prepare BIG-IP® Virtual Edition (VE) images for use and to launch VE in OpenStack clouds. + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Image Templates + Plugin Templates + Common Templates + Standalone Templates + + + diff --git a/docs/includes/concept_f5-iapps-plugins.rst b/docs/includes/concept_f5-iapps-plugins.rst new file mode 100644 index 0000000..e006ce1 --- /dev/null +++ b/docs/includes/concept_f5-iapps-plugins.rst @@ -0,0 +1,35 @@ +.. _f5-heat-plugins: + +F5® Heat Plugin Example Templates +================================= + +Before You Start +---------------- + +The ``f5_plugins`` templates require the F5® Heat plugins found in `F5Networks/f5-openstack-heat-plugins `_. See the `project documentation `_ for installation instructions. + +Overview +-------- +The ``f5_plugins`` templates use F5® iApps® and Heat templates in tandem to deploy BIG-IP® resources in OpenStack. F5®'s iApps® contain specific configuration deployments, represented as executable TCL scripts. Each of these scripts is called an iApps® template. + +There are two ways to use F5®'s Heat plugins to deploy iApps® templates. The first, demonstrated in :file:`deploy_composite_iapp.yaml` and :file:`F5::Sys::iAppCompositeTemplate`, combines Heat and iApps® templates to create an iApps® service on a BIG-IP®. + +The second method is a simple dump of the iApp®'s full TCL file into the Heat template, as we've done in :file:`F5::Sys::iAppFullTemplate`. Once the template has been created on the BIG-IP®, it can be executed to create the iApp® Service (``F5::Sys::iAppService``). + +We've provided example templates for each supported F5® plugin. Feel free to browse around the repo (`F5Networks/f5-openstack-heat/unsupported/f5_plugins `_); you can fork the project and tweak the parameters and resources to suit your needs. + + +iApps® APIC Integration Template +-------------------------------- + +This Heat template deploys an iApps® template that can automate and orchestrate Layer 4-7 applications service deployments using F5® BIG-IP®/BIG-IQ® products. Additionally, it can serve as a common integration point for third party SDN/NFV/Automation/Orchestration products. + +There are two major components to this deployment. The iApps® template deploys first, then the Heat template creates the service. When the service is deployed, the Heat template passes in a set of default answers to the choices/questions posed in the APL section of the iApps® template. These answers, which can be in the form of variables, tables, and/or lists, can be altered as needed to suit your needs. + +For more information about this iApp® and its author, please see `appsvcs_integration_iapp `_ on GitHub. + +Heat Composition +---------------- + +These templates are examples of how to perform Heat template composition. This is not the only way to do Heat template composition. Refer to the `Openstack Template Composition ` for more information on this way to compose Heat templates. These are specifically using composition and the F5® Heat plugins to stand up a load-balancing scenario. The client issues a curl request to the virtual IP address, and that request is proxied to the backend pool member. Both the client and the server are created in the template, but the underlying private networks they connect to are not. The other important note is that the VE itself is not created in these templates, we are merely interacting with an existing VE. + diff --git a/docs/includes/concept_learning-stacks.rst b/docs/includes/concept_learning-stacks.rst new file mode 100644 index 0000000..2a54e6b --- /dev/null +++ b/docs/includes/concept_learning-stacks.rst @@ -0,0 +1,7 @@ +Learning Stacks +=============== + +If you are just starting out with orchestration in OpenStack, you can use our Learning Stacks template(s) to get an idea of how a Heat stack manages resources. + +.. include:: concept_ubuntu-classic-stack.rst + diff --git a/docs/unsupported/service-providers_doc.rst b/docs/includes/concept_service-providers.rst similarity index 83% rename from docs/unsupported/service-providers_doc.rst rename to docs/includes/concept_service-providers.rst index 134930c..33ebb6b 100644 --- a/docs/unsupported/service-providers_doc.rst +++ b/docs/includes/concept_service-providers.rst @@ -8,5 +8,5 @@ Service Providers .. toctree:: :titlesonly: - sp-gi-simplify + concept_sp-gi-simplify diff --git a/docs/unsupported/sp-gi-simplify.rst b/docs/includes/concept_sp-gi-simplify.rst similarity index 100% rename from docs/unsupported/sp-gi-simplify.rst rename to docs/includes/concept_sp-gi-simplify.rst diff --git a/unsupported/learning_stacks/ubuntu_classic_stack.rst b/docs/includes/concept_ubuntu-classic-stack.rst similarity index 64% rename from unsupported/learning_stacks/ubuntu_classic_stack.rst rename to docs/includes/concept_ubuntu-classic-stack.rst index 11c457b..6fac1f2 100644 --- a/unsupported/learning_stacks/ubuntu_classic_stack.rst +++ b/docs/includes/concept_ubuntu-classic-stack.rst @@ -1,3 +1,7 @@ +.. toctree:: + :maxdepth: 2 + + Ubuntu Classic Stack ==================== @@ -14,4 +18,4 @@ Multi-homing ------------ All instances in this stack are multi-homed. This is important to know because default Ubuntu cloud images for 14.04 do not support multiple nics out of the box. You can solve these problems by referring to this `cloudify blog `_ regarding a multi-homed instance in OpenStack. -We have solved this problem by using `ifplugd `_, a service baked into the image that waits for any and all interfaces to be hotplugged. Cloud-init creates the port on the OpenStack side for this instance to connect to the additional networks and configures the ethernet devices to be available on the instance. It does not, however, bring up the additional interfaces. That's the job of ``ifplugd``, or of your startup script and whatever you choose to use. +We have solved this problem by using `ifplugd `_, a service baked into the image that waits for any and all interfaces to be hotplugged. Cloud-init creates the port on the OpenStack side for this instance to connect to the additional networks and configures the ethernet devices to be available on the instance. It does not, however, bring up the additional interfaces. That's the job of ``ifplugd``, or of your startup script and whatever you choose to use. diff --git a/unsupported/ve/common/common_templates.rst b/docs/includes/concept_ve-common.rst similarity index 98% rename from unsupported/ve/common/common_templates.rst rename to docs/includes/concept_ve-common.rst index d01900f..1f82641 100644 --- a/unsupported/ve/common/common_templates.rst +++ b/docs/includes/concept_ve-common.rst @@ -1,3 +1,5 @@ +.. _ve-common: + BIG-IP® VE Common Template Resources ==================================== @@ -33,3 +35,5 @@ The templates here named :file:`f5_ve_standalone_*_nic.yaml` contain the ``OS::N .. warning:: Do not modify these templates unless you've had experience both with Heat and complex network configurations. + + diff --git a/unsupported/ve/images/images.rst b/docs/includes/concept_ve-images.rst similarity index 100% rename from unsupported/ve/images/images.rst rename to docs/includes/concept_ve-images.rst diff --git a/unsupported/ve/standalone/standalone.rst b/docs/includes/concept_ve-standalone.rst similarity index 98% rename from unsupported/ve/standalone/standalone.rst rename to docs/includes/concept_ve-standalone.rst index 43ab180..e4048d6 100644 --- a/unsupported/ve/standalone/standalone.rst +++ b/docs/includes/concept_ve-standalone.rst @@ -1,3 +1,5 @@ +.. _ve-standalone: + BIG-IP® VE Standalone Templates =============================== @@ -22,4 +24,3 @@ The standalone templates utilize the same configuration settings as those in the * The outputs of these templates give you a programmatic way to retrieve details about the VE. - diff --git a/docs/includes/topic_add-ssh-key-horizon.rst b/docs/includes/topic_add-ssh-key-horizon.rst new file mode 100644 index 0000000..183950d --- /dev/null +++ b/docs/includes/topic_add-ssh-key-horizon.rst @@ -0,0 +1,14 @@ +.. _add-ssh-key-horizon: + +Add an SSH key to Horizon +````````````````````````` + +1. Go to :guilabel:`Compute` --> :guilabel:`Access & Security`. + +2. Click on :guilabel:`Key Pairs`. + +3. Click :guilabel:`Import Key Pair`. + +4. Give the key pair a name, and paste the public key from an existing key pair into the :guilabel:`Public Key` field. + +5. Click :guilabel:`Import`. diff --git a/docs/includes/topic_add-ubuntu-image-glance.rst b/docs/includes/topic_add-ubuntu-image-glance.rst new file mode 100644 index 0000000..cc10fec --- /dev/null +++ b/docs/includes/topic_add-ubuntu-image-glance.rst @@ -0,0 +1,16 @@ +.. _add-ubuntu-image-glance: + +Add a Ubuntu image to Glance +```````````````````````````` + +If you don't already have a Ubuntu image in your OpenStack environment, you'll need to add one to Glance before you can use the template. + +1. Copy the download URL for the Ubuntu Cloud server image of your choice. We used `trusty-server-cloudimg-amd64-disk1.img `_. + +2. Add the image to Glance: + + - In Horizon, go to :guilabel:`Compute` --> :guilabel:`Images`. + - Click :guilabel:`Create Image` and paste the image URL in the :guilabel:`Image Location` field. + - Enter the requested information, including the minimum requirements for your image (we used 7GB disk and 520MB RAM). + - Click :guilabel:`Create` to add the image to Glance. + diff --git a/docs/includes/topic_overview-full.rst b/docs/includes/topic_overview-full.rst new file mode 100644 index 0000000..110f6fb --- /dev/null +++ b/docs/includes/topic_overview-full.rst @@ -0,0 +1,12 @@ +Overview +-------- + +This guide demonstrates how to use the `OpenStack Heat `_ orchestration service to onboard and deploy F5® BIG-IP® Virtual Edition (VE) in OpenStack. + +The templates covered in this guide are: + +- :file:`patch_upload_ve_image.yaml`: makes a VE image OpenStack-ready. + +- :file:`f5_ve_standalone_3_nic`: deploys a standard standalone BIG-IP® VE that processes application traffic and sends it to a server pool on the BIG-IP®'s internal network. + +For both templates, we will work in the OpenStack `Horizon `_ dashboard (aka, the GUI). You will need to log in as a user with admin permissions. diff --git a/docs/includes/topic_overview.rst b/docs/includes/topic_overview.rst new file mode 100644 index 0000000..c4e0faf --- /dev/null +++ b/docs/includes/topic_overview.rst @@ -0,0 +1,5 @@ +Overview +-------- + +This guide demonstrates how to use the `OpenStack Heat `_ orchestration service to onboard and deploy F5® BIG-IP® Virtual Edition (VE) in OpenStack. + diff --git a/docs/includes/topic_release-info.rst b/docs/includes/topic_release-info.rst new file mode 100644 index 0000000..0f31c98 --- /dev/null +++ b/docs/includes/topic_release-info.rst @@ -0,0 +1,34 @@ +.. _topic_release-info: + +Release +------- + +The current release of the F5® Heat templates, |release|, is compatible with OpenStack |openstack|. See the `F5® OpenStack Releases, Versioning, and Support matrix `_ for more information, including BIG-IP® version compatibility. + +Summary +------- + +Release |release| adds support for three Heat templates: + +* f5_supported/ve/images/patch_upload_ve_image.yaml -- prepares a user-supplied BIG-IP® VE image for booting in Openstack +* f5_supported/ve/standalone/f5_ve_standalone_2_nic.yaml -- boots a prepared VE image attached to a single management network and a single data network +* f5_supported/ve/standalone/f5_ve_standalone_3_nic.yaml -- boots a prepared VE image attached to a single management network and two data networks (i.e., client and server networks) + +Please see the :ref:`User Guide ` for usage instructions. + +Release Highlights +------------------ + +* Each template contains a 'description' section which indicates its basic usage. +* The 'parameters' section of each template indicates what prerequisite resources are needed to launch that particular template. + +Caveats +------- + +* The security groups being used by the standalone templates have not yet been promoted to supported. +* There is a `known issue `_ with ``python-glanceclient`` that returns an unspecified error after you launch a stack. You may need to upgrade in order to resolve this issue. + +Open Issues +----------- + +See the [project issues page](https://github.com/F5Networks/f5-openstack-heat/issues) for a full list of open issues. diff --git a/docs/includes/topic_user-guide-before-you-begin.rst b/docs/includes/topic_user-guide-before-you-begin.rst new file mode 100644 index 0000000..5282c7e --- /dev/null +++ b/docs/includes/topic_user-guide-before-you-begin.rst @@ -0,0 +1,37 @@ +.. _topic_before-you-begin: + +Before You Begin +---------------- + +You will need the following in order to use this guide: + +* A functional OpenStack |openstack| deployment with at least one controller node; a physical external network; a client network; and a server network. + + Unsure how to get started with OpenStack? See the F5® OpenStack `Deployment Guide `_ and `Configuration Guide `_. + +* A BIG-IP® VE image, v11.5.2 or later. This guide uses BIG-IP® VE 11.6.0 LTM (image filename: :file:`BIGIP-11.6.0.6.0.442.LTM.qcow2.zip`). + + `Buy from f5.com `_ + +* The F5® Heat plugins. These create the BIG-IP® objects used by both Heat and iApp® templates to provision BIG-IP® LTM® resources in OpenStack. + + See the `F5® Heat Plugins `_ documentation for installation instructions. + +* F5® Heat templates: + + We strongly recommend that you `fork this repo `_ and clone it locally. This will give you access to all of the latest F5® Heat templates, as well as make it easy for you to customize them to suit your needs. An alternative is to download the latest `release package `_. + + .. code-block:: shell + + $ curl -O -L https://github.com/F5Networks/f5-openstack-heat@v7.0.1 + + At minimum, you can download the templates used in this guide: + + :download:`patch_upload_ve_image.yaml <../../f5_supported/ve/images/patch_upload_ve_image.yaml>` + + :download:`f5_ve_standalone_3_nic.yaml <../../f5_supported/ve/standalone/f5_ve_standalone_3_nic.yaml>` + + + + + diff --git a/docs/index.rst b/docs/index.rst index 46148ff..727afcc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,11 +9,13 @@ F5 Networks® OpenStack Heat Template Library :hidden: :maxdepth: 2 - f5-supported/f5-supported-index - unsupported/unsupported-index + User Guide + F5® Supported Templates + Unsupported Templates + +Overview +-------- -Introduction ------------- The F5® OpenStack Heat template library contains templates that can be used to deploy and/or configure F5® BIG-IP® in an OpenStack cloud. The library contains two groups of templates: @@ -23,25 +25,26 @@ The library contains two groups of templates: Releases and Versions --------------------- -Release v |release| supports the OpenStack |openstack| release. +Release |release| supports the OpenStack |openstack| release. For more information regarding releases and versioning, please see the `Release, Versioning, and Support Matrix `_. -.. include:: ../f5_supported/README.rst - -.. include:: ../unsupported/README.rst - Installation & Configuration ---------------------------- + Any of F5®'s Heat templates can be downloaded, copied, and/or modified as needed to deploy resources in OpenStack. -Heat templates can be loaded via the OpenStack Horizon GUI, the Heat command line, or API. Please see the `OpenStack Heat documentation `_ for usage instructions. +Heat templates can be loaded via the OpenStack Horizon GUI, the Heat command line, or API. Please see the `OpenStack Heat documentation `_ for instructions. .. note:: Many of the templates require the F5® Heat plugins to be installed. Please see the `documentation `_ for instructions. +* :ref:`How To: Onboard a VE Image Using Heat ` +* :ref:`How To: Launch a 2-NIC, Standalone VE Using Heat ` +* :ref:`How To: Launch a 3-NIC, Standalone VE Using Heat ` + Copyright --------- diff --git a/docs/map_heat-user-guide.rst b/docs/map_heat-user-guide.rst new file mode 100644 index 0000000..eb52d64 --- /dev/null +++ b/docs/map_heat-user-guide.rst @@ -0,0 +1,17 @@ +.. _heat-user-guide: + +User Guide: Deploying BIG-IP® VE using Heat +=========================================== + +.. include:: includes/topic_overview.rst + :start-line: 3 + +.. toctree:: + :titlesonly: + + includes/topic_overview-full.rst + includes/topic_release-info + includes/topic_user-guide-before-you-begin + how-to_onboard-ve-image + how-to_launch-bigip-standalone-3nic + diff --git a/docs/templates/supported/ref_common_f5-ve-standalone-2nic.rst b/docs/templates/supported/ref_common_f5-ve-standalone-2nic.rst new file mode 100644 index 0000000..65d194e --- /dev/null +++ b/docs/templates/supported/ref_common_f5-ve-standalone-2nic.rst @@ -0,0 +1,8 @@ +F5 VE Standalone 2-nic +====================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../f5_supported/ve/standalone/f5_ve_standalone_2_nic.yaml>` + +.. literalinclude:: ../../../f5_supported/ve/standalone/f5_ve_standalone_2_nic.yaml diff --git a/docs/templates/supported/ref_common_f5-ve-standalone-3nic.rst b/docs/templates/supported/ref_common_f5-ve-standalone-3nic.rst new file mode 100644 index 0000000..fb21d2b --- /dev/null +++ b/docs/templates/supported/ref_common_f5-ve-standalone-3nic.rst @@ -0,0 +1,9 @@ +F5 VE Standalone 3-nic +====================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../f5_supported/ve/standalone/f5_ve_standalone_3_nic.yaml>` + +.. literalinclude:: ../../../f5_supported/ve/standalone/f5_ve_standalone_3_nic.yaml + diff --git a/docs/templates/supported/ref_images_patch-upload-ve-image.rst b/docs/templates/supported/ref_images_patch-upload-ve-image.rst new file mode 100644 index 0000000..422bbf8 --- /dev/null +++ b/docs/templates/supported/ref_images_patch-upload-ve-image.rst @@ -0,0 +1,8 @@ +F5 VE Image Patch Upload +======================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../f5_supported/ve/images/patch_upload_ve_image.yaml>` + +.. literalinclude:: ../../../f5_supported/ve/images/patch_upload_ve_image.yaml diff --git a/docs/templates/unsupported/ref_common_bigip-control-security-group.rst b/docs/templates/unsupported/ref_common_bigip-control-security-group.rst new file mode 100644 index 0000000..3fd63cc --- /dev/null +++ b/docs/templates/unsupported/ref_common_bigip-control-security-group.rst @@ -0,0 +1,8 @@ +BIG-IP Control Security Group +============================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/bigip_control_security_group.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/bigip_control_security_group.yaml diff --git a/docs/templates/unsupported/ref_common_bigip-data-security-group.rst b/docs/templates/unsupported/ref_common_bigip-data-security-group.rst new file mode 100644 index 0000000..b43f571 --- /dev/null +++ b/docs/templates/unsupported/ref_common_bigip-data-security-group.rst @@ -0,0 +1,8 @@ +BIG-IP Data Security Group +========================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/bigip_data_security_group.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/bigip_data_security_group.yaml \ No newline at end of file diff --git a/docs/templates/unsupported/ref_common_bigip-mgmt-security-group.rst b/docs/templates/unsupported/ref_common_bigip-mgmt-security-group.rst new file mode 100644 index 0000000..d7efbf7 --- /dev/null +++ b/docs/templates/unsupported/ref_common_bigip-mgmt-security-group.rst @@ -0,0 +1,8 @@ +BIG-IP Management Security Group +================================ + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/bigip_mgmt_security_group.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/bigip_mgmt_security_group.yaml \ No newline at end of file diff --git a/docs/templates/unsupported/ref_common_f5-ve-standalone-10nic.rst b/docs/templates/unsupported/ref_common_f5-ve-standalone-10nic.rst new file mode 100644 index 0000000..32a4bba --- /dev/null +++ b/docs/templates/unsupported/ref_common_f5-ve-standalone-10nic.rst @@ -0,0 +1,8 @@ +Standalone Deployment - 10-nic +============================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/f5_ve_standalone_10_nic.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/f5_ve_standalone_10_nic.yaml diff --git a/docs/templates/unsupported/ref_common_f5-ve-standalone-4nic.rst b/docs/templates/unsupported/ref_common_f5-ve-standalone-4nic.rst new file mode 100644 index 0000000..4b35ff9 --- /dev/null +++ b/docs/templates/unsupported/ref_common_f5-ve-standalone-4nic.rst @@ -0,0 +1,8 @@ +Standalone Deployment - 4-nic +============================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/f5_ve_standalone_4_nic.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/f5_ve_standalone_4_nic.yaml diff --git a/docs/templates/unsupported/ref_common_f5-ve-standalone-5nic.rst b/docs/templates/unsupported/ref_common_f5-ve-standalone-5nic.rst new file mode 100644 index 0000000..044ca6c --- /dev/null +++ b/docs/templates/unsupported/ref_common_f5-ve-standalone-5nic.rst @@ -0,0 +1,8 @@ +Standalone Deployment - 5-nic +============================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/f5_ve_standalone_5_nic.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/f5_ve_standalone_5_nic.yaml \ No newline at end of file diff --git a/docs/templates/unsupported/ref_common_f5-ve-standalone-6nic.rst b/docs/templates/unsupported/ref_common_f5-ve-standalone-6nic.rst new file mode 100644 index 0000000..fd752ec --- /dev/null +++ b/docs/templates/unsupported/ref_common_f5-ve-standalone-6nic.rst @@ -0,0 +1,8 @@ +Standalone Deployment - 6-nic +============================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/f5_ve_standalone_6_nic.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/f5_ve_standalone_6_nic.yaml \ No newline at end of file diff --git a/docs/templates/unsupported/ref_common_f5-ve-standalone-7nic.rst b/docs/templates/unsupported/ref_common_f5-ve-standalone-7nic.rst new file mode 100644 index 0000000..1579c56 --- /dev/null +++ b/docs/templates/unsupported/ref_common_f5-ve-standalone-7nic.rst @@ -0,0 +1,8 @@ +Standalone Deployment - 7-nic +============================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/f5_ve_standalone_7_nic.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/f5_ve_standalone_7_nic.yaml \ No newline at end of file diff --git a/docs/templates/unsupported/ref_common_f5-ve-standalone-8nic.rst b/docs/templates/unsupported/ref_common_f5-ve-standalone-8nic.rst new file mode 100644 index 0000000..443e3f1 --- /dev/null +++ b/docs/templates/unsupported/ref_common_f5-ve-standalone-8nic.rst @@ -0,0 +1,8 @@ +Standalone Deployment - 8-nic +============================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/f5_ve_standalone_8_nic.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/f5_ve_standalone_8_nic.yaml \ No newline at end of file diff --git a/docs/templates/unsupported/ref_common_f5-ve-standalone-9nic.rst b/docs/templates/unsupported/ref_common_f5-ve-standalone-9nic.rst new file mode 100644 index 0000000..5af1fdd --- /dev/null +++ b/docs/templates/unsupported/ref_common_f5-ve-standalone-9nic.rst @@ -0,0 +1,8 @@ +Standalone Deployment - 9-nic +============================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/ve/common/f5_ve_standalone_9_nic.yaml>` + +.. literalinclude:: ../../../unsupported/ve/common/f5_ve_standalone_9_nic.yaml diff --git a/docs/templates/unsupported/ref_f5plugins_deploy-composite-iapp-get-file-answers.rst b/docs/templates/unsupported/ref_f5plugins_deploy-composite-iapp-get-file-answers.rst new file mode 100644 index 0000000..15e89e3 --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_deploy-composite-iapp-get-file-answers.rst @@ -0,0 +1,9 @@ +Deploy iApp Using Answers File +============================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/deploy_composite_iapp_with_get_file_answers.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/deploy_composite_iapp_with_get_file_answers.yaml + diff --git a/docs/templates/unsupported/ref_f5plugins_deploy-composite-iapp.rst b/docs/templates/unsupported/ref_f5plugins_deploy-composite-iapp.rst new file mode 100644 index 0000000..b95ecbb --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_deploy-composite-iapp.rst @@ -0,0 +1,8 @@ +Deploy Composite iApp +===================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/deploy_composite_iapp.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/deploy_composite_iapp.yaml diff --git a/docs/templates/unsupported/ref_f5plugins_deploy-lb.rst b/docs/templates/unsupported/ref_f5plugins_deploy-lb.rst new file mode 100644 index 0000000..09dd2c4 --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_deploy-lb.rst @@ -0,0 +1,8 @@ +Deploy Load Balancing +===================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/deploy_lb.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/deploy_lb.yaml diff --git a/docs/templates/unsupported/ref_f5plugins_iapp-apic-service.rst b/docs/templates/unsupported/ref_f5plugins_iapp-apic-service.rst new file mode 100644 index 0000000..44e9d9c --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_iapp-apic-service.rst @@ -0,0 +1,8 @@ +Deploy iApp and Service +======================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/apic_iapp/iapp_apic_service.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/apic_iapp/iapp_apic_service.yaml diff --git a/docs/templates/unsupported/ref_f5plugins_iapp-client.rst b/docs/templates/unsupported/ref_f5plugins_iapp-client.rst new file mode 100644 index 0000000..c75c607 --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_iapp-client.rst @@ -0,0 +1,8 @@ +Deploy iApp - Client +==================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/heat_composition/iapp_client.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/heat_composition/iapp_client.yaml diff --git a/docs/templates/unsupported/ref_f5plugins_iapp-env.rst b/docs/templates/unsupported/ref_f5plugins_iapp-env.rst new file mode 100644 index 0000000..7d68b60 --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_iapp-env.rst @@ -0,0 +1,8 @@ +Deploy iApp - Environment +========================= + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/heat_composition/iapp_env.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/heat_composition/iapp_env.yaml diff --git a/docs/templates/unsupported/ref_f5plugins_iapp-lb-deploy.rst b/docs/templates/unsupported/ref_f5plugins_iapp-lb-deploy.rst new file mode 100644 index 0000000..92be579 --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_iapp-lb-deploy.rst @@ -0,0 +1,8 @@ +Deploy iApp - Load Balancing +============================ + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/heat_composition/iapp_lb_deploy.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/heat_composition/iapp_lb_deploy.yaml diff --git a/docs/templates/unsupported/ref_f5plugins_pool.rst b/docs/templates/unsupported/ref_f5plugins_pool.rst new file mode 100644 index 0000000..0f1cfb7 --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_pool.rst @@ -0,0 +1,8 @@ +Deploy Pool +=========== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/pool.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/pool.yaml diff --git a/docs/templates/unsupported/ref_f5plugins_virtual-server.rst b/docs/templates/unsupported/ref_f5plugins_virtual-server.rst new file mode 100644 index 0000000..06787be --- /dev/null +++ b/docs/templates/unsupported/ref_f5plugins_virtual-server.rst @@ -0,0 +1,8 @@ +Deploy Virtual Server +===================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/f5_plugins/virtual_server.yaml>` + +.. literalinclude:: ../../../unsupported/f5_plugins/virtual_server.yaml diff --git a/docs/templates/unsupported/ref_learning_ubuntu-classic.rst b/docs/templates/unsupported/ref_learning_ubuntu-classic.rst new file mode 100644 index 0000000..a580eb9 --- /dev/null +++ b/docs/templates/unsupported/ref_learning_ubuntu-classic.rst @@ -0,0 +1,8 @@ +Deploy Ubuntu Classic Stack +=========================== + +Download the template via the link below, or copy and paste the text into a new file (must be saved as ``.yaml``. + +:download:`Download <../../../unsupported/learning_stacks/ubuntu_classic_stack.yaml>` + +.. literalinclude:: ../../../unsupported/learning_stacks/ubuntu_classic_stack.yaml diff --git a/docs/unsupported-index.rst b/docs/unsupported-index.rst new file mode 100644 index 0000000..74c7aec --- /dev/null +++ b/docs/unsupported-index.rst @@ -0,0 +1,17 @@ +.. _unsupported_home: + +Unsupported Heat Templates +========================== + +.. include:: ../unsupported/README.rst + :start-line: 3 + +The following templates are currently unsupported: + +.. toctree:: + :titlesonly: + :glob: + + templates/unsupported/* + + diff --git a/docs/unsupported/apic-iapp.rst b/docs/unsupported/apic-iapp.rst deleted file mode 100644 index 6541e64..0000000 --- a/docs/unsupported/apic-iapp.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. toctree:: - :maxdepth: 1 - - -iApps® APIC Integration Template -================================ - -.. include:: ../../unsupported/f5_plugins/apic_iapp/apic_iapp.rst - :start-line: 6 - diff --git a/docs/unsupported/f5-bigip-ve_doc.rst b/docs/unsupported/f5-bigip-ve_doc.rst deleted file mode 100644 index 5622699..0000000 --- a/docs/unsupported/f5-bigip-ve_doc.rst +++ /dev/null @@ -1,24 +0,0 @@ -F5® BIG-IP® VE Templates -======================== - -Overview --------- - -We have four sets of Heat templates that can be used with BIG-IP® VE: - - - OpenStack-Ready BIG-IP® VE Image Templates: prepare a standard VE image for use in OpenStack. - - F5® Plugins Templates: can be used with external resources (such as F5® iApps® templates) to deploy specific configurations. - - BIG-IP® VE Common Template Resources, which contain common configurations that can be used by other templates to compose customized stacks. - - BIG-IP® VE Standalone Templates, which deploy a single (or, 'standalone') VE instance. - -.. toctree:: - :titlesonly: - :maxdepth: 1 - - Image Templates - Plugin Templates - Common Templates - Standalone Templates - - - diff --git a/docs/unsupported/f5-iapps-plugins_doc.rst b/docs/unsupported/f5-iapps-plugins_doc.rst deleted file mode 100644 index b7c5144..0000000 --- a/docs/unsupported/f5-iapps-plugins_doc.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _f5-plugins: - -F5® iApps® Plugins -================== - -.. include:: ../../unsupported/f5_plugins/README.rst - :start-line: 3 - -.. toctree:: - :titlesonly: - :glob: - - f5_plugins/* - diff --git a/docs/unsupported/learning-stacks_doc.rst b/docs/unsupported/learning-stacks_doc.rst deleted file mode 100644 index 9742523..0000000 --- a/docs/unsupported/learning-stacks_doc.rst +++ /dev/null @@ -1,12 +0,0 @@ -Learning Stacks -=============== - -.. include:: ../../unsupported/learning_stacks/README.rst - :start-line: 3 - -.. toctree:: - :titlesonly: - - ubuntu-classic-stack - - diff --git a/docs/unsupported/ubuntu-classic-stack.rst b/docs/unsupported/ubuntu-classic-stack.rst deleted file mode 100644 index 8cf7d62..0000000 --- a/docs/unsupported/ubuntu-classic-stack.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. toctree:: - :maxdepth: 2 - - -Ubuntu Classic Stack -==================== - -.. include:: ../../unsupported/learning_stacks/ubuntu_classic_stack.rst - :start-line: 2 \ No newline at end of file diff --git a/docs/unsupported/unsupported-index.rst b/docs/unsupported/unsupported-index.rst deleted file mode 100644 index 4cec166..0000000 --- a/docs/unsupported/unsupported-index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _unsupported_home: - -.. toctree:: - :hidden: - :titlesonly: - :maxdepth: 1 - - -Unsupported Heat Templates -========================== - -.. include:: ../../unsupported/README.rst - :start-line: 3 - -.. toctree:: - - Learning Stacks - F5® iApps® Plugins - F5® BIG-IP® VE - Service Providers - - - - - diff --git a/docs/unsupported/ve-common.rst b/docs/unsupported/ve-common.rst deleted file mode 100644 index dc12ce8..0000000 --- a/docs/unsupported/ve-common.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. _ve-common: - -.. include:: ../../unsupported/ve/common/common_templates.rst diff --git a/docs/unsupported/ve-images.rst b/docs/unsupported/ve-images.rst deleted file mode 100644 index 769f963..0000000 --- a/docs/unsupported/ve-images.rst +++ /dev/null @@ -1,11 +0,0 @@ - - -.. _ve-images: - -.. include:: ../../unsupported/ve/images/images.rst - -.. toctree:: - :maxdepth: 1 - :glob: - - ../../unsupported/ve/images/* \ No newline at end of file diff --git a/docs/unsupported/ve-standalone.rst b/docs/unsupported/ve-standalone.rst deleted file mode 100644 index 9712a44..0000000 --- a/docs/unsupported/ve-standalone.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. _ve-standalone: - -.. include:: ../../unsupported/ve/standalone/standalone.rst diff --git a/f5_supported/ve/images/README.rst b/f5_supported/ve/images/README.rst new file mode 100644 index 0000000..3490f26 --- /dev/null +++ b/f5_supported/ve/images/README.rst @@ -0,0 +1,9 @@ +OpenStack-Ready BIG-IP® VE Images +================================= + +Overview +-------- +The BIG-IP® VE 'OpenStack-Ready' image template makes a BIG-IP® VE image ready for use in OpenStack. + +See the `project documentation `_ for more information. + diff --git a/f5_supported/ve/images/patch_upload_ve_image.yaml b/f5_supported/ve/images/patch_upload_ve_image.yaml index f66a1d2..8a13f57 100644 --- a/f5_supported/ve/images/patch_upload_ve_image.yaml +++ b/f5_supported/ve/images/patch_upload_ve_image.yaml @@ -69,7 +69,7 @@ parameters: apt_cache_proxy_url: type: string label: Apt-cache URL - description: URL for local apt-cahce proxy + description: URL for local apt-cache proxy default: None parameter_groups: diff --git a/f5_supported/ve/standalone/README.rst b/f5_supported/ve/standalone/README.rst new file mode 100644 index 0000000..4e64f84 --- /dev/null +++ b/f5_supported/ve/standalone/README.rst @@ -0,0 +1,6 @@ +BIG-IP® VE Standalone Templates +=============================== + +The templates in this directory can be used to deploy varying configurations of standalone BIG-IP® Virtual Editions (VE). + +See the `project documentation `_ for more information. diff --git a/unsupported/f5_plugins/README.rst b/unsupported/f5_plugins/README.rst index cb3a9d6..6a64f5c 100644 --- a/unsupported/f5_plugins/README.rst +++ b/unsupported/f5_plugins/README.rst @@ -1,18 +1,8 @@ F5® Heat Plugin Example Templates -================================ - -Before You Start ----------------- - -The f5_plugins templates require the F5® Heat plugins found in `F5Networks/f5-openstack-heat-plugins `_. The repo's readme contains instructions for deploying the plugins in your own OpenStack. +================================= Overview -------- -The f5_plugins templates demonstrate using F5® iApps® and Heat templates in tandem to deploy resources in OpenStack. F5®'s iApps® contain specific configuration deployments, represented as executable TCL scripts. Each of these scripts is called an iApps® template. - -There are two ways to use F5®'s Heat plugins to deploy iApps® templates. The first is demonstrated in :file:`deploy_composite_iapp.yaml` / :file:`F5::Sys::iAppCompositeTemplate`. This combination of Heat and iApps templates uses an ``F5::Sys::iAppCompositeTemplate`` and ``F5::Sys::iAppService`` Heat resource to create an iApps® service on the BIG-IP®. - -The second method is a simple dump of the iApp®'s full TCL file into the Heat template, as we've done in :file:`F5::Sys::iAppFullTemplate`. Once the template has been created on the BIG-IP®, it can be executed to create the iApp® Service (``F5::Sys::iAppService``). -We've provided example templates for each supported F5® plugin. Feel free to browse around the repo (`F5Networks/f5-openstack-heat/unsupported/f5_plugins `_); you can fork the project and tweak the parameters and resources to suit your needs. +The ``f5_plugins`` templates use F5® iApps® and Heat templates in tandem to deploy BIG-IP® resources in OpenStack. See the `project documentation `_ for more information. diff --git a/unsupported/f5_plugins/apic_iapp/apic_iapp.rst b/unsupported/f5_plugins/apic_iapp/apic_iapp.rst deleted file mode 100644 index 5be4e98..0000000 --- a/unsupported/f5_plugins/apic_iapp/apic_iapp.rst +++ /dev/null @@ -1,10 +0,0 @@ -iApps® APIC Integration Template -================================ - -Overview --------- -This Heat template deploys an iApps® template that can automate and orchestrate Layer 4-7 applications service deployments using F5® BIG-IP®/BIG-IQ® products. Additionally, it can serve as a common integration point for third party SDN/NFV/Automation/Orchestration products. - -There are two major components to this deployment. The iApps® template deploys first, then the Heat template creates the service. When the service is deployed, the Heat template passes in a set of default answers to the choices/questions posed in the APL section of the iApps® template. These answers, which can be in the form of variables, tables, and/or lists, can be altered as needed to suit your needs. - -For more information about this iApp® and its author, please see `appsvcs_integration_iapp `_ on GitHub. diff --git a/unsupported/f5_plugins/heat_composition/heat_composition.rst b/unsupported/f5_plugins/heat_composition/heat_composition.rst deleted file mode 100644 index 7dd4639..0000000 --- a/unsupported/f5_plugins/heat_composition/heat_composition.rst +++ /dev/null @@ -1,6 +0,0 @@ -Heat Composition -================ - -Description ------------ -The templates within offer examples of how to perform Heat template composition. This is not the only way to do Heat template composition. Refer to the `Openstack Template Composition ` for more information on this way to compose Heat templates. These are specifically using composition and the F5® Heat plugins to stand up a load-balancing scenario. The client issues a curl request to the virtual IP address, and that request is proxied to the backend pool member. Both the client and the server are created in the template, but the underlying private networks they connect to are not. The other important note is that the VE itself is not created in these templates, we are merely interacting with an existing VE. diff --git a/unsupported/learning_stacks/README.rst b/unsupported/learning_stacks/README.rst index c541847..7e47f8f 100644 --- a/unsupported/learning_stacks/README.rst +++ b/unsupported/learning_stacks/README.rst @@ -1,9 +1,8 @@ Learning Stacks =============== -Overview --------- -If you are just starting out with orchestration in OpenStack, you can use our Learning Stacks template(s) to get an idea of how a Heat stack manages resources. +If you are just starting out with orchestration in OpenStack, you can use our Learning Stacks template(s) to get an idea of how a Heat stack manages resources. See the `project documentation `_ for more information. + diff --git a/unsupported/ve/README.rst b/unsupported/ve/README.rst index 882b448..8cd3fad 100644 --- a/unsupported/ve/README.rst +++ b/unsupported/ve/README.rst @@ -3,12 +3,7 @@ VE Templates ============ -Overview --------- - The templates within the VE directory can be used to prepare BIG-IP® Virtual Edition (VE) images for use and to launch VE in OpenStack clouds. -Before you can launch a VE in OpenStack, the image must be converted to make it 'OpenStack-Ready'. We've created templates in the 'images' directory which do just that. The operation is done via a heat stack with an onboarding server. For further details, see :ref:`Images `. - -The ``/common`` and ``/standalone`` directories contain templates via which you can launch different configurations of one or more VEs. There are templates to launch a six-armed VE (that is, six data interfaces) and other for a two-armed deployment. The input paramaters included for each should be enough to get started and customize the deployment to meet your needs. +See the `project documentation `_ for more information. diff --git a/unsupported/ve/common/README.rst b/unsupported/ve/common/README.rst new file mode 100644 index 0000000..5a722ed --- /dev/null +++ b/unsupported/ve/common/README.rst @@ -0,0 +1,6 @@ +BIG-IP® VE Common Template Resources +==================================== + +The templates in this directory are often used by other templates to compose a customized stack. + +See the `project documentation `_ for more information. diff --git a/unsupported/ve/images/README.rst b/unsupported/ve/images/README.rst new file mode 100644 index 0000000..54dbf05 --- /dev/null +++ b/unsupported/ve/images/README.rst @@ -0,0 +1,7 @@ +OpenStack-Ready BIG-IP® VE Images +================================= + +The BIG-IP® VE 'OpenStack-Ready' image template makes a BIG-IP® VE image ready for use in OpenStack. + +See the `project documentation `_ for more information. + diff --git a/unsupported/ve/standalone/README.rst b/unsupported/ve/standalone/README.rst new file mode 100644 index 0000000..780d4d5 --- /dev/null +++ b/unsupported/ve/standalone/README.rst @@ -0,0 +1,6 @@ +BIG-IP® VE Standalone Templates +=============================== + +The BIG-IP® VE Standalone templates deploy a single VE instance, with variations on the number of desired data interfaces. + +See the `project documentation `_ for more information. \ No newline at end of file