From 1c90eaaf3df2c5326f49d20a50b4a1a887bfe087 Mon Sep 17 00:00:00 2001 From: Prajwal214 <167504578+Prajwal214@users.noreply.github.com> Date: Mon, 9 Sep 2024 11:47:09 +0530 Subject: [PATCH] Docs: Updated Domain in Docker Compose & Docs (#17603) * Minor: Updating Domain in Docker Compose & Docs * replace openmetadata to open-metadata --------- Co-authored-by: Prajwal Pandit Co-authored-by: Chirag Madlani <12962843+chirag-madlani@users.noreply.github.com> Co-authored-by: Shailesh Parmar --- conf/openmetadata.yaml | 2 +- docker/development/docker-compose-gcp.yml | 4 ++-- docker/development/docker-compose-postgres.yml | 4 ++-- docker/development/docker-compose.yml | 4 ++-- .../docker-compose-openmetadata.yml | 4 ++-- docker/docker-compose-openmetadata/env-mysql | 2 +- docker/docker-compose-openmetadata/env-postgres | 2 +- .../docker-compose-postgres.yml | 4 ++-- .../docker-compose-quickstart/docker-compose.yml | 4 ++-- .../v1.4.x/deployment/security/basic-auth/index.md | 14 ++++++++++++-- .../v1.4.x/deployment/security/ldap/bare-metal.md | 4 ++-- .../v1.4.x/quick-start/local-docker-deployment.md | 2 +- .../quick-start/local-kubernetes-deployment.md | 2 +- .../v1.5.x/deployment/security/basic-auth/index.md | 14 ++++++++++++-- .../v1.5.x/deployment/security/ldap/bare-metal.md | 4 ++-- .../v1.5.x/quick-start/local-docker-deployment.md | 2 +- .../quick-start/local-kubernetes-deployment.md | 2 +- .../deployment/security/basic-auth/index.md | 14 ++++++++++++-- .../deployment/security/ldap/bare-metal.md | 4 ++-- .../quick-start/local-docker-deployment.md | 2 +- .../quick-start/local-kubernetes-deployment.md | 2 +- .../resources/ui/cypress/constants/constants.ts | 2 +- .../main/resources/ui/playwright/constant/user.ts | 2 +- 23 files changed, 65 insertions(+), 35 deletions(-) diff --git a/conf/openmetadata.yaml b/conf/openmetadata.yaml index d24b2ee046c..dedceb705dd 100644 --- a/conf/openmetadata.yaml +++ b/conf/openmetadata.yaml @@ -167,7 +167,7 @@ authorizerConfiguration: containerRequestFilter: ${AUTHORIZER_REQUEST_FILTER:-org.openmetadata.service.security.JwtFilter} adminPrincipals: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} allowedEmailRegistrationDomains: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} - principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} enforcePrincipalDomain: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} enableSecureSocketConnection : ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} useRolesFromProvider: ${AUTHORIZER_USE_ROLES_FROM_PROVIDER:-false} diff --git a/docker/development/docker-compose-gcp.yml b/docker/development/docker-compose-gcp.yml index 90492f5131e..169cee1a591 100644 --- a/docker/development/docker-compose-gcp.yml +++ b/docker/development/docker-compose-gcp.yml @@ -90,7 +90,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} @@ -300,7 +300,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} diff --git a/docker/development/docker-compose-postgres.yml b/docker/development/docker-compose-postgres.yml index d2a78566767..b3730292518 100644 --- a/docker/development/docker-compose-postgres.yml +++ b/docker/development/docker-compose-postgres.yml @@ -87,7 +87,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} @@ -302,7 +302,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} diff --git a/docker/development/docker-compose.yml b/docker/development/docker-compose.yml index 4c60336d8b0..804c7e9a801 100644 --- a/docker/development/docker-compose.yml +++ b/docker/development/docker-compose.yml @@ -86,7 +86,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} @@ -298,7 +298,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} diff --git a/docker/docker-compose-openmetadata/docker-compose-openmetadata.yml b/docker/docker-compose-openmetadata/docker-compose-openmetadata.yml index f5ae6d52cb5..bfc903d62f7 100644 --- a/docker/docker-compose-openmetadata/docker-compose-openmetadata.yml +++ b/docker/docker-compose-openmetadata/docker-compose-openmetadata.yml @@ -30,7 +30,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} @@ -240,7 +240,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} diff --git a/docker/docker-compose-openmetadata/env-mysql b/docker/docker-compose-openmetadata/env-mysql index b20bd87cf3a..413352d0898 100644 --- a/docker/docker-compose-openmetadata/env-mysql +++ b/docker/docker-compose-openmetadata/env-mysql @@ -12,7 +12,7 @@ AUTHORIZER_REQUEST_FILTER="org.openmetadata.service.security.JwtFilter" AUTHORIZER_ADMIN_PRINCIPALS=[admin] AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN=["all"] AUTHORIZER_INGESTION_PRINCIPALS=[ingestion-bot] -AUTHORIZER_PRINCIPAL_DOMAIN="openmetadata.org" +AUTHORIZER_PRINCIPAL_DOMAIN="open-metadata.org" AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN="false" AUTHORIZER_ENABLE_SECURE_SOCKET="false" AUTHENTICATION_PROVIDER="basic" diff --git a/docker/docker-compose-openmetadata/env-postgres b/docker/docker-compose-openmetadata/env-postgres index 7e53c3a09a0..650cc2f9359 100644 --- a/docker/docker-compose-openmetadata/env-postgres +++ b/docker/docker-compose-openmetadata/env-postgres @@ -12,7 +12,7 @@ AUTHORIZER_REQUEST_FILTER="org.openmetadata.service.security.JwtFilter" AUTHORIZER_ADMIN_PRINCIPALS=[admin] AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN=["all"] AUTHORIZER_INGESTION_PRINCIPALS=[ingestion-bot] -AUTHORIZER_PRINCIPAL_DOMAIN="openmetadata.org" +AUTHORIZER_PRINCIPAL_DOMAIN="open-metadata.org" AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN="false" AUTHORIZER_ENABLE_SECURE_SOCKET="false" AUTHENTICATION_PROVIDER="basic" diff --git a/docker/docker-compose-quickstart/docker-compose-postgres.yml b/docker/docker-compose-quickstart/docker-compose-postgres.yml index 7eb13c9f1ee..66ac68bb766 100644 --- a/docker/docker-compose-quickstart/docker-compose-postgres.yml +++ b/docker/docker-compose-quickstart/docker-compose-postgres.yml @@ -78,7 +78,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} @@ -288,7 +288,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} diff --git a/docker/docker-compose-quickstart/docker-compose.yml b/docker/docker-compose-quickstart/docker-compose.yml index c61f734b298..7ce4f1479b7 100644 --- a/docker/docker-compose-quickstart/docker-compose.yml +++ b/docker/docker-compose-quickstart/docker-compose.yml @@ -76,7 +76,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} @@ -286,7 +286,7 @@ services: AUTHORIZER_ADMIN_PRINCIPALS: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} AUTHORIZER_INGESTION_PRINCIPALS: ${AUTHORIZER_INGESTION_PRINCIPALS:-[ingestion-bot]} - AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + AUTHORIZER_PRINCIPAL_DOMAIN: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN: ${AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN:-false} AUTHORIZER_ENABLE_SECURE_SOCKET: ${AUTHORIZER_ENABLE_SECURE_SOCKET:-false} AUTHENTICATION_PROVIDER: ${AUTHENTICATION_PROVIDER:-basic} diff --git a/openmetadata-docs/content/v1.4.x/deployment/security/basic-auth/index.md b/openmetadata-docs/content/v1.4.x/deployment/security/basic-auth/index.md index 48108a62e7a..09ffd9365a4 100644 --- a/openmetadata-docs/content/v1.4.x/deployment/security/basic-auth/index.md +++ b/openmetadata-docs/content/v1.4.x/deployment/security/basic-auth/index.md @@ -10,9 +10,19 @@ Out of the box, OpenMetadata comes with a Username & Password Login Mechanism. The default Username and Password for Login are: ```commandline -Username - admin@openmetadata.org +Username - admin@open-metadata.org Password - admin ``` +When using a custom domain, configure the principal domain as follows: + +```yaml +config: + authorizer: + adminPrincipals: [admin] + principalDomain: "yourdomain.com" +``` + +With this setup, the default Username will be `admin@yourdomain.com`. {%important%} @@ -55,7 +65,7 @@ This configuration controls the authorizer for OpenMetadata: authorizerConfiguration: adminPrincipals: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} allowedEmailRegistrationDomains: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} - principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} ``` For the Basic auth we need to set: diff --git a/openmetadata-docs/content/v1.4.x/deployment/security/ldap/bare-metal.md b/openmetadata-docs/content/v1.4.x/deployment/security/ldap/bare-metal.md index 0bc672684d3..bf26a1ba4bd 100644 --- a/openmetadata-docs/content/v1.4.x/deployment/security/ldap/bare-metal.md +++ b/openmetadata-docs/content/v1.4.x/deployment/security/ldap/bare-metal.md @@ -143,12 +143,12 @@ This configuration controls the authorizer for OpenMetadata: ```yaml authorizerConfiguration: adminPrincipals: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} - principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} ``` For the Ldap we need to set: -- `adminPrincipals`: This is the list of admin Principal for the OpenMetadata , if mail in ldap is example@openmetadata.org, then if we want this user to be admin in the OM, we should add 'example', in this list. +- `adminPrincipals`: This is the list of admin Principal for the OpenMetadata , if mail in ldap is example@open-metadata.org, then if we want this user to be admin in the OM, we should add 'example', in this list. - `principalDomain`: Company Domain. {% partial file="/v1.4/deployment/configure-ingestion.md" /%} diff --git a/openmetadata-docs/content/v1.4.x/quick-start/local-docker-deployment.md b/openmetadata-docs/content/v1.4.x/quick-start/local-docker-deployment.md index 7f381315113..1018b94a14c 100644 --- a/openmetadata-docs/content/v1.4.x/quick-start/local-docker-deployment.md +++ b/openmetadata-docs/content/v1.4.x/quick-start/local-docker-deployment.md @@ -184,7 +184,7 @@ OpenMetadata provides a default admin account to login. You can access OpenMetadata at [http://localhost:8585](http://localhost:8585). Use the following credentials to log in to OpenMetadata. -- Username: `admin@openmetadata.org` +- Username: `admin@open-metadata.org` - Password: `admin` Once you log in, you can goto Settings -> Users to add another user and make them admin as well. diff --git a/openmetadata-docs/content/v1.4.x/quick-start/local-kubernetes-deployment.md b/openmetadata-docs/content/v1.4.x/quick-start/local-kubernetes-deployment.md index c2f6986b630..78a5a80b515 100644 --- a/openmetadata-docs/content/v1.4.x/quick-start/local-kubernetes-deployment.md +++ b/openmetadata-docs/content/v1.4.x/quick-start/local-kubernetes-deployment.md @@ -135,7 +135,7 @@ kubectl port-forward service/openmetadata 8585:http The above command will port forward traffic from local machine port 8585 to a named port of OpenMetadata kubernetes service `http`. -Browse the Application with url `http://localhost:8585` from your Browser. The default login credentials are `admin@openmetadata.org:admin` to log into OpenMetadata Application. +Browse the Application with url `http://localhost:8585` from your Browser. The default login credentials are `admin@open-metadata.org:admin` to log into OpenMetadata Application. ### 7. Cleanup diff --git a/openmetadata-docs/content/v1.5.x/deployment/security/basic-auth/index.md b/openmetadata-docs/content/v1.5.x/deployment/security/basic-auth/index.md index 6b6dc7a0da0..65b81c614ac 100644 --- a/openmetadata-docs/content/v1.5.x/deployment/security/basic-auth/index.md +++ b/openmetadata-docs/content/v1.5.x/deployment/security/basic-auth/index.md @@ -11,9 +11,19 @@ Out of the box, OpenMetadata comes with a Username & Password Login Mechanism. The default Username and Password for Login are: ```commandline -Username - admin@openmetadata.org +Username - admin@open-metadata.org Password - admin ``` +When using a custom domain, configure the principal domain as follows: + +```yaml +config: + authorizer: + adminPrincipals: [admin] + principalDomain: "yourdomain.com" +``` + +With this setup, the default Username will be `admin@yourdomain.com`. {%important%} @@ -56,7 +66,7 @@ This configuration controls the authorizer for OpenMetadata: authorizerConfiguration: adminPrincipals: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} allowedEmailRegistrationDomains: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} - principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} ``` For the Basic auth we need to set: diff --git a/openmetadata-docs/content/v1.5.x/deployment/security/ldap/bare-metal.md b/openmetadata-docs/content/v1.5.x/deployment/security/ldap/bare-metal.md index 3fa97c3ff09..23a45eca2d2 100644 --- a/openmetadata-docs/content/v1.5.x/deployment/security/ldap/bare-metal.md +++ b/openmetadata-docs/content/v1.5.x/deployment/security/ldap/bare-metal.md @@ -144,12 +144,12 @@ This configuration controls the authorizer for OpenMetadata: ```yaml authorizerConfiguration: adminPrincipals: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} - principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} ``` For the Ldap we need to set: -- `adminPrincipals`: This is the list of admin Principal for the OpenMetadata , if mail in ldap is example@openmetadata.org, then if we want this user to be admin in the OM, we should add 'example', in this list. +- `adminPrincipals`: This is the list of admin Principal for the OpenMetadata , if mail in ldap is example@open-metadata.org, then if we want this user to be admin in the OM, we should add 'example', in this list. - `principalDomain`: Company Domain. {% partial file="/v1.5/deployment/configure-ingestion.md" /%} diff --git a/openmetadata-docs/content/v1.5.x/quick-start/local-docker-deployment.md b/openmetadata-docs/content/v1.5.x/quick-start/local-docker-deployment.md index 358481e48f3..4b3edaab243 100644 --- a/openmetadata-docs/content/v1.5.x/quick-start/local-docker-deployment.md +++ b/openmetadata-docs/content/v1.5.x/quick-start/local-docker-deployment.md @@ -184,7 +184,7 @@ OpenMetadata provides a default admin account to login. You can access OpenMetadata at [http://localhost:8585](http://localhost:8585). Use the following credentials to log in to OpenMetadata. -- Username: `admin@openmetadata.org` +- Username: `admin@open-metadata.org` - Password: `admin` Once you log in, you can goto Settings -> Users to add another user and make them admin as well. diff --git a/openmetadata-docs/content/v1.5.x/quick-start/local-kubernetes-deployment.md b/openmetadata-docs/content/v1.5.x/quick-start/local-kubernetes-deployment.md index c2f6986b630..78a5a80b515 100644 --- a/openmetadata-docs/content/v1.5.x/quick-start/local-kubernetes-deployment.md +++ b/openmetadata-docs/content/v1.5.x/quick-start/local-kubernetes-deployment.md @@ -135,7 +135,7 @@ kubectl port-forward service/openmetadata 8585:http The above command will port forward traffic from local machine port 8585 to a named port of OpenMetadata kubernetes service `http`. -Browse the Application with url `http://localhost:8585` from your Browser. The default login credentials are `admin@openmetadata.org:admin` to log into OpenMetadata Application. +Browse the Application with url `http://localhost:8585` from your Browser. The default login credentials are `admin@open-metadata.org:admin` to log into OpenMetadata Application. ### 7. Cleanup diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/basic-auth/index.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/basic-auth/index.md index 6b6dc7a0da0..65b81c614ac 100644 --- a/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/basic-auth/index.md +++ b/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/basic-auth/index.md @@ -11,9 +11,19 @@ Out of the box, OpenMetadata comes with a Username & Password Login Mechanism. The default Username and Password for Login are: ```commandline -Username - admin@openmetadata.org +Username - admin@open-metadata.org Password - admin ``` +When using a custom domain, configure the principal domain as follows: + +```yaml +config: + authorizer: + adminPrincipals: [admin] + principalDomain: "yourdomain.com" +``` + +With this setup, the default Username will be `admin@yourdomain.com`. {%important%} @@ -56,7 +66,7 @@ This configuration controls the authorizer for OpenMetadata: authorizerConfiguration: adminPrincipals: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} allowedEmailRegistrationDomains: ${AUTHORIZER_ALLOWED_REGISTRATION_DOMAIN:-["all"]} - principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} ``` For the Basic auth we need to set: diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/ldap/bare-metal.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/ldap/bare-metal.md index 191a1c6ee8a..c2ec2adf4d1 100644 --- a/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/ldap/bare-metal.md +++ b/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/ldap/bare-metal.md @@ -144,12 +144,12 @@ This configuration controls the authorizer for OpenMetadata: ```yaml authorizerConfiguration: adminPrincipals: ${AUTHORIZER_ADMIN_PRINCIPALS:-[admin]} - principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"openmetadata.org"} + principalDomain: ${AUTHORIZER_PRINCIPAL_DOMAIN:-"open-metadata.org"} ``` For the Ldap we need to set: -- `adminPrincipals`: This is the list of admin Principal for the OpenMetadata , if mail in ldap is example@openmetadata.org, then if we want this user to be admin in the OM, we should add 'example', in this list. +- `adminPrincipals`: This is the list of admin Principal for the OpenMetadata , if mail in ldap is example@open-metadata.org, then if we want this user to be admin in the OM, we should add 'example', in this list. - `principalDomain`: Company Domain. {% partial file="/v1.5/deployment/configure-ingestion.md" /%} diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/quick-start/local-docker-deployment.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/quick-start/local-docker-deployment.md index 65cba983b6f..faf99d14631 100644 --- a/openmetadata-docs/content/v1.6.x-SNAPSHOT/quick-start/local-docker-deployment.md +++ b/openmetadata-docs/content/v1.6.x-SNAPSHOT/quick-start/local-docker-deployment.md @@ -184,7 +184,7 @@ OpenMetadata provides a default admin account to login. You can access OpenMetadata at [http://localhost:8585](http://localhost:8585). Use the following credentials to log in to OpenMetadata. -- Username: `admin@openmetadata.org` +- Username: `admin@open-metadata.org` - Password: `admin` Once you log in, you can goto Settings -> Users to add another user and make them admin as well. diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/quick-start/local-kubernetes-deployment.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/quick-start/local-kubernetes-deployment.md index c2f6986b630..78a5a80b515 100644 --- a/openmetadata-docs/content/v1.6.x-SNAPSHOT/quick-start/local-kubernetes-deployment.md +++ b/openmetadata-docs/content/v1.6.x-SNAPSHOT/quick-start/local-kubernetes-deployment.md @@ -135,7 +135,7 @@ kubectl port-forward service/openmetadata 8585:http The above command will port forward traffic from local machine port 8585 to a named port of OpenMetadata kubernetes service `http`. -Browse the Application with url `http://localhost:8585` from your Browser. The default login credentials are `admin@openmetadata.org:admin` to log into OpenMetadata Application. +Browse the Application with url `http://localhost:8585` from your Browser. The default login credentials are `admin@open-metadata.org:admin` to log into OpenMetadata Application. ### 7. Cleanup diff --git a/openmetadata-ui/src/main/resources/ui/cypress/constants/constants.ts b/openmetadata-ui/src/main/resources/ui/cypress/constants/constants.ts index 995d6ba5da4..77bb0b8a1b0 100644 --- a/openmetadata-ui/src/main/resources/ui/cypress/constants/constants.ts +++ b/openmetadata-ui/src/main/resources/ui/cypress/constants/constants.ts @@ -338,7 +338,7 @@ export const ENTITY_SERVICE_TYPE = { }; export const LOGIN = { - username: 'admin@openmetadata.org', + username: 'admin@open-metadata.org', password: 'admin', }; diff --git a/openmetadata-ui/src/main/resources/ui/playwright/constant/user.ts b/openmetadata-ui/src/main/resources/ui/playwright/constant/user.ts index 6eda5def42d..be0dafa0648 100644 --- a/openmetadata-ui/src/main/resources/ui/playwright/constant/user.ts +++ b/openmetadata-ui/src/main/resources/ui/playwright/constant/user.ts @@ -11,7 +11,7 @@ * limitations under the License. */ export const DEFAULT_ADMIN_USER = { - userName: 'admin@openmetadata.org', + userName: 'admin@open-metadata.org', password: 'admin', };