Newer
Older
# F5 Beacon SRE Demo
[](LICENSE)
[](https://github.com/RichardLitt/standard-readme)
This document covers the initial setup and configuration of the SRE Demo as demostrated on the most recent webinar.
## Table of Contents
- [Security](#security)
- [Background](#background)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Beacon](#beacon)
- [DataDog](#datadog)
- [BIG-IP](#big-ip)
- [NGINX+](#ngnix)
- [Usage](#usage)
- [API](#api)
- [Contributing](#contributing)
- [License](#license)
## Security
F5 Telemetry Streaming services (TS) operate over HTTPS using OAuth2 authorisation.
## Background
This is a How To Guide to replicate, with references to the underlying infrastructure of additional testing would
like to be explored, this will cover just the steps required to complete configuration for NGINX+, cBIG-IP & F5aaS Beacon.
## Prerequisites
To support this deployment pattern the following components are required:
* [F5 CloudServices Portal](https://portal.cloudservices.f5.com/) Account
* [DataDog](https://www.datadoghq.com/free-datadog-trial/) Account
* F5 BIP-IP (physical or VE)
* NGINX+ Instance
* F5 Toolchain Components:
* [F5 Application Services v3 (AS3)](https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/)
* [F5 Telemetry Streaming (TS)](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/)
* [Postman](https://www.postman.com/)
If there is the desire to install the full demo stack the additional tools/accounts are suggested:
* [Terraform CLI](https://www.terraform.io/docs/cli-index.html)
* [git](https://git-scm.com/)
* [AWS CLI](https://aws.amazon.com/cli/) access.
* [AWS Access Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)
## Installation
This section covers the configuration for the deployment of the example application as demostrated in the recent
Beacon webinar. This flow is built around the assumed deployment pattern that is similar to [F5-SRE-Demo](https://github.com/merps/f5-sre-demo),
the additional steps required for that deployment to replicate the webinar environment are contained in the [Configuration](#configuration)
section of this HowTo.
Intially the sign-up for both F5 CloudServices and DataDog Trial account for the purpose of testing is covered here in this section, DataDog
Agents are a technical requirement at time of writing as Telemetry Streaming is not support with NGINX+.
F5 Beacon is a Cloud Services SaaS offering that provides both insights and anayltics, this [demonstration](https://youtu.be/j81wsUgwFFI) video
provides a greater understanding of Beacon's current capabilites.
Also, as it coincides with this demo Beacon also has a 45 free day trial period so you may use and explore how Beacon provides insights to
organisational needs. To see how easy it is to sign up for both a F5 CloudServices Account and subscribe to Beacon refer to this [PDF](files/Beacon_Sub.pdf)
[Work with F5 Beacon](https://clouddocs.f5.com/cloud-services/latest/f5-cloud-services-Beacon-WorkWith.html) to explore many addtional resources outside of
this SRE Demo HowTo.
Explore your stack with a free [Datadog trial](https://www.datadoghq.com/free-datadog-trial/), try Datadog for 14 days and learn how seamlessly uniting metrics, traces, and logs in one platform improves agility, increases efficiency, and provides end-to-end visibility across your entire stack.
DataDog insights and metrics are used in combination with NGINX+ provides logs and metrics of the instances used in this demo.
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
The deployment environment used for development is coovered in detail [F5 SRE Demo](https://github.com/merps/f5-sre-demo),
this is a AWS Deployment example of AutoScaling AWAF. For simplicity, steps replicate this deployment are as follows;
***a)*** First, clone the repo:
```
git clone https://github.com/merps/f5-sre-demo.git
```
***b)*** Second, create a [tfvars](https://www.terraform.io/docs/configuration/variables.html) file in the following format to deploy the environment;
#### Inputs
Name | Description | Type | Default | Required
---|---|---|---|---
cidr | CIDR Range for VPC | String | *NA* | **Yes**
region | AWS Deployment Region | String | *NA* | **Yes**
azs | AWS Avaliability Zones | List | *NA* | **Yes**
secops-profile | SecurityOperations AWS Profile | String | `default` | **Yes**
customer | Customer/Client Short name used for AWS Tag/Naming | String | `customer` | No
environment | Environment Shortname name used for AWS Tag/Naming | String | `demo` | No
project | Project Shortname name used for AWS Tag/Naming | String | `project` | No
ec2_key_name | EC2 KeyPair for Instance Creation | String | *NA* | **Yes**
***c)*** Third, intialise and plan the terraform deployment as follows:
```
cd f5-sre-demo/
terraform init
terraform plan --vars-file ../variables.tfvars
```
this will produce and display the deployment plan using the previously created `varibles.tfvars` file.
***d)*** Then finally to deploy the successfuly plan;
```
terraform apply --vars-file ../variables.tfvars
```
> **_NOTE:_** This architecture deploys two c4.2xlage PAYG BIG-IP Marketplace instances, it is
recommended to perform a `terraform destroy` to not incur excessive usage costs outside of free tier.
This deployment also covers the provisioning of the additional F5 prerequeset components so required for
deployment example covered in the [F5 SRE Demo](https://github.com/merps/f5-sre-demo)
### *NGINX*
As with the installation of BIG-IP, this HowTo is based on that deployment. To replicate this deployment please
refer to the well documented process of [Deploying NGINX and NGINX Plus on Docker](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/) otherwise the steps outined in the [Configuration](#configuration) section outline what is required for a WordPress
As with other products and services, NGINX+ also offers a free license period that you can request [here](https://www.nginx.com/free-trial-request/ "Trial Request") where you can also trial additional modules of NGNIX+
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
As with DataDog, detailed instructions for the deployment and configuration for TS is located at
[F5 Telemetry Streaming](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/).
As previously, steps to configure;
1. Update TS declations as this example example;
```
{
"class": "Telemetry",
"TS_System": {
"class": "Telemetry_System",
"systemPoller": {
"interval": 60,
"enable": true,
"trace": false,
"actions": [
{
"setTag": {
"tenant": "`T`",
"application": "`A`"
},
"enable": true
}
]
},
"enable": true,
"trace": false,
"host": "localhost",
"port": 8100,
"protocol": "http"
},
"TS_Listener": {
"class": "Telemetry_Listener",
"port": 6514,
"enable": true,
"trace": false,
"match": "",
"actions": [
{
"setTag": {
"tenant": "`T`",
"application": "`A`"
},
"enable": true
}
]
},
"Poller":{
"class":"Telemetry_System_Poller",
"interval":60,
"enable":true,
"trace":false,
"allowSelfSignedCert":false,
"host":"localhost",
"port":8100,
"protocol":"http"
},
"Beacon_Consumer": {
"class": "Telemetry_Consumer",
"type": "Sumo_Logic",
"host": "collectors.au.sumologic.com",
"protocol": "https",
"port": 443,
"enable": true,
"trace": false,
"path": "/receiver/v1/http/",
"passphrase": {
"cipherText": "this is a secret"
}
},
"schemaVersion": "1.6.0"
}
```
3. Push updated TS declaration to cBIG-IP.
The configuration component is divided into two sections, [Docker Agent](http://docs.datadoghq.com/agent/docker) and the associated metrics.
The deployment of the WordPress NGINX+ Docker example is documented and deployed with use of the deployment pattern as described within [F5 SRE Demo](https://github/merps/f5-sre-demo) where the application is deployed via API.
For the purpose of this HowTo, it will use the [F5 Beacon API](https://clouddocs.f5.com/cloud-services/latest/f5-cloud-services-Beacon-API.html) Postman collection
For both ease and simplicity, this section builds upon the Docker deployment with the use of a docker-compose, this detailed in [wordpress-nginx-docker-compose](https://github.com/merps/wordpress-nginx-docker-compose)
## TODO
List of task to make the process my automated;
## Contributing
See [the contributing file](CONTRIBUTING.md)!
PRs accepted.
### ChangeLog
**2020-06-16**
- Initial merge to [f5devcentral](https://github.com/f5devcentral/f5-bd-sre-demo) from [F5-SRE-HowTo](https://github.com/merps/f5-sre-howto)