Prepare repo to be public

Author: SaiedKazemi

README.md

@@ -0,0 +1,14 @@
+
+
+This repository contains a collection of tools for Iris maintainers
+to make it easier to manage Iris.  Currently it includes tools for:
+
+  - Publishing Iris data
+  - Scanning container logs
+  - Updating `iris-agent` containers without having to recreate them
+
+Note that some of these tools, which interact directly with the
+Iris containers running on the Iris server, must be executed on the
+Iris server itself.
+
+Also, the tool for updating `iris-agent` containers requires `gcloud`.

README.txt

@@ -1,5 +1,6 @@
-This directory contains files that may take a long time to generate,
-but all contents can and should be regenerated to meet your desired
-criteria.
+This directory serves as a cache directory for files that can take
+a long time to generate.
 
-You can use the contents here for quick reference.
+You can use the cached files here for quick reference but all of
+these files can and should be regenerated to meet your desired
+criteria.

cache/README.txt

@@ -84,10 +84,10 @@ readonly CLEANED_RESULTS_TABLE_EXPORT=$(cat <<EOF
 EOF
 )
 # Uploading.
-readonly GCP_PROJECT_ID="mlab-edgenet"
-readonly BQ_PUBLIC_DATASET="iris_test" # public dataset with tables in scamper1 format
-readonly BQ_PRIVATE_DATASET="iris_test_2" # private dataset to store temporary tables during conversion
-readonly BQ_TABLE="elena1" # table in scamper1 format
+readonly GCP_PROJECT_ID=""
+readonly BQ_PUBLIC_DATASET="" # public dataset with tables in scamper1 format
+readonly BQ_PRIVATE_DATASET="" # private dataset to store temporary tables during conversion
+readonly BQ_TABLE="" # table in scamper1 format
 readonly SCHEMA_RESULTS_JSON="${toplevel}/db/schema_results.json"
 readonly SCHEMA_SCAMPER1_JSON="${toplevel}/db/scamper1.json"
 readonly TABLE_CONVERSION_QUERY="${toplevel}/db/iris_to_mlab.sql"

conf/tables.conf

@@ -1,4 +1,6 @@
-This directory contains exported Iris tables from ClickHouse and
-serves as the staging area for uploading them to BigQuery.  None
-of the exported tables in this directory should be added to the
-repo.
+When publishing Iris data, this directory will contain exported
+Iris tables from ClickHouse and will serve as the staging area for
+uploading them to BigQuery.
+
+None of the exported tables in this directory should be added to
+the repo.

exported_tables/README.txt

@@ -2,10 +2,10 @@
 
 #
 # This script must be executed on the Iris server, as it relies on
-# the `logcli`.
+# the `logcli` tool.
 #
 # It scans container logs of $CONTAINER_NAME for a specific $PATTERN
-# within from $START_DATE to $END_DATE.
+# from $START_DATE to $END_DATE.
 #
 # The time period is divided into 30-day intervals to comply with
 # Loki's configuration limits (i.e., longer periods are not supported).

tools/scan_logs.sh

@@ -37,7 +37,7 @@ ZONES=(
 main() {
 	for ((i=0; i<${#HOSTS[@]}; i++)); do
 	    echo "${HOSTS[${i}]}"
-	    gcloud compute ssh --project mlab-edgenet --zone "${ZONES[${i}]}" "${HOSTS[${i}]}" --command="
+	    gcloud compute ssh --project "${GCP_PROJECT_ID}" --zone "${ZONES[${i}]}" "${HOSTS[${i}]}" --command="
 			readonly IMAGE_NAME=\"ghcr.io/dioptra-io/iris/iris-agent:production\"
 			readonly CONTAINER_NAME=\"iris-agent\"