Skip to main content
Version: Preview

Get started

By the end of this page you'll have a Marmot Cloud instance with your first source cataloged and searchable in Discover.

  1. Create your account

    Sign up at cloud.marmotdata.io, then choose a plan under Billing. Start on Free needs no card and gives you 1 instance with room for 500 assets. The pricing page lists what the paid plans add.

  2. Launch an instance

    In the console, select New instance, enter an Instance name and select Launch instance. Launching usually takes about a minute and carries on if you leave the page.

    The New instance page with a name entered:

    The console New instance page with Kelp catalog as the instance name, the Europe region selected and the Launch instance buttonThe console New instance page with Kelp catalog as the instance name, the Europe region selected and the Launch instance button

    When it's ready, the instance's page shows its Address under Connect, such as <instance>.marmotdata.cloud.

  3. Sign in

    Under Admin sign-in on the instance's page, select Reveal password, then open the address and sign in as admin. Marmot asks for a new password straight away, and the initial one stops working.

    Admin sign-in on the instance's page:

    The Admin sign-in section of an instance page, showing the admin username and the Reveal password buttonThe Admin sign-in section of an instance page, showing the admin username and the Reveal password button

  4. Catalog your first source

    In your instance, open Plugins and pick your system under Add a source:

    Add a source on the Plugins page, listing plugins grouped by kind with a search boxAdd a source on the Plugins page, listing plugins grouped by kind with a search box
    1. Enter a Pipeline name, such as warehouse, and select Continue.
    2. Fill in the connection details and select Check and continue.
    3. Leave Run on a schedule off for now and select Create pipeline.
    4. On the pipeline's page, select Run now.

    Your instance connects to public addresses only. For a database on a private network, run the plugin inside that network with marmot plugin. For BigQuery, Glue or Blob Storage, connect your cloud instead, so the pipeline needs no password.

  5. Find it in Discover

    When the run finishes, open Discover. Your source's tables, topics or files are listed there, alongside data products, glossary terms and teams in one search:

    Discover in a Marmot Cloud instance, with filters for kind, type and provider beside a list of cataloged assetsDiscover in a Marmot Cloud instance, with filters for kind, type and provider beside a list of cataloged assets

Optional: work from your terminal​

Everything above can also be done from the CLI or Terraform. Neither is needed to use Marmot Cloud.

Install the CLI and sign in. Your browser opens, and the CLI keeps a token for 24 hours:

Homebrew

brew install marmot

Install script

curl -fsSL get.marmotdata.io | sh

Verify scripts

It's good practice to inspect the contents of any script before piping it into bash.
marmot login <instance>.marmotdata.cloud
marmot assets list

The Terraform provider signs in with the same CLI session, so you don't need an API key on your own machine:

terraform {
  required_providers {
    marmot = {
      source = "marmotdata/marmot"
    }
  }
}

provider "marmot" {
  host = "https://<instance>.marmotdata.cloud"
}

In CI, give Terraform a service account of its own.

Next steps​

Last updated on