yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-14 02:08:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

changed catalog to openmetadata in all the docs (#52)

Browse Source 
* changed catalog to openmetadata in all the docs

* changed README.md

Co-authored-by: parthp2107 <parth.panchal@deuexsoultions.com>
This commit is contained in:
parthp2107 2021-08-05 19:56:33 +05:30 committed by GitHub
parent 7c219d891f
commit 55d7cb41bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 61 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -28,13 +28,13 @@ mysql -u username -p (Enter password when prompted)
mysql> CREATE USER 'openmetadata_user'@'%' IDENTIFIED WITH mysql_native_password BY 'openmetadata_password'; mysql> CREATE USER 'openmetadata_user'@'%' IDENTIFIED WITH mysql_native_password BY 'openmetadata_password';
mysql> CREATE DATABASE openmetadata_db; mysql> CREATE DATABASE openmetadata_db;
mysql> `GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'%' IDENTIFIED BY 'openmetadata_password'`; mysql> GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'%';
mysql> FLUSH PRIVILEGES; mysql> FLUSH PRIVILEGES;
``` ```
### Build OpenMetdata project and run it ### Build OpenMetdata project and run it
Make sure mysql is running with credentials user 'openmetadata_user' with password 'openmetadata_password'. Make sure mysql is running with credentials user 'openmetadata_user' with password 'openmetadata_password'.
Connect to mysql following steps mentioned [here](#steps-to-connect-mysql). Connect to mysql following steps mentioned [here](#Set up mysql database used as OpenMetadata backend).
```shells ```shells
mvn -DskipTests clean package mvn -DskipTests clean package

4
docs/SUMMARY.md
View File

@ -58,11 +58,11 @@
* [Google SSO](install/enable-security/google-sso/README.md) * [Google SSO](install/enable-security/google-sso/README.md)
* [Create Server Credentials](install/enable-security/google-sso/google-server-creds.md) * [Create Server Credentials](install/enable-security/google-sso/google-server-creds.md)
* [Create Service Account](install/enable-security/google-sso/create-ingestion-service-account.md) * [Create Service Account](install/enable-security/google-sso/create-ingestion-service-account.md)
* [Configure OpenMetadata Server](install/enable-security/google-sso/okta-catalog-config.md) * [Configure OpenMetadata Server](install/enable-security/google-sso/google-catalog-config.md)
* [Configure Ingestion](install/enable-security/google-sso/configure-security-ingestion.md) * [Configure Ingestion](install/enable-security/google-sso/configure-security-ingestion.md)
* [Okta SSO](install/enable-security/okta-sso/README.md) * [Okta SSO](install/enable-security/okta-sso/README.md)
* [Create Server Credentials](install/enable-security/okta-sso/okta-server-creds.md) * [Create Server Credentials](install/enable-security/okta-sso/okta-server-creds.md)
* [Configure OpenMetadata Server](install/enable-security/okta-sso/google-catalog-config.md) * [Configure OpenMetadata Server](install/enable-security/okta-sso/okta-catalog-config.md)
* [Create Service Account](install/enable-security/okta-sso/create-ingestion-service-account.md) * [Create Service Account](install/enable-security/okta-sso/create-ingestion-service-account.md)
* [Configure Ingestion](install/enable-security/okta-sso/configure-security-ingestion.md) * [Configure Ingestion](install/enable-security/okta-sso/configure-security-ingestion.md)

4
docs/community/developer.md
View File

@ -120,9 +120,9 @@ Make sure you followed [Create a distribution](#building) steps to create binary
1. unzip open-metadata-{project.verson}.zip 1. unzip open-metadata-{project.verson}.zip
2. cd open-metadata-{project.version} 2. cd open-metadata-{project.version}
3. Edit conf/catalog.yaml and provide the database and credentials under the "database". 3. Edit conf/openmetadata.yaml and provide the database and credentials under the "database".
4. ./bootstrap/bootstrap-storage.sh migrate 4. ./bootstrap/bootstrap-storage.sh migrate
5. ./bin/catalog start 5. ./bin/openmetadata.sh start
9. You should be able to access OpenMetadata by visiting http://HOST:8585/ 9. You should be able to access OpenMetadata by visiting http://HOST:8585/
<a name="run-intellij"></a> <a name="run-intellij"></a>

4
docs/install/Okta_OAuth_Setup.md
View File

@ -57,10 +57,10 @@ It will generate information which is required to perform single sign on activit
![Alt text](https://user-images.githubusercontent.com/83201188/123376802-b56d6700-d5a8-11eb-89b3-a59b3192fce6.png) ![Alt text](https://user-images.githubusercontent.com/83201188/123376802-b56d6700-d5a8-11eb-89b3-a59b3192fce6.png)
**** ****
## Step 5: Adding the details in catalog-security.yaml ## Step 5: Adding the details in openmetadata-security.yaml
* **Once the `Client Id`, `Client secret`, `issuer` and `audience` is generated. * **Once the `Client Id`, `Client secret`, `issuer` and `audience` is generated.
Add those details in catalog-security.yaml file in the respective field.** Add those details in openmetadata-security.yaml file in the respective field.**
![Alt text](https://user-images.githubusercontent.com/83201188/123380400-054e2d00-d5ad-11eb-9937-2813f69cb268.png) ![Alt text](https://user-images.githubusercontent.com/83201188/123380400-054e2d00-d5ad-11eb-9937-2813f69cb268.png)
**** ****

22
docs/install/README.md
View File

@ -1,7 +1,7 @@
# Catalog # OpenMetadata
## Docker ## Docker
### Steps to run catalog using docker ### Steps to run openmetadata using docker
```shell ```shell
cd docker/metadata/ cd docker/metadata/
docker-compose build docker-compose build
@ -14,37 +14,37 @@ Open in browser http://localhost:8585/api/swagger
```shell ```shell
mysql -u username -p (Enter password when prompted) mysql -u username -p (Enter password when prompted)
mysql> CREATE USER 'catalog_user'@'%' IDENTIFIED WITH mysql_native_password BY 'catalog_password'; mysql> CREATE USER 'openmetadata_user'@'%' IDENTIFIED WITH mysql_native_password BY 'openmetadata_password';
mysql> CREATE DATABASE catalog_db; mysql> CREATE DATABASE openmetadata_db;
mysql> GRANT ALL PRIVILEGES ON catalog_db.* TO 'catalog_user'@'%' IDENTIFIED BY 'catalog_password'; mysql> GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'%';
mysql> FLUSH PRIVILEGES; mysql> FLUSH PRIVILEGES;
``` ```
### Build OpenMetdata project and run it ### Build OpenMetdata project and run it
Make sure MySQL is running with credentials user 'catalog_user' with password 'catalog_password'. Make sure MySQL is running with credentials user 'openmetadata_user' with password 'openmetadata_password'.
Connect to MySQL following steps mentioned [here](#steps-to-connect-mysql). Connect to MySQL following steps mentioned [here](#steps-to-connect-mysql).
```shells ```shells
mvn -DskipTests clean package mvn -DskipTests clean package
cd dist/target cd dist/target
unzip catalog-1.0.0-SNAPSHOT.zip unzip openmetadata-1.0.0-SNAPSHOT.zip
cd catalog-1.0.0-SNAPSHOT/bootstrap cd openmetadata-1.0.0-SNAPSHOT/bootstrap
./bootstrap_storage.sh migrate ./bootstrap_storage.sh migrate
cd ../ cd ../
``` ```
If authorizer is configured, run: If authorizer is configured, run:
``` ```
./bin/catalog-server-start.sh conf/catalog-security.yaml ./bin/openmetadata-server-start.sh conf/openmetadata-security.yaml
``` ```
otherwise run otherwise run
``` ```
./bin/catalog-server-start.sh conf/catalog.yaml ./bin/openmetadata-server-start.sh conf/openmetadata.yaml
``` ```
Open browser http://localhost:8585/api/swagger to look at API documentation. Open browser http://localhost:8585/api/swagger to look at API documentation.
## Setup Authorizer Configuration ## Setup Authorizer Configuration
Enter following information in ***/conf/catalog-security.yaml*** file: Enter following information in ***/conf/openmetadata-security.yaml*** file:
``` ```
authorizerConfiguration: authorizerConfiguration:
className: <authorizer_classname> className: <authorizer_classname>

4
docs/install/enable-security/google-sso/google-catalog-config.md
View File

@ -1,10 +1,10 @@
# Configure OpenMetadata Server # Configure OpenMetadata Server
## Update conf/catalog-security.yaml ## Update conf/openmetadata-security.yaml
* Once the `Client Id` and `Client secret` is generated. * Once the `Client Id` and `Client secret` is generated.
Add the `Client Id` in catalog-security.yaml file in `client_id` field. Add the `Client Id` in openmetadata-security.yaml file in `client_id` field.
![Alt text](https://user-images.githubusercontent.com/83201188/123221536-ade88800-d4ec-11eb-9c49-d7ce16eecb7d.png) ![Alt text](https://user-images.githubusercontent.com/83201188/123221536-ade88800-d4ec-11eb-9c49-d7ce16eecb7d.png)

10
docs/install/enable-security/okta-sso/google-catalog-config.md
View File

@ -1,10 +0,0 @@
# Configure OpenMetadata Server
## Update conf/catalog-security.yaml
* Once the `Client Id` and `Client secret` is generated.
Add the `Client Id` in catalog-security.yaml file in `client_id` field.
![Alt text](https://user-images.githubusercontent.com/83201188/123221536-ade88800-d4ec-11eb-9c49-d7ce16eecb7d.png)

4
docs/install/enable-security/google-sso/okta-catalog-config.md → docs/install/enable-security/okta-sso/okta-catalog-config.md
View File

@ -1,10 +1,10 @@
# Configure OpenMetadata Server # Configure OpenMetadata Server
## Update conf/catalog-security.yaml ## Update conf/openmetadata-security.yaml
* Once the **Client Id**, **Client secret**, **issuer** and **audience** is generated. * Once the **Client Id**, **Client secret**, **issuer** and **audience** is generated.
Add those details in catalog-security.yaml file in the respective field. Add those details in openmetadata-security.yaml file in the respective field.
![Alt text](https://user-images.githubusercontent.com/83201188/123380400-054e2d00-d5ad-11eb-9937-2813f69cb268.png) ![Alt text](https://user-images.githubusercontent.com/83201188/123380400-054e2d00-d5ad-11eb-9937-2813f69cb268.png)

4
docs/install/enable-security/okta-sso/okta-server-creds.md
View File

@ -59,11 +59,11 @@
![Alt text](https://user-images.githubusercontent.com/83201188/123376802-b56d6700-d5a8-11eb-89b3-a59b3192fce6.png) ![Alt text](https://user-images.githubusercontent.com/83201188/123376802-b56d6700-d5a8-11eb-89b3-a59b3192fce6.png)
## Step 5: Adding the details in catalog-security.yaml ## Step 5: Adding the details in openmetadata-security.yaml
* Once the **Client Id**, **Client secret**, **issuer** and **audience** is generated. * Once the **Client Id**, **Client secret**, **issuer** and **audience** is generated.
Add those details in catalog-security.yaml file in the respective field. Add those details in openmetadata-security.yaml file in the respective field.
![Alt text](https://user-images.githubusercontent.com/83201188/123380400-054e2d00-d5ad-11eb-9937-2813f69cb268.png) ![Alt text](https://user-images.githubusercontent.com/83201188/123380400-054e2d00-d5ad-11eb-9937-2813f69cb268.png)

24
docs/install/local-Install.md
View File

@ -18,7 +18,7 @@ This is a guide that will show you how to quickly start standalone server.
## Download OpenMetadata Distribution ## Download OpenMetadata Distribution
First, Lets download the OpenMetadata Distribution from [Github Releases](https://github.com/StreamlineData/catalog/releases) First, Lets download the OpenMetadata Distribution from [Github Releases](https://github.com/open-metadata/OpenMetadata/releases)
{% hint style="info" %} {% hint style="info" %}
@ -41,7 +41,7 @@ Make sure you have the above installed and ready.
{% tab title="Build from source " %} {% tab title="Build from source " %}
Follow these steps to checkout code from [Github](https://github.com/StreamlineData/catalog) and build OpenMetadata locally Follow these steps to checkout code from [Github](https://github.com/open-metadata/OpenMetadata) and build OpenMetadata locally
{% hint style="info" %} {% hint style="info" %}
**Prerequisites** **Prerequisites**
@ -51,16 +51,16 @@ Install [Apache Maven](https://maven.apache.org/install.html) 3.6 or higher
```bash ```bash
# checkout OpenMetadata # checkout OpenMetadata
git clone https://github.com/StreamlineData/catalog git clone https://github.com/open-metadata/OpenMetadata
cd catalog cd OpenMetadata
# build OpenMetadata # build OpenMetadata
mvn install package -DskipTests mvn install package -DskipTests
# navigate to directory containing the setup scripts # navigate to directory containing the setup scripts
cd dist/target/ cd dist/target/
unzip catalog-1.0.0-SNAPSHOT.zip unzip openmetadata-1.0.0-SNAPSHOT.zip
cd catalog-1.0.0-SNAPSHOT cd openmetadata-1.0.0-SNAPSHOT
``` ```
{% endtab %} {% endtab %}
{% tab title="Download the release" %} {% tab title="Download the release" %}
@ -69,10 +69,10 @@ Once you have the tar file,
```bash ```bash
# untar it # untar it
tar -zxvf catalog-1.0.0-SNAPSHOT.tar.gz tar -zxvf openmetadata-1.0.0-SNAPSHOT.tar.gz
# navigate to directory containing the launcher scripts # navigate to directory containing the launcher scripts
cd catalog-1.0.0-SNAPSHOT cd openmetadata-1.0.0-SNAPSHOT
``` ```
{% endtab %} {% endtab %}
{% endtabs %} {% endtabs %}
@ -99,9 +99,9 @@ cd catalog-1.0.0-SNAPSHOT
```bash ```bash
mysql -u root -p mysql -u root -p
create database catalog_db; create database openmetadata;
CREATE USER 'catalog_user'@'localhost' IDENTIFIED BY 'catalog_password'; CREATE USER 'openmetadata_user'@'%' IDENTIFIED BY 'openmetadata_password';
GRANT ALL PRIVILEGES ON catalog_db.* TO 'catalog_user'@'localhost' WITH GRANT OPTION; GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'%';
commit; commit;
``` ```
2. Run bootstrap scripts to initiate the database and tables 2. Run bootstrap scripts to initiate the database and tables
@ -113,7 +113,7 @@ cd catalog-1.0.0-SNAPSHOT
3. Start the OpenMetadata Server 3. Start the OpenMetadata Server
```bash ```bash
./bin/catalog.sh start ./bin/openmetadata.sh start
``` ```
4. Start ElasticSearch in a docker 4. Start ElasticSearch in a docker

4
docs/install/metadata-ingestion/connectors/mysql.md
View File

@ -40,8 +40,8 @@ metadata ingest -c ./pipelines/mysql.json
"source": { "source": {
"type": "mysql", "type": "mysql",
"config": { "config": {
"username": "catalog_user", "username": "openmetadata_user",
"password": "catalog_password", "password": "openmetadata_password",
"service_name": "local_mysql", "service_name": "local_mysql",
"table_pattern": { "table_pattern": {
"deny": ["mysql.*", "information_schema.*"] "deny": ["mysql.*", "information_schema.*"]

6
docs/install/metadata-ingestion/connectors/postgres.md
View File

@ -40,14 +40,14 @@ metadata ingest -c ./pipelines/postgres.json
"source": { "source": {
"type": "postgres", "type": "postgres",
"config": { "config": {
"username": "catalog_user", "username": "openmetadata_user",
"password": "catalog_password", "password": "openmetadata_password",
"host_port": "localhost:5432", "host_port": "localhost:5432",
"database": "pagila", "database": "pagila",
"service_name": "local_postgres", "service_name": "local_postgres",
"service_type": "POSTGRES", "service_type": "POSTGRES",
"table_pattern": { "table_pattern": {
"deny": ["pg_catalog.*[a-zA-Z0-9]*","information_schema.*[a-zA-Z0-9]*"] } "deny": ["pg_openmetadata.*[a-zA-Z0-9]*","information_schema.*[a-zA-Z0-9]*"] }
} }
}, },
... ...

4
docs/install/metadata-ingestion/ingest-sample-data.md
View File

@ -26,8 +26,8 @@ OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
{% tab title="Build from source " %} {% tab title="Build from source " %}
```bash ```bash
# checkout OpenMetadata # checkout OpenMetadata
git clone https://github.com/StreamlineData/catalog git clone https://github.com/open-metadata/OpenMetadata.git
cd catalog/ingestion cd OpenMetadata/ingestion
``` ```
{% endtab %} {% endtab %}

22
docs/install/run-locally.md
View File

@ -23,7 +23,7 @@ OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
{% tabs %} {% tabs %}
{% tab title="Build from source " %} {% tab title="Build from source " %}
Follow these steps to checkout code from [Github](https://github.com/StreamlineData/catalog) and build OpenMetadata locally Follow these steps to checkout code from [Github](https://github.com/open-metadata/OpenMetadata) and build OpenMetadata locally
{% hint style="info" %} {% hint style="info" %}
**Prerequisites** **Prerequisites**
@ -33,16 +33,16 @@ Install [Apache Maven](https://maven.apache.org/install.html) 3.6 or higher
```bash ```bash
# checkout OpenMetadata # checkout OpenMetadata
git clone https://github.com/StreamlineData/catalog git clone https://github.com/open-metadata/OpenMetadata
cd catalog cd OpenMetadata
# build OpenMetadata # build OpenMetadata
mvn install package -DskipTests mvn install package -DskipTests
# navigate to directory containing the setup scripts # navigate to directory containing the setup scripts
cd dist/target/ cd dist/target/
unzip catalog-1.0.0-SNAPSHOT.zip unzip openmetadata-1.0.0-SNAPSHOT.zip
cd catalog-1.0.0-SNAPSHOT cd openmetadata-1.0.0-SNAPSHOT
``` ```
{% endtab %} {% endtab %}
@ -51,10 +51,10 @@ Download the latest binary release from [OpenMetadata](https://open-metadata.org
```bash ```bash
# untar it # untar it
tar -zxvf catalog-1.0.0-SNAPSHOT.tar.gz tar -zxvf openmetadata-1.0.0-SNAPSHOT.tar.gz
# navigate to directory containing the launcher scripts # navigate to directory containing the launcher scripts
cd catalog-1.0.0-SNAPSHOT cd openmetadata-1.0.0-SNAPSHOT
``` ```
{% endtab %} {% endtab %}
{% endtabs %} {% endtabs %}
@ -82,9 +82,9 @@ cd catalog-1.0.0-SNAPSHOT
```text ```text
mysql -u root -p mysql -u root -p
CREATE DATABASE catalog_db; CREATE DATABASE openmetadata_db;
CREATE USER 'catalog_user'@'localhost' IDENTIFIED BY 'catalog_password'; CREATE USER 'openmetadata_user'@'localhost' IDENTIFIED BY 'openmetadata_password';
GRANT ALL PRIVILEGES ON catalog_db.* TO 'catalog_user'@'localhost' WITH GRANT OPTION; GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'localhost' WITH GRANT OPTION;
commit; commit;
``` ```
@ -98,6 +98,6 @@ cd catalog-1.0.0-SNAPSHOT
3. Start the OpenMetadata Server 3. Start the OpenMetadata Server
```text ```text
./bin/catalog.sh start ./bin/openmetadata.sh start
``` ```

4
docs/install/setup-ingestion.md
View File

@ -4,7 +4,7 @@ description: This guide will help you setup the Ingestion framework and connecto
# Setup Ingestion # Setup Ingestion
Ingestion is a data ingestion library, which is inspired by [Apache Gobblin](https://gobblin.apache.org/). It could be used in an orchestration framework\(e.g. Apache Airflow\) to build data for Catalog. Ingestion is a data ingestion library, which is inspired by [Apache Gobblin](https://gobblin.apache.org/). It could be used in an orchestration framework\(e.g. Apache Airflow\) to build data for OpenMetadata.
{% hint style="info" %} {% hint style="info" %}
**Prerequisites** **Prerequisites**
@ -95,7 +95,7 @@ metadata ingest -c ./pipelines/redshift.json
### Run Ingestion docker ### Run Ingestion docker
The Catalog should be up and running before you run the docker on the system. The OpenMetadata should be up and running before you run the docker on the system.
```text ```text
docker build -t ingestion . docker build -t ingestion .

2
docs/open-source-community/community.md
View File

@ -8,7 +8,7 @@ All OpenMetadata discussions happen on the [mailing list](community.md), [Github
## Github ## Github
Star us at [open-metadata/catalog](https://github.com/open-metadata/catalog) to follow the development. Ask questions, raise issues or contribute pull requests. Please see [Developers](https://github.com/StreamlineData/catalog/tree/b882d5238a1e21ebc73edb1693a59296f4d38e24/docs/open-source-community/open-source-community/developer.md) Star us at [open-metadata/OpenMetadata](https://github.com/open-metadata/OpenMetadata) to follow the development. Ask questions, raise issues or contribute pull requests. Please see [Developers](https://github.com/open-metadata/OpenMetadata/blob/main/docs/open-source-community/developer/README.md)
## Slack Channel ## Slack Channel

4
docs/open-source-community/developer/build-code-run-tests.md
View File

@ -35,11 +35,11 @@ dist/target/open-metadata-<version>.zip
1. Add new Run/Debug configuration like below screenshot. 1. Add new Run/Debug configuration like below screenshot.
![Intellj Run Configuration](https://github.com/StreamlineData/catalog/raw/master/docs/install/images/ingestion-bot-service-account.png) ![Intellj Run Configuration](https://github.com/open-metadata/OpenMetadata/blob/main/docs/install/images/ingestion-bot-service-account.png)
## Coding Style ## Coding Style
1. [Refer to coding guidelines](https://github.com/StreamlineData/catalog/tree/b882d5238a1e21ebc73edb1693a59296f4d38e24/docs/open-source-community/open-source-community/coding-style.md) 1. [Refer to coding guidelines](https://github.com/open-metadata/OpenMetadata/blob/main/docs/open-source-community/developer/coding-style.md)
2. Configure Intellij to disable the \[wild-card imports\] 2. Configure Intellij to disable the \[wild-card imports\]
\([https://www.jetbrains.com/help/idea/creating-and-optimizing-imports.html\#disable-wildcard-imports](https://www.jetbrains.com/help/idea/creating-and-optimizing-imports.html#disable-wildcard-imports)\) \([https://www.jetbrains.com/help/idea/creating-and-optimizing-imports.html\#disable-wildcard-imports](https://www.jetbrains.com/help/idea/creating-and-optimizing-imports.html#disable-wildcard-imports)\)

2
docs/open-source-community/developer/run-integration-tests.md
View File

@ -1,7 +1,7 @@
# Run Integration Tests # Run Integration Tests
{% hint style="info" %} {% hint style="info" %}
Make sure catalog is up and running Make sure openmetadata is up and running
{% endhint %} {% endhint %}
## Run MySQL test ## Run MySQL test