diff --git a/openmetadata-docs/content/v1.5.x/deployment/security/saml/aws.md b/openmetadata-docs/content/v1.5.x/deployment/security/saml/aws.md index b601acedb23..9bbb4d8bfac 100644 --- a/openmetadata-docs/content/v1.5.x/deployment/security/saml/aws.md +++ b/openmetadata-docs/content/v1.5.x/deployment/security/saml/aws.md @@ -83,7 +83,7 @@ Security requirements for your **production** environment: keyStorePassword: ${SAML_KEYSTORE_PASSWORD:-""} ``` -- Populate the above config from xml metadata +- Populate the above config from [xml metadata](/deployment/security/saml/xml_file) {% image src="/images/v1.5/deployment/security/saml/aws/saml-aws-8.png" alt="populate-metadata" /%} diff --git a/openmetadata-docs/content/v1.5.x/deployment/security/saml/azure.md b/openmetadata-docs/content/v1.5.x/deployment/security/saml/azure.md index 925e2117b9f..8533fe2dcfc 100644 --- a/openmetadata-docs/content/v1.5.x/deployment/security/saml/azure.md +++ b/openmetadata-docs/content/v1.5.x/deployment/security/saml/azure.md @@ -80,12 +80,14 @@ openssl x509 -in saml.crt -out samlCER.cer -outform DER - Open the downloaded metadata xml file, and populate the following properties in `openmetadata.yml` ```yaml + authenticationConfiguration: + provider: ${AUTHENTICATION_PROVIDER:-saml} samlConfiguration: debugMode: ${SAML_DEBUG_MODE:-false} idp: entityId: ${SAML_IDP_ENTITY_ID:-"https://mocksaml.com/api/saml/sso"} ssoLoginUrl: ${SAML_IDP_SSO_LOGIN_URL:-"https://saml.example.com/entityid"} - idpX509Certificate: ${SAML_IDP_CERTIFICATE:-""} + idpX509Certificate: ${SAML_IDP_CERTIFICATE:-""} #Pass the certificate as a string authorityUrl: ${SAML_AUTHORITY_URL:-"https://{your domain}/api/v1/saml/login"} nameId: ${SAML_IDP_NAME_ID:-"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"} sp: @@ -108,8 +110,10 @@ openssl x509 -in saml.crt -out samlCER.cer -outform DER keyStorePassword: ${SAML_KEYSTORE_PASSWORD:-""} ``` -- Populate the above config from xml metadata +- Populate the above config from [xml metadata](/deployment/security/saml/xml_file) + {% image src="/images/v1.5/deployment/security/saml/aws/saml-aws-8.png" alt="populate-metadata" /%} + - IDP Config `entityID` -> Populate it from Metadata XML Entity ID `HTTP-Redirect SSO Login URL` -> always select HTTP-Redirect Url for SSO Login Url diff --git a/openmetadata-docs/content/v1.5.x/deployment/security/saml/docker.md b/openmetadata-docs/content/v1.5.x/deployment/security/saml/docker.md index ff7fd3e24aa..a747a765206 100644 --- a/openmetadata-docs/content/v1.5.x/deployment/security/saml/docker.md +++ b/openmetadata-docs/content/v1.5.x/deployment/security/saml/docker.md @@ -4,7 +4,7 @@ slug: /deployment/security/saml/docker collate: false --- -# Keycloak SSO for Docker +# SAML SSO for Docker To enable security for the Docker deployment, follow the next steps: diff --git a/openmetadata-docs/content/v1.5.x/developers/architecture/code-layout.md b/openmetadata-docs/content/v1.5.x/developers/architecture/code-layout.md index 5bfe579194f..0abc5c02f99 100644 --- a/openmetadata-docs/content/v1.5.x/developers/architecture/code-layout.md +++ b/openmetadata-docs/content/v1.5.x/developers/architecture/code-layout.md @@ -64,12 +64,12 @@ Ingestion is a simple Python framework to ingest metadata from external sources OpenMetadata defines and uses a set of components called `Connectors` for metadata ingestion. Each data service requires its own connector. See the documentation on how to [build a connector]() for details on developing connectors for new services. -1. Workflow [`OpenMetadata/ingestion/src/metadata/ingestion/api/workflow.py`](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/api/workflow.py) -2. Source [`OpenMetadata/ingestion/src/metadata/ingestion/api/source.py`](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/api/source.py) -3. Processor [`OpenMetadata/ingestion/src/metadata/ingestion/api/processor.py`](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/api/processor.py) -4. Sink [`OpenMetadata/ingestion/src/metadata/ingestion/api/sink.py`](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/api/sink.py) -5. Stage [`OpenMetadata/ingestion/src/metadata/ingestion/api/stage.py`](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/api/stage.py) -6. BulkSink [`OpenMetadata/ingestion/src/metadata/ingestion/api/bulk_sink.py`](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/api/bulk_sink.py) +1. Workflow [`ingestion/src/metadata/workflow/metadata.py`](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/workflow/metadata.py) +2. Source [`ingestion/src/metadata/ingestion/api/steps.py#L36`](https://github.com/open-metadata/OpenMetadata/blob/ea205d3ff4c6ede659059fca5447cd808f37d93c/ingestion/src/metadata/ingestion/api/steps.py#L36) +3. Processor [`ingestion/src/metadata/ingestion/api/steps.py#L75`](https://github.com/open-metadata/OpenMetadata/blob/ea205d3ff4c6ede659059fca5447cd808f37d93c/ingestion/src/metadata/ingestion/api/steps.py#L75) +4. Sink [`ingestion/src/metadata/ingestion/api/steps.py#L63`]( https://github.com/open-metadata/OpenMetadata/blob/ea205d3ff4c6ede659059fca5447cd808f37d93c/ingestion/src/metadata/ingestion/api/steps.py#L63) +5. Stage [`ingestion/src/metadata/ingestion/api/steps.py#L83`](https://github.com/open-metadata/OpenMetadata/blob/ea205d3ff4c6ede659059fca5447cd808f37d93c/ingestion/src/metadata/ingestion/api/steps.py#L83) +6. BulkSink [`ingestion/src/metadata/ingestion/api/steps.py#L91`](https://github.com/open-metadata/OpenMetadata/blob/ea205d3ff4c6ede659059fca5447cd808f37d93c/ingestion/src/metadata/ingestion/api/steps.py#L91) Workflow is a simple orchestration job that runs `Source`, `Processor`, `Sink`, `Stage` and `BulkSink` based on the configurations present under [`OpenMetadata/ingestion/examples/workflows`](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/examples/workflows). diff --git a/openmetadata-docs/content/v1.6.x/deployment/security/saml/aws.md b/openmetadata-docs/content/v1.6.x/deployment/security/saml/aws.md index db3e4fd7390..40a20c52f1d 100644 --- a/openmetadata-docs/content/v1.6.x/deployment/security/saml/aws.md +++ b/openmetadata-docs/content/v1.6.x/deployment/security/saml/aws.md @@ -83,7 +83,7 @@ Security requirements for your **production** environment: keyStorePassword: ${SAML_KEYSTORE_PASSWORD:-""} ``` -- Populate the above config from xml metadata +- Populate the above config from [xml metadata](/deployment/security/saml/xml_file) {% image src="/images/v1.6/deployment/security/saml/aws/saml-aws-8.png" alt="populate-metadata" /%} diff --git a/openmetadata-docs/content/v1.6.x/deployment/security/saml/azure.md b/openmetadata-docs/content/v1.6.x/deployment/security/saml/azure.md index f708fd20463..171842cabba 100644 --- a/openmetadata-docs/content/v1.6.x/deployment/security/saml/azure.md +++ b/openmetadata-docs/content/v1.6.x/deployment/security/saml/azure.md @@ -92,12 +92,14 @@ openssl x509 -in saml.crt -out samlCER.cer -outform DER - Open the downloaded metadata xml file, and populate the following properties in `openmetadata.yml` ```yaml + authenticationConfiguration: + provider: ${AUTHENTICATION_PROVIDER:-saml} samlConfiguration: debugMode: ${SAML_DEBUG_MODE:-false} idp: entityId: ${SAML_IDP_ENTITY_ID:-"https://mocksaml.com/api/saml/sso"} ssoLoginUrl: ${SAML_IDP_SSO_LOGIN_URL:-"https://saml.example.com/entityid"} - idpX509Certificate: ${SAML_IDP_CERTIFICATE:-""} + idpX509Certificate: ${SAML_IDP_CERTIFICATE:-""} #Pass the certificate as a string authorityUrl: ${SAML_AUTHORITY_URL:-"http://localhost:8585/api/v1/saml/login"} nameId: ${SAML_IDP_NAME_ID:-"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"} sp: @@ -120,7 +122,9 @@ openssl x509 -in saml.crt -out samlCER.cer -outform DER keyStorePassword: ${SAML_KEYSTORE_PASSWORD:-""} ``` -- Populate the above config from xml metadata +- Populate the above config from [xml metadata](/deployment/security/saml/xml_file) + + {% image src="/images/v1.6/deployment/security/saml/aws/saml-aws-8.png" alt="populate-metadata" /%} - IDP Config `entityID` -> Populate it from Metadata XML Entity ID diff --git a/openmetadata-docs/content/v1.6.x/deployment/security/saml/docker.md b/openmetadata-docs/content/v1.6.x/deployment/security/saml/docker.md index 70987b81516..00120136bd7 100644 --- a/openmetadata-docs/content/v1.6.x/deployment/security/saml/docker.md +++ b/openmetadata-docs/content/v1.6.x/deployment/security/saml/docker.md @@ -4,7 +4,7 @@ slug: /deployment/security/saml/docker collate: false --- -# Keycloak SSO for Docker +# SAML SSO for Docker To enable security for the Docker deployment, follow the next steps: diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/aws.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/aws.md index 27fd23f23da..7372f74f6ed 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/aws.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/aws.md @@ -83,7 +83,7 @@ Security requirements for your **production** environment: keyStorePassword: ${SAML_KEYSTORE_PASSWORD:-""} ``` -- Populate the above config from xml metadata +- Populate the above config from [xml metadata](/deployment/security/saml/xml_file) {% image src="/images/v1.7/deployment/security/saml/aws/saml-aws-8.png" alt="populate-metadata" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/azure.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/azure.md index 3a184c3f88b..9f6cc27c280 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/azure.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/azure.md @@ -92,12 +92,14 @@ openssl x509 -in saml.crt -out samlCER.cer -outform DER - Open the downloaded metadata xml file, and populate the following properties in `openmetadata.yml` ```yaml + authenticationConfiguration: + provider: ${AUTHENTICATION_PROVIDER:-saml} samlConfiguration: debugMode: ${SAML_DEBUG_MODE:-false} idp: entityId: ${SAML_IDP_ENTITY_ID:-"https://mocksaml.com/api/saml/sso"} ssoLoginUrl: ${SAML_IDP_SSO_LOGIN_URL:-"https://saml.example.com/entityid"} - idpX509Certificate: ${SAML_IDP_CERTIFICATE:-""} + idpX509Certificate: ${SAML_IDP_CERTIFICATE:-""} #Pass the certificate as a string authorityUrl: ${SAML_AUTHORITY_URL:-"http://localhost:8585/api/v1/saml/login"} nameId: ${SAML_IDP_NAME_ID:-"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"} sp: @@ -120,7 +122,9 @@ openssl x509 -in saml.crt -out samlCER.cer -outform DER keyStorePassword: ${SAML_KEYSTORE_PASSWORD:-""} ``` -- Populate the above config from xml metadata +- Populate the above config from [xml metadata](/deployment/security/saml/xml_file) + + {% image src="/images/v1.7/deployment/security/saml/aws/saml-aws-8.png" alt="populate-metadata" /%} - IDP Config `entityID` -> Populate it from Metadata XML Entity ID diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/docker.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/docker.md index 19927ce9c29..51f44a2eadb 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/docker.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/docker.md @@ -4,7 +4,7 @@ slug: /deployment/security/saml/docker collate: false --- -# Keycloak SSO for Docker +# SAML SSO for Docker To enable security for the Docker deployment, follow the next steps: