Dev

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.12"
+ # You can also specify other tool versions:
+ # nodejs: "19"
+ # rust: "1.64"
+ # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+ configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+# - pdf
+# - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+ install:
+ - requirements: requirements.txt

_static/custom.css

@@ -0,0 +1,20 @@
+div.section table, td
+{
+ white-space: normal !important; 
+}
+
+div.section tbody, tr, td
+{
+ border: 1px; 
+}
+
+div.section thead, th
+{
+ color: #FFFFFF;
+ background-color: #4472C4; 
+}
+
+div.section tr.row-odd
+{
+ background-color: #D9E2F3; 
+}

docs/_templates/breadcrumb.html

@@ -0,0 +1,23 @@
+ <!-- custom breadcrumb -->
+ <h5>
+ {%- if master_doc == pagename %}
+ <a href="/training/community/index.html">F5 Community Training &amp; Labs</a>
+ {%- else %}
+ <a href="{{ pathto(master_doc) }}">{{ project|striptags|e }}</a>
+ {%- endif %}
+ {%- if parents|length > 0 %}
+ {%- for parent in parents %}
+ &gt; <a href="{{ parents[loop.index0].link }}">{{ parents[loop.index0].title|striptags|e }}</a>
+ {%- endfor %}
+ {%- endif %}
+
+ <span class="right">
+ {%- if show_source and has_source and sourcename %}
+ <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow">Source</a> |
+ {%- endif %}
+ {%- if github_url is defined %}
+ <a href="{{ github_url }}">Edit on <i class="fa fa-github" aria-hidden="true"></i></a>
+ {%- endif %}
+ </span>
+ </h5>
+ <!-- end custom breadcrumb -->

docs/_templates/header.html

