From 05c6527b2c852c34b8f3069de33339db3b593756 Mon Sep 17 00:00:00 2001 From: Curtis Robert Date: Mon, 9 Sep 2024 14:30:02 -0700 Subject: [PATCH] Pass in otelcol version using CLI arg --- deployments/cloudfoundry/tile/scripts/README.md | 13 ++++++++++++- .../cloudfoundry/tile/scripts/generate_osdf.py | 12 +++++++++--- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/deployments/cloudfoundry/tile/scripts/README.md b/deployments/cloudfoundry/tile/scripts/README.md index c66d6490b2..2c5045b48a 100644 --- a/deployments/cloudfoundry/tile/scripts/README.md +++ b/deployments/cloudfoundry/tile/scripts/README.md @@ -5,8 +5,19 @@ This script is used to setup your Tanzu environment for testing with the Splunk OpenTelemetry Collector Tanzu Tile. Running this script will allow you to install the Tanzu Tile in your Tanzu environment. +**Sample usage:** +```shell +$ export TAS_JSON=/path/to/hammer/file +$ ./setup_tanzu.sh +``` + ## generate_osdf.py This script is used to generate the open source disclosure file (OSDF). This is a file that discloses all of the Tanzu Tile's dependencies. The Tanzu team used to provide a website interface that would generate this file in a specific -format but dropped support for it. This script generates the file in the same format as their website did. \ No newline at end of file +format but dropped support for it. This script generates the file in the same format as their website did. + +**Sample usage:** +```shell +$ python3 generate_osdf.py --otelcol_version 0.X.0 +``` \ No newline at end of file diff --git a/deployments/cloudfoundry/tile/scripts/generate_osdf.py b/deployments/cloudfoundry/tile/scripts/generate_osdf.py index 14910dad18..4665ec8396 100644 --- a/deployments/cloudfoundry/tile/scripts/generate_osdf.py +++ b/deployments/cloudfoundry/tile/scripts/generate_osdf.py @@ -1,3 +1,4 @@ +import argparse import io import subprocess @@ -398,14 +399,19 @@ def get_appendix_output(): return output def main(): - otelcol_ver = "0.95.0" + parser = argparse.ArgumentParser(description='Generate open source disclosure file (OSDF) for Tanzu Tile') + parser.add_argument('--otelcol_version', dest="otelcol_ver", type=str, + help='Splunk OpenTelemetry Collector version') + args = parser.parse_args() + + parse_dependencies() - output = HEADER.replace("COLLECTOR_VERSION", otelcol_ver) + output = HEADER.replace("COLLECTOR_VERSION", args.otelcol_ver) output += get_primary_output() output += get_appendix_output() output += APPENDIX_CONTENTS - with open("./OSDF V" + otelcol_ver + ".txt", "w") as file: + with open("./OSDF V" + args.otelcol_ver + ".txt", "w") as file: file.write(output) if __name__ == '__main__':