Stay organized with collections Save and categorize content based on your preferences.

Migrate data to a new managed notebooks instance

This page describes how to migrate data and files from an existing managed notebooks instance to a new one.

When to migrate

You might want to migrate to a new managed notebooks instance for any of the following reasons:

  • To use new capabilities that are only available in a newer version.

  • To benefit from framework updates, package updates, and bug fixes that have been implemented in a newer version.

Migration options

To migrate data and files from one managed notebooks instance to another, consider using the following methods:

  • Use GitHub: Copy your data and files to a GitHub repository by using the Git extension for JupyterLab.

  • Use Cloud Storage and the terminal: Copy your data and files to Cloud Storage and then to another instance by using the terminal.

  • Use Cloud Storage within JupyterLab notebooks: Copy your data and files to Cloud Storage and then to another instance by running commands within your respective instances' notebook cells.

This guide describes how to migrate data and files by using Cloud Storage and the terminal.

Requirements

You must have terminal access to your managed notebooks instance. Terminal access is manually set when you create an instance. The terminal access setting cannot be changed after the instance is created.

Before you begin

Create a Cloud Storage bucket in the same project where your managed notebooks instance is located.

Migrate your data to a new managed notebooks instance

To migrate data and files to a new managed notebooks instance by using Cloud Storage and the terminal, complete the following steps.

  1. In your managed notebooks instance's JupyterLab interface, select File > New > Terminal to open a terminal window.

  2. Use the gsutil tool to copy your user data to a Cloud Storage bucket. The following example command copies all of the files from your instance's /home/jupyter/ directory to a directory in a Cloud Storage bucket.

    gsutil cp -R /home/jupyter/* gs://BUCKET_NAMEPATH
    

    Replace the following:

    • BUCKET_NAME: the name of your Cloud Storage bucket
    • PATH: the path to the directory where you want to copy your files, for example: /copy/jupyter/
  3. Create a managed notebooks instance.

  4. In your new managed notebooks instance's JupyterLab interface, select File > New > Terminal to open a terminal window.

  5. Use the gsutil tool to restore your data on the new instance. The following example command copies all of the files from a Cloud Storage directory to the your new instance's /home/jupyter/ directory.

    gsutil cp gs://BUCKET_NAMEPATH* /home/jupyter/