@@ -0,0 +1,137 @@
+<nav class="navbar navbar-default navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="row corp-header">
+ <div class="container corp-header">
+ <div class="container corp-menu">
+ <ul>
+ <li><a href="https://f5.com" class="internalLink">F5.com</a></li>
+ <li><a href="https://support.f5.com">Support</a></li>
+ <li><a href="https://devcentral.f5.com">Community</a></li>
+ <li><a href="https:/F5Networks">GitHub</a></li>
+ <li><a href="https://f5.com/about-us/careers">Careers</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+
+ <div class="row pageHeader">
+ <div class="container stat">
+ <div class="col-xs-12 stat">
+ <a class="internalLink" href="https://f5.com">
+ <img class="logo" src="https://cdn.f5.com/websites/support/assets/images/logo.svg" width="50" height="44" alt="F5 Networks" title="F5 Networks" border="0">
+ </a>
+ <ul id="MainMenu" class="main-menu">
+ <li>
+ <a href="#">Products
+ <span class="indicator"><span class="arrow-up"></span></span>
+ </a>
+
+ <div class="menu-panel soft-hide" id="ProductsSubmenu">
+ <div class="container">
+ <ul class="submenu col-sm-11">
+ <li class="third"><span class="a-mm-h">Connectors</span>
+ <ul>
+ <li><a href="http://clouddocs.f5.com/products/connectors/marathon-bigip-ctlr/latest" data-link-type="Nav: Mega">F5 Marathon BIG-IP Controller</a></li>
+ <li><a href="http://clouddocs.f5.com/products/connectors/marathon-asp-ctlr/latest" data-link-type="Nav: Mega">F5 Marathon ASP Controller</a></li>
+ <li><a href="http://clouddocs.f5.com/products/connectors/k8s-bigip-ctlr/latest" data-link-type="Nav: Mega">F5 Kubernetes BIG-IP Controller</a></li>
+ <li><a href="http://clouddocs.f5.com/products/connectors/f5-kube-proxy/latest" data-link-type="Nav: Mega">F5 Kubernetes Proxy</a></li>
+ </ul>
+ <!--span class="seemore"><a data-link-type="Nav: Mega" href="/products/connectors">See all </a></--span-->
+ </li>
+ <li class="divider"></li>
+ <li class="third"><span class="a-mm-h">Application Service Proxy</span>
+ <ul>
+ <li><a href="http://clouddocs.f5.com/products/asp/latest" data-link-type="Nav: Mega">F5 Application Service Proxy</a></li>
+ </ul>
+ <!--span class="seemore"><a href="/products/">See all </a></span-->
+ </li>
+ </ul>
+ </div>
+ </div>
+ </li>
+ <li>
+ <a href="#">Container Integrations
+ <span class="indicator"><span class="arrow-up"></span></span>
+ </a>
+
+ <div class="menu-panel soft-hide" id="ContainersSubmenu">
+ <div class="container">
+ <ul class="submenu col-sm-11">
+ <li class="third"><span class="a-mm-h">Container Integrations</span>
+ <ul>
+ <li><a href="http://clouddocs.f5.com/containers/latest/marathon/" data-link-type="Nav: Mega">Mesos Marathon</a></li>
+ <li><a href="http://clouddocs.f5.com/containers/latest/kubernetes/" data-link-type="Nav: Mega">Kubernetes</a></li>
+ <li><a href="http://clouddocs.f5.com/containers/latest/openshift/" data-link-type="Nav: Mega">RedHat OpenShift</a></li>
+ </ul>
+ <span class="seemore"><a data-link-type="Nav: Mega" href="http://clouddocs.f5.com/containers/latest">View details </a></span>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </li>
+ <li>
+ <a href="#">Clouds
+ <span class="indicator"><span class="arrow-up"></span></span>
+ </a>
+
+ <div class="menu-panel soft-hide" id="CloudsSubmenu">
+ <div class="container">
+ <ul class="submenu col-sm-11">
+ <li class="third"><span class="a-mm-h">Cloud Integrations</span>
+ <ul>
+ <li><a href="http://clouddocs.f5.com/cloud/openstack/" data-link-type="Nav: Mega">OpenStack</a></li>
+ </ul>
+ <!--span class="seemore"><a data-link-type="Nav: Mega" href="/cloud/">See all </a></span-->
+ </li>
+ </ul>
+ </div>
+ </div>
+ </li>
+ <li>
+ <a href="#">Resources
+ <span class="indicator"><span class="arrow-up"></span></span>
+ </a>
+ <div class="menu-panel soft-hide" id="UPCProgramSubmenu">
+ <div class="container">
+ <ul class="submenu col-sm-11">
+ <li class="third">
+ <span class="a-mm-h">Downloads</span>
+ <ul>
+ <li><a target="_blank" data-link-type="Nav: Mega" href="https://hub.docker.com/r/f5networks/" class="internalLink">Docker Hub</a></li>
+ <li><a target="_blank" data-link-type="Nav: Mega" href="https://store.docker.com/images/f5networks" class="internalLink">Docker Store</a></li>
+ </ul>
+ </li>
+ <li class="divider"></li>
+
+ <li class="third">
+ <span class="a-mm-h">OpenSource</span>
+ <ul>
+ <li><a target="_blank" data-link-type="Nav: Mega" href="https:/F5Networks" class="internalLink">GitHub</a></li>
+ </ul>
+ </li>
+ <li class="divider"></li>
+
+ <li class="third">
+ <a href="//university.f5.com" class="a-mm-h internalLink" target="_blank" data-link-type="Nav: Mega">F5 University</a>
+ <ul>
+ <li>
+ <p>Get up to speed with free self-paced courses</p>
+ </li>
+ </ul>
+ <a data-ng-href="https://devcentral.f5.com" class="a-mm-h internalLink" target="_blank" data-link-type="Nav: Mega" href="https://devcentral.f5.com">DevCentral</a>
+ <ul>
+ <li>
+ <p>Join the community of 250,000+ technical peers</p>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div> <!-- /container-fluid -->
+</nav>

docs/_templates/layout.html

