Publish AST v0.1.1

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1 +1,161 @@
-AST
+# Application Study Tool
+
+## Overview
+
+The Application Study Tool is intended to provide enhanced insights into (classic) BIG-IP products, leveraging best in class
+open source telemetry tools. The full installation inculdes:
+
+* Custom Instance of OpenTelemetry Collector with enhanced BIG-IP data receivers (data fetched via iControlRest).
+* Prometheus timeseries database for storing and querying collected data.
+* Grafana Instance with pre-configured dashboards for quick insights at the device and "fleet" levels.
+
+The Application Study Tool has everything needed to quickly get up and running with application insights at less than
+production levels of reliability. For production/operational use cases, you can build on the included components,
+accounting for things like high availability, enhanced security via e.g. grafana OIDC integrationm, and similar. Alternatively,
+the openetlemetry collector can be configured to send data to existing production ops monitoring tools as desired.
+
+## Getting Started
+
+### Prerequisites
+
+docker (or compatible) - [Installation Instructions](https://docs.docker.com/engine/install/)
+
+### Installation
+
+Clone the repo or download source tarball from the [release](https://github.com/f5devcentral/application-study-tool/releases) section.
+
+```shell
+git clone https://github.com/f5devcentral/application-study-tool.git
+cd application-study-tool
+```
+
+#### Configure Devices To Scrape
+Application Study Tool includes an init container which builds an OpenTelemetry
+Collector Configuration file based on a provided list of BIG-IPs in JSON format.
+
+Edit config/big-ips.json to reflect your list of BIG-IPs and their access credentials:
+```json
+[
+  {
+    // Set this to the management IP for the device. This must be
+    // reachable from the Application Study Tool host.
+    "endpoint": "https://10.0.0.1",
+    // Set this to the desired account's user name
+    "username": "admin",
+    // This field tells the collector the name of an environment variable
+    // which contains the password for the device.
+    // This field does not contain the password itself.
+    "password_env_ref": "BIGIP_PASSWORD_1",
+    // Secure TLS communication requires mounting the certificate bundle
+    // used to sign the BigIP certificates. Though not recommended, in the
+    // case of self-signed certificates or for testing purposes, you can skip
+    // this check by setting this field to true.
+    "tls_insecure_skip_verify": false,
+    // The path to a CA File used to validate BIG-IP certificates. This is required
+    // if tls_insecure_skip_verify is set to false. See below for details.
+    "ca_file": "",
+  }
+]
+```
+
+#### Configure Device Secrets
+The application study tool default configuration relies on environment variables
+which contain device access credentials. There are a number of ways to manage and
+inject secrets into a container environment (modifications to the docker-compose file
+to support your preferred management process are encouraged), but for simplicity,
+if there is a file named .env.device-secrets in the root project directory they will be
+mounted.
+
+Create a file called .env.device-secrets, and add your BIP passwords like so:
+```
+BIGIP_PASSWORD_1=foo-bar123!
+BIGIP_PASSWORD_2=bar-foo123!
+```
+
+The variable name (the part on the left of the equal sign) must match the configured
+value for the devices that use this password in config/big-ips.json.
+
+#### Configure CA File
+AST expects a valid TLS cert bundle unless `tls_insecure_skip_verify` is
+set to true for each device. In order to mount and use your CA file, you must
+configure the docker-compose.yaml file in this directory, and set the `ca_file` parameter to the resulting path. Example:
+
+docker-compose.yaml:
+```yaml
+  ...
+  otel-collector:
+    ...
+    volumes:
+      - otel_collector:/etc/otel-collector-config
+      - ./config/ca_bundle.pem:/etc/ssl/ca_bundle.pem
+```
+
+big-ips.json:
+```json
+[
+  { // device 1
+    ...
+    "ca_file": "/etc/ssl/ca_bundle.pem",
+  },
+  { // device 2
+    ...
+    "ca_file": "/etc/ssl/ca_bundle.pem",
+  },
+]
+```
+
+The configuration paramteter `tls_insecure_skip_verify` defaults to false. Installers
+ that would like to opt-in to run in an insecure TLS mode must set
+ `tls_insecure_skip_verify: true` for each BIG-IP in the config array and understand
+ that the connection between the OTEL collector and the BIG-IP does not have secure
+ TLS termination.
+
+#### Configure Grafana
+The Grafana instance can be configured via environment variable using their standard
+[options](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#override-configuration-with-environment-variables).
+
+The included .env-example can be copied over and modified to set the initial admin
+password to a value you select:
+
+```
+cp .env-example .env
+<edit .env with desired admin password and any other variables>
+```
+
+#### Run Application Study Tool
+```
+docker compose up
+```
+
+#### View The Dashboards
+The default grafana user/pass is `admin/admin`, and can be accessed at
+`http://<hostname>:3000`.
+
+
+## Support
+
+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).
+
+## Community Code of Conduct
+
+Please refer to the [F5 DevCentral Community Code of Conduct](code_of_conduct.md).
+
+## License
+
+[Apache License 2.0](LICENSE)
+
+## Copyright
+
+Copyright 2014-2024 F5 Networks Inc.
+
+### F5 Networks Contributor License Agreement
+
+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).
+
+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.
+Otherwise by submitting a CLA you represent that you are legally entitled to grant the licenses recited therein.
+
+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.
+
+If you are signing on behalf of a company, you represent that you are legally entitled to grant the license recited therein.
+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.

SUPPORT.md

@@ -0,0 +1,8 @@
+# Support Information
+
+Maintenance and F5 Technical Support of this F5 code is provided only if the
+software (i) is unmodified; and (ii) has been marked as F5 Supported in
+SOL80012344, (<https://support.f5.com/csp/article/K80012344>).
+
+Support will only be provided to customers who have an existing BIG-IP support contract associated with a valid BIG-IP serial number.
+For information about support policies, see <http://www.f5.com/about/guidelines-policies/> and <http://askf5.com>.

VERSION

@@ -0,0 +1 @@
+v0.1.1