mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-31 04:14:34 +00:00
Documentation Section for using openmetadata-ops.sh usage (#19048)
This commit is contained in:
safayavatsal
GitHub
parent
2dff3f87be
commit
cab9245b4d
@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Understanding openmetadata-ops.sh file
|
||||
slug: /developers/contribute/build-code-and-run-tests/openmetadata-ops
|
||||
---
|
||||
|
||||
# Understanding openmetadata-ops.sh file
|
||||
Learn how to run the OpenMetadata Ops in development mode by using commands.
|
||||
|
||||
#### Key Commands:
|
||||
How to run the `openmetadata-ops.sh` file.
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh [OPTIONS] [COMMANDS]
|
||||
```
|
||||
|
||||
#### Options:
|
||||
1. -c, --config=<configFilePath>
|
||||
2. -d, --debug
|
||||
3. -h, --help Show this help message and exit.
|
||||
4. -V, --version Print version information and exit.
|
||||
|
||||
**Example:**
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh --help
|
||||
```
|
||||
|
||||
#### Commands:
|
||||
1. **migrate** Migrates the OpenMetadata database schema and search index mappings.
|
||||
|
||||
2. **reindex** Re Indexes data into search engine from command line.
|
||||
|
||||
3. **repair** Repairs the DATABASE_CHANGE_LOG table which is used to trackall the migrations on the target database. This involves removing entries for the failed migrations and updatethe checksum of migrations already applied on the target database.
|
||||
|
||||
4. **validate** Checks if the all the migrations haven been applied on the target database.
|
||||
|
||||
5. **drop-create** Deletes any tables in configured database and creates a new tables based on current version of OpenMetadata. This command also re-creates the search indexes.
|
||||
|
||||
6. **deploy-pipelines** Deploy all the service pipelines.
|
||||
|
||||
7. **analyze-tables** Migrate secrets from DB to the configured Secrets Manager. Note that this does not support migrating between external Secrets Managers.
|
||||
|
||||
8. **changelog** Prints the change log of database migration.
|
||||
|
||||
9. **check-connection** Checks if a connection can be successfully obtained for the target database
|
||||
|
||||
10. **info** Shows the list of migrations applied and the pending migration waiting to be applied on the target database
|
||||
|
||||
11. **migrate-secrets** Migrate secrets from DB to the configured Secrets Manager. Note that this does not support migrating between external Secrets Managers
|
||||
|
||||
12. **syncEmailFromEnv** Sync the email configuration from environment variables
|
||||
|
||||
**Example:**
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh migration
|
||||
```
|
||||
@ -50,6 +50,10 @@ Extract the distribution tar.gz file created on the previous step and run the fo
|
||||
cd open-metadata-<version>
|
||||
sh bootstrap/openmetadata-ops.sh drop-create
|
||||
```
|
||||
{%note%}
|
||||
Why Needed: The script simplifies the setup and execution of OpenMetadata by handling Java dependencies, configurations, and environment variables automatically.
|
||||
{%/note%}
|
||||
**Note** To understand more about openmetadata-ops.sh file click [here](/developers/contribute/build-code-and-run-tests/openmetadata-ops)
|
||||
|
||||
## Running the OpenMetadata server
|
||||
|
||||
|
||||
@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Understanding openmetadata-ops.sh file
|
||||
slug: /developers/contribute/build-code-and-run-tests/openmetadata-ops
|
||||
---
|
||||
|
||||
# Understanding openmetadata-ops.sh file
|
||||
Learn how to run the OpenMetadata Ops in development mode by using commands.
|
||||
|
||||
#### Key Commands:
|
||||
How to run the `openmetadata-ops.sh` file.
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh [OPTIONS] [COMMANDS]
|
||||
```
|
||||
|
||||
#### Options:
|
||||
1. -c, --config=<configFilePath>
|
||||
2. -d, --debug
|
||||
3. -h, --help Show this help message and exit.
|
||||
4. -V, --version Print version information and exit.
|
||||
|
||||
**Example:**
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh --help
|
||||
```
|
||||
|
||||
#### Commands:
|
||||
1. **migrate** Migrates the OpenMetadata database schema and search index mappings.
|
||||
|
||||
2. **reindex** Re Indexes data into search engine from command line.
|
||||
|
||||
3. **repair** Repairs the DATABASE_CHANGE_LOG table which is used to trackall the migrations on the target database. This involves removing entries for the failed migrations and updatethe checksum of migrations already applied on the target database.
|
||||
|
||||
4. **validate** Checks if the all the migrations haven been applied on the target database.
|
||||
|
||||
5. **drop-create** Deletes any tables in configured database and creates a new tables based on current version of OpenMetadata. This command also re-creates the search indexes.
|
||||
|
||||
6. **deploy-pipelines** Deploy all the service pipelines.
|
||||
|
||||
7. **analyze-tables** Migrate secrets from DB to the configured Secrets Manager. Note that this does not support migrating between external Secrets Managers.
|
||||
|
||||
8. **changelog** Prints the change log of database migration.
|
||||
|
||||
9. **check-connection** Checks if a connection can be successfully obtained for the target database
|
||||
|
||||
10. **info** Shows the list of migrations applied and the pending migration waiting to be applied on the target database
|
||||
|
||||
11. **migrate-secrets** Migrate secrets from DB to the configured Secrets Manager. Note that this does not support migrating between external Secrets Managers
|
||||
|
||||
12. **syncEmailFromEnv** Sync the email configuration from environment variables
|
||||
|
||||
**Example:**
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh migration
|
||||
```
|
||||
@ -50,6 +50,10 @@ Extract the distribution tar.gz file created on the previous step and run the fo
|
||||
cd open-metadata-<version>
|
||||
sh bootstrap/openmetadata-ops.sh drop-create
|
||||
```
|
||||
{%note%}
|
||||
Why Needed: The script simplifies the setup and execution of OpenMetadata by handling Java dependencies, configurations, and environment variables automatically.
|
||||
{%/note%}
|
||||
**Note** To understand more about openmetadata-ops.sh file click [here](/developers/contribute/build-code-and-run-tests/openmetadata-ops)
|
||||
|
||||
## Running the OpenMetadata server
|
||||
|
||||
|
||||
@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Understanding openmetadata-ops.sh file
|
||||
slug: /developers/contribute/build-code-and-run-tests/openmetadata-ops
|
||||
---
|
||||
|
||||
# Understanding openmetadata-ops.sh file
|
||||
Learn how to run the OpenMetadata Ops in development mode by using commands.
|
||||
|
||||
#### Key Commands:
|
||||
How to run the `openmetadata-ops.sh` file.
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh [OPTIONS] [COMMANDS]
|
||||
```
|
||||
|
||||
#### Options:
|
||||
1. -c, --config=<configFilePath>
|
||||
2. -d, --debug
|
||||
3. -h, --help Show this help message and exit.
|
||||
4. -V, --version Print version information and exit.
|
||||
|
||||
**Example:**
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh --help
|
||||
```
|
||||
|
||||
#### Commands:
|
||||
1. **migrate** Migrates the OpenMetadata database schema and search index mappings.
|
||||
|
||||
2. **reindex** Re Indexes data into search engine from command line.
|
||||
|
||||
3. **repair** Repairs the DATABASE_CHANGE_LOG table which is used to trackall the migrations on the target database. This involves removing entries for the failed migrations and updatethe checksum of migrations already applied on the target database.
|
||||
|
||||
4. **validate** Checks if the all the migrations haven been applied on the target database.
|
||||
|
||||
5. **drop-create** Deletes any tables in configured database and creates a new tables based on current version of OpenMetadata. This command also re-creates the search indexes.
|
||||
|
||||
6. **deploy-pipelines** Deploy all the service pipelines.
|
||||
|
||||
7. **analyze-tables** Migrate secrets from DB to the configured Secrets Manager. Note that this does not support migrating between external Secrets Managers.
|
||||
|
||||
8. **changelog** Prints the change log of database migration.
|
||||
|
||||
9. **check-connection** Checks if a connection can be successfully obtained for the target database
|
||||
|
||||
10. **info** Shows the list of migrations applied and the pending migration waiting to be applied on the target database
|
||||
|
||||
11. **migrate-secrets** Migrate secrets from DB to the configured Secrets Manager. Note that this does not support migrating between external Secrets Managers
|
||||
|
||||
12. **syncEmailFromEnv** Sync the email configuration from environment variables
|
||||
|
||||
**Example:**
|
||||
```shell
|
||||
sh bootstrap/openmetadata-ops.sh migration
|
||||
```
|
||||
@ -50,6 +50,10 @@ Extract the distribution tar.gz file created on the previous step and run the fo
|
||||
cd open-metadata-<version>
|
||||
sh bootstrap/openmetadata-ops.sh drop-create
|
||||
```
|
||||
{%note%}
|
||||
Why Needed: The script simplifies the setup and execution of OpenMetadata by handling Java dependencies, configurations, and environment variables automatically.
|
||||
{%/note%}
|
||||
**Note** To understand more about openmetadata-ops.sh file click [here](/developers/contribute/build-code-and-run-tests/openmetadata-ops)
|
||||
|
||||
## Running the OpenMetadata server
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user