@@ -0,0 +1,146 @@
+<!DOCTYPE html>
+{% extends "basic/layout.html" %}
+ {{ super() }}
+
+
+
+{% set css_files = css_files +
+ [ "_static/css/bootstrap.min.css",
+ "_static/css/f5.css",
+ "_static/css/f5-theme.css",
+ "_static/css/CoveoFullSearch.css",
+ "_static/css/custom.css",
+ "https://use.fontawesome.com/21fb8a09c3.css" ] %}
+
+{% set script_files = script_files + [
+ "https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/jquery.mark.js"
+ ]%}
+
+{% include "head.html" %}
+
+<!-- Google Tag Manager (noscript) -->
+<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-PPZPQ6" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+<!-- End Google Tag Manager (noscript) -->
+
+{# Do not create the standard relbars and sidebars #}
+{%- block relbar1 %}{% endblock %}
+{%- block relbar2 %}{% endblock %}
+{%- block sidebar1 %}{% endblock %}
+{%- block sidebar2 %}{% endblock %}
+
+{%- block header %}
+ <div id="clouddocs-header"></div>
+{% endblock %}
+
+<div class="wrapper">
+
+<div id="docs-wrapper" itemscope itemtype="http://schema.org/Article">
+
+{% block content %}
+
+ {%- if sidebars != None %}
+ {%- block f5sidebar %}
+ <div id="sidebar" class="section-nav">
+ {% if (theme_version_selector) %}
+ <!-- version selector ------------------>
+ <div id="version_selector_wrapper">
+ </div>
+ {%- endif %}
+ <nav class="nav-sidebartoc">
+
+ {% if release %}
+ <h5>{{ project }} {{ release }} </h5>
+ {% else %}
+ <h5>{{ project }} {{ version }} </h5>
+ {% endif %}
+
+ <hr>
+ <span class="nav-sidebartoc">
+ {{ toctree(includehidden=True, collapse=True) }}
+ </span>
+ {%- include "extralinks.html" %}
+ </nav>
+ </div>
+
+
+ <div id="right-sidebar">
+ <h7 style="font-weight:normal">On this page:</h7>
+ <nav class="nav-sidebartoc">
+ <span class="nav-sidebartoc">
+ {{ toc }}
+ </span>
+ </nav>
+ </div>
+
+
+ {%- endblock %}
+ {%- endif %}
+
+
+
+
+
+ {% block main %}
+ <div class="main active" id="content" >
+ <article class="docs-container site-article-inner">
+
+ {%- block breadcrumb %}
+ {% include "breadcrumb.html" %}
+ {% endblock %}
+
+
+ <!--a title="Export PDF" id="export-pdf" class="btn btn btn-link pull-right">View PDF</a-->
+ <button type="button" id="export-pdf" class="btn btn-link right">PDF</button>
+
+
+ {% if (theme_version_selector) %}
+ {% if (theme_enable_version_warning_banner) %}
+ <div class="sidebar" id="version-warning" style="display: none;">
+ <p class="first sidebar-title">
+ <span class="icon fa fa-info-circle fa-lg"></span> Version notice:</p>
+ <p class="last" id="currentVersion"></p>
+ </div>
+ {%- endif %}
+ {%- endif %}
+
+
+ <div role="main">
+ {% block body %}{% endblock %}
+ </div>
+ {% if (next or prev) and (theme_next_prev_link) %}
+ <div class="row next-prev-btn-row">
+ <div class="col-lg-12">
+ {% if prev %}
+ <a href="{{ prev.link|e }}" title="{{ prev.title|striptags|e }}" accesskey="p" class="btn btn-primary left"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i> Previous</a>
+ {% endif %}
+ {% if next %}
+ <a href="{{ next.link|e }}" title="{{ next.title|striptags|e }}" accesskey="n" class="btn btn-primary right">Next <i class="fa fa-arrow-circle-right" aria-hidden="true"></i></a>
+ {% endif %}
+ </div>
+ </div>
+ {% endif %}
+
+ </article>
+ </div>
+ {%- endblock %}
+
+</div>
+
+{% endblock %}
+</div>
+
+{%- block footer %}
+ <div id="clouddocs-footer"></div>
+ <!-- Bootstrap core JavaScript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+{% if (theme_version_selector) %}
+ <script src="{{ pathto('_static/js/index.js', 1) }}"></script>
+{%- endif %}
+ <script src="{{ pathto('_static/js/jquery.appear.js', 1) }}"></script>
+ <script src="{{ pathto('_static/js/printThis.js', 1) }}"></script>
+ <script src="{{ pathto('_static/js/bootstrap.min.js', 1) }}"></script>
+ <script src="{{ pathto('_static/js/clouddocs.js', 1) }}"></script>
+ <script src="{{ pathto('_static/js/CoveoJsSearch.Lazy.min.js', 1) }}"></script>
+
+{%- endblock %}

docs/code/api/api.rst

@@ -0,0 +1,4 @@
+F5 Distributed Cloud API:
+===============================
+
+The following are sample API requests and usage leveraging F5 Distributed Cloud SaaS-based services. They are intended to provide readers specific automation examples using the F5 Distributed Cloud Platform and its services.