Get started for admins
Get started for admins
An administrator or anyone with admin access to your team's cloud provider account typically sets up Anyscale for a team. 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 Anyscale. If your team is already using Anyscale, ask the admin to invite you to the organization.
1. Create an Anyscale organization
Follow the sign-up process at console.anyscale.com
to create a new organization.
- Enter your email address.
- Verify your email.
- Set a password to sign in.
Anyscale deploys a new organization and a serverless Anyscale cloud (also called an Anyscale-hosted cloud) in your organization.
If your email address is already a user of an Anyscale organization, this flow signs into your existing organization.
Contact Anyscale support if you need to create another Anyscale organization.
When you create an Anyscale organization for your team, you become the organization owner by default. As an organization owner, you can invite users 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. See Introduction to Anyscale clouds.
Anyscale provides a serverless (or Anyscale-hosted) cloud by default. Anyscale recommends using this cloud during initial product evaluation. Configure a self-hosted cloud to explore full product functionality and support production workloads.
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. For detailed requirements, see Configure AWS resources for an Anyscale cloud.
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, see Configure AWS resources for an Anyscale cloud.
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 <cloud-name> --functional-verify workspace,service
Step 1: Configure your Google Cloud account
- Follow the Google Cloud instructions for installing the
gcloud
CLI. - Create a Google Cloud project for Anyscale to launch clusters in.
Confirm you're the owner of the Google Cloud project in which Anyscale operates, by clicking IAM & Admin in the Google Cloud 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, see Configure Google Cloud resources for an Anyscale cloud.
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 <cloud-name> --functional-verify workspace,service
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 Users tab.
Manage roles
You can assign owner and collaborator roles to users. See Roles and permissions.
Admins can also configure SSO for their Anyscale organization.
5. Add more Anyscale clouds
Organization owners can add multiple self-hosted clouds to their Anyscale organization. To create a cloud, click the user icon, select Clouds, then click Create.
➡️ Overview of Anyscale clouds - Learn more about Anyscale clouds and cloud resource configuration options
➡️ Access management - Add users and manage permissions
➡️ Resource management - Track health, performance, and utilization of your workloads
➡️ Usage Dashboard - Track usage of Anyscale Credits across your organization
➡️ Budgets - Set cost budgets at different levels to track organization's usage
➡️ Resource Quotas - Set limits on your organization's resource usage