Projects
Workspaces, Jobs, and Services are created without a Project, by default. Resources without a Project are accessible to the entire Organization.
When the number of resources becomes large, it can be useful to organize them in Projects. Creating additional Projects makes it possible to group Workspaces, Jobs, and Services. Besides organizing resources, Projects can be used to restrict access to only users that have been given permission to access them. The following diagram illustrates how Projects work:
Creating and managing Projects
You can create a Project from the Web UI by going to the "Projects" page from the navigation menu. If you select "Blank project," you'll be able to name your Project and specify whether the Project should be private or public. Projects can also be created from the CLI with anyscale project create
.
If you make the Project private, only you will be able to access it initially. You can search for the Project in this same page, and from the Project page click on "Share" to add and remove collaborators, or share it with the entire organization. Collaborators can be owners (can create, view and delete resources) or read-only (can view resources but not create them).
Using Projects
A Project id or Project name can be specified for all CLI commands that use a Project (for example, when starting a Job or Service). Alternatively, the environment variable ANYSCALE_PROJECT_NAME
can be set to use a Project for CLI commands, instead of specifying in the command itself. If a Project is not specified for any command that uses it, no Project will be used.