From 159444285fa2bb9e2b7ab3c1c9aa5532a23e43bd Mon Sep 17 00:00:00 2001
From: Prajwal214 <167504578+Prajwal214@users.noreply.github.com>
Date: Mon, 3 Jun 2024 19:42:43 +0530
Subject: [PATCH] Minor: Adding Docs for openmetadata-ops (#16460)

---
 .../deployment/upgrade/post-upgrade-steps.md  | 79 +++++++++++++++++++
 .../deployment/upgrade/post-upgrade-steps.md  | 79 +++++++++++++++++++
 2 files changed, 158 insertions(+)

diff --git a/openmetadata-docs/content/partials/v1.3/deployment/upgrade/post-upgrade-steps.md b/openmetadata-docs/content/partials/v1.3/deployment/upgrade/post-upgrade-steps.md
index b2241dbaa67..062fe68cf45 100644
--- a/openmetadata-docs/content/partials/v1.3/deployment/upgrade/post-upgrade-steps.md
+++ b/openmetadata-docs/content/partials/v1.3/deployment/upgrade/post-upgrade-steps.md
@@ -32,3 +32,82 @@ pip install openmetadata-managed-apis==x.y.z
 {% partial file="/v1.3/deployment/redeploy.md" /%}
 
 If you are seeing broken dags select all the pipelines from all the services and re deploy the pipelines.
+
+# Openmetadata-ops Script
+
+## Overview
+
+The `openmetadata-ops` script is designed to manage and migrate databases and search indexes, reindex existing data into Elastic Search or OpenSearch, and redeploy service pipelines.
+
+## Usage
+
+``` bash
+sh openmetadata-ops.sh [-dhV] [COMMAND]
+```
+
+#### Commands
+* analyze-tables 
+
+Migrates secrets from the database to the configured Secrets Manager. Note that this command does not support migrating between external Secrets Managers.
+
+* changelog
+
+Prints the change log of database migration.
+
+* check-connection
+
+Checks if a connection can be successfully obtained for the target database.
+
+* deploy-pipelines
+
+Deploys all the service pipelines.
+
+* drop-create
+
+Deletes any tables in the configured database and creates new tables based on the current version of OpenMetadata. This command also re-creates the search indexes.
+
+* info
+
+Shows the list of migrations applied and the pending migrations waiting to be applied on the target database.
+
+* migrate
+
+Migrates the OpenMetadata database schema and search index mappings.
+
+* migrate-secrets
+
+Migrates secrets from the database to the configured Secrets Manager. Note that this command does not support migrating between external Secrets Managers.
+
+* reindex
+
+Reindexes data into the search engine from the command line.
+
+* repair
+
+Repairs the DATABASE_CHANGE_LOG table, which is used to track all the migrations on the target database. This involves removing entries for the failed migrations and updating the checksum of migrations already applied on the target database.
+
+* validate
+
+Checks if all the migrations have been applied on the target database.
+
+### Examples
+
+Display Help To display the help message:
+
+```bash
+sh openmetadata-ops.sh --help
+```
+
+### Migrate Database Schema
+
+To migrate the database schema and search index mappings:
+```bash
+sh openmetadata-ops.sh migrate
+```
+
+### Reindex Data
+
+To reindex data into the search engine:
+```bash
+sh openmetadata-ops.sh reindex
+```
diff --git a/openmetadata-docs/content/partials/v1.4/deployment/upgrade/post-upgrade-steps.md b/openmetadata-docs/content/partials/v1.4/deployment/upgrade/post-upgrade-steps.md
index 39bf81d5cd5..0797f852471 100644
--- a/openmetadata-docs/content/partials/v1.4/deployment/upgrade/post-upgrade-steps.md
+++ b/openmetadata-docs/content/partials/v1.4/deployment/upgrade/post-upgrade-steps.md
@@ -32,3 +32,82 @@ pip install openmetadata-managed-apis==x.y.z
 {% partial file="/v1.4/deployment/redeploy.md" /%}
 
 If you are seeing broken dags select all the pipelines from all the services and re deploy the pipelines.
+
+# Openmetadata-ops Script
+
+## Overview
+
+The `openmetadata-ops` script is designed to manage and migrate databases and search indexes, reindex existing data into Elastic Search or OpenSearch, and redeploy service pipelines.
+
+## Usage
+
+``` bash
+sh openmetadata-ops.sh [-dhV] [COMMAND]
+```
+
+#### Commands
+* analyze-tables 
+
+Migrates secrets from the database to the configured Secrets Manager. Note that this command does not support migrating between external Secrets Managers.
+
+* changelog
+
+Prints the change log of database migration.
+
+* check-connection
+
+Checks if a connection can be successfully obtained for the target database.
+
+* deploy-pipelines
+
+Deploys all the service pipelines.
+
+* drop-create
+
+Deletes any tables in the configured database and creates new tables based on the current version of OpenMetadata. This command also re-creates the search indexes.
+
+* info
+
+Shows the list of migrations applied and the pending migrations waiting to be applied on the target database.
+
+* migrate
+
+Migrates the OpenMetadata database schema and search index mappings.
+
+* migrate-secrets
+
+Migrates secrets from the database to the configured Secrets Manager. Note that this command does not support migrating between external Secrets Managers.
+
+* reindex
+
+Reindexes data into the search engine from the command line.
+
+* repair
+
+Repairs the DATABASE_CHANGE_LOG table, which is used to track all the migrations on the target database. This involves removing entries for the failed migrations and updating the checksum of migrations already applied on the target database.
+
+* validate
+
+Checks if all the migrations have been applied on the target database.
+
+### Examples
+
+Display Help To display the help message:
+
+```bash
+sh openmetadata-ops.sh --help
+```
+
+### Migrate Database Schema
+
+To migrate the database schema and search index mappings:
+```bash
+sh openmetadata-ops.sh migrate
+```
+
+### Reindex Data
+
+To reindex data into the search engine:
+```bash
+sh openmetadata-ops.sh reindex
+```