Skip to content

Waldur Documentation

Index

Initializing search

About
Admin guide
Developer guide
Integrations
Integrator guide
User guide
API docs

Waldur Documentation

About
About
- Getting started
- Contributing
- Data processing disclaimer
- Dependency Vulnerability Management
- Governance
- LLM-Friendly Documentation (llms.txt)
- Academic publications
- Reporting issues
- Screenshots
- Support
- Concepts
  Concepts
- Terminology
  Terminology
  - Glossary
  - Roles and permissions
- Changelog
Admin guide
Admin guide
- AI Assistant configuration
- Architecture
- Backups
- Billing and accounting in Waldur
- Checklist for Go live
- Cookie policy and Telemetry
- Debugging guide for Waldur Mastermind
- Grafana and Prometheus Metrics
- Hardware Requirements
- Matrix chat integration
- OfferingUser management
- Waldur Shell
- Deployment
  Deployment
  - Argocd
    Argocd
    
    Waldur deployment in ArgoCD
  - Docker compose
    Docker compose
    
    Index
    
    Matrix chat add on
  - Helm
    Helm
    
    Index
    
    Docs
    Docs
    
    Index
    
    Components
    
    External db integration
    
    Helm
    
    Host aliasing
    
    Hpa
    
    Ip whitelisting
    
    Kubectl
    
    Marketplace script
    
    Mastermind templates
    
    Matrix chat
    
    Migration from psql ha
    
    Minikube
    
    Postgres backup management
    
    Postgres db ha
    
    Postgres db
    
    Postgres operator
    
    Proxy setup
    
    Rabbitmq operator
    
    Rabbitmq
    
    Saml2
    
    Service endpoint
    
    Tls config
    
    Whitelabeling
- Identities
  Identities
  - LDAP
  - MyAccessID
  - TARA
  - eduGAIN
  - eduTEAMS
  - FreeIPA
  - Keycloak
  - Summary
- Mastermind configuration
  Mastermind configuration
- Operators
  Operators
  - SLURM periodic usage policies: lifecycle and debugging
- Providers
  Providers
  - Azure
  - Custom scripts
  - MOAB
  - OpenPortal integration
  - OpenStack
  - Remote Offering
  - SLURM provider
  - Site agent
    Site agent
    
    Index
    
    Waldur Site Agent — Changelog
    
    LICENCE
    
    Docs
    Docs
    
    Architecture
    
    Configuration validation
    
    Configuration
    
    Deployment
    
    E2e testing
    
    Installation rocky9
    
    Installation ubuntu24
    
    Installation
    
    Offering users
    
    Plugin development guide
    
    Releasing
    
    Rocky9 python313 validation
    
    Rocky9 validation results final
    
    Rocky9 validation results
    
    Sdk
    
    Slurm rest api design
    
    Slurm storage quotas
    
    Slurm usage reporting setup
    
    Ubuntu24 validation results
    
    Upgrading
    
    Waldur offering user sync
    
    Plugins
    Plugins
    
    Basic username management
    Basic username management
    
    Index
    
    Croit s3
    Croit s3
    
    Index
    
    Cscs dwdi
    Cscs dwdi
    
    Index
    
    Digitalocean
    Digitalocean
    
    Index
    
    Harbor
    Harbor
    
    Index
    
    K8s ut namespace
    K8s ut namespace
    
    Index
    
    Ldap
    Ldap
    
    Index
    
    Moab
    Moab
    
    Index
    
    Mup
    Mup
    
    Index
    
    Okd
    Okd
    
    Index
    
    Opennebula
    Opennebula
    
    Index
    
    Docs
    Docs
    
    Saml setup
    Saml setup
    
    Index
    
    Rancher
    Rancher
    
    Index
    
    Rancher kc crd
    Rancher kc crd
    
    Index
    
    Slurm
    Slurm
    
    Index
    
    Docs
    Docs
    
    Upgrading
    
    Tests
    Tests
    
    Test historical usage
    Test historical usage
    
    Index
    
    Test periodic limits
    Test periodic limits
    
    Index
    
    EMULATOR USAGE
    
    TEST SCENARIO MAPPING
    
    Waldur
    Waldur
    
    Index
    
    Tests
    Tests
    
    E2e
    E2e
    
    TEST PLAN
    
    Integration test report
- Rke2 setup
  Rke2 setup
  - Waldur on RKE2
Developer guide
Developer guide
- Index
- Core concepts
  Core concepts
- Guides
  Guides
- Ui
  Ui
