fest: create basic script for index drift detection and elimination

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{js,json,yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

.gitignore

@@ -0,0 +1,134 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+!indexes/**
+
+.DS_Store

.nvmrc

@@ -0,0 +1 @@
+v22

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

Dockerfile

@@ -0,0 +1,21 @@
+FROM node:22-alpine AS base
+WORKDIR /app
+RUN corepack enable
+COPY package.json yarn.lock .yarnrc.yml ./
+
+FROM base AS build
+COPY . .
+RUN yarn workspaces focus --all \
+  && yarn build
+
+FROM base AS prod-dependencies
+RUN yarn workspaces focus --all --production
+
+FROM base AS production
+COPY --chown=node:node package.json .
+COPY --chown=node:node --from=prod-dependencies /app/node_modules ./node_modules
+COPY --chown=node:node --from=build /app/dist ./dist
+COPY --chown=node:node ./indexes ./indexes
+
+USER node
+ENTRYPOINT ["node", "dist/index.js"]

README.md

@@ -1 +1,101 @@
-# index-alignment
+# Codefresh index alignment
+
+## Usage
+
+```shell
+docker run quay.io/codefresh/index-alignment:<version> --help
+```
+```
+Options:
+  -h, --help         display help for command
+
+Commands:
+  dump [options]     [Internal] Dump all indexes from a MongoDB instance
+  stats [options]    Get stats for all collections from a MongoDB instance
+  compare [options]  Compare indexes from a target MongoDB instance with a recommended dump
+  sync [options]     Sync indexes from a recommended dump with a target MongoDB instance. The command
+                     will fail if it is required to create indexes on heavily populated collections and
+                     the `--force` flag has not been specified
+  help [command]     display help for command
+```
+
+
+
+### Commands
+
+## `compare`
+
+Compare indexes from a target MongoDB instance with a recommended dump.
+
+All logs are written to the STDERR stream, so they can be easily separated from the actual output, which is written to STDOUT.
+
+We recommend redirecting the output of `compare` command to JSON file.
+
+> [!IMPORTANT]
+> The credentials under which the command is run must have read access to all databases controlled by Codefresh.
+
+```
+Options:
+  -p, --product <product>                       Codefresh product: classic | gitops
+  -u, --uri <uri>                               MongoDB URI
+  -m --db-map [dump-db-name=target-db-name...]  Map the databases in the dump with the target databases. We have our own naming convention for the production databases, but it is up to the customers to name their databases (default: ["google_production=codefresh","chart-manager=charts-manager","kubernetes-monitor=k8s-monitor"])
+  -h, --help                                    display help for command
+```
+
+Example:
+
+```shell
+docker run quay.io/codefresh/index-alignment:<version> compare --product "classic" --uri "<db-uri>" > classic-diff.json
+
+docker run quay.io/codefresh/index-alignment:<version> compare --product "gitops" --uri "<db-uri>" > gitops-diff.json
+```
+
+## `stats`
+
+Get stats for all collections from a MongoDB instance. Following commands will be executed:
+
+* `dbStats` command ([doc](https://www.mongodb.com/docs/v5.0/reference/command/dbStats/));
+
+* `$collStats` aggregation ([doc](https://www.mongodb.com/docs/v5.0/reference/operator/aggregation/collStats/));
+
+* `$planCacheStats` aggregation ([doc](https://www.mongodb.com/docs/v5.0/reference/operator/aggregation/plancachestats/));
+
+* queries `_id` of the oldest doc in each collection.
+
+> [!IMPORTANT]
+> The credentials under which the command is run must have permissions to execute the commands specified above.
+
+All logs are written to the STDERR stream, so they can be easily separated from the actual output, which is written to STDOUT.
+
+We recommend redirecting the output of `stats` command to JSON file.
+
+```
+Options:
+  -u, --uri <uri>  MongoDB URI
+  -h, --help       display help for command
+```
+
+Example:
+
+```shell
+docker run quay.io/codefresh/index-alignment:<version> stats --uri "<db-uri>" > db-stats.json
+```
+
+## `sync`
+
+> [!CAUTION]
+> This command changes indexes in the target DB, which may have performance impact.
+>
+> We strongly advice to NOT use this command against production DB because of possible performance impact. Instead, use `compare` command to get the diff, then consider eliminating index diff manually during maintainance window.
+
+
+Sync indexes from a recommended dump with a target MongoDB instance. The command will fail if it is required to create indexes on heavily populated collections and the `--force` flag has not been specified
+
+```
+Options:
+  -p, --product <product>                       Codefresh product: classic | gitops
+  -u, --uri <uri>                               MongoDB URI
+  -f --force                                    Create indexes even on heavily populated collections, which may take a while
+  -m --db-map [dump-db-name=target-db-name...]  Map the databases in the dump with the target databases. We have our own naming convention for the production databases, but it is up to the customers to name their databases (default: ["google_production=codefresh","chart-manager=charts-manager","kubernetes-monitor=k8s-monitor"])
+  -h, --help                                    display help for command
+```