F5 Agility Labs - Index¶
Welcome¶
Welcome to the Getting Started with F5 BIG-IP lab at F5 Agility 2021
The content contained here leverages a full DevOps CI/CD pipeline and is sourced from the GitHub repository at https://github.com/f5devcentral/your-class-repo. Bugs and Requests for enhancements can be made using by opening an Issue within the repository.
Getting Started¶
Todo
Complete getting started instructions
Please follow the instructions provided by the instructor to start your lab and access your jump host.
Note
All work for this lab will be performed exclusively from the Windows jumphost. No installation or interaction with your local system is required.
Lab Topology¶
Todo
Complete lab topology
The following components have been included in your lab environment:
- 2 x F5 BIG-IP VE (v12.1)
- 1 x F5 iWorkflow VE (v2.1)
- 1 x Linux LAMP Webserver (xubuntu 14.04)
- 1 x Windows Jumphost
Lab Components¶
Todo
Complete lab components table
The following table lists VLANS, IP Addresses and Credentials for all components:
| Component | VLAN/IP Address(es) | Credentials |
|---|---|---|
| Sample Host |
|
admin/admin |
Class - Getting Started with F5 BIG-IP¶
Todo
Need class description
This class covers the following topics:
- Downloading a F5 Networks BIG-IP Virtual Edition
- Installing a BIG-IP Virtual Edition image on a hypervisor
- Installing a F5 Networks BIG-IP Appliance
- Powering on a BIG-IP Appliance
Expected time to complete: 3 hours
Module – Installing a BIG-IP Virtual Edition¶
Todo
Needs module description
In this module you will learn how to install a F5 Networks BIG-IP Virtual Edition into your environment.
Lab – Download the BIG-IP Virtual Edition Image¶
Todo
Needs lab description
This lab will teach you how to download the BIG-IP Virtual Edition image to your system.
Task – Open a Web Browser¶
Todo
Needs task description
In this task you will open a web browser and navigate to the F5 Networks Downloads site.
Note
An account is required to download software. You can create one at https://login.f5.com/resource/registerEmail.jsp
Follow these steps to complete this task:
Open your web browser
Navigate to https://downloads.f5.com
Login with your username and password.
After logging in you should see the following window:
Task – Download the Image¶
Todo
Needs task description
In this task we will download the F5 Networks BIG-IP Virtual Edition image to your system
Follow these steps to complete this task:
Click the ‘Find a Download’ button.
Click the link that contains the BIG-IP TMOS software version you would like to download.
Important
Be sure to click a link that has “Virtual Edition” in the name
Find the image appropriate for your hypervisor
Download the image and save it to you local system
Lab – Install a BIG-IP Virtual Edition image on a Hypervisor¶
Todo
Needs lab description
In the previous lab we learned how to download the BIG-IP Virtual Edition image. Now, we can install the image onto a hypervisor.
Task – Upload the image to your Hypervisor¶
Todo
Needs task description
In this task you will upload the image to your hypervisor.
Follow these steps to complete this task:
Open your hypervisor management console
Figure out how to upload the image
Error
These are bad instructions…
Great! You’re done
Task – Start a BIG-IP Virtual Edition Instance¶
Todo
Needs task description
In this task we will start and instance of BIG-IP using the image uploaded in the previous task.
Follow these steps to complete this task:
- Open your hypervisor management console
- Click the BIG-IP image
- Click the ‘Start’ button (or it’s equivalent)
Module – Installing a BIG-IP Appliance¶
Todo
Needs module description
In this module you will learn how to install a F5 Networks BIG-IP Appliance into your datacenter.
Lab – Install a F5 Networks BIG-IP Appliance¶
Todo
Needs lab description
In this lab we will unpack and install the BIG-IP Appliance into a rack in your datacenter.
Task – Unpack the BIG-IP Appliance¶
Todo
Needs task description
In this task you will remove the BIG-IP Appliance from it’s packaging.
Follow these steps to complete this task:
Open the box with an extremely sharp knife or cutter
Danger
Knives are sharp and can cut you. Please be careful.
Carefully remove the BIG-IP from it’s packaging
Set it down on a stable surface
Task – Install the BIG-IP Appliance in a Datacenter Rack¶
Todo
Needs task description
In this task you will install the BIG-IP Appliance into a Rack. You will need the following tools:
- Phillips Screwdriver
- Hammer
- Crowbar
Caution
Appliances can be heavy. Please follow all applicable safety guidelines.
Follow these steps to complete this task:
- Install the rackmount rails onto the appliance using the included hardware
- Lift the appliance into place
- Complete installation by using your tools to secure the appliance.
Lab – Power-on the BIG-IP Appliance¶
Todo
Needs lab description
In this lab we will connect the power cord and turn on the BIG-IP Appliance.
Task – Connect the Power Cord¶
Todo
Needs task description
In this task you will connect the appropriate power cord.
Important
Be sure to use the appropriate power cord for your region. Follow all applicable electrical guidelines and codes.
Follow these steps to complete this task:
- Connect one end to the BIG-IP
- Connect the other end to the power source
Task – Turn on the BIG-IP Appliance¶
Todo
Needs task description
In this task you turn on the BIG-IP Appliance.
Follow these steps to complete this task:
- Push the ‘On’ button
- Verify the red F5 ball lights up
Examples of Common Formatting¶
Todo
Examples need to be removed from your class
Hint
To remove this page:
- Edit the
index.rstfile and remove theexamplesline - Delete the
examples.rstfile
This page has examples of many different types of formatting that can be achieved using reStructuredText. Complete documentation is available at:
http://www.sphinx-doc.org/en/stable/rest.html
Text Markup¶
Code Samples¶
code sample
This is one example of a code block:
import math
print 'import done'
Code block without syntax highlighting:
$ ls -l
total 96
-rw-r--r-- 1 user staff 610 Jun 22 17:51 Makefile
drwxr-xr-x 4 user staff 136 Jun 22 21:14 _build
drwxr-xr-x 3 user staff 102 Jun 22 21:16 _static
drwxr-xr-x 3 user staff 102 Jun 22 17:55 _templates
drwxr-xr-x 5 user staff 170 Jun 22 21:00 class1
-rw-r--r-- 1 user staff 6764 Jun 22 21:26 conf.py
-rw-r--r--@ 1 user staff 733 Jun 22 21:41 examples.rst
-rw-r--r-- 1 user staff 152 Jun 22 21:32 index.rst
-rw-r--r-- 1 user staff 995 Jun 22 20:55 intro.rst
-rw-r--r-- 1 user staff 817 Jun 22 17:51 make.bat
$
Code block with syntax highlighting:
Note
A list of supported languages can be found at here
import math
a = 1
b = 2
sum = a + b
print 'Sum: %s' % sum
Code block with highlighting and line numbers:
1 2 3 4 5 | import math
a = 1
b = 2
sum = a + b
print 'Sum: %s' % sum
|
Code block with highlighting, line numbers, and line highlighting:
1 2 3 4 5 | import math
a = 1
b = 2
sum = a + b
print 'Sum: %s' % sum
|
Substitutions¶
rST:
.. |name| replace:: replacement *text*
|name|
Result:
replacement text
Pre-configured Substitutions¶
A number of common substitutions are pre-configured for convenience:
| Name | Value |
|---|---|
|classname| |
Getting Started with F5 BIG-IP |
|classbold| |
Getting Started with F5 BIG-IP |
|classitalic| |
Getting Started with F5 BIG-IP |
|ltm| |
Local Traffic Manager |
|adc| |
Application Delivery Controller |
|gtm| |
Global Traffic Manager |
|dns| |
DNS |
|asm| |
Application Security Manager |
|afm| |
Advanced Firewall Manager |
|apm| |
Access Policy Manager |
|ipi| |
IP Intelligence |
|iwf| |
iWorkflow |
|biq| |
BIG-IQ |
|bip| |
BIG-IP |
|f5| |
F5 Networks |
|f5i| |
F5 Networks, Inc. |
|year| |
2021 |
Hyperlinks¶
External¶
- Bare URL: https://www.f5.com
- Named Link: Click here to goto F5’s website
Internal¶
- Reference section headers in this document: Hyperlinks
- Reference other pages: Welcome
Lists¶
Unordered Lists¶
- This
- Is
- A
- List
Ordered Lists¶
- One
- Two
- Three
- Four
Nested Lists¶
- This
- One
- Two
- Alpha
- Bravo
- Charlie
- Is
- 1
- 2
- A
- Nested
- List
Tables¶
List Tables¶
With Stub Column¶
| Column 1 (Stub) | Column 2 | Column 3 |
|---|---|---|
| Row 1 | Value 1 | Value 2 |
| Row 2 | Value 1 | Value 2 |
Without Stub Column¶
| Column 1 | Column 2 | Column 3 |
|---|---|---|
| Row 1 | Value 1 | Value 2 |
| Row 2 | Value 1 | Value 2 |
Grid Tables¶
| Header row, column 1 (header rows optional) | Header 2 | Header 3 | Header 4 |
|---|---|---|---|
| body row 1, column 1 | column 2 | column 3 | column 4 |
| body row 2 | Cells may span columns. | ||
| body row 3 | Cells may span rows. |
|
|
| body row 4 | |||
| body row 5 | Cells may also be
empty: --> |
||
Giant Tables¶
| Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
Simple Tables¶
| A | B | A and B |
|---|---|---|
| False | False | False |
| True | False | False |
| False | True | False |
| True | True | True |
Admonitions¶
Admonitions (a.k.a Callouts) can be used to make important information stand out. Examples of different admonitions are shown below.
When including TMSH commands please use the TMSH admonition
TMSH¶
TMSH
tmsh show sys hardware
Hint¶
Hint
This is a HINT admonition
Important¶
Important
This is a IMPORTANT admonition
Tip¶
Tip
This is a TIP admonition
Note¶
Note
This is a NOTE admonition
Attention¶
Attention
This is a ATTENTION admonition
Caution¶
Caution
This is a CAUTION admonition
Warning¶
Warning
This is a WARNING admonition
Error¶
Error
This is a ERROR admonition
Danger¶
Danger
This is a DANGER admonition
TODO’s¶
TODO items can be marked in your docs. By default the item will be included in the generated docs and a build warning will be printed.
To change the defaults edit conf.py and look modify
todo_emit_warnings = True
todo_include_todos = True
Here is the rST code for a TODO:
.. TODO:: This is my example todo. Please ignore me.
.. TODO:: This is my second example todo. Please ignore me.
And the TODO themselves:
Todo
This is my first example todo. Please ignore me.
Todo
This is my second example todo. Please ignore me.
You can also get a list of TODO’s:
rST:
.. TODOLIST::
Todo
Need class description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/class1.rst, line 33.)
Todo
Needs lab description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module1/lab1.rst, line 33.)
Todo
Needs task description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module1/lab1.rst, line 40.)
Todo
Needs task description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module1/lab1.rst, line 60.)
Todo
Needs lab description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module1/lab2.rst, line 33.)
Todo
Needs task description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module1/lab2.rst, line 41.)
Todo
Needs task description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module1/lab2.rst, line 59.)
Todo
Needs module description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module1/module1.rst, line 33.)
Todo
Needs lab description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module2/lab1.rst, line 33.)
Todo
Needs task description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module2/lab1.rst, line 41.)
Todo
Needs task description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module2/lab1.rst, line 59.)
Todo
Needs lab description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module2/lab2.rst, line 33.)
Todo
Needs task description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module2/lab2.rst, line 40.)
Todo
Needs task description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module2/lab2.rst, line 55.)
Todo
Needs module description
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/class1/module2/module2.rst, line 33.)
Todo
Examples need to be removed from your class
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/examples.rst, line 33.)
Todo
This is my first example todo. Please ignore me.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/examples.rst, line 425.)
Todo
This is my second example todo. Please ignore me.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/examples.rst, line 427.)
Todo
Complete getting started instructions
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/intro.rst, line 33.)
Todo
Complete lab topology
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/intro.rst, line 46.)
Todo
Complete lab components table
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/f5-agility-lab-template1/checkouts/latest/docs/intro.rst, line 58.)
Font-Awesome Icons¶
The f5-sphinx-theme can use icons from the Font Awesome:
For example:
* :fonticon:`fa fa-home`
* :fonticon:`fa fa-home fa-lg`
* :fonticon:`fa fa-home fa-border`
* :fonticon:`fa fa-home fa-2x`
* :fonticon:`fa fa-home fa-3x`
* :fonticon:`fa fa-home fa-4x`
* :fonticon:`fa fa-gear fa-spin fa-4x`
* :fonticon:`fa fa-gear fa-spin fa-4x text-success`