Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore][Tanzu Tile] Update docs and add helper scripts #5329

Merged
merged 3 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 44 additions & 7 deletions deployments/cloudfoundry/tile/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,27 @@
### 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.
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
```shell
$ ./make-latest-tile
# Alternatively, if just making changes to the tile config without touching the BOSH release, you can just run "tile build"
# instead of the whole make-latest-tile script
```

### Configuring the Tile in the Tanzu Environment

The Tanzu Tile created must be imported, configured, and deployed in your Tanzu environment for testing. The
import and configuration process can be done either via the CLI or Tanzu Ops Manager UI, as described below.
The deployment of the tile is done via the Tanzu Ops Manager UI.

#### CLI Configuration

- A local file in your working directory is required for PCF commands to work. This file must be named `metadata`.
Example contents:

```yaml
---
# Values are found in the hammer file from Self Service's "ops_manager" key
Expand All @@ -28,13 +46,7 @@ opsmgr:
username: pivotalcf
password: plain_text_password
```

### CLI Commands
```shell
$ ./make-latest-tile
# Alternatively, if just making changes to the tile config without touching the BOSH release, you can just run "tile build"
# instead of the whole make-latest-tile script

$ pcf import product/splunk-otel-collector-<TILE_VERSION>.pivotal
$ pcf install splunk-otel-collector <TILE_VERSION>

Expand Down Expand Up @@ -63,6 +75,31 @@ 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.
- Login using credentials provided in self service center.
- Upload Tanzu Tile
- Click`IMPORT A PRODUCT` -> select the created Tanzu Tile.
- The Tile will show up in the left window pane, simply click `+` next to it.
- The Tile will be shown on the Installation Dashboard as not being configured properly.
- Configure Tanzu Tile
- Assign AZs and Networks - Fill in required values, these do not have an impact on the Collector's deployment.
- Nozzle Config - The two UAA arguments are required, use the values supplied by the [setup script](./scripts/setup_tanzu.sh). The default username is `my-v2-nozzle` and password is `password`.
- Splunk Observability Cloud - These config options are directly mapped to the SignalFx's exporter options, so fill in values you use there.
- Resource Config - No changes necessary.
- Click Save after every page's changes.

### Deploying the Tanzu Tile

- Install the Tanzu Tile
- Browse to Tanzu Ops Manager home page.
- Ensure Tanzu Tile shows up with a green bar underneath (configuration is complete).
- Select `REVIEW PENDING CHANGES`
- Optional: Unselect `Small Footprint VMware Tanzu Application Service`. Unselecting this will speed up deployment time.
- Select `APPLY CHANGES`

Once changes are successfully applied, you should see data populating the charts in the Splunk Cloud Observability Suite

### Debugging Common Issues
Expand Down
23 changes: 23 additions & 0 deletions deployments/cloudfoundry/tile/scripts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Tanzu Tile Scripts
crobert-1 marked this conversation as resolved.
Show resolved Hide resolved

## setup_tanzu.sh

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.

**Sample usage:**
```shell
$ python3 generate_osdf.py --otelcol_version 0.X.0
```
Loading