Documentation

Sign In

Organizations

Organizations are the central unit in Compute Share that group together members, machines, and jobs.

Overview

An organization represents a team or company sharing computational resources. All machines and jobs belong to an organization, and members collaborate within this shared workspace.

Organization Structure

  • Owner - Creator with full administrative rights
  • Admins - Manage members, approve machines, view all data
  • Members - Submit jobs, register machines, view own data

Creating an Organization

First-time Setup

When signing in for the first time:

  1. Complete the account setup flow
  2. Choose Create New Organization
  3. Enter organization details:
    • Organization name
    • Description (optional)

Organization Settings

Configure from the Settings page:

  • Organization name and description
  • Member invitation settings
  • Machine approval requirements
  • Resource allocation policies

Managing Members

Inviting Members

Admins and owners can invite new members:

  1. Go to Members
  2. Click Invite Member
  3. Share the invitation code or link

Members can join by:

  • Using the invitation link
  • Entering the invite code during account setup

Member Roles

Assign appropriate roles:

Owner

  • Full control over organization
  • Can delete organization
  • Manage admins
  • All admin permissions

Admin

  • Manage members (except owner)
  • Approve/reject machines
  • View all jobs and resources
  • Modify organization settings

Member

  • Register and manage own machines
  • Submit and view own jobs
  • Access shared datasets
  • View organization overview

Removing Members

To remove a member:

  1. Navigate to Members
  2. Select the member
  3. Click Remove from Organization

⚠️ Warning: Removing a member will:

  • Terminate all their running jobs
  • Remove their machines from the pool
  • Revoke access to organization resources

Resource Management

Viewing Resources

Track organization-wide resources:

  • Total Machines - All registered machines
  • Available Capacity - Ready for new jobs
  • Active Jobs - Currently running
  • Compute Time - Total accumulated runtime

Resource Policies

Set organization-wide limits:

organization:
  limits:
    max_machines_per_user: 10
    max_concurrent_jobs_per_user: 20
    max_job_runtime: 86400  # 24 hours
    max_job_memory: 65536   # 64 GB

Fair Usage

Ensure fair resource distribution:

  • Monitor per-user resource consumption
  • Set appropriate job priorities
  • Configure queue limits
  • Review usage patterns regularly

Datasets

Shared Datasets

Organizations can maintain shared datasets:

  1. Upload dataset to organization storage
  2. Members can reference in job configs
  3. Mounted read-only by default

Dataset Management

From the Datasets page:

  • Upload new datasets
  • View dataset details and size
  • Set access permissions
  • Delete unused datasets

Billing & Usage (Future)

Track organization usage:

  • Compute hours consumed
  • Storage used
  • Number of active members
  • Job execution counts

Organization Settings

General Settings

Configure basic information:

  • Organization name
  • Description
  • Logo/avatar
  • Contact information

Security Settings

Control access and security:

  • Member invitation requirements
  • Machine approval workflow
  • Two-factor authentication
  • API access tokens

Integration Settings

Connect external services:

  • GitHub for authentication
  • Slack for notifications
  • S3 for dataset storage
  • Prometheus for metrics

Leaving an Organization

Members can leave at any time:

  1. Go to dashboard sidebar
  2. Click Leave Organization
  3. Confirm the action

⚠️ This will:

  • Terminate your running jobs
  • Remove your machines
  • Revoke access to shared resources
  • Cannot be undone

After leaving, you can:

  • Create a new organization
  • Join a different organization
  • Request to rejoin (requires admin approval)

Deleting an Organization

Only owners can delete organizations:

  1. Navigate to Settings
  2. Scroll to Danger Zone
  3. Click Delete Organization
  4. Confirm by typing organization name

⚠️ Warning: This will:

  • Remove all members
  • Delete all jobs and history
  • Remove all machines
  • Delete all datasets
  • Cannot be undone

Best Practices

Onboarding

  • Create clear documentation for new members
  • Define role assignments upfront
  • Set resource expectations
  • Provide example job configurations

Governance

  • Regular review of member access
  • Audit resource usage patterns
  • Monitor for idle machines
  • Clean up old jobs and datasets

Communication

  • Use organization Slack/Discord for coordination
  • Document standard job patterns
  • Share best practices
  • Coordinate major workload schedules

Scalability

  • Plan machine capacity ahead of demand
  • Monitor job queue lengths
  • Add machines before peak periods
  • Archive old data regularly

Next Steps