yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-26 06:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

saml documentation updated (#20318)

Browse Source
This commit is contained in:
safayavatsal 2025-03-18 16:03:32 +05:30 committed by GitHub
parent 20ab64d1f1
commit 86714dc066
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 30 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
openmetadata-docs/content/v1.5.x/deployment/security/saml/aws.md
View File

@ -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" /%}

8
openmetadata-docs/content/v1.5.x/deployment/security/saml/azure.md
View File

@ -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

2
openmetadata-docs/content/v1.5.x/deployment/security/saml/docker.md
View File

@ -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:

12
openmetadata-docs/content/v1.5.x/developers/architecture/code-layout.md
View File

@ -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).

2
openmetadata-docs/content/v1.6.x/deployment/security/saml/aws.md
View File

@ -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" /%}

8
openmetadata-docs/content/v1.6.x/deployment/security/saml/azure.md
View File

@ -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

2
openmetadata-docs/content/v1.6.x/deployment/security/saml/docker.md
View File

@ -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:

2
openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/aws.md
View File

@ -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" /%}

8
openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/azure.md
View File

@ -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

2
openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/security/saml/docker.md
View File

@ -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: