Skip to content

Commit 3a4fab5

Browse files
authored
[chore][Tanzu Tile] Update docs and add helper scripts (#5329)
* [chore][Tanzu Tile] Update docs and add helper scripts * Update deployments/cloudfoundry/tile/scripts/setup_tanzu.sh * Pass in otelcol version using CLI arg
1 parent a417122 commit 3a4fab5

File tree

4 files changed

+501
-7
lines changed

4 files changed

+501
-7
lines changed

deployments/cloudfoundry/tile/DEVELOPMENT.md

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,27 @@
1717
### Environment setup
1818

1919
- Refer to [this guide](https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/cloudfoundry)
20-
on how to setup the Tanzu environment and local authentication information.
20+
on how to setup the Tanzu environment and local authentication information. The guide has also been copied to a
21+
[script](./scripts/setup_tanzu.sh) that can be used to prepare the Tanzu environment for deploying the tile.
22+
23+
- Create a Tanzu Tile with the latest Splunk OpenTelemetry Collector
24+
```shell
25+
$ ./make-latest-tile
26+
# Alternatively, if just making changes to the tile config without touching the BOSH release, you can just run "tile build"
27+
# instead of the whole make-latest-tile script
28+
```
29+
30+
### Configuring the Tile in the Tanzu Environment
31+
32+
The Tanzu Tile created must be imported, configured, and deployed in your Tanzu environment for testing. The
33+
import and configuration process can be done either via the CLI or Tanzu Ops Manager UI, as described below.
34+
The deployment of the tile is done via the Tanzu Ops Manager UI.
35+
36+
#### CLI Configuration
37+
2138
- A local file in your working directory is required for PCF commands to work. This file must be named `metadata`.
2239
Example contents:
40+
2341
```yaml
2442
---
2543
# Values are found in the hammer file from Self Service's "ops_manager" key
@@ -28,13 +46,7 @@ opsmgr:
2846
username: pivotalcf
2947
password: plain_text_password
3048
```
31-
32-
### CLI Commands
3349
```shell
34-
$ ./make-latest-tile
35-
# Alternatively, if just making changes to the tile config without touching the BOSH release, you can just run "tile build"
36-
# instead of the whole make-latest-tile script
37-
3850
$ pcf import product/splunk-otel-collector-<TILE_VERSION>.pivotal
3951
$ pcf install splunk-otel-collector <TILE_VERSION>
4052

@@ -63,6 +75,31 @@ Once tile is installed and configured you can go to the Ops Manager in your brow
6375
`Splunk Opentelemetry Collector` tile is there, green, and the correct version. Select `Review Pending Changes` ->
6476
Check box for staged changes on your tile -> `APPLY CHANGES`
6577

78+
79+
#### Ops Manager Configuration
80+
81+
- Browse to the Tanzu Ops Manager that you've created in the self service environment.
82+
- Login using credentials provided in self service center.
83+
- Upload Tanzu Tile
84+
- Click`IMPORT A PRODUCT` -> select the created Tanzu Tile.
85+
- The Tile will show up in the left window pane, simply click `+` next to it.
86+
- The Tile will be shown on the Installation Dashboard as not being configured properly.
87+
- Configure Tanzu Tile
88+
- Assign AZs and Networks - Fill in required values, these do not have an impact on the Collector's deployment.
89+
- 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`.
90+
- Splunk Observability Cloud - These config options are directly mapped to the SignalFx's exporter options, so fill in values you use there.
91+
- Resource Config - No changes necessary.
92+
- Click Save after every page's changes.
93+
94+
### Deploying the Tanzu Tile
95+
96+
- Install the Tanzu Tile
97+
- Browse to Tanzu Ops Manager home page.
98+
- Ensure Tanzu Tile shows up with a green bar underneath (configuration is complete).
99+
- Select `REVIEW PENDING CHANGES`
100+
- Optional: Unselect `Small Footprint VMware Tanzu Application Service`. Unselecting this will speed up deployment time.
101+
- Select `APPLY CHANGES`
102+
66103
Once changes are successfully applied, you should see data populating the charts in the Splunk Cloud Observability Suite
67104

68105
### Debugging Common Issues
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Tanzu Tile Scripts
2+
3+
## setup_tanzu.sh
4+
5+
This script is used to setup your Tanzu environment for testing with the Splunk OpenTelemetry Collector Tanzu Tile. Running
6+
this script will allow you to install the Tanzu Tile in your Tanzu environment.
7+
8+
**Sample usage:**
9+
```shell
10+
$ export TAS_JSON=/path/to/hammer/file
11+
$ ./setup_tanzu.sh
12+
```
13+
14+
## generate_osdf.py
15+
16+
This script is used to generate the open source disclosure file (OSDF). This is a file that discloses all of the Tanzu
17+
Tile's dependencies. The Tanzu team used to provide a website interface that would generate this file in a specific
18+
format but dropped support for it. This script generates the file in the same format as their website did.
19+
20+
**Sample usage:**
21+
```shell
22+
$ python3 generate_osdf.py --otelcol_version 0.X.0
23+
```

0 commit comments

Comments
 (0)