- Ad-hoc scripts
- Affiliate program
- Autoprovisioning
- Component discounts
- Component usage
- Constance settings
- Course accounts
- Customer onboarding complete guide
- Events
- Handlers
- HomePort requirements
- I18n
- Identifiers
- Identity bridge
- Maintenance announcement
- Mixins
- Models
- Multi client oidc
- Offering compliance
- Offering groups
- Offering tags
- Offering visibility
- Personal access tokens
- Project lifecycle
- Project metadata
- Provider helpdesk
- Release Orchestration
- Service accounts
- Settings policy
- Support
- Terms of service
- User actions
- User data access tracking
- User profile attributes
- Waldur CI/CD
- Admin guide
  Admin guide
  - Matrix appservice setup
- Design
  Design
  - Pubsub architecture
- Plugins
  Plugins
Integrations
Integrations
- Integrations
- Systemd setup for glauth and config refresher
- Integrating LEXIS with Waldur
- Integrating Open OnDemand with Waldur and SLURM
- Service Desk integrations
- Waldur keycloak mapper
  Waldur keycloak mapper
  - Index
- Waldur MCP server
Integrator guide
Integrator guide
- API Versioning and Change Policy
- API Stability Roadmap
- Reporting
- Waldur Python SDK
- Service Provider Onboarding
- Terraform Provider for Waldur
- APIs
  APIs
- SDK Examples
  SDK Examples
  - Allocation Lifecycle Management by Service Provider
- Ansible
  Ansible
  - Index
  - Docs
    Docs
    
    Best practices
    
    Modules
    
    Plugins
    
    Tests
- Existing integrations
  Existing integrations
  - VPNaaS custom script - Provisioning VPN as a Service based on Firezone
  - Waldur Guacamole integration
- Waldur cli
  Waldur cli
  - Index
  - Docs
    Docs
    
    1 getting started
    
    2 querying resources
    
    3 managing resources
    
    4 provisioning openstack
    
    5 recipes and tips
    
    6 troubleshooting
    
    Development
    
    Reference
    Reference
    
    Index
    
    Auth
    Auth
    
    Index Index
    Table of contents
    
    personal-access-token
    
    ssh-key
    
    Personal access token create
    
    Personal access token delete
    
    Personal access token get
    
    Personal access token list
    
    Personal access token rotate
    
    Personal access token wait
    
    Ssh key create
    
    Ssh key delete
    
    Ssh key get
    
    Ssh key list
    
    Ssh key wait
    
    Marketplace
    Marketplace
    
    Index
    
    Offering get
    
    Offering list
    
    Offering wait
    
    Order approve by consumer
    
    Order cancel
    
    Order delete attachment
    
    Order get
    
    Order retry
    
    Order set state done
    
    Order set state executing
    
    Order unlink
    
    Order wait
    
    Resource get
    
    Resource list
    
    Resource provision
    
    Resource terminate
    
    Resource unlink
    
    Resource wait
    
    Openstack
    Openstack
    
    Index
    
    Flavor get
    
    Flavor list
    
    Flavor wait
    
    Floating ip delete
    
    Floating ip detach from port
    
    Floating ip get
    
    Floating ip list
    
    Floating ip set ok
    
    Floating ip unlink
    
    Floating ip wait
    
    Image get
    
    Image list
    
    Image wait
    
    Instance get
    
    Instance list
    
    Instance provision
    
    Instance restart
    
    Instance set ok
    
    Instance start
    
    Instance stop
    
    Instance terminate
    
    Instance unlink
    
    Instance unrescue
    
    Instance update
    
    Instance wait
    
    Network delete
    
    Network get
    
    Network list
    
    Network update
    
    Network wait
    
    Security group delete
    
    Security group get
    
    Security group list
    
    Security group update
    
    Security group wait
    
    Subnet delete
    
    Subnet get
    
    Subnet list
    
    Subnet update
    
    Subnet wait
    
    Tenant get
    
    Tenant list
    
    Tenant provision
    
    Tenant terminate
    
    Tenant update
    
    Tenant wait
    
    Volume detach
    
    Volume get
    
    Volume list
    
    Volume provision
    
    Volume set ok
    
    Volume terminate
    
    Volume unlink
    
    Volume update
    
    Volume wait
    
    Team
    Team
    
    Index
    
    Customer create
    
    Customer delete
    
    Customer get
    
    Customer list
    
    Customer update
    
    Customer wait
    
    Project create
    
    Project delete
    
    Project get
    
    Project list
    
    Project update
    
    Project wait
    
    Role create
    
    Role delete
    
    Role get
    
    Role list
    
    Role update
    
    Role wait
    
    User create
    
    User delete
    
    User get
    
    User list
    
    User update
    
    User wait
User guide
User guide
- User guide
- Call managing organization
  Call managing organization
- Customer organization
  Customer organization
- End users
  End users
- Service provider organization
  Service provider organization
- Staff users
  Staff users
API docs

Table of contents

personal-access-token
ssh-key

`waldur-cli auth`

personal-access-token

list
get
create
delete
wait
rotate

ssh-key

list
get
create
delete
wait

Copyright © 2016 - 2025 Waldur team

Made with MaterialX