You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-25Lines changed: 7 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ configuration, troubleshooting (REST changes) info, etc.
7
7
8
8
> See the [F5 Application Study Tool Labs](https://clouddocs.f5.com/training/community/ast/html/) for an educational guided lab experience.
9
9
10
-
The Application Study Tool is intended to provide enhanced insights into (classic) BIG-IP products, leveraging best in class
10
+
The F5 Application Study Tool is intended to provide enhanced insights into (classic) BIG-IP products, leveraging best in class
11
11
open source telemetry tools. The full installation includes:
12
12
13
13
* Custom Instance of OpenTelemetry Collector with enhanced BIG-IP data receivers (data fetched via iControlRest) [Full List of Metrics Collected](pages/components/otel_collector/receiver_metrics.md).
@@ -173,6 +173,8 @@ Create a file called .env.device-secrets, and add your BIP passwords like so:
173
173
BIGIP_PASSWORD_1=foo-bar123!
174
174
BIGIP_PASSWORD_2=bar-foo123!
175
175
```
176
+
> **Note:** Ensure that the permissions on the (_.env.device-secrets_) file are restricted to allow read access only to the user running the Docker containers.
177
+
> This ensures that credential information remains protected from unauthorized access.
176
178
177
179
The variable name (the part on the left of the equal sign) must match the configured
178
180
value for the devices that use this password in config/ast_defaults.yaml or device specific
@@ -348,7 +350,7 @@ cp .env-example .env
348
350
```
349
351
350
352
### Run Application Study Tool
351
-
Once the above configurations have been made, the tool can be started with:
353
+
After the above configurations have been made, start the tool with:
352
354
353
355
```shell
354
356
# `docker compose up -d` to start in background mode
@@ -357,7 +359,7 @@ docker compose up
357
359
358
360
#### View The Dashboards
359
361
The default Grafana user/pass is `admin/admin`, and can be accessed at
360
-
`http://<hostname>:3000`.
362
+
`http://<hostname>:3000`. If HTTPS is configured, use `https://<hostname>:3001`.
361
363
362
364
363
365
## Updating AST Versions
@@ -371,7 +373,7 @@ special instructions / breaking changes.
For support, please open a GitHub issue. Note, the code in this repository is community supported and is not supported by F5 Networks. For a complete list of supported projects please reference [SUPPORT.md](SUPPORT.md).
386
-
387
-
## Community Code of Conduct
388
-
389
-
Please refer to the [F5 DevCentral Community Code of Conduct](code_of_conduct.md).
390
-
391
385
## License
392
386
393
387
[Apache License 2.0](LICENSE)
394
388
395
389
## Copyright
396
390
397
-
Copyright 2014-2024 F5 Networks Inc.
398
-
399
-
### F5 Networks Contributor License Agreement
400
-
401
-
Before you start contributing to any project sponsored by F5 Networks, Inc. (F5) on GitHub, you will need to sign a Contributor License Agreement (CLA).
402
-
403
-
If you are signing as an individual, we recommend that you talk to your employer (if applicable) before signing the CLA since some employment agreements may have restrictions on your contributions to other projects.
404
-
Otherwise by submitting a CLA you represent that you are legally entitled to grant the licenses recited therein.
405
-
406
-
If your employer has rights to intellectual property that you create, such as your contributions, you represent that you have received permission to make contributions on behalf of that employer, that your employer has waived such rights for your contributions, or that your employer has executed a separate CLA with F5.
407
-
408
-
If you are signing on behalf of a company, you represent that you are legally entitled to grant the license recited therein.
409
-
You represent further that each employee of the entity that submits contributions is authorized to submit such contributions on behalf of the entity pursuant to the CLA.
This section outlines the steps required to enable HTTPS for Grafana when deployed using Docker Compose.
4
+
5
+
#### 1. Generate SSL Certificate and Key
6
+
7
+
To enable HTTPS, you need a certificate `(cert.pem)` and a private key `(key.pem)`. For local development, you can generate self-signed certificates using OpenSSL with the following commands:
> **Note:** In production environments, always use certificates from a trusted Certificate Authority (CA).
17
+
> It is recommended to rotate these certificates regularly before they expire to minimize the risk of security breaches.
18
+
19
+
> **Reference:** For more detailed guidance on configuring HTTPS, refer to the [official Grafana documentation](https://grafana.com/docs/grafana/latest/setup-grafana/set-up-https/).
20
+
21
+
#### 2. Modify the Docker Compose Configuration
22
+
23
+
Update your `docker-compose.yaml` file with the necessary configurations to enable HTTPS for Grafana. Below is an example snippet for the Grafana service:
By following these steps, you will successfully enable HTTPS for your Grafana deployment. Ensure you test your configuration in both development and production environments to verify functionality and security compliance.
0 commit comments