Publish and share on Azure¶
This page describes how to publish Kedro-Viz on Azure to share it with others. It uses the spaceflights tutorial as an example.
Setup your kedro project¶
If you haven’t installed Kedro follow the documentation to get set up.
Important
We recommend that you use the same version of Kedro that was most recently used to test this tutorial (0.19.1). To check the version installed, type kedro -V in your terminal window.
In your terminal window, navigate to the folder you want to store the project. Generate the spaceflights tutorial project with all the code in place by using the Kedro starter for the spaceflights tutorial:
kedro new --starter=spaceflights-pandas
When prompted for a project name, you can enter anything, but we will assume Spaceflights throughout.
When your project is ready, navigate to the root directory of the project. Install the dependencies from the project root directory by typing the following in your terminal:
pip install -r requirements.txt
Kedro-Viz requires specific minimum versions of fsspec, and kedro to publish your project. Ensure you have these correct versions by updating the requirements.txt file of the Kedro project to add the following:
fsspec>=2023.9.0
kedro>=0.18.2
Install cloud dependencies¶
Step 1:
pip install 'kedro-viz[azure]'
Configure your Azure Blob Storage¶
You can host your Kedro-Viz project on Azure Blob Storage.
Enable static website hosting - Follow the Azure tutorial to configure static website hosting on Azure Blob Storage.
Note
The process of uploading your site’s files will be done through Kedro-Viz.
Register an app: Sign in to the Azure Portal and create an App Registration.
Obtain parameters: In the app registration’s overview pane, note down the Application (Client) ID and Directory (Tenant) ID.
Add client secret: Create a client secret for the app registration.
Assign IAM role: Assign an Access Control (IAM) role to the storage account.
Note
Kedro-Viz uses Gen2 filesystem protocol abfs to write files on AzureBlobStorage.
Important
Having a $web container in your AzureBlobStorage is mandatory to use Kedro-Viz publish and share feature on Azure. For more information, see the official Azure documentation about
Setting up a static website.
Set credentials¶
Once that’s completed, you’ll need to set your Azure credentials as environment variables in your terminal window, as shown below:
export AZURE_STORAGE_TENANT_ID="your-app-tenant-id"
export AZURE_STORAGE_CLIENT_ID="your-app-client-id"
export AZURE_STORAGE_CLIENT_SECRET="your-app-client-secret-value"
For more information, see the official Azure documentation about how to work with environmental credentials.
Set up endpoint¶
Important
The endpoint link can be found under Storage account -> Capabilities -> Static website -> Primary endpoint.
Before publishing, you can enable or disable the preview for all datasets by toggling the “All dataset previews” button in the modal dialog. Once those details are complete, click Publish. A hosted, shareable URL will be returned to you after the process completes.
Permissions and access control¶
Kedro-Viz does not manage permissions or access control. Azure manages all permissions and access control. As a user, you have the choice to allow anyone to view your project or restrict access to specific IP addresses, users, or groups.
You can control who can view your visualisation using attribute-based access control. See the official Azure documentation for more information.
Billing¶
Kedro-Viz does not handle billing. You pay for storing objects on your AzureBlobStorage. The amount you pay depends on the volume of data stored per month, quantity and types of operations performed, along with any data transfer costs, data redundancy option selected.
See the official Azure documentation for more information.