Skip to content

Commit 036ac0b

Browse files
authored
Update README.md
Added additional deployment instructions.
1 parent 372fd54 commit 036ac0b

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

ast-on-k8s/README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,26 @@
22

33
This directory contains the manifest files for running the Application Study Tool in a Kubernetes cluster
44

5-
You will also need to modify the following files at minimum.
5+
To just clone this directory (./ast-on-k8s), where the Kubernetes manifest files are located, you can follow these steps:
6+
```
7+
$ mkdir ast-on-k8s
8+
$ cd ast-on-k8s
9+
$ git init
10+
$ git remote add -f origin https://github.com/javajason/ast-config-wizard
11+
$ git config core.sparseCheckout true
12+
$ echo “ast-on-k8s/“ >> .git/info/sparse-checkout
13+
$ git pull origin main
14+
```
15+
16+
You will also need to modify the following files, at minimum.
617
- env-configmap.yaml:
718
Update the Grafana credentials to the desired credentials and the SENSOR_ID/SENSOR_SECRET_TOKEN if using the global AST dashboard.
819
- env-device-secrets-configmap.yaml:
9-
Update the BIGIP_PASSWORD_1 value to the password of your BIG-IPs. If there are multiple BIG-IP passwords, also update BIGIP_PASSWORD_2, BIGIP_PASSWORD_3, BIGIP_PASSWORD_4, etc.
20+
Update the BIGIP_PASSWORD_1 value to the password of your BIG-IPs. If there are multiple BIG-IP passwords, also update BIGIP_PASSWORD_2, BIGIP_PASSWORD_3, BIGIP_PASSWORD_4, etc. (TODO: This needs to be changed so these passwords are stored as Kubernetes secrets.)
1021
- otel-collector-deployment.yaml:
11-
This file has two environment variables for BIG-IP passwords, BIGIP_PASSWORD_1 and BIGIP_PASSWORD_2. If you have more than two BIG-IP passwords, you will need to add them here.
22+
This file has two environment variables that represent BIG-IP passwords, BIGIP_PASSWORD_1 and BIGIP_PASSWORD_2. If you have more than two BIG-IP passwords, you will need to add them here.
1223
- rec-pipe-configmap.yaml:
13-
This is the equivalent of the services/otel_collector/receivers.yaml file. You will need to list all BIG-IPs to be monitored, along with their settings, in this file. You will also need to reference the BIG-IPs (i.e., "bigip/1", "bigip/2", etc.) in the receivers section under pipelines.yaml (also in this file).
24+
This is the equivalent of the services/otel_collector/receivers.yaml file. You will need to list all BIG-IPs to be monitored, along with their settings, in this file. You will also need to reference the BIG-IPs (i.e., "bigip/1", "bigip/2", etc.) in the receivers subsection under pipelines.yaml section (also in this file).
1425

1526
Other files in this directory can also be modified for additional customization. See the original repo (https://github.com/f5devcentral/application-study-tool) for specific customization guidance.
1627

0 commit comments

Comments
 (0)