F5 Big-IP Networks provides a load balancer that is a device that acts as a reverse proxy and distributes network or application traffic across a number of servers. Load balancers are used to increase capacity (concurrent users) and reliability of applications.
This plugin provides integration with F5 Big IP Load balancer through its API.
-
Download or clone the EC-BigIp repository.
``` git clone https://github.com/electric-cloud-community/EC-BigIp.git ```
-
Zip up the files to create the plugin zip file.
``` cd EC-BigIp zip -r EC-BigIp.zip ./* ```
-
Import the plugin zip file into your CloudBees CD/RO server and promote it.
Plugin configurations are sets of parameters that can be applied across some, or all, of the plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them.
Parameter | Description |
---|---|
Configuration Name |
The name for the created configuration. |
Description |
Description for the configuration. |
Protocol |
Specifies whether to prefix hostname with https:// or leave http:// |
Host |
Host name of the iControlREST API instance. |
URL Path to API |
URL Base Path to iControlREST (if any)
that needs to be added to
For example if the URL path to iControlREST is
|
API server port |
Server port for example 443 |
Type Of Authentication |
Specifies how a particular consumer is authenticated to the system.
|
BigIp API Credentials |
Enter credentials required to perform basic authentication. |
Authentication Provider |
The identifier of the internal or external authentication provider: local, tmos. Depends on Token Based Authentication. |
Check Connection? |
If checked, the configuration will be saved only if the test request with given credentials succeeds. |
Debug Level |
This option sets debug level for logs. If info is selected, only summary information will be shown, for debug, there will be some debug information and for trace the whole requests and responses will be shown. |
Synchronizes the local BIG-IP device to the device group
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Device Group Name |
Name of the Sync-Failover or Sync-Only device group |
Result Property Sheet |
Results will be saved into this property/property sheet |
Create or update balancing pool configuration
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Update Action |
This parameter controls the update of a balancing pool if one with the same name exists already:
|
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Optional Parameters |
Semicolon separated list of values in the format parameter=value Available parameters:
|
Result Property Sheet |
Results will be saved into this property/property sheet. |
Get balancing pool list
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Result Property Sheet |
Results will be saved into this property/property sheet. |
Get pool configuration
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Result Property Sheet |
Results will be saved into this property/property sheet. |
Delete balancing pool configuration
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Result Property Sheet |
Results will be saved into this property/property sheet. |
Create the set of pool members that are associated with a load balancing pool
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Update Action |
This parameter controls the update of a balancing pool member if one with the same name exists already:
|
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Member Name |
A name for this member. |
Optional Parameters |
Semicolon separated list of values in the format parameter=value Available parameters:
|
Result Property Sheet |
Results will be saved into this property/property sheet. |
Change pool member status
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Member Name |
Name of the member. |
Status |
Desired status of the pool member:
Details: |
Result Property Sheet |
Results will be saved into this property/property sheet. |
Get all pool members that make up a load balancing pool
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Result Property Sheet |
Results will be saved into this property/property sheet. |
Get a specified pool member from a load balancing pool
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Member Name |
A name for this member. |
Result Property Sheet |
Results will be saved into this property/property sheet. |
Delete a specified pool member from a load balancing pool
Parameter | Description |
---|---|
Configuration Name |
Previously defined plugin configuration. |
Partition Name |
Name of the partition. |
Pool Name |
Name of the balancing pool. |
Member Name |
A name for this member. |
Result Property Sheet |
Results will be saved into this property/property sheet. |
Authentication token is renewed after the step is finished.
Improved error details in case of failure
Add checking connection while creating/editing a configuration
Add Token Based Authentication
Renaming to "CloudBees"
Remove excessive information from help
Procedure Interfaces in this version of the Plugin have been changed for Usability and Robustness. If a previous major version (i.e., version ⇐ 2.X) of this plugin exists in your environment, this version of the plugin will not promote, until you demote the previous major version. This approach is taken in order to provide you with an opportunity to understand refactoring impacts upon upgrade. Please make sure you understand the impact before upgrading to this version of the plugin. The following is the list of key changes made to this plugin.
-
New procedure LTM - Config sync.
-
New Field Update Action added to LTM - Create or update balancing pool to control update behavior.
-
New Field Update Action added to LTM - Create or update pool member to control update behavior.
-
Existing procedure LTM - Manage balancing pool removed.
-
Existing procedure LTM - Manage pool member removed.
- The plugin icon has been updated.
- Documentation cleanup.
- Plugin revision.
- Added new parameter Path to BigIp for all procedures.
- Fixed the step picker for procedure "Add Members to Pool"
-
4.1 XML parameter panels ready.
-
4.1 help page format ready.