Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This page contains a guide to install Lakehouse Monitor using cloud resources that were created previously by the administrator.

Step 1) Required Resources

Lakehouse Monitor requires the following resources to already be created:

Step 2) Configuration Prerequisites

  • Azure KeyVault needs to be preconfigured with the following secrets:

    • msft-provider-auth-secret - This is the Service Principal client secret

    • mssql-password - The SQL database password

    • storage-account-key - The access key used for the Azure storage account.
      Note: this is optional, needed only if you don’t want to access the storage account using the Service Principal.

...

Step 3) Installation procedure

  1. SSH into the BPLM VM configured at Step 1) Required Resources.

    1. download the install archive by running the following command:
      wget https://bplmdemoappstg.blob.core.windows.net/deployment/vm-azure/bplm-install.zip

  2. Extract the archive contents
    unzip archive.zip

  3. In the destination directory you should see the following files:

    Code Block
    .env
    docker-compose.yml
    setup.sh
    start.sh
    1. script will install Docker and other automation tools (e.g. OpenSSL)

  4. Before you start the setup you need to fill the .env file with the needed information (url of the app, Key Vault url, etc). Open the file in your editor of choice and fill in the values.

    1. Please find a brief explanation of the .env values below

    2. Code Block
      APPSERVICE_URL=    #default is https://<vm dns>
      AZURE_KEYVAULT_TENANTID=  # Azure Active Directory tenant ID
      AZURE_KEYVAULT_URI=  # can be found in keyvault properties page in azure portal
      AZURE_MANAGED_IDENTITY_ID= # VM system assigned identity objcet ID
      AZURE_MANAGED_IDENTITY_APP_ID= # app id of VM system assigned identity.  Can be found under the vm name in Enterprise application directory
      SERVICE_PRINCIPAL_CLIENTID= # Service principal tied to app registration client (also called app) id
      SERVICE_PRINCIPAL_OBJECTID= # Service principal tied to app registration object ID
      SERVICE_PRINCIPAL_TENANTID= # Azure Active Directory tenant ID
      SQL_SERVER_HOST= # can be found in sql server properties
      SQL_USER= # username of sql server
      STORAGE_AZURE_ACCOUNT= # storage account name
      STORAGE_AZURE_CONTAINER= # container name created for lakehouse
  5. Run the setup.sh.

    Code Block
    languages
    bash setup.sh -d=FQDNforLakehouse -v=LakehouseVersion
    • where FQDNforLakehouse is Fully Qualified Domain Name

    • where LakehouseVersion is the LHM version you want to install

    • e.g. bash setup.sh -d=my-lhm-deployment.com -v=2.1

    Note: when prompted if you want to use the Service Principal to access the storage account please keep in mind that if you choose Yes, the Key Vault should not contain the storage-account-key secret and if you choose No you will have to have that secret in the Key Vault.

  6. If the setup executed successfully you can run the start.sh script to start the system.

    Code Block
    bash start.sh -u=ACRUser -p=ACRPass

...