IBM Cloud Docs
Creating a project

Creating a project

In a projectA collection of artifacts that define and manage resources and Infrastructure as Code deployments. , you can add deployable architectures from the catalog and customize their configuration. Deploying a configuration from a project groups resources based on the configuration that you deployed. 

You can create a project by going to the Navigation menu icon Navigation Menu icon and selecting Projects or from a deployable architecture in the catalog. Projects can also be created by using the Project API.

Before you begin

Resources are created in the project account for the user. You must have permission to create a project and permission to create the project tooling resources within the account. Make sure that you have the following access:

  • The Editor role on the IBM Cloud Projects service.
  • The Editor and Manager role on the IBM Cloud® Schematics service
  • The Viewer role on the resource group for the project

For more information about access and permissions, see Assigning users access to projects.

Adding users to a project 

Project access is controlled by IBM Cloud Identity and Access Management (IAM). You add users to a project by granting the Reader role or higher on the project instance. For more information on assigning access to projects, see Assigning users access to projects.

Adding deployable architecture

Deployable architectures that you add to a project are represented as configurations in the project UI. After you add a deployable architecture to a project, you can edit your configuration before you deploy it. There are a couple of ways to add a deployable architecture to your project.

To add a deployable architecture to your project from the project dashboard, complete the following steps:

  1. From the project dashboard, select the Configurations tab.
  2. Click Create.
  3. Select a deployable architecture from the catalog.
  4. Click Review deployment options.
  5. Click Add to project.

You can also add a deployable architecture to a project directly from the catalog:

  1. Go to the IBM Cloud catalog.
  2. Select the deployable architecture.
  3. Click Review deployment options.
  4. Click Add to project.
  5. You can create a new project or add to an existing project.
  6. Enter the required details for the deployable architecture.
  7. Click Add.

Check out the steps on how to configure and deploy a deployable architecture when you're ready to deploy resources from a deployable architecture from a project.

Exporting the project JSON

As a user that’s working with projects, you can export the project JSON to manually manage the project in your own public or private repository. For example, you might want to push updates to the JSON by calling the project API using CLI commands or by using your own CICD tools. You might also export the JSON as a way to backup the project information outside of the IBM Cloud Projects service.

To export the project JSON, complete the following steps:

  1. In the IBM Cloud console, click the Navigation menu icon Navigation Menu icon > Projects.
  2. From the project dashbaord, click the Actions icon Actions icon > Export JSON
  3. From the modal, click Export.

For more information about the project JSON, see Project JSON.