Is this page helpful?

Create, Clone, Publish and Delete Projects#

Key Concepts#

Create

Initiating a net new project in a location with a simple default structure. Equivalent to git init –template <template> with the default structure.

Clone

Equivalent to git clone <repository>. Requires a properly formatted .project/spec.yaml file.

Publish

Pushes a new project to the intended Git platform. Equivalent to creating the repository on the platform, adding the remote origin, and pushing the project.

Git platform

Supported examples are GitHub, public GitLab and self-hosted GitLab. You must have an account to a Git platform to publish a project.

Create New Project#

Step One: Open a location and start project creation.

  1. Select Location Manager > Location Card

  2. Select Location Window > New Project

Step Two: Fill the dialog in the New Project modal.

  1. Enter New Project > Name (lowercase alphanumeric and hyphens)

  2. Optionally enter free text in New Project > Description

  3. (optional) Alter the default path on disk New Project > Path

  4. Click New Project > Next

Step Three: Select a base image container in the New Project modal.

  1. Select the desired image from the defaults in NGC Catalog > Image Card

  2. (optional) Select Custom Container > Text Bar and enter a URL

  3. Select Create

Success: The project tab will open and the container will start building.

The Custom Container option only works with a properly labeled image.

Image labels are required to create .project/spec.yaml. Default images have them.

Clone Existing Project#

Step One: Get the repository URL.

Make sure that it’s appropriate for an ordinary git clone.

Step Two: Open a location and clone using the URL.

  1. Select Location Manager > Location Card

  2. Select Location Window > Clone Project

Step Three: Enter the URL and initiate the clone in the Clone Project modal.

  1. Paste the URL Clone Project > Repository URL

  2. (optional) Alter the default path on disk Clone Project > Path

  3. Select Clone Project > Clone

Success: The project tab will open and the container will start building.

The repository must have a properly formatted .project/spec.yaml file.

It is required to enter the project into the inventory and build the container.

Publish Local Project#

Step One: Connect the Git platform to AI Workbench.

  1. Select the Gear Symbol in the top chrome of an application window to go to the Settings Page

  2. For public GitHub or GitLab, select Integrations > Platform Card

  3. Follow the authentication flow for the selected platform (see self-hosted GitLab here)

Step Two: Open a location and select the project to publish.

  1. Select Locations Manager > Location Card

  2. Select Location Window > Project Card

Step Three: Complete the publishing flow in the Publish Project modal.

  1. Select Project Tab > Publish

  2. Select Publish Project > Git Remote Server

  3. (optional) Select available namespace Publish Project > Namespace

  4. Set visibility Publish Project > Repository Visibility

  5. Select Publish Project > Publish

Success: You will see the Push Complete modal.

You can only publish a project if it has no pending changes to commit.

You will be prompted to commit or discard any pending changes.

Delete Existing Project#

Step One: Open a location and select the project to publish.

  1. Select Locations Manager > Location Card

Step Two: Delete the project using the option dots on the project card.

  1. Select Location Window > Project Card > Option Dots > Delete Project

  2. Select Delete Project > Yes, Delete in the modal

Success: The project card will disappear from the location window.

You need to verify the delete if the project has uncommitted changes.

A modal will appear asking you to verify the consequences of the deletion.