yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2026-01-06 04:26:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [#85] No subject

Browse Source
This commit is contained in:
OpenMetadata 2022-03-11 02:11:44 +00:00 committed by Sriharsha Chintalapani
parent 5aa24d5613
commit f292f53eed
11 changed files with 71 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
data-quality/data-quality-overview/tests.md
View File

@ -14,7 +14,7 @@ You can navigate in the UI to a Table Entity and **Add Tests** from there. The f
From the **Data Quality** Tab you can create both Table and Column Tests:
![Write your first test](<../../docs/.gitbook/assets/image (4).png>)
![Write your first test](<../../docs/.gitbook/assets/image (4) (1).png>)
![Sample form to create a column test](<../../docs/.gitbook/assets/image (16) (1).png>)

8
deploy/deploy-on-bare-metal/run-in-production.md
View File

@ -58,25 +58,25 @@ Visit the [releases page](https://github.com/open-metadata/OpenMetadata/releases
For example, the release for version 0.6 is found in the Assets section at the link highlighted in the figure below.
![](<../../docs/.gitbook/assets/image (1) (1).png>)
![](<../../docs/.gitbook/assets/image (4).png>)
### 2. Untar the release download
Once the tar file has download, run the following command, updated if necessary for the version of OpenMetadata that you downloaded.
```bash
tar -zxvf openmetadata-0.6.0.tar.gz
tar -zxvf openmetadata-0.9.0.tar.gz
```
### 3. Navigate to the directory created
```
cd openmetadata-0.6.0
cd openmetadata-0.9.0
```
### 4. Start OpenMetadata
OpenMetadata release ships with `./bin/openmetadata` init.d style script. Run the following command from the `openmetadata-0.6.0` directory.
OpenMetadata release ships with `./bin/openmetadata` init.d style script. Run the following command from the `openmetadata-0.9.0` directory.
```
./bin/openmetadata.sh start

BIN
docs/.gitbook/assets/image (31) (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 140 KiB

BIN
docs/.gitbook/assets/image (31) (1).png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 140 KiB

After

Width:  |  Height:  |  Size: 128 KiB

BIN
docs/.gitbook/assets/image (31).png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 128 KiB

After

Width:  |  Height:  |  Size: 55 KiB

BIN
docs/.gitbook/assets/image (4) (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 229 KiB

BIN
docs/.gitbook/assets/image (4) (1).png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 229 KiB

After

Width:  |  Height:  |  Size: 170 KiB

BIN
docs/.gitbook/assets/image (4).png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 170 KiB

After

Width:  |  Height:  |  Size: 55 KiB

32
docs/SUMMARY.md
View File

@ -144,21 +144,21 @@
* [Deploy OpenMetadata on Kubernetes](../deploy/deploy-on-kubernetes/run-in-kubernetes.md)
* [Values.yaml](../deploy/deploy-on-kubernetes/values.yaml.md)
* [Enable Security](../deploy/deploy-on-kubernetes/enable-security/README.md)
* [Copy of Google SSO](../deploy/deploy-on-kubernetes/enable-security/google-sso/README.md)
* [Copy of Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/google-sso/google-server-creds.md)
* [Copy of Create Service Account](../deploy/deploy-on-kubernetes/enable-security/google-sso/create-ingestion-service-account.md)
* [Copy of Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/google-sso/google-config.md)
* [Copy of Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/google-sso/configure-security-ingestion.md)
* [Copy of Okta SSO](../deploy/deploy-on-kubernetes/enable-security/okta-sso/README.md)
* [Copy of Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/okta-sso/okta-server-creds.md)
* [Copy of Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/okta-sso/okta-config.md)
* [Copy of Create Service Application](../deploy/deploy-on-kubernetes/enable-security/okta-sso/create-ingestion-service-account.md)
* [Copy of Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/okta-sso/configure-security-ingestion.md)
* [Copy of Auth0 SSO](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/README.md)
* [Copy of Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/auth0-server-creds.md)
* [Copy of Create Service Account](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/create-ingestion-service-account.md)
* [Copy of Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/auth0-config.md)
* [Copy of Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/configure-security-ingestion.md)
* [Google SSO](../deploy/deploy-on-kubernetes/enable-security/google-sso/README.md)
* [Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/google-sso/google-server-creds.md)
* [Create Service Account](../deploy/deploy-on-kubernetes/enable-security/google-sso/create-ingestion-service-account.md)
* [Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/google-sso/google-config.md)
* [Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/google-sso/configure-security-ingestion.md)
* [Okta SSO](../deploy/deploy-on-kubernetes/enable-security/okta-sso/README.md)
* [Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/okta-sso/okta-server-creds.md)
* [Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/okta-sso/okta-config.md)
* [Create Service Application](../deploy/deploy-on-kubernetes/enable-security/okta-sso/create-ingestion-service-account.md)
* [Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/okta-sso/configure-security-ingestion.md)
* [Auth0 SSO](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/README.md)
* [Create Server Credentials](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/auth0-server-creds.md)
* [Create Service Account](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/create-ingestion-service-account.md)
* [Configure OpenMetadata Server](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/auth0-config.md)
* [Configure Ingestion](../deploy/deploy-on-kubernetes/enable-security/auth0-sso/configure-security-ingestion.md)
* [Reference](../deploy/reference/README.md)
* [Server Configuration Parameters](../deploy/reference/configuration.md)
* [Connector Configuration Parameters](../deploy/reference/connector-configuration.md)
@ -200,7 +200,7 @@
* [Stage](open-source-community/developer/build-a-connector/stage.md)
* [BulkSink](open-source-community/developer/build-a-connector/bulksink.md)
* [Run Integration Tests](open-source-community/developer/run-integration-tests.md)
* [UI](open-source-community/developer/ui.md)
* [Web UI](open-source-community/developer/ui.md)
* [Solution Design](open-source-community/developer/solution-design.md)
* [Python API](open-source-community/developer/python-api.md)
* [Entities](open-source-community/developer/entities/README.md)

2
docs/integrations/connectors/bigquery/bigquery-metadata-extraction.md
View File

@ -583,7 +583,7 @@ If you want to limit metadata ingestion to a single database, enter the name of
In this step we will configure the metadata ingestion settings for your BigQuery deployment. Please follow the instructions below to ensure that you've configured the connector to read from your BigQuery service as desired.
![](<../../../.gitbook/assets/image (31) (1).png>)
![](<../../../.gitbook/assets/image (31) (1) (1).png>)
#### Ingestion name

50
docs/open-source-community/developer/ui.md
View File

@ -1,2 +1,50 @@
# UI
---
description: This guide will help you run OpenMetadata UI locally in dev mode.
---
# Web UI
### **Pre-requisites**
Before proceeding, ensure that you have installed the node and yarn with the versions given below.
```
"node": ">=10.0.0",
"yarn": "^1.22.0"
```
[**Install Node**](https://nodejs.org/en/download/)\
[**Install Yarn**](https://classic.yarnpkg.com/lang/en/docs/install/)****
Using the command below, spin up the server locally from the directory.`openmetadata-dist/target/openmetadata-*-SNAPSHOT`.
```shell
# # Non-secure mode
./bin/openmetadata-server-start.sh conf/openmetadata.yaml
# # Secure mode
./bin/openmetadata-server-start.sh conf/openmetadata-security.yaml
```
> Since typescript is heavily used in the OpenMetadata project, we generate the typescript types and the interface from JSON schema. We use the `QuickType` tool to generate the typescript types and interface. You can view the complete instructions [here](https://docs.open-metadata.org/open-source-community/developer/generate-typescript-types-from-json-schema)
### **Steps to Run OpenMetadata UI**
Once the node and yarn is installed in the system, you can go ahead and perform the following steps to run OpenMetadata UI.
**Step 1**: Run the given command to install the required dependencies.
**Note:** It’s a one-time task to install dependencies. If there are any changes in the `package.json` file, then again the following steps will have to be performed.
```shell
# installing dependencies
> make yarn_install_cache
```
**Step 2**: Start the UI locally
```shell
# starting the UI locally
> make yarn_start_dev_ui
```
**Step 3:** Visit [localhost:3000](http://localhost:3000) to access the OpenMetadata UI.