Skip to main content

Project

This guide outlines the steps to create an Ascend Project.

Before you begin​

New to Ascend? We recommend starting with:

If you're already set up with Ascend and just want to create a new Project, you've come to the right place.

Prerequisites​

Set up a Git repository​

Ascend Projects require a Git repository to store your code. Choose one of the following options to set up your repository and connect it to your Ascend Instance.

1. Create a new repository on GitHub

  • Navigate to GitHub's New Repository page
  • Set Owner to your personal GitHub account or organization
    tip

    If you have permissions to your company's GitHub Organization, create the repository there. Otherwise, create it under your personal account.

  • Set Repository name to ascend-quickstart-bigquery (or your preferred name)
  • Set Description to Ascend Quickstart BigQuery
  • Set visibility to Private
  • Click Create repository

2. Clone the Ascend Community Repository and push it to your new repository

# Set the variables
GITHUB_ORG="<your-github-org>" # Use your GitHub username or organization name
GITHUB_REPO="ascend-quickstart-bigquery"
# Clone the Ascend Community Repository
git clone git@github.com:ascend-io/ascend-community.git ${GITHUB_REPO}
cd ${GITHUB_REPO}

# Set the remote URL to your new repository
git remote set-url origin git@github.com:${GITHUB_ORG}/${GITHUB_REPO}.git

# Push the code to your new repository
git push -u origin main
info

If you encounter this error: git@github.com: Permission denied (publickey), follow the SSH steps outlined below before creating your repository.

For more detailed setup instructions for using Otto's Expeditions on your preferred GitHub provider, refer to our how-to guides for GitHub, GitLab, and Bitbucket.

Connect Ascend to your Git repository​

Create the SSH key pair​

  1. On your local machine, open a terminal and run the following command: 
    mkdir -p ~/.ssh && ssh-keygen -t ed25519 -f ~/.ssh/ascend_quickstart_repo_key -q -N ""
  2. This command will generate a new SSH key pair in the ~/.ssh directory.
  3. The public key will be saved in ~/.ssh/ascend_quickstart_repo_key.pub
  4. The private key will be saved in ~/.ssh/ascend_quickstart_repo_key.
    tip

    You can copy the contents of the public key to your clipboard by running:

    cat ~/.ssh/ascend_quickstart_repo_key.pub | pbcopy

Add the public key to your repository​

Please follow the instructions here to setup the public ssh key in your Github repository. You will need to allow write access.

Add the private key to Ascend​

  1. In the Ascend UI, navigate to the instance settings by clicking on the button in the top right with your instance name and your user icon.
  2. Click on the Repositories settings tab.
  3. Click the Add Repository button.
  4. Set the Repository URI in this format: git@github.com:<github-org>/<github-repo>.git.
  5. Set SSH Private Key to the private key you generated in the previous step.
tip

Make sure to copy the entire private key, including the lines that indicate the beginning and end of the key.

  1. Click Check and Create.

Create an Ascend Project​

After connecting your Git repository, create your Ascend Project:

  1. In the Ascend UI, click the Instance settings button (top right, showing your Instance name and user icon)
  2. Navigate to the Projects tab
  3. Click Add Project
  4. Enter a Title for your Project
  5. Select your Repository from the dropdown
  6. Set Project Root to the folder path containing your project code
  7. Click Save

Configure your Project​

Ascend Projects use a dual configuration approach:

  • ascend_project.yaml - defines Data Plane settings and default Flow specifications
  • pyproject.toml - manages Python package dependencies

The examples below show ascend_project.yaml configurations for different Data Planes, based on the Otto's Expeditions project. See this guide for pyproject.toml setup.

project:
  # only alphanumeric characters, dashes, and underscores are allowed for the Project name
  name: ottos-expeditions
  # in Ascend, Parameters are a core concept.
  # Think of parameters as a key:value mapping (dictionary, map, etc.) of variables
  # you can use in your Flows. The hierarchy of parameters is:
  # Project > Profile > Flow > Flow Run.
  # The Parameters below are the top-level variables -- you can think of them as a default
  # -- for all Flows in this project. Profiles are typically used to override Parameters
  parameters:
    data_planes:
      gcp:
        project_id: <your-gcp-project-id>
      bigquery:
        dataset: OTTOS_EXPEDITIONS_DEVELOPMENT
        location: US
  # defaults are typically used to specify the default Data Plane Connection
  # used for Flows, specified by a regex pattern on the Flow name
  defaults:
    - kind: Flow
      name:
        regex: .*
      spec:
        data_plane:
          connection_name: data_plane_bigquery

Next steps​

  • Set up your Workspace to start developing in Ascend
Last updated on