Skip to content

Commit

Permalink
[chore] Update Tile docs (#5440)
Browse files Browse the repository at this point in the history
* [chore][Tanzu] Clarify warning message from script

* [chore] Update Tanzu docs

* Remove unrelated change, add empty newline to end of file
  • Loading branch information
crobert-1 authored Oct 3, 2024
1 parent 2f02317 commit f86ae11
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 5 deletions.
16 changes: 12 additions & 4 deletions deployments/cloudfoundry/tile/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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.
Expand Down
10 changes: 9 additions & 1 deletion deployments/cloudfoundry/tile/scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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
```
```

## 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.
29 changes: 29 additions & 0 deletions deployments/cloudfoundry/tile/scripts/install_cli_depencies.sh
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit f86ae11

Please sign in to comment.