Get started for admins
Setting up Anyscale for a team is typically done by an administrator or anyone who has admin access to your team's cloud provider account. You need to:
- Create an Anyscale organization
- Set up the Anyscale cloud
- Enter billing information
After you complete these steps, you can invite team members to the Anyscale. If your team is already using Anyscale, join that existing organization with the instructions in Get started.
1. Create an Anyscale organization
- Sign up for an Anyscale account at
console.anyscale.com
. - Verify your email, set a password, and create your account.
- Anyscale creates an organization for your account.
When you create an Anyscale organization for your team, you become the organization owner by default. As an organization owner, you can invite collaborators to join the organization. Organization owners are also responsible for providing a payment method.
2. Set up the environment
To programmatically interact with Anyscale outside the console and from your terminal, you need to install the Anyscale CLI.
- AWS
- GCP
Step 1: Install the Anyscale CLI and Python client package
pip install -U anyscale
Step 2: Authenticate the CLI
To access Anyscale's services, you need to obtain a token that verifies
your identity. Running the following command fetches and updates the
token in the local credential file ~/.anyscale/credentials.json
:
anyscale login
You can also manually generate your API token through the
console, and set it in the
ANYSCALE_CLI_TOKEN
environment variable.
Step 1: Install the Anyscale CLI and Python client package
pip install -U "anyscale[gcp]"
Step 2: Authenticate the CLI
To access Anyscale's services, you need to obtain a token that verifies your
identity. Running the following command fetches and updates the token in the
local credential file ~/.anyscale/credentials.json
:
anyscale login
You can also manually generate your API token through the console, and set it in the ANYSCALE_CLI_TOKEN
environment variable.
3. Create an Anyscale cloud
An Anyscale cloud abstracts the resources and infrastructure necessary for managing Anyscale clusters. You have 2 deployment options:
-
Deploy in Anyscale's cloud (Anyscale-hosted): This option is ideal for users who want to get started without having a cloud provider account of their own. You can go directly to Step 4.
-
Bring your own cloud (Self-hosted): This option is ideal for users who want to use their own compute hosted in AWS or GCP, on-prem machines, or in Kubernetes.
Set up a self-hosted Anyscale cloud
- AWS
- GCP
Step 1: Configure AWS credentials
Ensure you have set up AWS credentials on the local machine. See the AWS configuration guide for initial setup instructions. Run this command to quickly set and view the credentials:
aws configure
- Confirm the credentials can launch EC2 instances in the desired AWS region.
- Check permissions for managing VPC, subnets, Security Group, IAM, S3, and EFS. Find detailed requirements in the Anyscale AWS management guide.
Step 2: Create your Anyscale cloud
To set up your Anyscale cloud with default settings, run the following command:
anyscale cloud setup
For troubleshooting and advanced customization, follow the complete Anyscale Cloud on AWS guide.
Step 3: Verify the Anyscale cloud
To verify that the Anyscale cloud satisfies the minimum resource requirements, run the following command to launch a test workspace and service:
anyscale cloud verify --name NAME_OF_CLOUD --functional-verify workspace,service
Step 1: Configure your GCP Account
- Follow the Google Cloud instructions for installing the
gcloud
CLI. - Create a GCP project for Anyscale to launch clusters in.
- Confirm you're the owner of the GCP project in which Anyscale operates, by clicking IAM & Admin in the Google Cloud Platform Console.
Step 2: Create the Anyscale cloud
To set up the Anyscale cloud with default settings, run the following command:
anyscale cloud setup
For troubleshooting and advanced customization, follow the complete Anyscale clouds on GCP guide.
Step 3: Verify the Anyscale cloud
To verify that the Anyscale cloud satisfies the minimum resource requirements, run the following command to launch a test Workspace and Service:
anyscale cloud verify --name NAME_OF_CLOUD --functional-verify workspace,service
Learn more about cloud deployment on Anyscale here
4. Invite users to your organization
You can now invite your team members to join your Anyscale organization. To add team members, click the user icon, select Organization settings, then click the Members tab.
Manage roles
You can assign owner and collaborator roles to team members. See Permissions for more details on the permissions and access control structure.
Admins can also configure SSO for their Anyscale organization.
5. Add more Anyscale clouds
Organization owners can create and add one Anyscale hosted cloud and multiple self-hosted clouds to their Anyscale organization. To create a cloud, click on the user icon, select Clouds, then click on Create.
➡️ Overview of Anyscale clouds - Learn more about Anyscale clouds and deployment options ➡️ Access management - Add users and manage permissions ➡️ Resource management - Track health, performance and utilization of your workloads ➡️ Budgets - Set cost budgets at different levels to track organization's usage ➡️ Resource Quotas - Set limits on your organization's resource usage