Skip to content

Commit

Permalink
API workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
jimmccarron committed Nov 8, 2024
1 parent e9d4384 commit c19b3de
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
26 changes: 17 additions & 9 deletions docs/automating_rseries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
Automating F5OS on rSeries
===========================================

Since F5OS is an API first architecture, everything is automatable at the F5OS layer. There are F5OS API's for every function, and the GUI and CLI are built on top of the API. API reference materials are published on clouddocs.f5.com in addtion to the most common API workflows. In addition, Terraform providers and Ansible collections are also available for F5OS, and more functionality is being added with each release of those packages.
Since F5OS is an API first architecture, everything is automatable at the F5OS layer. There are F5OS API's for every function, and the GUI and CLI are built on top of the API. API reference materials are published on clouddocs.f5.com in addition to the most common API workflows. In addition, Terraform providers and Ansible collections are also available for F5OS, and more functionality is being added with each release of those packages.

If you want to see what API functions are available you can view the API reference documentation for the specific F5OS version you are running. As you can see, rSeries / F5OS-A have its own API reference pages and F5OS-C / VELOS have similar pages, most of the API calls are common expcept for those that are specific to the platform.
If you want to see what API functions are available you can view the API reference documentation for the specific F5OS version you are running. As you can see, rSeries / F5OS-A have its own API reference pages and F5OS-C / VELOS have similar pages, most of the API calls are common except for those that are specific to the platform.

`F5OS-A/F5 rSeries - API <https://clouddocs.f5.com/api/rseries-api/rseries-api-index.html>`_

.. image:: images/automating_rseries/image1.png
:align: center
:scale: 70%

The API workflows section has an index which maps to all the common API workflow examples in the rSeries planning guide. In addtion, there is an accompanying Postman collection which can be downloaded and used within your own environment if you want to become familiar with the F5OS API.
The API workflows section has an index which maps to all the common API workflow examples in the rSeries planning guide. In addition, there is an accompanying Postman collection which can be downloaded and used within your own environment if you want to become familiar with the F5OS API.

`F5 rSeries API Workflows <https://clouddocs.f5.com/training/community/rseries-training/html/rseries_api_workflows.html>`_

Below is a smaple of some of the workflows available in the link above, and there are many more.
Below is a sample of some of the workflows available in the link above, and there are many more.

.. image:: images/automating_rseries/image2.png
:align: center
Expand All @@ -25,15 +25,23 @@ Below is a smaple of some of the workflows available in the link above, and ther
F5OS Ansible Collection
=======================

Ansible collections have been created for F5OS for some of the more common tasks. Addtional API workflows are constantly being added to the collections.
Ansible collections have been created for F5OS for some of the more common tasks. Additional API workflows are constantly being added to the collections.


`F5OS modules Ansible collection <https://clouddocs.f5.com/products/orchestration/ansible/devel/f5os/F5OS-index.html>`_

F5 Professional Services F5OS Ansible Collection
================================================

Ansible collections have been created for F5OS for some of the more common tasks. The Ansible modules contributed to the F5 DevCentral community by F5 Professional Services. Additional API workflows are constantly being added to the collections.


`F5 Professional Services F5OS modules Ansible collection <https://f5devcentral.github.io/f5-ps-ansible/>`_

F5OS Terraform Provider
=======================

Terraform providers have been created for F5OS for some of the more common tasks. Addtional API workflows are constantly being added to the providers. An overview of the F5OS provider is available using the link below.
Terraform providers have been created for F5OS for some of the more common tasks. Additional API workflows are constantly being added to the providers. An overview of the F5OS provider is available using the link below.

`F5OS Provider Overview <https://clouddocs.f5.com/products/orchestration/terraform/latest/F5OS/f5os-index.html#f5os-index>`_

Expand Down Expand Up @@ -171,7 +179,7 @@ Below is the output from the API query above:
Curl Examples
==============

Below is an API call using Curl to an rSeries system. Note, that the Curl request is using **username:password** to authenticate. In the response, an authentication token is generated by F5OS with the header **X-Auth-Token**. This token can be used for future reqests instead of using the basic authentication method until the token times out. At that point you'll need to refresh the token.
Below is an API call using Curl to an rSeries system. Note, that the Curl request is using **username:password** to authenticate. In the response, an authentication token is generated by F5OS with the header **X-Auth-Token**. This token can be used for future requests instead of using the basic authentication method until the token times out. At that point you'll need to refresh the token.

.. code-block:: bash
Expand All @@ -194,7 +202,7 @@ Below is an API call using Curl to an rSeries system. Note, that the Curl reques
{"ietf-restconf:restconf":{"data":{},"operations":{},"yang-library-version":"2019-01-04"}}% prompt%
You may send API calls to either port 8888 or port 443. The URI path will change slightly depending on which TCP port you choose to use. For API calls sent to port 443, the initial path will be **/api**, while API calls to port 8888 will start with **/restconf**. F5OS also listens on port 80 and will redirect to TCP port 443. The API call below is sent to port 443, note the intial path will be **/api/data**.
You may send API calls to either port 8888 or port 443. The URI path will change slightly depending on which TCP port you choose to use. For API calls sent to port 443, the initial path will be **/api**, while API calls to port 8888 will start with **/restconf**. F5OS also listens on port 80 and will redirect to TCP port 443. The API call below is sent to port 443, note the initial path will be **/api/data**.

.. code-block:: bash
Expand Down Expand Up @@ -307,7 +315,7 @@ You may send API calls to either port 8888 or port 443. The URI path will change
}
prompt%
You may send API calls to either port 8888 or port 443. The URI path will change slightly depending on which TCP port you choose to use. For API calls sent to port 443, the initial path will be **/api**, while API calls to port 8888 will start with **/restconf**. F5OS also listens on port 80 and will redirect to TCP port 443. The API call below is sent to port 8888, note the intial path will be **/restconf/data**.
You may send API calls to either port 8888 or port 443. The URI path will change slightly depending on which TCP port you choose to use. For API calls sent to port 443, the initial path will be **/api**, while API calls to port 8888 will start with **/restconf**. F5OS also listens on port 80 and will redirect to TCP port 443. The API call below is sent to port 8888, note the initial path will be **/restconf/data**.

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/rseries_references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ rSeries References

`F5 rSeries Appliance Datasheet <https://www.f5.com/products/big-ip-services/rseries-adc-hardware-appliance>`_


`F5 Professional Services Ansible Collection <https://f5devcentral.github.io/f5-ps-ansible/>`_

0 comments on commit c19b3de

Please sign in to comment.