diff --git a/cli/installation.mdx b/api-reference/permissions-and-authorization.mdx similarity index 97% rename from cli/installation.mdx rename to api-reference/permissions-and-authorization.mdx index 822bba1..bbe8b23 100644 --- a/cli/installation.mdx +++ b/api-reference/permissions-and-authorization.mdx @@ -1,5 +1,5 @@ --- -title: Permissions-and-authorization +title: Permissions and Authorization createdAt: Tue Jan 14 2025 02:09:39 GMT+0000 (Coordinated Universal Time) updatedAt: Tue Apr 29 2025 16:45:10 GMT+0000 (Coordinated Universal Time) --- @@ -68,9 +68,9 @@ The following json would create a user that has access to the specified categori ```text Text { "api": { - "misc": {}, - "user_read":{}, - "instance_read": {}, + "misc": {}, + "user_read":{}, + "instance_read": {}, "instance_write": {}, "billing_read": {}, "billing_write": {} @@ -83,9 +83,9 @@ The following json would create restricted access to only the presented categori ```text Text { "api": { - "misc": {}, - "user_read":{}, - "instance_read": {}, + "misc": {}, + "user_read":{}, + "instance_read": {}, "instance_write": {} } } @@ -105,9 +105,9 @@ The following permissions would allow a user to read the instance logs of instan ```text Text { "api": { - "misc": {}, - "user_read":{}, - "instance_read": {}, + "misc": {}, + "user_read":{}, + "instance_read": {}, "instance_write": {}, "billing_read": { "api.instance.request_logs": { @@ -284,5 +284,4 @@ The following permissions would allow a user to read the instance logs of instan - [Update Team Role](https://docs.vast.ai/api-reference/team/update-team-role) - [Delete Team Role](https://docs.vast.ai/api-reference/team/destroy-team-role) - [Invite Team Member](https://docs.vast.ai/api-reference/team/invite-team-member) -- [Delete Team Member](https://docs.vast.ai/api-reference/team/remove-team-member) - +- [Delete Team Member](https://docs.vast.ai/api-reference/team/remove-team-member) \ No newline at end of file diff --git a/cli/get-started.mdx b/cli/get-started.mdx index 9dc166d..ea00a4e 100644 --- a/cli/get-started.mdx +++ b/cli/get-started.mdx @@ -40,7 +40,7 @@ updatedAt: "Thu Apr 24 2025 19:41:24 GMT+0000 (Coordinated Universal Time)" }) }} /> -We provide a python CLI (open-source) for a convenient interface to the rest API. You can use the --explain option with any CLI command and it will print out the underlying API calls. +We provide a python CLI (open-source) for managing Vast.ai resources from the command line. You can use the --explain option with any CLI command to see the underlying API calls if needed. ## PyPI Install @@ -72,7 +72,7 @@ where the `xxxx...` is a unique api-key (a long hexadecimal number). Note that if the script is named "vast" in this command on the website and your installed script is named "vast.py" you will need to change the name of the script in the command you run. The `set api-key` command saves your api-key in a hidden file in your home directory. Do not share your api-keys with anyone as they authenticate commands from your account. -Your default main key allows full access to all commands without limitations, but you can use the CLI to create additional keys with [fine-grained access restrictions](/cli/installation). +Your default main key allows full access to all commands without limitations. To create restricted keys, use the `create api-key` command (see [CLI commands](/cli/commands#create-api-key)) with the permission JSON structure described in the [permissions documentation](/api-reference/permissions-and-authorization). ## Usage @@ -82,7 +82,7 @@ For the most up to date help, use 'vast.py --help'. You can then get a list of t vastai --help ``` -To see how the API works you can use it to find machines for rent. +Here's how to search for available machines to rent: ```text Text vastai search offers --help diff --git a/docs.json b/docs.json index 385ed3e..dc3e4a8 100644 --- a/docs.json +++ b/docs.json @@ -304,7 +304,6 @@ "icon": "terminal", "pages": [ "cli/get-started", - "cli/installation", "cli/commands" ] } @@ -317,7 +316,8 @@ "group": "API Reference", "icon": "webhook", "pages": [ - "api-reference/introduction" + "api-reference/introduction", + "api-reference/permissions-and-authorization" ] }, { @@ -385,10 +385,6 @@ "source": "/api-reference/overview-and-quickstart", "destination": "/cli/get-started" }, - { - "source": "/api-reference/permissions-and-authorization", - "destination": "/cli/installation" - }, { "source": "/index", "destination": "/documentation/get-started" diff --git a/documentation/get-started/index.mdx b/documentation/get-started/index.mdx index c22a0c4..fff210e 100644 --- a/documentation/get-started/index.mdx +++ b/documentation/get-started/index.mdx @@ -32,17 +32,54 @@ description: "Step-by-step Vast.ai developer documentation with examples, guides [Vast.ai](https://www.vast.ai) is a marketplace for affordable GPU cloud computing. We make it easy for anyone to: -- Spin up GPU instances in seconds at competitive [prices](https://vast.ai/pricing). +- Spin up GPU instances in seconds at competitive [prices](/documentation/instances/pricing). - Scale across thousands of GPUs from [Secure Cloud datacenters](https://cloud.vast.ai/create/?instanceDiskSizeMin=16&instanceDurationMin=259200&instanceType=onDemand&isAvxSupported=false&isHostSecure=true&isMachineIpStatic=false&isOfferAvailable=true&isOfferCompatible=true&isOfferVerified=true&isQueryInverted=false&machineReliabilityMin=0.9&sorts=score-desc) or community providers. -- Launch [prebuilt](https://cloud.vast.ai/templates/) or [custom templates](/documentation/templates/creating-templates) with one click. +- Launch [prebuilt](/documentation/templates/introduction) or [custom templates](/documentation/templates/creating-templates) with one click. ## How It Works -Vast.ai connects compute providers — from hobbyists to Tier-4 datacenters — with users who need GPUs. Our search engine lets you filter by GPU type, RAM, CPU, bandwidth, and more, while providers retain full control over pricing and contracts. +Vast.ai connects compute providers — from hobbyists to Tier-4 datacenters — with users who need GPUs. Our [search engine](/documentation/instances/choosing/find-and-rent) lets you filter by GPU type, RAM, CPU, bandwidth, and more, while providers retain full control over [pricing](/documentation/instances/pricing) and [contracts](/documentation/instances/choosing/instance-types). -## Getting started +## Get Started + + + Launch your first GPU instance in minutes with our step-by-step guide + + +## GPU Instances + + + + Learn about GPU instances, containers, and compute options + + + Understand marketplace pricing and cost optimization strategies + + + Search and rent the perfect GPU for your workload + + + Access instances via SSH, Jupyter, or web portal + + + +## Common Tasks + + + + Learn about pre-built environments and customization + + + Transfer files to and from your instances + + + Save up to 50% with long-term commitments + + + Start, stop, and monitor your GPU rentals + + -Ready to get started? Follow our [Quick Start Guide](/documentation/get-started/quickstart) to launch your first instance. ## Mission @@ -52,4 +89,6 @@ Vast.ai's mission is to align and democratize AI. Machine learning is progressin - **Support Chat** → Available 24/7 in the bottom-right corner of our [console](https://cloud.vast.ai). - **Email** → [contact@vast.ai](mailto:contact@vast.ai) +- **Discord** → Join our [community](https://discord.gg/vast) for help and discussions. +- **Documentation** → Browse our [instances guide](/documentation/instances/overview), [templates documentation](/documentation/templates/introduction), or [troubleshooting tips](/documentation/reference/troubleshooting). diff --git a/documentation/get-started/quickstart.mdx b/documentation/get-started/quickstart.mdx index 9c6c89b..6ab02bf 100644 --- a/documentation/get-started/quickstart.mdx +++ b/documentation/get-started/quickstart.mdx @@ -75,7 +75,8 @@ This Quickstart will guide you through setting up your Vast.ai account and runni - Create an account on [vast.ai.](https://cloud.vast.ai/) - Verify your email address. -- Go to [**Billing**](https://cloud.vast.ai/billing/) → **Add Credit** and top up using credit card, Coinbase, or Crypto.com. +- Go to [**Billing**](/documentation/reference/billing) → **Add Credit** and top up using [credit card, Coinbase, or Crypto.com](/documentation/reference/billing#payment-methods). +- Learn about [auto-billing](/documentation/reference/billing#auto-debit) to avoid interruptions. ![Billing](/images/guides-overview-quick-start.webp) @@ -85,16 +86,16 @@ This Quickstart will guide you through setting up your Vast.ai account and runni ![](/images/guides-overview-quick-start-2.webp) - Before you can **rent a machine **or **create a team**, you must verify your email address. After signing up, check your inbox (and spam folder) for the verification email and click the link inside. You can resend the verification email anytime from **Settings → Resend Verification Email.** + Before you can **rent a machine** or **create a team**, you must [verify your email address](/documentation/reference/account-settings#email-verification). After signing up, check your inbox (and spam folder) for the verification email and click the link inside. You can resend the verification email anytime from [**Settings**](/documentation/reference/account-settings) → Resend Verification Email. Learn more about [teams](/documentation/teams/teams-overview) and [instance management](/documentation/instances/manage-instances). ### 2**. Prepare to Connect** -- **For SSH access**: generate an [SSH key pair](/documentation/instances/sshscp) and upload your **public key** in [Keys page](https://cloud.vast.ai/manage-keys/). +- **For SSH access**: generate an [SSH key pair](/documentation/instances/connect/ssh#generating-ssh-keys) following our [complete SSH guide](/documentation/instances/connect/ssh) and upload your **public key** in [Keys page](https://cloud.vast.ai/manage-keys/) or via [account settings](/documentation/reference/keys). ![Keys](/images/guides-overview-quick-start-3.webp) -- **For Jupyter access**: download and install the provided [TSL certificate](/documentation/instances/jupyter#1SmCz) (needed for secure browser access). +- **For Jupyter access**: download and install the provided [TSL certificate](/documentation/instances/connect/jupyter#certificate-installation) following our [Jupyter setup guide](/documentation/instances/connect/jupyter) (needed for secure browser access). If you don’t install the provided browser certificate: @@ -105,19 +106,19 @@ This Quickstart will guide you through setting up your Vast.ai account and runni Installing the certificate once removes the warning permanently. - ### 3**. Pick a **[**Template**](/documentation/instances/templates)** & Find a Machine** + ### 3. Pick a [**Template**](/documentation/templates/introduction) & Find a Machine - - Browse [**Templates**](https://cloud.vast.ai/templates/) for pre-built setups (e.g., [PyTorch](/pytorch), TensorFlow, ComfyUI). -- Go to [**Search**](https://cloud.vast.ai/create/) and filter by GPU type, count, RAM, CPU, network speed, and price. -- **Disk Space is Permanent. **The disk size you choose when creating an instance cannot be changed later. If you run out of space, you’ll need to create a new instance with a larger disk. Tip: Allocate a bit more than you think you need to avoid interruptions. -- Click **Rent** when you find a match. -- Wait for the instance to start—cached images launch quickly, fresh pulls may take 10–60 minutes. -- Click **Open** button to access your instance. + - Browse [**Templates**](https://cloud.vast.ai/templates/) for pre-built setups (e.g., [PyTorch](/pytorch), TensorFlow, ComfyUI) or [create custom templates](/documentation/templates/creating-templates). +- Go to [**Search**](https://cloud.vast.ai/create/) and filter by GPU type, count, RAM, CPU, network speed, and price. Learn about [search filters](/documentation/instances/choosing/overview#search-filters) and [instance types](/documentation/instances/choosing/instance-types). +- **Disk Space is Permanent.** The disk size you choose when creating an instance cannot be changed later. If you run out of space, you'll need to create a new instance with a larger disk. Learn about [storage types](/documentation/instances/storage/types) and [volumes](/documentation/instances/storage/volumes). Tip: Allocate a bit more than you think you need to avoid interruptions. +- Click **Rent** when you find a match. Consider [reserved instances](/documentation/instances/choosing/reserved-instances) for 50% savings on long-term projects. +- Wait for the instance to start—cached images launch quickly, fresh pulls may take 10–60 minutes. Check [instance status](/documentation/instances/manage-instances#status) for progress. +- Click **Open** button to access your instance via your chosen [connection method](/documentation/instances/connect/overview). -### **4. **[**Manage or End Your Instance**](/documentation/instances/managing-instances) +### **4. [Manage or End Your Instance](/documentation/instances/manage-instances)** -- Use **Stop** to pause GPU billing (storage still accrues charges). -- Use **Delete** when finished to stop *all* charges. +- Use **Stop** to pause GPU billing ([storage still accrues charges](/documentation/instances/storage/types#costs)). Learn about the [instance lifecycle](/documentation/instances/manage-instances#lifecycle). +- Use **Delete** when finished to stop *all* charges. See [data movement](/documentation/instances/storage/data-movement) if you need to save data first. ![Manage or End Your Instance](/images/guides-overview-quick-start-4.webp) @@ -129,8 +130,22 @@ The minimum deposit amount on Vast.ai is $5. ### What happens when my balance runs out? Can I avoid interruptions? -When your balance reaches zero, your running instances will automatically stop. To avoid this, you can enable **auto-billing **on the Billing page. Set an auto-charge threshold higher than your average daily spend, so your card is automatically charged when your balance falls below that amount. We also recommend setting a **low-balance email alert **at a slightly lower threshold to notify you if the auto-charge fails for any reason. +When your balance reaches zero, your running instances will automatically stop. To avoid this, you can enable [**auto-billing**](/documentation/reference/billing#auto-debit) on the [Billing page](/documentation/reference/billing). Set an auto-charge threshold higher than your average daily spend, so your card is automatically charged when your balance falls below that amount. We also recommend setting a [**low-balance email alert**](/documentation/reference/account-settings#notifications) at a slightly lower threshold to notify you if the auto-charge fails for any reason. Learn more about [billing management](/documentation/reference/billing) and [cost optimization](/documentation/instances/pricing). ### How can I customize a template? -You can create a new template from scratch, or you can edit an existing template. You can find a guide [here](/documentation/instances/templates#LrOME). +You can create a new template from scratch, or you can edit an existing template. You can find a guide [here](/documentation/templates/creating-templates). See also [template settings](/documentation/templates/template-settings) and [advanced setup](/documentation/templates/advanced-setup) for more customization options. Learn about [managing templates](/documentation/templates/managing-templates) for organizing your template library. + +## Next Steps + + + + Complete guide to GPU instances, types, and management + + + Marketplace pricing, instance types, and saving strategies + + + Pre-built environments, customization, and Docker setup + + diff --git a/documentation/instances/choosing/overview.mdx b/documentation/instances/choosing/overview.mdx index 29e27c7..67b3f9b 100644 --- a/documentation/instances/choosing/overview.mdx +++ b/documentation/instances/choosing/overview.mdx @@ -42,10 +42,20 @@ For the fastest path to a running instance: ## What's in This Section -- **[Instance Types](/documentation/instances/choosing/instance-types)** - Understand on-demand vs interruptible vs reserved options -- **[Choosing a Template](/documentation/instances/choosing/templates)** - Understanding and selecting templates -- **[Finding & Renting](/documentation/instances/choosing/find-and-rent)** - Search, filter, configure, and rent -- **[Reserved Instances](/documentation/instances/choosing/reserved-instances)** - Save up to 50% with prepayment + + + Understand on-demand vs interruptible vs reserved options + + + Understanding and selecting templates for your needs + + + Search, filter, configure, and rent GPU instances + + + Save up to 50% with prepayment options + + ## Common Questions diff --git a/documentation/instances/connect/overview.mdx b/documentation/instances/connect/overview.mdx index 235a3f8..a82a3a9 100644 --- a/documentation/instances/connect/overview.mdx +++ b/documentation/instances/connect/overview.mdx @@ -3,7 +3,31 @@ title: Overview description: Learn about Vast.ai connection methods—SSH, Jupyter, and Entrypoint—and how each controls instance access and workflow. --- -We currently support 3 launch modes: entrypoint, ssh, and jupyter. +Choose how to access your GPU instances based on your workflow needs. + +## Connection Methods + + + + Terminal access with port forwarding and VS Code support + + + Web-based notebooks for interactive development + + + +**Note:** For automated execution without interactive access, see [Entrypoint](#entrypoint) below. + +## Additional Options + + + + Web access to any application via secure tunnels + + + Configure exposed ports and bandwidth settings + + ## Entrypoint diff --git a/documentation/instances/manage-instances.mdx b/documentation/instances/manage-instances.mdx index 793a666..d5b0ae5 100644 --- a/documentation/instances/manage-instances.mdx +++ b/documentation/instances/manage-instances.mdx @@ -181,9 +181,17 @@ This means geolocation couldn't determine the state. It's not an indication of r ### Can I run VMs or bare metal? Currently only Docker containers are supported. VM and bare-metal options planned for future. -## Related Documentation +## Next Steps + + + + Transfer files to and from your instances + + + Save up to 50% with long-term commitments + + + Access web services running in your instances + + -- [Instance Types](/documentation/instances/instance-types) - On-demand vs Reserved vs Interruptible -- [Storage Options](/documentation/instances/storage/types) - Managing disk space -- [Connection Methods](/documentation/instances/connect/overview) - SSH, Jupyter, and more -- [Templates](/documentation/instances/templates) - Instance configuration \ No newline at end of file diff --git a/documentation/instances/overview.mdx b/documentation/instances/overview.mdx index a750b4e..99c331c 100644 --- a/documentation/instances/overview.mdx +++ b/documentation/instances/overview.mdx @@ -23,39 +23,39 @@ New to Vast.ai? Start with the [Quickstart Guide](/documentation/get-started/qui - + Market-driven rates for GPU, storage, and bandwidth - + On-demand, Reserved, and Interruptible options - + Pre-configured environments or custom Docker images - + Find and rent GPUs by model, location, and price - + SSH, Jupyter, and Entrypoint connection methods - + Start, stop, connect, and monitor your instances - + Container storage and persistent volumes - + Move data between instances, cloud, and local storage - + Sync with Google Drive, S3, and other cloud providers @@ -67,7 +67,7 @@ Sync with Google Drive, S3, and other cloud providers [Start with the Quickstart Guide →](/documentation/get-started/quickstart) for a complete walkthrough **Ready to rent?** -[Understand pricing →](/documentation/instances/pricing) | [Choose a template →](/documentation/instances/templates) | [Find GPUs →](/documentation/instances/choose-an-instance) +[Understand pricing →](/documentation/instances/pricing) | [Choose a template →](/documentation/templates/introduction) | [Find GPUs →](/documentation/instances/choosing/find-and-rent) **Need help connecting?** -[Connection methods →](/documentation/instances/connect/overview) | [SSH guide →](/documentation/instances/connect/ssh) +[Connection methods →](/documentation/instances/connect/overview) | [SSH guide →](/documentation/instances/connect/ssh) | [Jupyter setup →](/documentation/instances/connect/jupyter) diff --git a/documentation/instances/storage/cloud-sync.mdx b/documentation/instances/storage/cloud-sync.mdx index 3bbbeaa..4d549be 100644 --- a/documentation/instances/storage/cloud-sync.mdx +++ b/documentation/instances/storage/cloud-sync.mdx @@ -5,6 +5,15 @@ createdAt: Mon Jan 13 2025 21:20:40 GMT+0000 (Coordinated Universal Time) updatedAt: Mon Jun 16 2025 16:05:17 GMT+0000 (Coordinated Universal Time) --- + +This feature appears as: +- **"Cloud Copy"** button in the web interface +- **`vastai cloud copy`** command in the CLI +- **"Cloud Sync"** in the documentation navigation + +All refer to the same feature for syncing data with cloud storage providers. + + **WARNING**
Cloud Sync is only supported on Docker-based instances. Cloud Sync is not currently supported on VM-based instances (instances created using a vastai/kvm repository template) diff --git a/documentation/instances/storage/data-movement.mdx b/documentation/instances/storage/data-movement.mdx index e937143..ec4a0f8 100644 --- a/documentation/instances/storage/data-movement.mdx +++ b/documentation/instances/storage/data-movement.mdx @@ -1,6 +1,6 @@ --- title: "Data Movement" -description: "Learn how to move data on Vast.ai using cloud sync, instance-to-instance transfers, CLI copy, VM migration, scp, and other efficient methods." +description: "Learn how to move data on Vast.ai using Cloud Sync, instance-to-instance transfers, CLI copy, VM migration, scp, and other efficient methods." createdAt: "Mon Jan 13 2025 21:20:40 GMT+0000 (Coordinated Universal Time)" updatedAt: "Fri Aug 15 2025 00:57:59 GMT+0000 (Coordinated Universal Time)" --- @@ -11,7 +11,7 @@ For docker based instances: 1. Instance\<-\>Instance and Instance\<-\>Local copy using the `vastai copy` CLI command 2. Instance\<-\>Instance copy in the GUI instance control panel or `vastai copy` CLI command -3. Instance\<-\>Cloud copy using the GUI instance control panel or `vastai cloud copy` CLI command +3. Cloud Sync using the GUI instance control panel or `vastai cloud copy` CLI command For VM instances: @@ -21,9 +21,9 @@ These are in addition to standard ssh based copy protocols such as scp or sftp w The 3 built-in methods discussed here are unique in that they offer ways to copy data to/from a _stopped instance_, with some constraints. Copying data between instances accrues internet bandwidth usage charges (with prices varying across providers), unless the copy is between two instances on the same machine or local network, in which case there is no bandwidth charge. -## Instance\<-\>Cloud copy (cloud sync) +## Cloud Sync -The cloud sync feature allows you to copy data to/from instance local storage and several cloud storage providers (S3, gdrive, backblaze, etc) - even when the instance is stopped. +The Cloud Sync feature allows you to copy data to/from instance local storage and several cloud storage providers (S3, gdrive, backblaze, etc) - even when the instance is stopped. ### Using the GUI @@ -123,17 +123,9 @@ This will transfer the contents of 1241241 to 1241245. For VM-based instances, the destination instance must be stopped during the transfer. - - **WARNING**\ - - You should not copy to /root or / as a destination directory, as this can mess - up the permissions on your instance ssh folder, breaking future copy - operations (as they use ssh authentication). - - ### Performance -If your data is already stored in the cloud (S3, gdrive, etc) then you should naturally use the appropriate linux CLI or commands to download and upload data directly, or you could use the [cloud sync](/documentation/instances/cloud-sync) feature. +If your data is already stored in the cloud (S3, gdrive, etc) then you should naturally use the appropriate linux CLI or commands to download and upload data directly, or you could use the [Cloud Sync](/documentation/instances/cloud-sync) feature. This generally will be one the fastest methods for moving large quantities of data, as it can fully saturate a large number of download links. If you are using multiple instances with significant data movement requirements you will want to use high bandwidth cloud storage to avoid any single machine bottlenecks. @@ -180,7 +172,7 @@ scp -P 7417 myfile.tar.gz root@52.204.230.7:/mydir ### How do you recommend I move data from an existing instance? -The [cloud sync feature](/documentation/instances/cloud-sync) will allow you to move data to and from instances easily. +The [Cloud Sync feature](/documentation/instances/cloud-sync) will allow you to move data to and from instances easily. The main benefit is that you can move data around while the machine is inactive. Currently, we support Google Drive, S3, Dropbox, and Backblaze diff --git a/documentation/instances/storage/types.mdx b/documentation/instances/storage/types.mdx index b59fff9..ef8bdae 100644 --- a/documentation/instances/storage/types.mdx +++ b/documentation/instances/storage/types.mdx @@ -7,8 +7,8 @@ description: Understand the different storage options available on Vast.ai insta Vast.ai provides two main types of storage for your instances: -1. **Container Storage** - Temporary storage within the Docker container -2. **Volumes** - Persistent local storage that can be attached to instances +1. **Container Storage** - Temporary storage within Docker container that's deleted with instance +2. **Volumes** - Persistent local storage that survives instance deletion (see [Volumes guide](/documentation/instances/storage/volumes)) ## Container Storage @@ -111,7 +111,15 @@ No, container storage size is fixed at creation. You can: ## Next Steps -- [Volumes](/documentation/instances/storage/volumes) - Create and manage persistent volumes -- [Data Movement](/documentation/instances/storage/data-movement) - Transfer files between instances -- [Cloud Sync](/documentation/instances/storage/cloud-sync) - Connect to cloud storage providers -- [Cloud Backups](/documentation/instances/storage/cloud-backups) - Automate backup strategies \ No newline at end of file + + + Create and manage persistent storage volumes + + + Transfer files between instances and local machines + + + Connect to Google Drive, S3, and other cloud storage + + + diff --git a/documentation/teams/teams-quickstart.mdx b/documentation/teams/teams-quickstart.mdx index da2f1ec..6b80452 100644 --- a/documentation/teams/teams-quickstart.mdx +++ b/documentation/teams/teams-quickstart.mdx @@ -88,7 +88,7 @@ To create a new role with your desired permissions, navigate to the **Roles** ta ![](/images/teams-quickstart-5.webp) -For more information on Permission Groups and what they allow access to, [click here](/cli/installation). +For more information on Permission Groups and what they allow access to, [click here](/api-reference/permissions-and-authorization). ## Inviting Team Members diff --git a/documentation/teams/teams-roles.mdx b/documentation/teams/teams-roles.mdx index e7703b9..bca7699 100644 --- a/documentation/teams/teams-roles.mdx +++ b/documentation/teams/teams-roles.mdx @@ -34,7 +34,7 @@ Team roles in Vast.ai's platform are designed to streamline collaboration and en - _Member_: Has ability to view, create, and interact with instances, but no access to billing info, team management, autoscaler, machines, etc. 2. **Custom Roles**: Custom roles allow team managers to create roles with custom, tailored permissions via permission groups. This feature is particularly useful for teams with unique workflow requirements or specific security protocols. -For more information on Permission Groups and what they allow access to, [click here](/cli/installation). +For more information on Permission Groups and what they allow access to, [click here](/api-reference/permissions-and-authorization). ### Creating Custom Roles @@ -90,7 +90,7 @@ An example of a permissions json would look like this: In order to create a granular team roles you must either use the CLI or the API. In the above example, the only API under team_read that the user would have access to would be viewing the list of team members. -For more information on Permissions [click here](/cli/installation). +For more information on Permissions [click here](/api-reference/permissions-and-authorization). ### Best Practices for Using Team Roles diff --git a/documentation/templates/introduction.mdx b/documentation/templates/introduction.mdx index b9fbcf9..e0cf71b 100644 --- a/documentation/templates/introduction.mdx +++ b/documentation/templates/introduction.mdx @@ -49,6 +49,20 @@ The **Instance Portal** provides easy access links to services running in your i Full documentation for the Instance Portal is available in our [Instance Portal guide](/documentation/instances/instance-portal). +## Instance Setup + +### Docker Execution Environment + +The standard and most common way to run instances on Vast.ai is using Docker containers. When you select a template, it launches a Docker container with your specified image and configuration. + +**Docker templates are ideal for:** +- Running pre-configured ML frameworks (PyTorch, TensorFlow, etc.) +- Deploying web services and APIs +- Development environments with Jupyter notebooks +- Custom applications with specific dependencies + +All of our recommended templates use Docker containers, providing isolation, reproducibility, and easy deployment across different host machines. + ### Virtual Machine Templates In addition to standard Docker container templates, we also offer Virtual Machine (VM) templates. These launch a full virtual machine environment rather than a docker container. @@ -62,14 +76,20 @@ In addition to standard Docker container templates, we also offer Virtual Machin You can edit VM templates just like regular templates, but you should not change the docker image field. Only the images we distribute from `docker.io/vastai/kvm` will work. -### Customizing Recommended Templates +## Customizing Recommended Templates To learn how to customize our recommended templates with provisioning scripts or build your own custom Docker images, see our [Advanced Setup](/documentation/templates/advanced-setup) guide. ## Next Steps -Ready to start using templates? Here's what you can do: - -- **Try it now** - Follow our [Quick Start](/documentation/templates/quickstart) guide to run your first template in minutes -- **Create your own** - See [Creating Templates](/documentation/templates/creating-templates) to build a custom template -- **Learn more** - Explore [Advanced Setup](/documentation/templates/advanced-setup) for provisioning scripts and custom Docker images + + + Run your first template in minutes + + + Build custom templates for your needs + + + Provisioning scripts and Docker customization + +