diff --git a/README.md b/README.md index acc7c237e84..5a8c8d9f37b 100644 --- a/README.md +++ b/README.md @@ -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 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; ``` ### Build OpenMetdata project and run it 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 mvn -DskipTests clean package diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 133d6ead1a1..f5baf6bbee7 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -58,11 +58,11 @@ * [Google SSO](install/enable-security/google-sso/README.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) - * [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) * [Okta SSO](install/enable-security/okta-sso/README.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) * [Configure Ingestion](install/enable-security/okta-sso/configure-security-ingestion.md) diff --git a/docs/community/developer.md b/docs/community/developer.md index dac8c697f8f..2aff6e06866 100644 --- a/docs/community/developer.md +++ b/docs/community/developer.md @@ -120,9 +120,9 @@ Make sure you followed [Create a distribution](#building) steps to create binary 1. unzip open-metadata-{project.verson}.zip 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 -5. ./bin/catalog start +5. ./bin/openmetadata.sh start 9. You should be able to access OpenMetadata by visiting http://HOST:8585/ diff --git a/docs/install/Okta_OAuth_Setup.md b/docs/install/Okta_OAuth_Setup.md index a5c6da240a9..6ce67ad2fe3 100644 --- a/docs/install/Okta_OAuth_Setup.md +++ b/docs/install/Okta_OAuth_Setup.md @@ -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) **** -## 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. - 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) **** \ No newline at end of file diff --git a/docs/install/README.md b/docs/install/README.md index 3825ad64935..95008283e26 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -1,7 +1,7 @@ -# Catalog +# OpenMetadata ## Docker -### Steps to run catalog using docker +### Steps to run openmetadata using docker ```shell cd docker/metadata/ docker-compose build @@ -14,37 +14,37 @@ Open in browser http://localhost:8585/api/swagger ```shell mysql -u username -p (Enter password when prompted) -mysql> CREATE USER 'catalog_user'@'%' IDENTIFIED WITH mysql_native_password BY 'catalog_password'; -mysql> CREATE DATABASE catalog_db; -mysql> GRANT ALL PRIVILEGES ON catalog_db.* TO 'catalog_user'@'%' IDENTIFIED BY 'catalog_password'; +mysql> CREATE USER 'openmetadata_user'@'%' IDENTIFIED WITH mysql_native_password BY 'openmetadata_password'; +mysql> CREATE DATABASE openmetadata_db; +mysql> GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'%'; mysql> FLUSH PRIVILEGES; ``` ### 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). ```shells mvn -DskipTests clean package cd dist/target -unzip catalog-1.0.0-SNAPSHOT.zip -cd catalog-1.0.0-SNAPSHOT/bootstrap +unzip openmetadata-1.0.0-SNAPSHOT.zip +cd openmetadata-1.0.0-SNAPSHOT/bootstrap ./bootstrap_storage.sh migrate cd ../ ``` 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 ``` -./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. ## Setup Authorizer Configuration -Enter following information in ***/conf/catalog-security.yaml*** file: +Enter following information in ***/conf/openmetadata-security.yaml*** file: ``` authorizerConfiguration: className: diff --git a/docs/install/enable-security/google-sso/google-catalog-config.md b/docs/install/enable-security/google-sso/google-catalog-config.md index ab3d13c8d60..8e8cc50b404 100644 --- a/docs/install/enable-security/google-sso/google-catalog-config.md +++ b/docs/install/enable-security/google-sso/google-catalog-config.md @@ -1,10 +1,10 @@ # Configure OpenMetadata Server -## Update conf/catalog-security.yaml +## Update conf/openmetadata-security.yaml * 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) diff --git a/docs/install/enable-security/okta-sso/google-catalog-config.md b/docs/install/enable-security/okta-sso/google-catalog-config.md deleted file mode 100644 index ab3d13c8d60..00000000000 --- a/docs/install/enable-security/okta-sso/google-catalog-config.md +++ /dev/null @@ -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) - diff --git a/docs/install/enable-security/google-sso/okta-catalog-config.md b/docs/install/enable-security/okta-sso/okta-catalog-config.md similarity index 66% rename from docs/install/enable-security/google-sso/okta-catalog-config.md rename to docs/install/enable-security/okta-sso/okta-catalog-config.md index 3783df104a2..d409fef13ec 100644 --- a/docs/install/enable-security/google-sso/okta-catalog-config.md +++ b/docs/install/enable-security/okta-sso/okta-catalog-config.md @@ -1,10 +1,10 @@ # Configure OpenMetadata Server -## Update conf/catalog-security.yaml +## Update conf/openmetadata-security.yaml * 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) diff --git a/docs/install/enable-security/okta-sso/okta-server-creds.md b/docs/install/enable-security/okta-sso/okta-server-creds.md index e332567285c..01c9b441c17 100644 --- a/docs/install/enable-security/okta-sso/okta-server-creds.md +++ b/docs/install/enable-security/okta-sso/okta-server-creds.md @@ -59,11 +59,11 @@ ![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. - 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) diff --git a/docs/install/local-Install.md b/docs/install/local-Install.md index d538e6ad6e9..f401d485a41 100644 --- a/docs/install/local-Install.md +++ b/docs/install/local-Install.md @@ -18,7 +18,7 @@ This is a guide that will show you how to quickly start standalone server. ## 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" %} @@ -41,7 +41,7 @@ Make sure you have the above installed and ready. {% 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" %} **Prerequisites** @@ -51,16 +51,16 @@ Install [Apache Maven](https://maven.apache.org/install.html) 3.6 or higher ```bash # checkout OpenMetadata -git clone https://github.com/StreamlineData/catalog -cd catalog +git clone https://github.com/open-metadata/OpenMetadata +cd OpenMetadata # build OpenMetadata mvn install package -DskipTests # navigate to directory containing the setup scripts cd dist/target/ -unzip catalog-1.0.0-SNAPSHOT.zip -cd catalog-1.0.0-SNAPSHOT +unzip openmetadata-1.0.0-SNAPSHOT.zip +cd openmetadata-1.0.0-SNAPSHOT ``` {% endtab %} {% tab title="Download the release" %} @@ -69,10 +69,10 @@ Once you have the tar file, ```bash # 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 -cd catalog-1.0.0-SNAPSHOT +cd openmetadata-1.0.0-SNAPSHOT ``` {% endtab %} {% endtabs %} @@ -99,9 +99,9 @@ cd catalog-1.0.0-SNAPSHOT ```bash mysql -u root -p - create database catalog_db; - CREATE USER 'catalog_user'@'localhost' IDENTIFIED BY 'catalog_password'; - GRANT ALL PRIVILEGES ON catalog_db.* TO 'catalog_user'@'localhost' WITH GRANT OPTION; + create database openmetadata; + CREATE USER 'openmetadata_user'@'%' IDENTIFIED BY 'openmetadata_password'; + GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'%'; commit; ``` 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 ```bash - ./bin/catalog.sh start + ./bin/openmetadata.sh start ``` 4. Start ElasticSearch in a docker diff --git a/docs/install/metadata-ingestion/connectors/mysql.md b/docs/install/metadata-ingestion/connectors/mysql.md index 7c52b6b3eb0..22d3956b818 100644 --- a/docs/install/metadata-ingestion/connectors/mysql.md +++ b/docs/install/metadata-ingestion/connectors/mysql.md @@ -40,8 +40,8 @@ metadata ingest -c ./pipelines/mysql.json "source": { "type": "mysql", "config": { - "username": "catalog_user", - "password": "catalog_password", + "username": "openmetadata_user", + "password": "openmetadata_password", "service_name": "local_mysql", "table_pattern": { "deny": ["mysql.*", "information_schema.*"] diff --git a/docs/install/metadata-ingestion/connectors/postgres.md b/docs/install/metadata-ingestion/connectors/postgres.md index dd163b8e8df..782885b82a4 100644 --- a/docs/install/metadata-ingestion/connectors/postgres.md +++ b/docs/install/metadata-ingestion/connectors/postgres.md @@ -40,14 +40,14 @@ metadata ingest -c ./pipelines/postgres.json "source": { "type": "postgres", "config": { - "username": "catalog_user", - "password": "catalog_password", + "username": "openmetadata_user", + "password": "openmetadata_password", "host_port": "localhost:5432", "database": "pagila", "service_name": "local_postgres", "service_type": "POSTGRES", "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]*"] } } }, ... diff --git a/docs/install/metadata-ingestion/ingest-sample-data.md b/docs/install/metadata-ingestion/ingest-sample-data.md index 1d566d1d856..9500f0cfa78 100644 --- a/docs/install/metadata-ingestion/ingest-sample-data.md +++ b/docs/install/metadata-ingestion/ingest-sample-data.md @@ -26,8 +26,8 @@ OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. {% tab title="Build from source " %} ```bash # checkout OpenMetadata -git clone https://github.com/StreamlineData/catalog -cd catalog/ingestion +git clone https://github.com/open-metadata/OpenMetadata.git +cd OpenMetadata/ingestion ``` {% endtab %} diff --git a/docs/install/run-locally.md b/docs/install/run-locally.md index 78db6b1579a..73205f40e23 100644 --- a/docs/install/run-locally.md +++ b/docs/install/run-locally.md @@ -23,7 +23,7 @@ OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. {% tabs %} {% 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" %} **Prerequisites** @@ -33,16 +33,16 @@ Install [Apache Maven](https://maven.apache.org/install.html) 3.6 or higher ```bash # checkout OpenMetadata -git clone https://github.com/StreamlineData/catalog -cd catalog +git clone https://github.com/open-metadata/OpenMetadata +cd OpenMetadata # build OpenMetadata mvn install package -DskipTests # navigate to directory containing the setup scripts cd dist/target/ -unzip catalog-1.0.0-SNAPSHOT.zip -cd catalog-1.0.0-SNAPSHOT +unzip openmetadata-1.0.0-SNAPSHOT.zip +cd openmetadata-1.0.0-SNAPSHOT ``` {% endtab %} @@ -51,10 +51,10 @@ Download the latest binary release from [OpenMetadata](https://open-metadata.org ```bash # 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 -cd catalog-1.0.0-SNAPSHOT +cd openmetadata-1.0.0-SNAPSHOT ``` {% endtab %} {% endtabs %} @@ -82,9 +82,9 @@ cd catalog-1.0.0-SNAPSHOT ```text mysql -u root -p - CREATE DATABASE catalog_db; - CREATE USER 'catalog_user'@'localhost' IDENTIFIED BY 'catalog_password'; - GRANT ALL PRIVILEGES ON catalog_db.* TO 'catalog_user'@'localhost' WITH GRANT OPTION; + CREATE DATABASE openmetadata_db; + CREATE USER 'openmetadata_user'@'localhost' IDENTIFIED BY 'openmetadata_password'; + GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'localhost' WITH GRANT OPTION; commit; ``` @@ -98,6 +98,6 @@ cd catalog-1.0.0-SNAPSHOT 3. Start the OpenMetadata Server ```text - ./bin/catalog.sh start + ./bin/openmetadata.sh start ``` diff --git a/docs/install/setup-ingestion.md b/docs/install/setup-ingestion.md index 10461cb68e8..442b3c4cab6 100644 --- a/docs/install/setup-ingestion.md +++ b/docs/install/setup-ingestion.md @@ -4,7 +4,7 @@ description: This guide will help you setup the Ingestion framework and connecto # 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" %} **Prerequisites** @@ -95,7 +95,7 @@ metadata ingest -c ./pipelines/redshift.json ### 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 docker build -t ingestion . diff --git a/docs/open-source-community/community.md b/docs/open-source-community/community.md index 799e5884c40..34eb11051fd 100644 --- a/docs/open-source-community/community.md +++ b/docs/open-source-community/community.md @@ -8,7 +8,7 @@ All OpenMetadata discussions happen on the [mailing list](community.md), [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 diff --git a/docs/open-source-community/developer/build-code-run-tests.md b/docs/open-source-community/developer/build-code-run-tests.md index ae863318a1f..bdca53d87de 100644 --- a/docs/open-source-community/developer/build-code-run-tests.md +++ b/docs/open-source-community/developer/build-code-run-tests.md @@ -35,11 +35,11 @@ dist/target/open-metadata-.zip 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 -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\] \([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)\) diff --git a/docs/open-source-community/developer/run-integration-tests.md b/docs/open-source-community/developer/run-integration-tests.md index 975657d3508..c48e29d4426 100644 --- a/docs/open-source-community/developer/run-integration-tests.md +++ b/docs/open-source-community/developer/run-integration-tests.md @@ -1,7 +1,7 @@ # Run Integration Tests {% hint style="info" %} -Make sure catalog is up and running +Make sure openmetadata is up and running {% endhint %} ## Run MySQL test