Add README for toolbox and correct logging env variable name

This commit is contained in:
Carsten Schafer
2024-06-26 15:55:17 -04:00
parent e86f807619
commit cac306cda8
2 changed files with 29 additions and 2 deletions

View File

@@ -107,10 +107,11 @@ public_env_variables:
CGW_KAFKA_PORT: "9092"
CGW_REDIS_HOST: "redis"
CGW_REDIS_PORT: "6379"
CFG_LOG_LEVEL: "Info" # or Debug
CGW_LOG_LEVEL: "info" # or debug
CGW_KAFKA_CONSUME_TOPIC: "CnC"
CGW_KAFKA_PRODUCE_TOPIC: "CnC_Res"
DEFAULT_WSS_THREAD_NUM: "4"
# set to (#cpus * 2) - 2
DEFAULT_WSS_THREAD_NUM: "6"
secret_env_variables:
CGW_DB_PASSWORD: "123"

26
utils/toolbox/README.md Normal file
View File

@@ -0,0 +1,26 @@
# CGW Toolbox
## About
Toolbox can be used to run the various utilities in the _openlan-cgw/utils/_ directory within the
confines of the cluster (and with full access to the various services.)
It has utilities to access redis, kafka and postgres.
## Usage
```bash
# To run a temporary toolbox (disappears when you exit the session):
kubectl -n NAMESPACE run -it cgwtools --rm --image tip-tip-wlan-cloud-ucentral.jfrog.io/cgw-toolbox:latest --command -- /bin/bash
# Keep it around:
kubectl -n NAMESPACE run -it cgwtools --image tip-tip-wlan-cloud-ucentral.jfrog.io/cgw-toolbox:latest --command -- /bin/bash
# You can then attach to it with this command at any time
kubectl -n NAMESPACE attach cgwtools -c cgwtools -it
# Then delete it when you're done
kubectl -n NAMESPACE delete pod cgwtools
```
Once inside you can run various commands:
TODO show some available commands