Project Management

caution

The Ash Console is currently in beta and not production-ready. It is under active development and subject to breaking changes.

The first step for an Ash Console user is to create a project: a logical set of resources that are deployed in cloud regions.

List projects

Using the Ash Console

To list projects, navigate to the Ash Console home page:

Using the Ash CLI

tip

The Ash CLI displays information in a table format by default. To get a more detailed output (or for scripting), use the --json flag.

To list projects you have access to, run:

Command

ash console project list

Output

+--------------+------------+---------+---------------+-----------+------------+
| Project name | Project ID | Network | Cloud regions | Resources | Created at |
+==============+============+=========+===============+===========+============+
+--------------+------------+---------+---------------+-----------+------------+

Using the Ash Console API

tip

See Authentication for more information on how to get an access token.

The project API endpoint is /projects.:

Command

curl https://api.console.ash.center/projects \
  -H "Authorization: Bearer ${access_token}"

Output

[]

Create a project

Using the Ash Console

To create a project, navigate to the Ash Console home page and click on the Create a project button:

Using the Ash CLI

To create a new project, use the create project command and provide the required project properties as JSON:

Command

ash console project create '{name: my-devnet-project, network: local}'

Output

Project created successfully!
+-------------------+-------------+---------+---------------+-----------+------------------+
| Project name      | Project ID  | Network | Cloud regions | Resources | Created at       |
+===================+=============+=========+===============+===========+==================+
| my-devnet-project | d11f...453e | Local   |               |           | 2024-04-04T15:04 |
+-------------------+-------------+---------+---------------+-----------+------------------+

Switched to project 'my-devnet-project' (d11ff0c8-8f09-4991-9832-bd79df9b453e)!

Using the Ash Console API

To create a new project, you have to send a POST request with the required project properties as JSON:

Command

curl -X POST https://api.console.ash.center/projects \
  -H "Authorization: Bearer ${access_token}" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-devnet-project", "network": "local"}'

Output

{
  "id": "5064c6a6-1542-43d9-b8bb-9ce9502347ff", 
  "ownerId": "4d4dee2d-e943-432c-91ee-678975615caa", 
  "name": "my-devnet-project", 
  "network": "local", 
  "sharedResourceConfig": {"avalancheNodeConfig": {}}, 
  "created": "2024-04-04T15:15:10.022849", 
  "cloudRegionsIds": {}, 
  "resourcesIds": {}
}

Select the current project (CLI only)

Using the Ash CLI

The Ash CLI stores the current project in a configuration file. This project will be used by default for all the commands that require a project (e.g. console region ...).

To show the current project, run:

Command

ash console project show

Output

Current project: 'my-devnet-project' (5064c6a6-1542-43d9-b8bb-9ce9502347ff)

You can switch between projects:

Command

ash console project select my-devnet-project

Output

Switched to project 'my-devnet-project' (5064c6a6-1542-43d9-b8bb-9ce9502347ff)!

Using the Ash Console API

This feature does not exist in the Ash Console API.

Update a project

tip

You can also provide the project name instead of its ID.

Using the Ash Console

To update a project's configuration, navigate to the Project overview page and click on the Project Settings button:

Edit the configuration as needed and click on the Update button.

Using the Ash CLI

The only propery that can be updated is the project name:

Command

ash console project update 5064c6a6-1542-43d9-b8bb-9ce9502347ff '{name: my-devnet-project-updated}'

Output

Project updated successfully!
+---------------------------+-------------+---------+---------------+-----------+------------------+
| Project name              | Project ID  | Network | Cloud regions | Resources | Created at       |
+===========================+=============+=========+===============+===========+==================+
| my-devnet-project-updated | 5064...47ff | Local   |               |           | 2024-04-04T15:15 |
+---------------------------+-------------+---------+---------------+-----------+------------------+

Using the Ash Console API

The only propery that can be updated is the project name by sending a PATCH to the projects/${projectId} endpoint:

Command

curl -X PATCH https://api.console.ash.center/projects/5064c6a6-1542-43d9-b8bb-9ce9502347ff \
  -H "Authorization: Bearer ${access_token}" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-devnet-project-updated"}'

Output

{
  "id": "5064c6a6-1542-43d9-b8bb-9ce9502347ff", 
  "ownerId": "4d4dee2d-e943-432c-91ee-678975615caa", 
  "name": "my-devnet-project-updated", 
  "network": "local", 
  "sharedResourceConfig": {"avalancheNodeConfig": {}}, 
  "created": "2024-04-04T15:15:10.022849", 
  "cloudRegionsIds": {}, 
  "resourcesIds": {}
}

Delete a project

caution

Deleting a project will recursively delete all the cloud regions and resources that belong to it!

Using the Ash Console

To delete a project, navigate to the Project overview page and click on the Project Settings button:

You can delete the project by clicking on the Delete button.

Using the Ash CLI

The CLI will ask for confirmation before deleting the project. To skip the confirmation, use the `--yes` flag.

Command

ash console project delete my-devnet-project-updated

Output

> Are you sure you want to delete this project? Yes
Project deleted successfully!

Using the Ash Console API

Command

curl -X DELETE https://api.console.ash.center/projects/my-devnet-project-updated \
  -H "Authorization: Bearer ${access_token}"

Output

{
  "id": "5064c6a6-1542-43d9-b8bb-9ce9502347ff", 
  "ownerId": "4d4dee2d-e943-432c-91ee-678975615caa", 
  "name": "my-devnet-project-updated", 
  "network": "local", 
  "sharedResourceConfig": {"avalancheNodeConfig": {}}, 
  "created": "2024-04-04T15:15:10.022849", 
  "cloudRegionsIds": {}, 
  "resourcesIds": {}
}