Skip to content
Waldur Documentation
waldur-cli auth
Initializing search
Get started
Use Waldur
Operate Waldur
Integrations
Build with Waldur
About
API reference
Waldur Documentation
Get started
Get started
Overview
Try Waldur locally
Make your first API call
Contribute to Waldur
Use Waldur
Use Waldur
Overview
Using the portal
Using the portal
Interface introduction
How you reach services
Passkeys
Personal access tokens
Your POSIX identity on Linux and HPC offerings
AI Assistant
Chat encryption
Resource actions
Organizations and projects
Organizations and projects
Organization
Organization
Create an organization
Organization management
Organization membership management
Affiliate earnings and volume discounts
Projects
Projects
Project management
Project membership management
Project metrics
Course accounts
Resources
Resources
Resource management
Changing a resource end date
Requesting resource limit changes
Resource spending limits
Resource API keys
Access subnets
Inference services
VMware virtual machines
Metrics of OpenStack virtual machines and volumes
OpenStack networking
OpenStack networking
Tenant network topology
Router external gateway management
IPv6 in OpenStack tenants
Costs and credits
Costs and credits
Credit management for organization owners
Credit consumption dashboard
Usage reports
Cost and usage policies
Service providers
Service providers
Get set up
Get set up
Service provider registration
Offerings
Software Catalogs
Backend ID rules
Resource slug template
Orders and customers
Orders and customers
Order management
Project groups
Membership sync status
OpenStack tenant quotas
Usage and accounting
Usage and accounting
Accounting
Reporting resource usage
Custom metrics
OpenStack instance metrics
POSIX identity and LDAP
POSIX identity and LDAP
Shared POSIX identity, step by step
Managing POSIX ID pools
GLAuth (LDAP) user accounts
Shared project storage with GLAuth and SSSD
Waldur-authoritative accounts in OpenLDAP
POSIX identity with OpenLDAP and FirecREST
HPC workspace with FirecREST
Calls for proposals
Calls for proposals
For call managers
For call managers
Call management
Call manager workflow
Workflow configuration
Checklists and forms
Proposal ID configuration
Reviewer management
Conflict of interest management
Purchase orders in calls
Data export
For applicants and reviewers
For applicants and reviewers
Applicant guide
Reviewer guide
Reviewer workflow
Staff and support
Staff and support
Organizations and users
Organizations and users
Organization management
Organization onboarding
Organization-scoped roles
User role management
Team management for staff
Changing user passwords
Impersonation functionality
Project name restrictions
Multiple projects removal via admin panel
Science domain management
Portal and communication
Portal and communication
Branding configuration
Catalogue mode
Announcements
Broadcast
Notification management
Service desk
Service desk
Reviewing AI Assistant chat sessions
Service desk configuration
Service desk interactions
Marketplace and billing
Marketplace and billing
Credit management configuration for staff
Affiliate program (staff)
Acting on several offerings at once
Offering merges
Remote sync of offerings
Bulk article code update
Custom metrics catalogue
Reporting
Webhook event consumers
Operate Waldur
Operate Waldur
Overview
Deploy
Deploy
Hardware Requirements
Install
Install
Docker Compose
Docker Compose
Waldur Docker-compose deployment
Matrix chat with Docker Compose
Helm
Helm
Waldur Helm
Docs
Docs
Waldur Helm chart configuration
Prerequisites
Prerequisites
Installing Helm
Installing kubectl
Installing minikube
Configuration
Configuration
Additional settings overrides, feature flags, and custom roles
Waldur Components Architecture
Service endpoints
TLS configuration instructions
Gateway API support
Proxy setup for Waldur components
Host aliasing
Limiting network access to Mastermind APIs
HPA setup and configuration
White-labeling instructions
SAML2 configuration
Outgoing email
Mastermind Templates
Databases and queues
Databases and queues
PostgreSQL (bundled subchart)
PostgreSQL Operators (Production)
PostgreSQL backup configuration
External DB Integration
Migration from Postgresql HA
RabbitMQ (bundled subchart)
RabbitMQ Cluster Operator (Production)
Optional components
Optional components
Matrix chat with Helm
Waldur Marketplace script plugin setup
Web shell (development only)
Trusting a private CA
ArgoCD
ArgoCD
Waldur deployment in ArgoCD
RKE2 cluster
RKE2 cluster
Waldur on RKE2
Checklist for Go live
Configure
Configure
Settings
Settings
General Configuration
Configuration options
Features
Email configuration
Notifications
Message templates
Service access modes
Scheduled Background Jobs
SCIM 2.0 Identity Provider
SCIM Entitlements (outbound push)
Arrow (ArrowSphere) Integration
Adding Sections to Marketplace Categories
Backfilling the credit ledger
Table Growth Monitoring
CLI guide
OfferingUser management
AI Assistant configuration
Feedback surveys
Matrix chat overview
Web shell
Identity and access
Identity and access
Summary
Keycloak
eduTEAMS
eduGAIN
MyAccessID
TARA
LDAP
FreeIPA
Passkeys (FIDO2/WebAuthn)
Assigning roles from identity provider claims
Providers
Providers
OpenStack
OpenStack compatibility check
OpenStack compatibility check
OpenStack compatibility check
VMware vSphere
Azure
Site Agent
Site Agent
Waldur Site Agent
Guides
Guides
Quickstart
Installation Guide
Configuration Reference
Configuration Validation
Deployment Guide
Offering Users and Async User Creation
Waldur Plugin: Offering User Sync
Upgrading Waldur Site Agent
SLURM Usage Reporting Setup Guide
SLURM Storage Quotas
Plugins
Plugins
Azure
Azure
Azure plugin for Waldur Site Agent
Basic username management
Basic username management
Basic username management plugin for Waldur Site Agent
Ceph s3
Ceph s3
Ceph S3 Storage Plugin for Waldur Site Agent
Cscs dwdi
Cscs dwdi
CSCS-DWDI Plugin for Waldur Site Agent
Digitalocean
Digitalocean
DigitalOcean plugin for Waldur Site Agent
Envoy ai gateway
Envoy ai gateway
Envoy AI Gateway Plugin for Waldur Site Agent
Harbor
Harbor
Harbor Container Registry Plugin for Waldur Site Agent
K8s ut namespace
K8s ut namespace
Waldur Site Agent - K8s UT Namespace Plugin
Keycloak client
Keycloak client
Keycloak client for Waldur Site Agent plugins
Ldap
Ldap
LDAP Username Management Plugin for Waldur Site Agent
Ldap client
Ldap client
LDAP client for Waldur Site Agent plugins
Ldap roles
Ldap roles
waldur-site-agent-ldap-roles
Litellm
Litellm
LiteLLM Plugin for Waldur Site Agent
Moab
Moab
MOAB plugin for Waldur Site Agent
Mup
Mup
MUP plugin for Waldur Site Agent
Nextcloud
Nextcloud
waldur-site-agent-nextcloud
Okd
Okd
Waldur Site Agent OKD Plugin
Opennebula
Opennebula
OpenNebula Plugin for Waldur Site Agent
Docs
Docs
Saml setup
Saml setup
OpenNebula Keycloak SAML Integration Setup Guide
Rancher
Rancher
Waldur Site Agent - Rancher Plugin
Rancher kc crd
Rancher kc crd
waldur-site-agent-rancher-kc-crd
Manual Testing Guide
Slurm
Slurm
SLURM Plugin for Waldur Site Agent
Docs
Docs
Upgrading the SLURM Plugin
Tests
Tests
Test historical usage
Test historical usage
SLURM historical usage tests
Test periodic limits
Test periodic limits
SLURM periodic limits tests
Waldur
Waldur
Waldur Federation Plugin for Waldur Site Agent
Tests
Tests
E2e
E2e
Waldur Federation E2E Test Plan
MOAB
Rancher access matched by civil code
Rancher Keycloak Operator
Rancher Keycloak Operator
rancher-keycloak-operator
Docs
Docs
Keycloak setup for the operator
Remote Offering
OpenPortal integration
Custom scripts
Run
Run
Architecture
Backups
Grafana and Prometheus Metrics
Debugging guide for Waldur Mastermind
Waldur Shell
Billing and accounting in Waldur
SLURM usage policies
SLURM usage policies
SLURM periodic usage policies: lifecycle and debugging
Compliance
Compliance
Cookie policy and Telemetry
Integrations
Integrations
Integrations
Systemd setup for glauth and config refresher
Integrating LEXIS with Waldur
Integrating Open OnDemand with Waldur and SLURM
Service desk
Service desk
Service Desk integrations
Service Desk offerings
SRAM (SURF Research Access Management)
Waldur keycloak mapper
Waldur keycloak mapper
Waldur Keycloak mapper
Waldur MCP server
Build with Waldur
Build with Waldur
Integrate with the API
Integrate with the API
REST API
REST API
REST API
Authentication
Permissions
Project API examples
Waldur SDK Documentation
Waldur Python SDK
SDK examples
SDK examples
Allocation Lifecycle Management by Service Provider
waldur-cli
waldur-cli
waldur-cli
Docs
Docs
Getting started
Querying resources
Managing resources
Provisioning
Recipes & tips
Troubleshooting
Development
Reference
Reference
waldur-cli command reference
Auth
Auth
waldur-cli auth
waldur-cli auth
Table of contents
personal-access-token
ssh-key
waldur-cli auth personal-access-token create
waldur-cli auth personal-access-token delete
waldur-cli auth personal-access-token get
waldur-cli auth personal-access-token list
waldur-cli auth personal-access-token rotate
waldur-cli auth ssh-key create
waldur-cli auth ssh-key delete
waldur-cli auth ssh-key get
waldur-cli auth ssh-key list
Marketplace
Marketplace
waldur-cli marketplace
waldur-cli marketplace offering get
waldur-cli marketplace offering list
waldur-cli marketplace order approve-by-consumer
waldur-cli marketplace order cancel
waldur-cli marketplace order delete-attachment
waldur-cli marketplace order get
waldur-cli marketplace order retry
waldur-cli marketplace order set-state-done
waldur-cli marketplace order set-state-executing
waldur-cli marketplace order unlink
waldur-cli marketplace order wait
waldur-cli marketplace resource get
waldur-cli marketplace resource list
waldur-cli marketplace resource provision
waldur-cli marketplace resource terminate
waldur-cli marketplace resource unlink
waldur-cli marketplace resource wait
Openstack
Openstack
waldur-cli openstack
waldur-cli openstack flavor get
waldur-cli openstack flavor list
waldur-cli openstack floating-ip delete
waldur-cli openstack floating-ip detach-from-port
waldur-cli openstack floating-ip get
waldur-cli openstack floating-ip list
waldur-cli openstack floating-ip set-ok
waldur-cli openstack floating-ip unlink
waldur-cli openstack image get
waldur-cli openstack image list
waldur-cli openstack instance get
waldur-cli openstack instance list
waldur-cli openstack instance provision
waldur-cli openstack instance restart
waldur-cli openstack instance set-ok
waldur-cli openstack instance start
waldur-cli openstack instance stop
waldur-cli openstack instance terminate
waldur-cli openstack instance unlink
waldur-cli openstack instance unrescue
waldur-cli openstack instance update
waldur-cli openstack instance wait
waldur-cli openstack network delete
waldur-cli openstack network get
waldur-cli openstack network list
waldur-cli openstack network update
waldur-cli openstack security-group delete
waldur-cli openstack security-group get
waldur-cli openstack security-group list
waldur-cli openstack security-group update
waldur-cli openstack subnet delete
waldur-cli openstack subnet get
waldur-cli openstack subnet list
waldur-cli openstack subnet update
waldur-cli openstack tenant get
waldur-cli openstack tenant list
waldur-cli openstack tenant provision
waldur-cli openstack tenant terminate
waldur-cli openstack tenant update
waldur-cli openstack tenant wait
waldur-cli openstack volume detach
waldur-cli openstack volume get
waldur-cli openstack volume list
waldur-cli openstack volume provision
waldur-cli openstack volume set-ok
waldur-cli openstack volume terminate
waldur-cli openstack volume unlink
waldur-cli openstack volume update
waldur-cli openstack volume wait
Team
Team
waldur-cli team
waldur-cli team customer create
waldur-cli team customer delete
waldur-cli team customer get
waldur-cli team customer list
waldur-cli team customer update
waldur-cli team project create
waldur-cli team project delete
waldur-cli team project get
waldur-cli team project list
waldur-cli team project update
waldur-cli team role create
waldur-cli team role delete
waldur-cli team role get
waldur-cli team role list
waldur-cli team role update
waldur-cli team user create
waldur-cli team user delete
waldur-cli team user get
waldur-cli team user list
waldur-cli team user update
Terraform Provider for Waldur
Ansible
Ansible
Ansible Waldur Module Generator
Docs
Docs
Best practices
Modele author guide
Plugin author guide
Test author guide
Service Provider Onboarding
Reporting
Existing integrations
Existing integrations
VPNaaS custom script - Provisioning VPN as a Service based on Firezone
Waldur Guacamole integration
API Versioning and Change Policy
API Stability Roadmap
Develop Waldur
Develop Waldur
Developer documentation
Core concepts
Core concepts
Marketplace
Marketplace
Waldur Marketplace Module
Offering Configuration
OfferingUser States and Management
Marketplace Orders and Processor Architecture
STOMP-Based Event Notification System
Projects and access
Projects and access
Project Model Lifecycle and Relationships
Role-based Access Control (RBAC)
Invitations
Managed entities
Quotas Application
Core Checklists
Calls and proposals
Calls and proposals
Waldur Proposal Module
Call Eligibility and Applicant Attribute Configuration
Reviewer-Proposal Matching System
Conflict of Interest (COI) Detection System
Platform
Platform
Background processing
Tasks and executors
Logging
Guides
Guides
Set up and workflow
Set up and workflow
Installation Guide
Build, Test, and Lint Commands
Development guidelines
Development Philosophy
Waldur Code Style Guide
Demo Presets
How to Reconcile a Long-Diverged Fork
Writing code
Writing code
Waldur Django Architecture
How to write serializers
How to write views
How to write tests
Waldur Testing Guide
Dynamic Test Scheduling in CI/CD
Developer's Guide to OpenAPI Schema Generation in Waldur
Declaring resource actions
Media Access Control
Permissions and roles
Permissions and roles
Waldur Permission System Guide
Organization-scoped custom roles
Resource Projects and Role Management
Marketplace and billing
Marketplace and billing
Implementing Custom Marketplace Option Types
Marketplace Software Catalogs
Marketplace SLURM Partitions, QoS, and Software Catalogs
SLURM Periodic Usage Policy Configuration Guide
Billing and Invoicing
Membership Sync Status
Events and APIs
Events and APIs
Unified Agent Queue (Pubsub)
Event Subscription Queues (Legacy — DEPRECATED)
Resource History API
Version History API
AI Assistant
UI (HomePort)
UI (HomePort)
Overview
Getting started
Getting started
Development Setup Guide
Development Workflow
Architecture Guide
Configuration Management Guide
Local pipeline for developers: OpenAPI -> TypeScript SDK -> Homeport
API Integration Guide
Code Quality Standards
Testing Standards & Strategy
E2E Locators
Design system
Design system
Design Tokens
Theme System
Component Library Guide
Button UI & Design System Guide
UI/UX Consistency Guidelines
Tailwind & shadcn UI Architecture
Accessibility (A11y) Decision Matrix: When to Use What
Terminology policy
Components and patterns
Components and patterns
Forms Guide
Table Component Documentation
Table
Table
Table Component: Column Setup & Configuration
Table Component: Data Fetching & Type Safety
Migration to Generated Table Filters
Table Component: Filters & URL Sync
Table Component: Form Integration (Final-Form)
Table Component: Getting Started
Table Component: Layout Wrappers & Portals
Migrating Hand-Rolled Tables
Table Component: Row Actions & Selection
Table Component: Visual Customizations
Modals
Menus, Dropdowns and Popovers
Tabs
Breadcrumbs
Sidebar Navigation Guide
Menu and Navigation Architecture Guide
Micro-Apps Guide
useManagedMutation Hook
Storage Manager
Features
Features
Role-based access control
Invitations Architecture
Internationalization (i18n) Guide
Class Names and Data Attributes
Property fields
Property Rendering Developer Guide
Visual Regression Testing
Plugins
Plugins
JIRA plugin
OpenStack Replication Plugin
OpenStack Plugin
Waldur plugins
Waldur Rancher Integration - Technical Architecture Overview
Ticket-Based Offerings
Valimo Authentication Plugin
Code patterns
Code patterns
Models
Registered Handlers
Events
Mixin classes documentation
ComponentUsage Model Documentation
Constance Settings Documentation
Settings Policy
Marketplace Resource Identifiers
Field encryption at rest
Backend internationalization (i18n)
Identity and users
Identity and users
Identity Bridge
Multi-Client OIDC Authentication
OIDC login flow, step by step
Personal Access Tokens
Service Accounts in Waldur
Terms of Service API Documentation
User Actions Notification System
User Data Access Tracking
User Profile Attributes
POSIX ID pools
Marketplace
Marketplace
Auto-Provisioning
Customer Onboarding - Complete Guide
Offering Compliance API Documentation
Offering Groups
Offering Tags
Marketplace Offering Visibility
Project and Resource Lifecycle Management
Project Metadata API Documentation
Provider Helpdesk System
Waldur Support Module
Course Accounts in Waldur
Billing and credits
Billing and credits
Affiliate Program
Component Dynamic Discounts
Credit ledger
Spending Limits
Resource API Keys
Operations and releases
Operations and releases
Ad-hoc scripts
Maintenance Announcement Management
Release Orchestration
Waldur CI/CD
Changelog System
HomePort requirements
Design notes
Design notes
Changelog support for offline / airgapped deployments
Event pub/sub architecture
Matrix chat operations
Matrix chat operations
Matrix chat setup and operations
Single sign-on for Matrix clients
About
About
Concepts
Concepts
Platform
Marketplace
Identity
Resource lifecycle
Billing & invoicing
Quotas
Policies
Call management
Support
Terminology
Terminology
Glossary
Roles and permissions
Changelog
Screenshots
Academic publications
Support
Governance
Contributing
Reporting issues
Data processing disclaimer
Dependency Vulnerability Management
LLM-Friendly Documentation (llms.txt)
API reference
Table of contents
personal-access-token
ssh-key
waldur-cli auth
personal-access-token
list
get
create
delete
rotate
ssh-key
list
get
create
delete
Back to top