Skip to main content

Create a Project from a Template

To help you get started quickly with DataOps, we include a template project which has by default the required configurations. You can save a lot of time by building on this template project as it:

  • Initializes your project with the recommended structure and the default project settings.
  • Includes the mandatory directories and files and many best-practice configurations.
  • Sets up the dependency to the reference project providing you seamless access to the DataOps platform.
tip

Always start from the template project and customize it to suit your needs. Starting from a blank project may lead to mistakes that are hard to find and correct.

Follow these steps to create your new project by cloning the DataOps template project:

  1. Within your DataOps group, click New project and select Create from template.

    The Create from template page opens.

  2. Click Use template to open the details of the standard template.

    use template button __shadow__

  3. Enter a name and description for your project.

    enter project name and project description details __shadow__

  4. Set the project URL and click Create project.

    An Import in progress page opens. Once the import is complete, a new page opens with project details.

You are a few steps away from using this template project and start building your data products with DataOps.live.

Follow the below steps for a quick start or see how to set up DataOps for a complete setup of the environment.

  1. Make sure you have an active runner associated with your project.

    1. Navigate to Settings > CI/CD

    2. Expand Runners and check if there's an available runner.

      If you create your project inside a group, you should have an available shared runner. Otherwise, you must install a runner https://docs.dataops.live/docs/admin-guide/docker-runner/.

    3. Copy the name of the available runner.

  2. Set the runner agent tag in the agent_tag.yml file.

    1. Navigate to Repository > File and click pipeline/includes.

    2. Click config and open agent_tag.yml.

    3. Replace SET_RUNNER_NAME_HERE with the name of the available runner or the runner you installed.

      The runner's name is case-sensitive. set the name of the available runner

  3. Set variables in the variables.yml file.

    1. Navigate to Repository > File and click pipeline/includes.

    2. Click config and open variables.yml.

    3. Set the DATAOPS_PREFIX variable to something meaningful for you. Use all caps.

      This defines the name of the environments created by this project: <PREFIX_branch name>. set the project variables

    4. In the secret manager configuration section, make sure the defined region matches where the secrets and runner are stored. For example, if you are using Azure or HashiCorp vault, this value should be different.

note

The template project assumes that you have access to the Snowflake sample data at sources/snowflake_sample_data/tpch_sf1. If this isn't enabled in your Snowflake environment, you may get an error.