From f86ae117466d0303280a4cc154a47738331dc571 Mon Sep 17 00:00:00 2001 From: Curtis Robert Date: Thu, 3 Oct 2024 13:05:34 -0700 Subject: [PATCH] [chore] Update Tile docs (#5440) * [chore][Tanzu] Clarify warning message from script * [chore] Update Tanzu docs * Remove unrelated change, add empty newline to end of file --- deployments/cloudfoundry/tile/DEVELOPMENT.md | 16 +++++++--- .../cloudfoundry/tile/scripts/README.md | 10 ++++++- .../tile/scripts/install_cli_depencies.sh | 29 +++++++++++++++++++ 3 files changed, 50 insertions(+), 5 deletions(-) create mode 100644 deployments/cloudfoundry/tile/scripts/install_cli_depencies.sh diff --git a/deployments/cloudfoundry/tile/DEVELOPMENT.md b/deployments/cloudfoundry/tile/DEVELOPMENT.md index ffaa79695a..95d096d3a2 100644 --- a/deployments/cloudfoundry/tile/DEVELOPMENT.md +++ b/deployments/cloudfoundry/tile/DEVELOPMENT.md @@ -16,13 +16,22 @@ Version `14.0.6-dev.1` has been confirmed to be work. ## Development Workflow -### Environment setup +### Install Required CLI tools -- Refer to [this guide](https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/cloudfoundry) +Refer to the [install_cli_dependencies script](https://github.com/signalfx/splunk-otel-collector/tree/main/deployments/cloudfoundry/tile/scripts#install_cli_depenciessh) +for information on how to install all required CLI tools locally. + +### Tanzu Environment setup + +Refer to [this guide](https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/cloudfoundry) on how to setup the Tanzu environment and local authentication information. The guide has also been copied to a [script](./scripts/setup_tanzu.sh) that can be used to prepare the Tanzu environment for deploying the tile. -- Create a Tanzu Tile with the latest Splunk OpenTelemetry Collector + +### Create a Tanzu Tile + +Create a Tanzu Tile with the latest Splunk OpenTelemetry Collector + ```shell $ ./make-latest-tile # Alternatively, if just making changes to the tile config without touching the BOSH release, you can just run "tile build" @@ -77,7 +86,6 @@ Once tile is installed and configured you can go to the Ops Manager in your brow `Splunk Opentelemetry Collector` tile is there, green, and the correct version. Select `Review Pending Changes` -> Check box for staged changes on your tile -> `APPLY CHANGES` - #### Ops Manager Configuration - Browse to the Tanzu Ops Manager that you've created in the self service environment. diff --git a/deployments/cloudfoundry/tile/scripts/README.md b/deployments/cloudfoundry/tile/scripts/README.md index 9dcfa91392..5ac6d2de76 100644 --- a/deployments/cloudfoundry/tile/scripts/README.md +++ b/deployments/cloudfoundry/tile/scripts/README.md @@ -7,6 +7,8 @@ this script will allow you to install the Tanzu Tile in your Tanzu environment. **Sample usage:** ```shell +# The hammer file is available in the Self Service center for your specific +# Tanzu environment. $ export TAS_JSON=/path/to/hammer/file $ ./setup_tanzu.sh ``` @@ -24,4 +26,10 @@ format but dropped support for it. This script generates the file in the same fo ```shell # When creating the tile locally the version can be found in deployments/cloudfoundry/tile/tile-history.yml $ python3 deployments/cloudfoundry/tile/scripts/generate_osdf.py --otelcol_version 0.X.0 -``` \ No newline at end of file +``` + +## install_cli_dependencies.sh + +This is a shell script used to install all of the CLI tools that are arequired for development +working on the Tanzu Tile. This script was made for MacOS, and has not been +tested on any other OS at this time. diff --git a/deployments/cloudfoundry/tile/scripts/install_cli_depencies.sh b/deployments/cloudfoundry/tile/scripts/install_cli_depencies.sh new file mode 100644 index 0000000000..ad2ca916ef --- /dev/null +++ b/deployments/cloudfoundry/tile/scripts/install_cli_depencies.sh @@ -0,0 +1,29 @@ +# Note: This script installs all CLI tools that are required for local Tanzu Tile related deevelopment +# This script was originally written for MacOS and has not been tested on other platforms. + +brew install jq +brew install wget +brew install cloudfoundry/tap/bosh-cli + +# Navigate to: https://github.com/cf-platform-eng/tile-generator +# Download the tile and pcf release asssets, these will need to be an old version on MacOS, darwin support was dropped +chmod +x ~/Downloads/tile_darwin-64bit +chmod +x ~/Downloads/pcf_darwin-64bit +mv ~/Downloads/pcf_darwin-64bit /usr/local/bin/pcf +mv ~/Downloads/tile_darwin-64bit /usr/local/bin/tile + +brew tap pivotal/hammer https://github.com/pivotal/hammer +brew install hammer +brew install cloudfoundry/tap/cf-cli@8 +brew tap pivotal-cf/om https://github.com/pivotal-cf/om +brew install om + +brew install rbenv ruby-build +echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile +source ~/.bash_profile +rbenv install 3.1.3 +rbenv global 3.1.3 +ruby -v +gem install cf-uaac + +gem install license_finder