Publish and share Kedro-Viz¶
Note
Kedro-Viz sharing was introduced in version 6.6.0.
This page describes how to publish Kedro-Viz so you can share it with others. It uses the spaceflights tutorial as an example.
If you haven’t installed Kedro follow the documentation to get set up. In your terminal window, navigate to the folder you want to store the project.
If you have not yet worked through the tutorial, use the to generate the project with working code in place. Type the following in your terminal:
kedro new --starter=spaceflights
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.
Update and install the dependencies¶
Kedro-Viz requires specific minimum versions of fsspec[s3], and kedro to publish your project.
You can ensure you have these correct versions by updating the requirements.txt file in the src folder of the Kedro project to the following:
fsspec[s3]>=2023.9.0
kedro>=0.18.2
Install the dependencies from the project root directory by typing the following in your terminal:
pip install -r src/requirements.txt
Configure your AWS S3 bucket and set credentials¶
You can host your Kedro-Viz project on Amazon S3. You must first create an S3 bucket and then enable static website hosting. To do so, follow the AWS tutorial to configure a static website on Amazon S3.
Once that’s completed, you’ll need to set your AWS credentials as environment variables in your terminal window, as shown below:
export AWS_ACCESS_KEY_ID="your_access_key_id"
export AWS_SECRET_ACCESS_KEY="your_secret_access_key"
For more information, see the official AWS documentation about how to work with credentials.
Publish and share the project¶
You’re now ready to publish and share your Kedro-Viz project. Start Kedro-Viz by running the following command in your terminal:
kedro viz
Click the Publish and share icon in the lower-left of the application. You will see a modal dialog to select your relevant AWS Bucket Region and enter your Bucket Name.
Once those two details are complete, click Publish. A hosted, shareable URL will be returned to you after the process completes.
Here’s an example of the flow:
Permissions and access control¶
All permissions and access control are controlled by AWS. It’s up to you, the user, if you want to allow anyone to see your project or limit access to certain IP addresses, users, or groups.
You can control who can view your visualisation using bucket and user policies or access control lists. See the official AWS documentation for more information.