@@ -25,7 +25,7 @@ Installation
25
25
~~~~~~~~~~~~
26
26
27
27
iControl LX Extensions use the common Redhat Package Manager (RPM) distribution
28
- format. To install an extension you need to first obtain the RPM file
28
+ format. To install an extension you need to first obtain the RPM file
29
29
associated with the extension.
30
30
31
31
AS3 RPMs are available at https://github.com/f5networks/f5-appsvcs-extension/releases
@@ -40,37 +40,39 @@ All of these mechanisms are supported and, if required, can be used in
40
40
conjunction with each other.
41
41
42
42
For instance, you can install AS3 from BIG-IP GUI and then deploy
43
- a new service via iControl REST using tools such as cURL, Postman
43
+ a new service via iControl REST using tools such as cURL, Postman
44
44
and Ansible.
45
45
46
46
To view installed iControl LX Extensions in the BIG-IP GUI you must first
47
47
enable this functionality. To do this, log in via SSH into the system with an ``admin ``
48
- account and execute ``touch /var/config/rest/iapps/enable ``. No reboot is required.
49
- This will enable the :menuselection: `iApps --> Package Management LX ` menu:
48
+ account and execute ``touch /var/config/rest/iapps/enable ``. No reboot is required.
49
+ This will enable the :menuselection: `iApps --> Package Management LX ` menu:
50
50
51
51
|lab-1-1 |
52
52
53
53
Clicking :guilabel: `Package Management LX ` will show a table of installed
54
54
iControl LX Extensions:
55
55
56
+ .. NOTE :: This will be empty until one or more iControl LX Extension packages have been imported.
57
+
56
58
|lab-1-2 |
57
59
58
60
Deployments
59
61
~~~~~~~~~~~
60
62
61
- .. NOTE :: Redeployment of AS3 services is facilitated/protected by a mechanism
62
- in BIG-IP platform to ensure safe changes to the configurations without
63
+ .. NOTE :: Redeployment of AS3 services is facilitated/protected by a mechanism
64
+ in BIG-IP platform to ensure safe changes to the configurations without
63
65
disrupting existing user traffic.
64
66
65
- iControl LX allows Extensions to register new REST API endpoints with the
67
+ iControl LX allows Extensions to register new REST API endpoints with the
66
68
iControl REST API. In the case of AS3 the following endpoints are exposed:
67
69
68
70
- **Version Info: ** ``/mgmt/shared/appsvcs/info ``
69
71
- **Declarations: ** ``/mgmt/shared/appsvcs/declare ``
70
72
- **Self-Test: ** ``/mgmt/shared/appsvcs/selftest ``
71
73
72
- Deployments use the `/mgmt/shared/appsvcs/declare ` endpoint. This endpoint
73
- accepts the Create, Read, Update and Delete (CRUD) operations using the HTTP
74
+ Deployments use the `/mgmt/shared/appsvcs/declare ` endpoint. This endpoint
75
+ accepts the Create, Read, Update and Delete (CRUD) operations using the HTTP
74
76
``POST ``, ``GET ``, ``PATCH `` and ``DELETE `` methods.
75
77
76
78
Additionally various query parameters are also supported. Full documentation
@@ -79,18 +81,18 @@ is available in the `AS3 Reference <http://clouddocs.f5.com/products/extensions/
79
81
Source-of-Truth
80
82
~~~~~~~~~~~~~~~
81
83
82
- In an automated environment, we **must ** always ensure that the
83
- **AS3 declarations ** are being used as the Source-of-Truth for an underlying
84
- deployment. Therefore, you should **NOT ** perform out-of-band modifications
84
+ In an automated environment, we **must ** always ensure that the
85
+ **AS3 declarations ** are being used as the Source-of-Truth for an underlying
86
+ deployment. Therefore, you should **NOT ** perform out-of-band modifications
85
87
to the configuration using the BIG-IP GUI or REST API.
86
88
87
89
For instance, after an AS3 declaration is deployed, modifying the underlying
88
- configuration will result in a Source-of-Truth violation. AS3 **does not **
89
- prevent out-of-band changes from occuring. This allows administrators to ensure
90
- total control over the system in emergency situations, however, the direct
91
- modification of objects configured on BIG-IP will effect the integrity of
92
- AS3 declaration that automation tools are interacting with, causing failures.
93
- It is therefore important to prevent out-of-band changes at all times for
90
+ configuration will result in a Source-of-Truth violation. AS3 **does not **
91
+ prevent out-of-band changes from occuring. This allows administrators to ensure
92
+ total control over the system in emergency situations, however, the direct
93
+ modification of objects configured on BIG-IP will effect the integrity of
94
+ AS3 declaration that automation tools are interacting with, causing failures.
95
+ It is therefore important to prevent out-of-band changes at all times for
94
96
automated deployments in normal production circumstances.
95
97
96
98
.. |lab-1-1 | image :: images/lab-1-1.png
0 commit comments