Skip to content

Waldur Documentation

Description Documentation of an open-source marketplace platform Waldur. See the latest version at https://docs.waldur.com
Copyright Copyright © 2016 - 2024 Waldur team

About ↵

Getting started

Installing Waldur is a simple and straightforward process.

Pick method of installation

There are 2 supported methods:

Configure Waldur

Tune Waldur configuration to match your deployment. Majority of the configuration is done on Mastermind side. Exact method of configuration depends on the chosen method of installation. Settings are grouped by modules, you can see all available ones in the configuration guide.

The most typical aspects for configuration are:

Tip

For easier management of Waldur deployments and configuration we provide Ansible playbooks.

Profit

You are done! If you are happy and want to support the project, make sure you check the support page.

Danger

Before going to production, make sure you have completed the go-live checklist.

Contributing

Waldur is an open project welcoming contributions. To assure the smooth acceptance of contributions please review the contribution guidelines below.

Pull requests

We welcome contributions (patches, new features, translations, etc) through pull requests. Please make sure that the following is addressed when making a pull request:

  • a request has a clear scope - new feature, bugfix, refactoring. Granular pull requests make integration much faster;
  • the code is following code conventions of the corresponding platform and linters / tests are passing;

Localisation

If you see a term, which needs to be translated better, please submit a fix via Localazy.

License

All contributions to Waldur can be accepted only you agree to license your contribution under the MIT license. Please make sure that you have the right to sign off code as MIT.

Code repositories

Repository Description
HomePort Code of Waldur Homeport web interface
MasterMind Code of Waldur Mastermind orchestrator
Helm package Helm packaging of Waldur for Kubernetes
Docker-compose Docker-compose packaging of Waldur
Ansible module Ansible module for Waldur APIs

Data processing disclaimer

Waldur developers would like to inform that we do not assume any responsibility for processing data generated or handled by the software.

Users (e.g platform operators, platform users) are solely responsible for ensuring that the data processed through our software complies with applicable laws, regulations, and industry standards. Waldur developers disclaim any liability for loss, damage, or unauthorized access to data from our software.

Our role is limited to the development of software solution. We do not control, manage, or take responsibility for our software processes' specific deployments and data, including but not limited to data storage, transmission, or any associated security measures.

Users are encouraged to implement data protection and security measures to secure their information. By using Waldur software, users acknowledge and agree that Waldur developers are not liable for any issues related to data processing.

Some highlights to keep in mind regarding user data processing in Waldur

  • Platform operator should have a DPA (Data Processing Agreement) with every Service Provider connected to the platform because, in case of a service request from a Service Provider, the latter gets the ability to see members of the project whereas service is to be provisioned. For example, an HPC service gets access to project member information only when the project is requesting access to the service. The access is revoked once the service is terminated.
  • Staff users (usually platform operators) can see all users personal information.
  • User profile modifications are logged, including modifier network address and changes for auditing and tracing abilities. Additionally, operations connected with the user, e.g. adding or removing SSH key, are also logged.
  • The authentication system is designed around the federated AAI solution, where a user is expected to conform explicitly to personal data propagation from the Identity Provider (IdP) to Waldur.
  • In cases when policy allows, it is possible to create a non-personalized group or robot account to act on behalf of the user, e.g. for CICD types of workflows.
  • All event logs contain references to a user - by UUID - if they are connected with the user. This allows the platform operator to have an easy information cleanup for user data according to specific deployment policies (e.g. removing data of deactivated users after two years) and to disclose user data easily collected about them.

Some suggestions to ensure that the data is securely protected

  • Waldur is pretty configurable, this means that the Waldur deployment operator can configure user profiles in a way that the information requested about the users is as minimal as possible.
  • User information is visible to all project members, so make sure that you include only these users in the project, who are allowed to see each other's information. In addition to that, organization managers can see the user information about users connected to that organization.

Governance

Waldur is a project co-developed by OpenNode and University of Tartu with contributions from different organizations. To make sure that the project is delivering a sound product, OpenNode maintains control over the authoritative source code and covers Product owner and Architect roles (see below).

Waldur and all of its components are released under MIT license to be as friendly towards ecosystem as possible.

Overview of the development process

Waldur team tries to maintain a transparent process of development. In a team, each person can have one or more of the roles below.

Roles

  • Project manager - collects and provides requirements for a particular Waldur-based project. Multiple people can have this role.
  • Product owner - analysis requirements from project managers and fits into a product roadmap. Maintains technical feature list. Single person at a time can have this role.
  • Architect - oversees Waldur platform development, including backend, frontend, external tools. Has a final word on the way how components are integrated. Single person at a time can have this role.
  • Developer - responsible for fulfilling tasks created. Multiple people can have this role.

Workflow

  • Project manager communicates with customers, defines requirements for product owner.
  • Product owner analyses requirements from all projects and creates epics for technical features implementation. Epics are assigned to the architect.
  • Architect defines general development plan for features from product owner, adds description to the epic and creates separate tasks or stories for component owners.
  • Developers process tasks.
  • Product owner releases tagged versions of the product once a certain amount of functionality or bugfixes went in.

Publications

Reporting issues

No software is perfect and issues are to be expected. If you observe something that you think needs fixing, please provide issue report, which includes:

From HomePort:

  1. HAR request that has failed or that contains data required for rendering of the data.
  2. Screenshot of the error in a high enough resolution.

From MasterMind:

  1. Latest mastermind logs that include stacktrace of the error, typically core.log and celery-celery.log.

Warning

Logs may contain sensitive data, please make sure that you either cleanup the data or share it with a trusted party before sharing the actual data.

Roadmap

Warning

The roadmap page is currently deprecated. We are working towards opening up a development process to enable more transparent and up-to-date roadmap display.

Disclaimer

This document is a living document and is used for planning. Plans for the unreleased features can change without further notice and hence cannot be used as a guaranteed delivery plan, the features can be delivered both earlier and later.

Roadmap is created based on the backlog and requests from the existing users of Waldur. If you are interested in a specific topic, please reach out to us.

Some of the tasks are common and some are functional, listed below.

Continuous improvements

Documentation

There is no such thing as a perfect documentation so we are constantly working on improving it.

CI/CD

We believe that automation is a key to improving quality of code and happiness of developers, so we are constantly working on improving CI/CD related aspects.

Tests

A good software is a reliable software, so we are always trying to add more sensible tests.

Functional

The list below is based on the Epics maintained in Waldur's task manager. They are labelled with domains, which have requested them. Domains are:

  • Generic - Common requirements, no extra label.
  • Academia - originating from the research community;
  • Commercial - originating from the commercial deployments;
  • Government - originating from the public sector deployments.

Open or in progress

Code Description Domain
WAL-4077 Integrate external quality metrics of Data repositories with Offerings
WAL-4074 FAIR Offerings - background linking of offering PIDs with published articles Academia
WAL-4073 FAIR-services - add reminders for users about referrals of consumed resources via PIDs Academia
WAL-4072 Expose summaries of Offerings publicly Academia
WAL-4000 Allow to limit visibility of Offering by service provider Academia Commercial
WAL-3999 Support for customer credits Academia Commercial Government
WAL-3997 Add common limit management support to HomePort Academia Commercial
WAL-3987 Extensions to SLURM module Academia
WAL-3964 Implement consolidated approach for remote user accounts management in marketplace offerings Academia
WAL-3963 Make order confirmation message a common functionality for all Marketplace Academia Government
WAL-3951 Implement more fine grained storage of user name
WAL-3943 Shared Openstack Tenant provider phase I Academia
WAL-3934 Functionality specific to deployment of Waldur in Puhuri project as Core Academia
WAL-3811 Improvements to feedback collection Government
WAL-3805 Direct LDAP support for Linux identity Academia
WAL-3793 Tasks related to simplification of the invoice model Government
WAL-3788 Add ability to see popularity of an offering from the list
WAL-3759 Add support of versioning for core objects Government
WAL-3744 Add support for creating / managing projects and resources through API of external Waldur Academia
WAL-3736 Allow protecting resources from accidental deletion Government
WAL-3689 Expose list of connected VMs for each security group Government
WAL-3626 Add ability to generate API docs for select endpoints Academia
WAL-3625 Migrate from Issue types to Request types for Jira support backend Government
WAL-3606 Introduce Organization level service manager role Government
WAL-3596 Allow logins to Rancher via keycloak Academia Government
WAL-3595 Expose port management for OpenStack tenant Government
WAL-3589 Expose Sankey diagram with costs and Service providers Academia
WAL-3585 Rancher access group management Academia Government
WAL-3582 Allow editing of invoice data for staff users Government
WAL-3563 Tasks related for getting Puhuri Core to work Academia
WAL-3524 Add support for sending notifications to users Commercial
WAL-3439 Add support for bookmarking offerings as favourites Academia
WAL-3400 Tasks related to gitlab dev pipelines
WAL-3339 Offerings (Reporting)
WAL-3334 Introduce vault for storing secret configuration in Waldur
WAL-3305 Chart for creating overview of existing organizations
WAL-3285 "Some of the services suggest purchasing of connected offerings To Do
WAL-3272 Allow setting limit for the maximal size of the total volume type quota Academia
WAL-3218 Payment profiles (Phase III)
WAL-3205 UX stabilization (phase I)
WAL-3195 Improvements to the request-based item UX
WAL-3136 Marketplace Checklists (phase II) Commercial
WAL-3135 Support for auto-scalability of Waldur running on K8S
WAL-3103 Second phase of support for virtual routers in OpenStack. Academia Government
WAL-3076 Extend current model with ability to attach VMs directly to external networks Academia Commercial
WAL-3072 Support for operations on multiple objects Commercial
WAL-3005 Followup tasks for payment profiles Government
WAL-2991 Markeplace Scripts plugin phase I Academia Commercial
WAL-2965 Enhancements to properly support virtual security gateway use-case Government
WAL-2961 Tasks related to Kubernetes ON service development and operation Government
WAL-2922 Tasks for exposing Offerings publicly Academia
WAL-2921 Extending Organization extended payment options Government
WAL-2920 Tasks related for extending Waldur with ability to assess compliancy of organizations
WAL-2850 Extending Rancher to support Helm charts Government
WAL-2843 Tasks related to building up monitoring for EOSC Academia
WAL-2780 Integration of PID services with Waldur models Academia
WAL-2776 A visual checklist for making sure that things are done for the project Government
WAL-2749 Tasks connected to improving security of Waldur
WAL-2748 Collection of tasks aimed at improving UX of Waldur
WAL-2747 Operational tools for Waldur deployments
WAL-2676 System for lightweight offering management
WAL-2637 Support for creating Rancher clusters Academia
WAL-2623 Introduce license support for OpenStack Commercial
WAL-2519 Improvements to VMware plugin Commercial
WAL-2401 Implement device booking feature Academia
WAL-2134 Further developments of Marketplace
WAL-1442 Enhancements to Waldur for service provider visibility Commercial
WAL-1309 Implement backend and frontend support for managing JIRA as a provider and issues as resources
WAL-1262 Efforts for getting Waldur into Redhat container store
WAL-1212 Reanimate Zabbix plugin
WAL-1056 IPv6 support for OpenStack provider Academia Commercial Government
WAL-868 Refactor cost tracking
WAL-842 On-demand demo environment from waldur.com
WAL-791 Stress testing & Profiling (vol 1)
WAL-500 Waldur-specifics for ISKE H audit Government
WAL-198 Resource retention management Academia Commercial Government
WAL-44 Navigation FTS
WAL-30 Quick alerts

Finished or discarded

Code Description Domain
WAL-3998 Add i18n support
WAL-3976 Allow setting end of life for project
WAL-3850 Convert OrderItems and Invoices PDF to on-the-fly generation
WAL-3833 Add an intro header to the personal dashboard
WAL-3804 Slurm user list
WAL-3710 Add support for tracking historical changes to important models
WAL-3592 Expose measured units in invoice details
WAL-3587 Render component usage as charts in homeport
WAL-3579 Support for description for Secgroup Rules
WAL-3551 Extensions to request-based item offerings to support Puhuri cases
WAL-3523 Add regular reminders for reviewing membership data of users
WAL-3520 Add a minimal privilege project member role
WAL-3497 Trello integration for feature requests
WAL-3466 Support editing of organizations in homeport
WAL-3407 Extension of checklists to personalized ones
WAL-3306 Growth chart shows changes over time of usage Academia
WAL-3297 Financial overview improvements
WAL-3294 Actions for setting up Waldur at VU
WAL-3197 ITA PKI extension improvements
WAL-3096 Add support for OpenStack Router Academia Government
WAL-3022 Redesign of slurm module
WAL-2989 Reports visible to support
WAL-2967 Basic feature to track quality of handling of a ticket
WAL-2666 Extending OpenStack integration with separate pricing for different volume types
WAL-2646 Tickets related to extension of OpenStack driver
WAL-2596 Drop OpenStack packages
WAL-2590 Tasks related to VMware that are need additional analysis
WAL-2491 VMware plugin
WAL-2025 Tasks related to extension of MasterMind API for BDG SSP
WAL-1988 Marketplace (3)
WAL-1808 Waldur Marketplace (Phase 2)
WAL-1640 Extension of ansible SDK with additional operations
WAL-1568 Migrate tables to React
WAL-1523 Waldur Marketplace (Phase I)
WAL-1504 Implement basic support for Dutch government cloud in Waldur
WAL-1402 Add support for MOAB provider
WAL-1289 Add support for Jira attachments
WAL-1288 Support view of users
WAL-1286 Add support for LDAP-based authentication backends
WAL-1255 Add support for Staff only VPC management
WAL-1113 Paypal support
WAL-1095 Basic Azure VM provider
WAL-1060 Waldur goes to K8S
WAL-1058 Resource import
WAL-969 Expert provider extension
WAL-962 Add organization self-registration
WAL-925 Add eduGain support for authentication
WAL-903 Improvements to invoice / accounting
WAL-839 Miration to ES 5.x
WAL-834 Migrate to Django 1.11
WAL-833 Create a PoC for Expert provider
WAL-832 Ansible module for Waldur
WAL-793 2nd phase of Grafana dashboards
WAL-790 Add ability to set cost limit on organization
WAL-751 Support for Ansible-playbooks as application providers
WAL-730 Waldur Mission Control (central management for Waldurs)
WAL-722 LDAP-based SSH access provider
WAL-713 Add TaaT authentication provider to Waldur
WAL-701 Notifications
WAL-686 Add support for smartid.ee IdP
WAL-604 Basic support mode
WAL-597 /admin improvements
WAL-596 HomePort localization
WAL-595 API Documentation
WAL-568 Grafana dashbord (for operators)
WAL-566 Predictive analysis for capacity planning (organization-view)
WAL-511 Fixes for a broken network model
WAL-479 Price estimation
WAL-468 Admin and user guides (initial)
WAL-463 Extended backup restoration
WAL-462 Extend snapshot management
WAL-461 Basic resource usage view
WAL-454 R: Update django to 1.9.
WAL-396 OpenStack providers pricing info
WAL-323 Use neutron for network operations.
WAL-297 Project policies
WAL-289 Optimizer for IaaS resource selection
WAL-287 Renaming of artifacts to Waldur
WAL-270 OpenStack Tenant dashboard access
WAL-262 OpenStack Tenant Network Management
WAL-259 OpenStack Instance Access Management
WAL-213 Basic policy support
WAL-199 Provider details
WAL-197 Customer support
WAL-169 API Token management
WAL-168 Extended membership management capabilities
WAL-106 Refactoring: Update DRF version.
WAL-88 Transactional event logs
WAL-82 Controls for user profile updates
WAL-79 Tenant Management
WAL-77 Request-based Offerings
WAL-76 Billing
WAL-75 Audit log
WAL-68 Waldur ServiceStore
WAL-43 Waldur white-labelling
WAL-42 Resource state display
WAL-41 Registration
WAL-17 Waldur HomePort L&F
WAL-15 Waldur web page
WAL-9 OpenStack VM backup management
WAL-8 OpenStack Storage management
WAL-7 OpenStack Instance management
WAL-6 Waldur HomePort navigation
WAL-4 VPC / OpenStack Tenant purchase
WAL-3 Organization team management
WAL-2 I want to be able to manage my SSH keys

Screenshots

Desktop view

Login page

Landing

Organization dashboard

Organization dashboard

Project dashboard

Project dashboard Resource list HPC details OpenStack details

Provider reporting and support dashboard

Monthly revenue Growth reporting Support view

Call management dashboard

Call management

Marketplace

Marketplace VPC creation SLURM creation

Admin dashboard

Admin dashboard

Mobile view

Login page

Landing

Organization dashboard

Organization dashboard

Project dashboard

Project dashboard Resource list HPC details OpenStack details

Provider reporting and support dashboard

Monthly revenue Growth reporting Support view

Marketplace

Marketplace Marketplace VPC creation SLURM creation

Admin dashboard

Admin dashboard

Support

Waldur is an open-source project co-developed by OpenNode and University of Tartu.

Support and sponsored development

OpenNode provides several options for support with varying SLAs.

If you would like to know more, reach out!

Managed hosting for academical institutions

Please reach out to support@hpc.ut.ee if you represent an R&D organization and interested in managed Waldur hosting.

Glossaries

Terminology

Name Description Examples
Organization Legal representation of the entity that can be a client of the Operator. Ministry A, Department B
Project Functionality in Self-Service Portal, which allows to group internal resources into projects, which allows to limit access to resources for people. Internal systems, Public web
Service Provider Organization can publish offerings in marketplace as soon as it is registered as service provider. ETAIS, UT HPCC
Offering Service Offering from Service Provider, which can be requested via a Marketplace. Correspond to an entry in the Service Catalogue. VPS with LB, VDC in DataCenter 1
Category A grouping of the Offerings defining metadata common to all offerings in this Category. Compute, Storage, Operations
Section Section is a named aggregate of offering attributes. System information, Support, Security
Attribute Attribute is an atomic piece of offering metadata, it has name, type and list of options. Peak TFlop/s, Memory per node (GB)
Plan An option for paying for a particular Offering. There can be multiple options but at each point in time only one Plan can be active. Small private cloud, Big private cloud
Order A collection of Order items. Considered as done when all Order Items have been processed. 3 different Offerings with configuration.
Order Item Connects Offering with concrete Organization and configuration settings. Small VPC with name “test”
Resource Created as part of fulfilling the Order Item. Represents part of the Offering that customer Organization can use. VM, VPC
Category component Specifies unit of measurement, display name and internal name of the component, which should be present in every category offerings. It is used for aggregating offering component usage and rendering dashboard charts in both project and organization workspace. vCPU, RAM, storage
Offering component Usage-based component that constitute offering. It may refer to the category component via parent field in order to ensure that component usage is aggregated. Database count, disk usage
Plan Component Components that constitute a plan. vCPU, RAM, storage, network bandwidth
Component usage Collects reported resource usage for each plan component separately. 5 virtual floating IPs for the last month.

Users, Organizations and Projects

Waldur is a service for sharing resources across projects. It is based on the delegation model where an organization can allocate certain users to perform technical or non-technical actions in the projects.

The most common types of Waldur installations include:

  • Cloud - used in commercial or government sectors for providing access to cloud resources like virtual machines, storage and Kubernetes clusters.
  • Academic - used in research and education. Waldur is deployed for a single university, high school or research infrastructure.
  • Academic Shared - the same purpose as Academic, but is shared among several universities or infrastructures.

Glossary

User

An account in Waldur belonging to a person or a robot. A user can have roles in Organizations and Projects. Some users - mostly affiliated with Waldur operator - can have global roles, e.g. support or staff.

Organization

A company or a department. Organization can be a customer, a service provider or both.

A faculty, department or an institute. Organization can be also a service provider, for example, an HPC center.

In Academic Shared model, all organizations are service providers allocating resources to their users (research groups or classes) through their Projects.

Project

A project within an Organization. Used for organizing and isolating Resources and Users.

Service Provider

Organization that provides services to other organizations.

User types

User Support agent Staff
Web and API access
Can create support requests
Can provide user support
Can see all projects and resources
Can manage organizations
Can access admin area

User roles in Organization

Owner Service Manager Project Manager System Administrator
Manage Team (pre-approved users)
Manage Projects
Request and Manage Resources
Approves creation of Resource Requests (Orders) (configurable)
Approves Resource Requests (Orders)
Manage Offerings (Service provider-specific)
PI Service Manager co-PI Member
Manage Team (pre-approved users)
Manage Projects
Request and Manage Resources
Approves creation of Resource Requests (Orders) (configurable)
Approves Resource Requests (Orders)
Manage Offerings (Service provider-specific)
Resource allocator Service Manager PI co-PI Member
Manage Team (pre-approved users)
Manage Projects
Request and Manage Resources
Approves creation of Resource Requests (Orders) (configurable)
Approves Resource Requests (Orders)
Manage Offerings (Service provider-specific)

Ended: Glossaries

Changelog

7.0.0

Notes: Bugfix release

Date: Tue Oct 1 19:48:59 UTC 2024

6.9.9

Notes: None

Date: Sun Sep 29 08:20:55 UTC 2024

6.9.8

Notes: Bugfixes

Date: Tue Sep 17 21:37:59 UTC 2024

6.9.7

Notes: Improved username display in team tabs, bugfixes.

Date: Fri Sep 13 14:15:32 UTC 2024

6.9.6

Notes: Openstack bugfixes

Date: Wed Sep 11 18:38:37 UTC 2024

6.9.5

Notes: Bugfix release

Date: Wed Sep 11 10:11:47 UTC 2024

6.9.4

Notes: Fix initialization of resource options

Date: Tue Sep 10 07:29:29 UTC 2024

6.9.3

Notes: Fix docker executor issue due to a conflict with requests

Date: Mon Sep 9 11:25:59 UTC 2024

6.9.2

Notes: Bugfixes, start of merging of Openstack applications.

Date: Thu Sep 5 13:40:32 UTC 2024

6.9.1

Notes: Bugfix release

Date: Tue Aug 27 10:37:35 UTC 2024

6.9.0

Notes: Resource option update bugfix

Date: Sun Aug 25 20:35:08 UTC 2024

6.8.9

Notes: Bugfixes

Date: Fri Aug 23 17:49:29 UTC 2024

6.8.8

Notes: None

Date: Wed Aug 21 19:47:22 UTC 2024

6.8.7

Notes: Allow exposing external IPs for Openstack deployments

Date: Sat Aug 17 08:00:05 UTC 2024

6.8.6

Notes: Bugfixes

Date: Thu Aug 15 16:25:26 UTC 2024

6.8.5

Notes: Extended user-onboarding options

Date: Wed Aug 14 10:10:26 UTC 2024

6.8.4

Notes: User management UI improvements

Date: Sun Aug 11 19:44:26 UTC 2024

6.8.3

Notes: Bugfix

Date: Thu Aug 8 09:41:55 UTC 2024

6.8.2

Notes: Introduce new configuration method in HomePort

Date: Wed Aug 7 11:01:56 UTC 2024

6.8.1

Notes: Fix resource name suggestion button

Date: Thu Aug 1 19:14:05 UTC 2024

6.8.0

Notes: Bugfixes

Date: Wed Jul 31 18:44:21 UTC 2024

6.7.9

Notes:

Date: Thu Jul 25 08:33:49 UTC 2024

6.7.8

Notes:

  • Bugfix

  • Extended SSH key hashes with sha256 and sha512

  • Waldur Mastermind: tag diff

  • Waldur Homeport: tag diff
  • Waldur Helm: tag diff
  • Waldur Docker Compose: tag diff
  • Waldur Prometheus Exporter: tag diff

Date: Sun Jul 21 18:05:27 UTC 2024

6.7.7

Notes: Bugfix

Date: Sun Jul 14 20:31:27 UTC 2024

6.7.6

Notes: Fix support configuration loading

Date: Thu Jul 11 15:01:09 UTC 2024

6.7.5

Notes: Bugfix

Date: Thu Jul 11 10:44:33 UTC 2024

6.7.4

Notes: Bugfixes

Date: Mon Jul 8 15:26:54 UTC 2024

6.7.3

Notes: Fixes broken 6.7.2 release

Date: Mon Jul 1 14:12:05 UTC 2024

6.7.2

Notes: None

Date: Sun Jun 30 19:51:44 UTC 2024

6.7.1

Notes: Bugfix release

Date: Fri Jun 21 21:40:08 UTC 2024

6.7.0

Notes: Introducing renewed UI

Date: Mon Jun 17 15:42:36 UTC 2024

6.6.9

Notes: None

Date: Tue Apr 30 07:40:46 UTC 2024

6.6.8

Notes: Bugfixes.

Date: Mon Apr 29 08:54:03 UTC 2024

6.6.7

Notes: Bugfixes

Date: Fri Apr 26 15:11:26 UTC 2024

6.6.6

Notes: Fix user management permissions.

Date: Mon Apr 22 16:07:21 UTC 2024

6.6.5

Notes: None

Date: Fri Apr 19 11:05:01 UTC 2024

6.6.4

Notes: Volume type selector bugfix

Date: Sun Apr 7 08:45:51 UTC 2024

6.6.3

Notes: Add support for Matomo user tracking

Date: Thu Apr 4 17:29:13 UTC 2024

6.6.2

Notes: Bugfix release

Date: Wed Apr 3 09:04:26 UTC 2024

6.6.1

Notes: Bugfix

Date: Mon Apr 1 15:40:22 UTC 2024

6.6.0

Notes: None

Date: Mon Apr 1 13:43:17 UTC 2024

6.5.9

Notes: SMAX configuration bugfix

Date: Tue Mar 26 21:45:17 UTC 2024

6.5.8

Notes: Bugfixes

Date: Tue Mar 26 19:20:27 UTC 2024

6.5.7

Notes: Bugfixes

Date: Mon Mar 25 17:45:10 UTC 2024

6.5.6

Notes: Bugfix release

Date: Fri Mar 15 20:08:05 UTC 2024

6.5.5

Notes: Openstack caching bugfix

Date: Tue Mar 12 19:31:25 UTC 2024

6.5.4

Notes: Bugfix

Date: Mon Mar 11 20:22:24 UTC 2024

6.5.3

Notes: Bugfix

Date: Thu Mar 7 18:23:33 UTC 2024

6.5.2

Notes: None

Date: Tue Mar 5 21:29:54 UTC 2024

6.5.1

Notes: Bugfix

Date: Tue Feb 27 20:45:36 UTC 2024

6.5.0

Notes: Bugfix release

Date: Mon Feb 26 22:29:21 UTC 2024

Ended: About

Admin guide ↵

Architecture

Waldur is composed of a several components.

  • Homeport (web client, graphical interface) - React application
  • Mastermind API server - Django/Django REST Framework application implementing the core business logic
  • Celery workers - Background processing of tasks
  • Celery beat - Scheduling of periodic tasks for background processing
  • PostgreSQL database - Storing persistent data, also serves as Celery result store in Kubernetes deployment
  • Redis - Tasks queue and result store for Celery (Docker Compose deployment only)
  • RabbitMQ - Tasks queue and result store for Celery (Kubernetes deployment only)

diagram

Backups

Waldur keeps state in 2 components:

  • Database - main persistency layer.
  • Message queue - contains transient data mostly about scheduled jobs and cache.

Of these, only database needs to be backed up.

A typical approach to a backup is:

1. Create a DB dump

  1. An entire db dump
1
docker exec -t waldur-db pg_dump -U waldur waldur | gzip -9 > waldur-$(date +'%Y%m%dT%H%M%S').sql.gz
  1. An entire db dump with cleanup commands:
1
docker exec -t waldur-db pg_dump --clean -U waldur waldur | gzip -9 > waldur-$(date +'%Y%m%dT%H%M%S').sql.gz
  1. A db dump containing only data
1
docker exec -t waldur-db pg_dump -a -U waldur waldur | gzip -9 > waldur-$(date +'%Y%m%dT%H%M%S').sql.gz

2. Copy backup to a remote location

Using rsync / scp or more specialised tools.

3. Restore the created backup

1
cat waldur-backup.sql | docker exec -i waldur-db psql -U waldur

We suggest to make sure that backups are running regularly, e.g. using cron.

Billing and accounting in Waldur

Waldur's accounting and billing components are responsible for collecting accounting data and presenting it to end users. It features built-in reporting and accounting functionality, enabling the tracking of usage information for each project and its resources. During the service offering creation process, providers can define accounting components (such as CPU-h, GPU-h, and storage for HPC; CPU, RAM, and storage for VMs) and set the pricing plans for each component. Consumers can view usage information according to the policies established by the provider.

From a provider point of view, Waldur supports invoice generation and exposes enough of information via APIs to integrate with custom payment providers.

Waldur offers convenient tools for consumers to view resource usage information. The user interface displays overall usage data within a project and breaks down monthly usage across resource components such as CPU, GPU, and storage. End users can export this usage data in PDF, CSV, and XLSX formats. Access to information varies by user role: project members can see details for their specific projects, while organization owners can view information for all projects within their organization.

In addition to that, Waldur offers convenient way for exporting the usage information for visualization with Grafana.

Checklist for Go live

General

  • Make sure that privacy policy and terms of use are updated to the site specific ones.
  • Make sure that SMTP server and outgoing email address are configured and emails are sent out.
  • Reboot test: restart all the nodes where Waldur components are running, application should recover automatically.

Security

  • Remove or disable default staff accounts.
  • Generate a new random secret key.

Backups

  • Make sure that configuration of Waldur is backed up and versioned.
  • Assure that DB backups are performed, i.e. backups are created when manually triggering
  • Assure that DB backups files are on a persistent storage, preferably outside the storage used for Waldur's database.

Air-gapped deployments

  • Make sure that Waldur docker images are mirrored to a local registry.

Cookie policy and Telemetry

Waldur can save data about the user in a browser. Data type and policy depends on the component.

  • Saving of the latest view point of the user.
  • Saving redirect information, i.e. where to forward from a certain state.
  • Saving which authentication method was used by user for logging in.
  • Saving user session token.
  • Saving user language preference.
  • Saving authentication token (cookie) when a user logs into /admin management interface.

Waldur can send telemetry metrics to the telemetry server. Metrics are sent only if the feature is enabled and the telemetry server is configured in the Waldur settings. To toggle the feature on or off, navigate to Administration -> Settings -> Features in HomePort and enable or disable the Send telemetry metrics feature.

An example of telemetry metrics is shown below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
Deployment ID: 0f115db062b7c0dd030b16878c7
Deployment type: other
Helpdesk backend: zammad
Helpdesk integration status: true
Number of users: 1555
Number of offerings: 796
Types of offering:
    Waldur.RemoteOffering
    Marketplace.Booking
    Marketplace.Rancher
    OpenStack.Volume
    VMware.VirtualMachine
    Marketplace.Basic
Version: 6.6.5+3.g6491c9dab.dirty
Installation date: 2022-06-10 11:28:50.585100+0000

Debug instructions for Waldur Mastermind

Upon sending an email, Waldur logs an event to the Celery output.

Docker Compose

A dedicated container logger collects all the logs from other Waldur containers. All you need is to:

  1. Go to the logs directory. It should be in the same directory where Compose runs:

    1
2
3
    $ cd ./logs
$ ls -lh waldur-mastermind-worker.log
-rw-r--r--. 1 root root 39M Jun  3 08:53 waldur-mastermind-worker.log

  2. Check the logs in the corresponding file:

    1
2
3
4
5
6
7
    $ cat waldur-mastermind-worker.log | grep -i "about to send"
...
[2024-05-31 08:09:46,569: INFO/ForkPoolWorker-1] About to send notify_provider_about_pending_order notification to email1@example.com
[2024-05-31 08:09:48,706: INFO/ForkPoolWorker-1] About to send notify_provider_about_pending_order notification to email2@example.com
[2024-05-31 08:09:49,524: INFO/ForkPoolWorker-8] About to send notify_provider_about_pending_order notification to email3@example.com
[2024-05-31 09:17:05,673: INFO/ForkPoolWorker-8] About to send invitation_created notification to email1@example.com
[2024-05-31 09:56:55,144: INFO/ForkPoolWorker-8] About to send notify_provider_about_pending_order notification to email2@example.com

Helm

In this case, you can use the same approach, but execute kubectl instead of docker command:

1
kubectl logs -l app=waldur-mastermind-worker --tail=-1 | grep -i "about to send"

Grafana and Prometheus Metrics

Waldur Homeport includes a number of reports, but for cases when additional custom reports need to be created, it is possible to setup a time-series database, for example, Prometheus, and setup business metrics exporter for Waldur.

This would allow to create live dashboards exposing, for example, growth of adoption of the platform in terms of users and offerings, aggregated costs of resource on a daily or weekly basis, total active provisioned resources on an hourly basis and so on.

To achieve that, waldur-prometheus-exporter needs to be setup. In addition, we provide example Grafana dashboard json for visualising the metrics.

Prometheus metrics

Prometheus exporter allows to setup export of business metrics and reporting information at the fine-grained granularity, for example, every 5 minutes or daily. Collected information can then be visualized in Grafana or other visualisation solutions.

Currently, the following metrics are supported:

  • Total count of users;
  • Total count of organizations;
  • Total count of projects;
  • Total count of users with owner permissions;
  • Total count of support users;
  • Total count of users with local registration method;
  • Total count of users with saml2 registration method;
  • Total count of users with tara registration method;
  • Total count of users with eduteams registration method;
  • Total count of active resources;
  • Count of projects for each organization;
  • Count of resources for every organization;
  • Count of members for every organization;
  • Resources limits by offerings, customer groups, customer countries;
  • Aggregated usages by offerings, customer groups, customer countries;
  • Aggregated usages per month;
  • Count of users visible to service provider;
  • Count of projects visible to service provider;
  • Count of projects visible to service provider and grouped by OECD science code;
  • Total cost of active resources per offering;
  • Projects usages grouped by OECD science code;
  • Projects limits grouped by OECD science code;
  • Projects usages grouped by industry flag;
  • Projects limits grouped by industry flag;
  • Count unique users connected with active resources of a service provider;
  • Count active resources grouped by offering;
  • Count active resources grouped by country;
  • Count active resources grouped by organization group;
  • Count projects with active resources grouped by provider and OECD science code;
  • Count projects with active resources grouped by provider and industry flag.

Hardware requirements

Docker-compose deployment (on a single server)

  • Docker version: 1.13+
  • Minimal configuration: 4 vCPU, 12 GB RAM

Helm-based deployment

  • Kubernetes version: 1.18+
  • Minimal namespace limits:
  • CPU: 8000m
    • Waldur: 4000m
    • PostgreSQL: 4000m
  • RAM: 10000Mi
    • Waldur: 6000Mi
    • PostgreSQL: 4000Mi
  • Storage: 20Gi (PostgreSQL DB)
  • Recommended namespace limits:
  • CPU: 12000m
    • Waldur: 6000m
    • PostgreSQL: 6000m
  • RAM: 14000Mi
    • Waldur: 8000Mi
    • PostgreSQL: 6000Mi
  • Storage: 40Gi (PostgreSQL DB)

Component specific requirements

Waldur Mastermind (API)

By default 4 uWSGI processes are started.

  • Minimum requirements: 1 CPU, 1GB RAM for every node
  • Recommended setup: 2 CPU or more, 2 GB RAM or more

Waldur Mastermind (Celery worker)

By default a single worker with 10 threads is started.

  • Minimum requirements: 2 CPU, 1 GB RAM
  • Recommended setup: 4 CPU or more, 8 GB RAM or more

More memory should be added if more Celery worker processes are running on the same host (512 MB for each 4 Celery workers).

Waldur Mastermind (Celery beat)

A single Celery beat process is started.

  • Minimum and recommended requirements: 1 CPU, 1 GB RAM

PostgreSQL

  • Minimum requirements: 1 CPU, 1 GB RAM
  • Recommended setup: 2 CPU or more, 2 GB RAM or more

Redis

  • Minimum requirements: 1 CPU, 512 MB RAM
  • Recommended setup: 2 CPU or more, 1 GB RAM or more

Waldur HomePort (Nginx)

  • Minimum and recommended requirements: 1 CPU and 512MB RAM

Managing Waldur with Ansible

NB! Repository with Ansible playbooks for Waldur management is not open-sourced. It is available to Waldur users that have purchased support packages.

Compatibility

Ansible version 2.9 is supported; code in this repository may work with other Ansible versions but it is not guaranteed.

Quick setup

  1. Make sure that you have:
    • Folder containing managed-ansible Ansible installer (this one).
    • Folder containing deployment-specific settings.
  2. Copy setup_deployment.sh.example to setup_deployment.sh, adjust:
    • INSTALLER_PATH - full path to current folder
    • DEPLOYMENT_CONFIG_PATH - full path to folder with deployment-specific information
    • DEPLOYMENT_IDS - list of deployment IDs you want to manage.
  3. Run ./setup_deployment.sh. This will create required symlinks.
  4. Run ansible-playbook -DC <deployment_id.yml> to check what installer will do.
  5. Run ansible-playbook -D <deployment_id.yml> to apply the installer.

Upgrading installer

  1. Download a new archive into a separate folder and unpack.

  2. Check what has changed:

    rsync --dry-run -avzh unpacked-folder-eg-ansible-3.2.3/ /path/to/installer/

  3. Do the upgrade:

    rsync -avzh unpacked-folder-eg-ansible-3.2.3/ /path/to/installer/

Upgrading Waldur

Upgrading Waldur to a new version is achieved by following the checklist:

  1. Update deployment-specific variables for the new version in groups_vars/<deployment_id>/vars and groups_vars/<deployment_id>/vault (if setting is private).
  2. Update target version in groups_vars/<deployment_id>/vars: set waldur_homeport_version and waldur_mastermind_version to a new version of the Waldur release.
  3. Run ansible-playbook -DC <deployment_id.yml> to check what installer will do during the upgrade.
  4. Run ansible-playbook -D <deployment_id.yml> to perform an upgrade.

Add new deployment

Infrastructure:

  1. Prepare servers matching requirements.
  2. Make sure you can access them by SSH by running only ssh <host>. Otherwise you should tweak ~/.ssh/config file or describe connectivity in the Ansible inventory.

Ansible (this repository):

  1. Add new deployment-specific host group to hosts file (example: [foo]); add hosts to this group.
  2. Add hosts to Waldur role groups in hosts file.
  3. Add variable files for new deployment: group_vars/foo/vars and group_vars/foo/vault
  4. Add deployment specific information under deployments folder.
  5. Copy existing playbook that is the closest match for a new deployment; modify as needed
  6. Run Ansible playbook to set up deployment: ansible-playbook -D foo.yml

Remove deployment

Ansible (this repository):

  1. Delete deployment-specific playbook, roles, tasks, templates etc.
  2. Delete variable files: rm -rf group_vars/foo
  3. Delete deployment-specific host group and all deployment-specific hosts from hosts file (example: [foo])

Managing Waldur deployed as Helm

Requirements:

  1. Installed and running kubernetes system on a node (e. g. minikube)
  2. Installed kubectl on the node

Place all configuration files for release in next manner:

  • values.yaml -> roles/waldur_helm/files/waldur_helm/waldur/
  • values.yaml -> roles/waldur_helm/files/waldur_helm/waldur/
  • Files related to TLS -> deployments/<deployment_id>/tls/
  • Files related to white-labeling -> deployments/<deployment_id>/whitelabeling/
  • Files related to mastermind templates -> deployments/<deployment_id>/mastermind_templates/
  • Files related to stress testing -> deployments/<deployment_id>/locust_tasks/
  • Files related to SAML2 -> deployments/<deployment_id>/waldur_saml2/

More configuration info:

Multilingual User Interface

Waldur user interface is available in several languages. Default language is English, but the end users may have several other options to choose from. The number of available languages depends on the Waldur's configuration. Current status of the overall avalable languages are visible on the Localazy website.

Waldur uses Localazy service, to translate the user interface. Localazy is a continuous localization platform and web-based translation management system. This allows to use AI or human translation. Everyone can contribute to Waldur's translation by adding new translantions or fixing current ones, more information here.

OfferingUser management

OfferingUser is a model in Waldur, which represents a link between an offering available in marketplace and a user. A service provider can utilize it to create an account for a service visible for all the offering resources, for example: a user account in a SLURM cluster. As an account, an OfferingUser can have a custom username different from user's one.

This feature is available for offerings of types:

  • Basic
  • SLURM
  • SLURM remote
  • Custom script
  • Rancher

For Basic, SLURM remote and Custom script offerings, offering-users are created automatically when a user is added to the project with active offering resources or when a new offering resource is created.

In case of Rancher, offering-users are created when users are imported from a Rancher cluster.

In case of SLURM, offering-users are created when association are imported from a SLURM cluster.

Username generation

The username field for the model can be generated via strategies:

  1. service_provider: a service provider should manually set usernames for the offering users (default strategy);
  2. anonymized: usernames are generated with <prefix>_<number>, e.g. "anonym_00001"; the prefix must be specified in the plugin options of the offering as username_anonymized_prefix;
  3. full_name: usernames are constructed using first and last name of users with numerical suffix, e.g. "john_doe_01";
  4. waldur_username: uses a username of a user;
  5. freeipa: uses the username field of a corresponding FreeIPA profile.

A service provider can choose the policy via UI:

  1. go to offering edit section in a service provider page;
  2. open Integration tab;
  3. click Edit integration options;
  4. choose a username generation policy from the drop-down list;
  5. click Save button.

After this, the usernames are regenerated for all the linked offering users.

Waldur Shell

Waldur provides a shell for command line scripting. To start a shell, run waldur shell in the MasterMind context.

For docker-compose deployments, please run:

docker exec -it waldur-mastermind-api waldur shell

For Helm-based K8s deployments, please run:

1
2
3
export KUBECONFIG=/etc/rancher/rke2/rke2.yaml  # if running from RKE2 node
kubectl get pods -A | grep waldur-mastermind-worker  # to find POD id
kubectl exec --stdin --tty waldur-mastermind-worker-POD-ID -- waldur shell

Examples

Setting/removing staff permissions for a user

1
2
3
4
5
6
7
8
from waldur_core.core.models import User

user = User.objects.get(
    username="example_user",
)
user.set_password("somesecretpassword")
user.is_staff = True  # set to False if you want to remove permission
user.save()

Creating a new user with token only authentication

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from rest_framework.authtoken.models import Token
from waldur_core.core.models import User

user = User.objects.create(
    username="example_accounting_user",
    first_name="Accounting",
    last_name="Reporter",
    email="test@example.com",
)
user.token_lifetime = None
user.set_unusable_password()
user.save()

token = Token.objects.get(user=user)
print(token)

Triggering pulling of usage data from remote Waldur

1
2
3
from waldur_mastermind.marketplace_remote.tasks import UsageListPullTask

UsageListPullTask().run()

Apply changes in Waldur HPC plugin to existing users

1
2
3
4
5
from waldur_core.core import models as core_models
from waldur_hpc.handlers import handle_new_user

for user in core_models.User.objects.filter(is_active=True, registration_method__iexact='saml2'):
    handle_new_user(None, user, created=True)

Cleanup leftover ports from OpenStack Project

Lookup UUID of an OpenStack tenant (aka backend_id in Waldur).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_openstack.models import Tenant

t_uuid = 'UUID_OF_TENANT'
t = Tenant.objects.get(backend_id=t_uuid)

nc = t.get_backend().neutron_client
all_ports = nc.list_ports()['ports']
tenant_ports = [port for port in all_ports if port['tenant_id'] == t_uuid and port.get('status') == 'DOWN']

for t in tenant_ports:
    print(t['id'], t['fixed_ips'][0]['ip_address'])
    nc.delete_port(t['id'])

Add affiliations to user

1
2
3
4
5
from waldur_core.core import models as core_models

user = core_models.User.objects.get(email='some.email@abc.example.com')
user.affiliations = ['some.affiliation@domain.example.com']
user.save()

Create a service user for API access

To create a service user - without valid access credntials and non-expiring Token, please run the following script.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_core.core.models import User

u = User.objects.create(username='waldur_demo_user', first_name='Demo',
                        last_name='Waldur user', email='demo@example.com')

# make sure that token doesn't time out
u.token_lifetime = None
u.save()

# print user authentication token
print(u.auth_token.key)

Synchronise SLURM associations

Note: <allocation-uuid> field can be found in an allocations's details page.

Select Organization -> Select project -> Select allocation -> Find 'UUID' field in the page.

1
2
3
4
5
6
7
8
from waldur_slurm import models as slurm_models

allocation = slurm_models.Allocation.objects.get(uuid='<allocation-uuid>')
backend = allocation.get_backend()

backend.add_new_users(allocation) # Creates associations on SLURM level

backend.pull_allocation(allocation) # Sync associations on Waldur level

Lookup user details from Eduteams

Note: USER_CUID is a unique ID of user in Eduteams.

1
2
3
4
5
from waldur_auth_social.utils import get_remote_eduteams_user_info

USER_CUID='semi_secret@eduteams.org'

get_remote_eduteams_user_info(USER_CUID)

Generate report for list of projects and their details

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import sys
import csv

from waldur_core.structure import models as structure_models


projects = structure_models.Project.objects.filter(created__lte='2022-05-31')
writer = csv.writer(sys.stdout)
for project in projects:
    owner = project.customer.get_owners().first()
    writer.writerow(
        [
            project.name,
            owner and owner.full_name,
            project.oecd_fos_2007_code,
            project.customer.country,
        ]
    )

Generate report for OpenStack resources across projects

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import csv
import sys

from waldur_openstack.models import Tenant, Instance, Volume
from waldur_core.structure.models import ServiceSettings

RAM_LIMIT_NAME = 'ram'
STORAGE_LIMIT_NAME = 'storage'

writer = csv.writer(sys.stdout)


def generate_report():
    tenants = Tenant.objects.filter(state=3)
    writer.writerow(
        [
            'Organisation',
            'Abbreviation',
            'Project',
            'VPC',
            'RAM limit',
            'RAM usage',
            'Storage limit',
            'Storage usage',
            'Number of VMs',
            'Big VM count',
            'Big volume count',
        ]
    )
    for tenant in tenants:
        number_of_vms = tenant.quotas.get(name='instances').usage
        ram_limit = tenant.quotas.get(name='ram').limit / 1024
        ram_usage = tenant.quotas.get(name='ram').usage / 1024
        storage_limit = tenant.quotas.get(name='storage').limit / 1024
        storage_usage = tenant.quotas.get(name='storage').usage / 1024
        # RAM > 16 GB
        big_vm_count = Instance.objects.filter(tenant=tenant, ram__gt=16 * 1024).count()
        # Disk > 256 GB
        big_storage_count = Volume.objects.filter(tenant=tenant, size__gt=256 * 1024).count()
        writer.writerow(
            [
                tenant.project.customer.name,
                tenant.project.customer.abbreviation,
                tenant.project.name,
                tenant,
                ram_limit,
                ram_usage,
                storage_limit,
                storage_usage,
                number_of_vms,
                big_vm_count,
                big_storage_count,
            ]
        )

Update limits for all tenants in a specific organization

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
WALDUR_API_URL = '<CHANGEME>'
WALDUR_API_TOKEN = '<CHANGEME>'
CUSTOMER_UUID = '<CHANGEME>'

CORES_LIMIT = 1
RAM_GB_LIMIT = 10
STORAGE_GB_LIMIT = 100

TENANT_LIMITS = {
    'cores': CORES_LIMIT,
    'ram': RAM_GB_LIMIT * 1024,
    'storage': STORAGE_GB_LIMIT * 1024
}

from waldur_client import WaldurClient

client = WaldurClient(WALDUR_API_URL, WALDUR_API_TOKEN)
tenants = client.list_tenants({'customer_uuid': CUSTOMER_UUID})

for tenant in tenants:
    client.marketplace_resource_update_limits_order(
        resource_uuid=tenant['marketplace_resource_uuid'],
        limits=TENANT_LIMITS,
    )

Generate cost report for a specific organization by month

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import sys
import csv

from waldur_core.structure import models as structure_models
from waldur_mastermind.invoices import models as invoice_models

customer = structure_models.Customer.objects.get(abbreviation='Ada')
invoices = invoice_models.Invoice.objects.filter(customer=customer).order_by('year', 'month')
writer = csv.writer(sys.stdout)
for invoice in invoices:
    writer.writerow(
        [
            invoice.year,
            invoice.month,
            invoice.state,
            invoice.price,
            invoice.tax,
            invoice.total,
        ]
    )

Generate a report for VMs created within a specific tenant offering

Upon running the script, please change year and offering_uuid variables.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
from waldur_mastermind.marketplace import models as mm
from urllib.parse import urlparse
from waldur_openstack import models as otm
import csv

year = 2024
offering_uuid = "changeme"

tenant_offering = mm.Offering.objects.get(uuid=offering_uuid)

vm_orders = mm.Order.objects.filter(
    offering__parent=tenant_offering,
    state=mm.Order.States.DONE,
    type=mm.Order.Types.CREATE,
    resource__created__year=year,
).order_by("created")

report = []

for order in vm_orders:
    resource = order.resource
    flavor_url = resource.attributes.get("flavor")

    if flavor_url is None:
        print("flavor_url is missing for order %s" % order)
        continue

    flavor_parsed_url = urlparse(flavor_url)
    flavor_url_parts = flavor_parsed_url.path.split("/")
    flavor_uuid = flavor_url_parts[-2]
    flavor = otm.Flavor.objects.filter(uuid=flavor_uuid).first()

    if flavor is None:
        print("There is no flavor for order %s" % order)
        continue

    system_volume_size = order.attributes["system_volume_size"]
    data_volume_size = resource.attributes.get("data_volume_size", 0)

    vm_terminated = ""
    if resource.state == mm.Resource.States.TERMINATED:
        termination_order = mm.Order.objects.filter(
            resource=resource, state=mm.Order.States.DONE, type=mm.Order.Types.TERMINATE
        ).first()

        if termination_order is None:
            print("Termination order for resource %s does not exist" % resource)
        else:
            vm_terminated = termination_order.consumer_reviewed_at.isoformat()

    report.append(
        {
            "vm_name": resource.name,
            "vm_created": resource.created.isoformat(),
            "vm_terminated": vm_terminated,
            "project_name": resource.project.name,
            "flavor_name": flavor.name,
            "flavor_cores": flavor.cores,
            "flavor_ram": flavor.ram,
            "flavor_disk": flavor.disk,
            "system_volume_size": system_volume_size,
            "data_volume_size": data_volume_size,
        }
    )

report_path = f"vm-report-{year}.csv"

with open(report_path, mode="w") as file:
    fieldnames = [
        "vm_name",
        "vm_created",
        "vm_terminated",
        "project_name",
        "flavor_name",
        "flavor_cores",
        "flavor_ram",
        "flavor_disk",
        "system_volume_size",
        "data_volume_size",
    ]
    writer = csv.DictWriter(file, fieldnames=fieldnames)
    writer.writeheader()
    writer.writerows(report)

Migrate users to a new Keycloak instance

Introduction

There are 3 scripts involved:

  1. export-keycloak-user-permissions.py: exports Keycloak user data to a .yaml file in the following format:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    - username: johndoe
  email: johndoe@example.com
  full_name: John Doe
  permissions:
    - type: project
      project_uuid: bed45d99e83d4c17a5bf5908ad70554e
      role_uuid: e4130fde02474571a5166bb6742dc2d0
      project_name: "Project 01"
      role_name: "PROJECT.MANAGER"
    - type: customer
      customer_uuid: 1aaec6489ea7492cbe0401997de13653
      role_uuid: 16ec8cf8874d467d9a2c7a0c822c6b3e
      customer_name: "Organization 01"
      role_name: "CUSTOMER.OWNER"

  2. delete-keycloak-users.py: removes data about all the users from an old Keycloak instance

  3. invite-keycloak-users.py: creates and sends invitations to the user emails based on their roles in project and organizations

When you are ready to migrate users to the new Keyaloak instance:

  1. copy the script file to the waldur-mastermind-api container using docker cp or kubectl cp commands;
  2. connect to the container shell using docker exec or kubectl exec;
  3. execute the scripts sequentially using waldur shell:
1
2
3
root@waldur-mastermind-api$ waldur shell < export-keycloak-user-permissions.py
root@waldur-mastermind-api$ waldur shell < delete-keycloak-users.py
root@waldur-mastermind-api$ waldur shell < invite-keycloak-users.py

export-keycloak-user-permissions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
from waldur_core.core import models as core_models
from waldur_core.structure import models as structure_models
from waldur_core.permissions.models import UserRole
from django.contrib.contenttypes.models import ContentType
import yaml

users = core_models.User.objects.filter(is_active=True, registration_method="keycloak")

project_content_type = ContentType.objects.get_for_model(structure_models.Project)
customer_content_type = ContentType.objects.get_for_model(structure_models.Customer)
roles = []

for user in users:
    entry = {
        "username": user.username,
        "email": user.email,
        "full_name": user.get_full_name(),
        "permissions": [],
    }
    perms = UserRole.objects.filter(user=user, is_active=True)

    for permission in perms:
        if permission.content_type == project_content_type:
            project = permission.scope
            entry["permissions"].append(
                {
                    "type": "project",
                    "project_uuid": project.uuid.hex,
                    "role_uuid": permission.role.uuid.hex,
                    "project_name": project.name,
                    "role_name": permission.role.name
                }
            )

        if permission.content_type == customer_content_type:
            customer = permission.scope
            entry["permissions"].append(
                {
                    "type": "customer",
                    "customer_uuid": customer.uuid.hex,
                    "role_uuid": permission.role.uuid.hex,
                    "customer_name": customer.name,
                    "role_name": permission.role.name
                }
            )

    roles.append(entry)

with open("roles.yaml", "w+") as output:
    yaml.dump(roles, output)

delete-keycloak-users

1
2
3
4
from waldur_core.core import models as core_models

users = core_models.User.objects.filter(is_active=True, registration_method="keycloak")
users.delete()

invite-keycloak-users

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
from waldur_core.structure import models as structure_models
from waldur_core.permissions import models as permission_models
from waldur_core.users import models as user_models
from waldur_core.core.utils import get_system_robot
from waldur_core.users import tasks as user_tasks
import yaml

system_robot = get_system_robot()

user_roles = []

with open("roles.yaml", "r") as roles_file:
    user_roles = yaml.safe_load(roles_file)

for user_role in user_roles:
    email = user_role["email"]
    full_name = user_role["full_name"]

    for perm in user_role["permissions"]:
        role_name = permission_models.Role.objects.get(uuid=perm["role_uuid"]).name
        role_name_suffix = role_name.split(".")[1].lower()

        if perm["type"] == "project":
            project = structure_models.Project.objects.get(uuid=perm["project_uuid"])

            invitation, created = user_models.Invitation.objects.get_or_create(
                email=email,
                full_name=full_name,
                customer=project.customer,
                project=project,
                project_role=role_name_suffix,
                created_by=system_robot,
            )

            if not created:
                continue

            print(
                f"Inviting user {full_name} ({email}) to project {project} as {role_name_suffix}"
            )
            user_tasks.send_invitation_created(
                invitation.uuid.hex, system_robot.full_name
            )

        if perm["type"] == "customer":
            customer = structure_models.Customer.objects.get(uuid=perm["customer_uuid"])

            invitation, created = user_models.Invitation.objects.get_or_create(
                email=email,
                full_name=full_name,
                customer=customer,
                customer_role=role_name_suffix,
                created_by=system_robot,
            )

            if not created:
                continue

            print(
                f"Inviting user {full_name} ({email}) to customer {customer} as {role_name_suffix}"
            )
            user_tasks.send_invitation_created(
                invitation.uuid.hex, system_robot.full_name
            )

White-labeling instructions

To change white-labeling settings on the fly, you can perform following steps:

  • Go to admin panel (e.g. http://localhost:8080/admin/)

  • Open Templates: Utilities -> Constance -> Config

img.png

You will see a list of white-labeling settings available to be changed.

You can change them as you wish to, or you can reset them to default values.

img.png

Save the changes and you are good to go.

Waldur Docker-compose deployment

Prerequisites

  • at least 8GB RAM on Docker Host to run all containers
  • Docker v1.13+

Prepare environment

1
2
3
4
5
# clone repo
git clone https://github.com/waldur/waldur-docker-compose.git
cd waldur-docker-compose
# setup settings
cp .env.example .env

Booting up

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# start containers
docker compose up -d

# verify
docker compose ps
docker exec -t waldur-mastermind-worker status

# Create user
docker exec -t waldur-mastermind-worker waldur createstaffuser -u admin -p password -e admin@example.com

# Create demo categories for OpenStack: Virtual Private Cloud, VMs and Storage
docker exec -t waldur-mastermind-worker waldur load_categories vpc vm storage

Waldur HomePort will be accessible on https://localhost. API will listen on https://localhost/api.

Healthcheck can be accessed on https://localhost/health-check.

Tearing down and cleaning up:

1
docker compose down

Logs

Logs emitted by the containers are collected and saved in the waldur_logs folder. You can change the location by editing environment variable (.env) and updating LOG_FOLDER value.

Known issues

When Waldur is launched for the first time, it applies initial database migrations. It means that you may need to wait few minutes until these migrations are applied. Otherwise you may observe HTTP error 500 rendered by REST API server. This issue would be resolved after upgrade to Docker Compose 1.29.

To use a custom script offering type, it should be possible to connect to /var/run/docker.sock from within the Waldur containers. If you are getting a permission denied error in logs, try setting more open permissions, for example, chmod 666 /var/run/docker.sock. Note that this is not a secure setup, so make sure you understand what you are doing.

Upgrading Waldur

1
2
docker compose pull
docker compose restart

Using TLS

This setup supports following types of SSL certificates:

  • Email - set environment variable TLS to your email to register Let's Encrypt account and get free automatic SSL certificates.

Example:

1
TLS=my@email.com
  • Internal - set environment variable TLS to "internal" to generate self-signed certificates for dev environments

Example:

1
TLS=internal
  • Custom - set environment variable TLS to "cert.pem key.pem" where cert.pem and key.pem - are paths to your custom certificates (this needs modifying docker-compose with path to your certificates passed as volumes)

Example:

1
TLS=cert.pem key.pem

Custom Caddy configuration files

To add additional caddy config snippets into the caddy virtual host configuration add .conf files to config/caddy-includes/

Keycloak

Keycloak is an Identity and Access Management software bundled with waldur-docker-compose.

To create a keycloak admin account set KEYCLOAK_ADMIN env variable in docker-compose.yaml and KEYCLOAK_ADMIN_PASSWORD in .env file.

After this, you can login to the admin interface at https://localhost/auth/admin and create Waldur users.

To use Keycloak as an identity provider within Waldur, follow the instruction here. The discovery url to connect to Keycloak from the waldur-mastermind-api container is:

1
http://keycloak:8080/auth/realms/<YOUR REALM>/.well-known/openid-configuration

Integration with SLURM

The integration is described here.

Whitelabeling settings

To set up whitelabeling, you need to define settings in ./config/waldur-mastermind/whitelabeling.yaml. You can see the list of all whitelabeling options below.

General whitelabeling settings

  • site_name
  • site_address
  • site_email
  • site_phone
  • short_page_title
  • full_page_title
  • brand_color
  • brand_label_color
  • hero_link_label
  • hero_link_url
  • site_description
  • currency_name
  • docs_url
  • support_portal_url

Logos and images of whitelabeling

The path to a logo is constructed like so: /etc/waldur/icons - is a path in the container (Keep it like it is) + the name of the logo file from config/whitelabeling directory.

All-together /etc/waldur/icons/file_name_from_whitelabeling_directory

  • powered_by_logo
  • hero_image
  • sidebar_logo
  • sidebar_logo_mobile
  • site_logo
  • login_logo
  • favicon

Waldur deployment in ArgoCD

This repository contains ansible playbook settings for infrastructure setup (ansible/ directory) together with Kubernetes manifest files for different applications managed by ArgoCD (applications/ directory).

Infrastructure setup

Before beginning with application management, infrastructure setup is required. For this, you should use the playbook ansible/cloud-infrastructure-setup.yaml. Given an access to virtual machines with python3.8+ installed, it is capable of:

  1. Disk setup in case if each virtual machine has a separate disk attached as a device;
  2. Installation of RKE2-managed Kubernetes cluster with a single server and workers;
  3. Installation of Helm tool binary;
  4. Installation of ArgoCD: both Kubernetes manifests and command-line binary.

All these steps can be customized via either ansible/vars.defaults or ansible/vars.custom file.

The example infra has 3 VMs with python3.9 installed. After establishing ssh-based connection to the machines, you can execute the playbook:

1
ansible-playbook -i hosts -D cloud-infrastructure-setup.yaml

After successful run, the infra is ready for further steps.

Installation and management of applications

You should run all the command described below on the RKE2 server, where ArgoCD binary installed, only.

Prerequisite

The following lines ensure user login to ArgoCD server via argocd binary. They should run prior to every application-related action.

1
2
3
ARGOCD_SERVER_IP=$(kubectl get service argocd-server -n argocd -o jsonpath={.spec.clusterIP})
ARGOCD_ADMIN_PASSWORD=$(argocd admin initial-password -n argocd | head -n1)
argocd login $ARGOCD_SERVER_IP:80 --username admin --password $ARGOCD_ADMIN_PASSWORD --name default

You can validate authentication and access:

1
2
argocd account get-user-info
argocd app list

Longhorn

You can use this app manifest and this custom values file for Longhorn installation.

This script creates a new Kubernetes namespace, where application is created synched:

1
2
3
kubectl create namespace longhorn-system
argocd app create -f applications/longhorn/application.yaml
argocd app sync argocd/longhorn

PostgreSQL operator

You can use this app manifest and this custom values file for PostgreSQL operator installation.

This script creates a new Kubernetes namespace, where application is created synched:

1
2
3
kubectl create namespace postgres-operator-system
argocd app create -f applications/postgresql-operator/application.yaml
argocd app sync argocd/postgres-operator

Waldur

Waldur requires PostgreSQL database as a persistent storage and RabbitMQ as a message queue to be up and running.

Firstly, you need to create a namespace for Waldur:

1
kubectl create namespace waldur

Secondly, create and sync PostgreSQL application managed by the operator installed before. You can use this manifest for ArgoCD app and this manifest for modification of the DB settings.

1
2
argocd app create -f applications/waldur-postgresql/application.yaml
argocd app sync argocd/waldur-postgresql

Finally, you can deploy Waldur using this app manifest and these values. NB: RabbitMQ is included in the deployment.

1
2
argocd app create -f applications/waldur/application.yaml
argocd app sync argocd/waldur

Ended: Argocd

Waldur Helm

Waldur is a platform for creating hybrid cloud solutions. It allows building enterprise-grade systems and providing self-service environment for the end-users.

Introduction

This chart bootstraps a Waldur deployment on a Kubernetes cluster using the Helm package manager.

Installing prerequisites

  1. Install Kubernetes server, for example, using minikube
  2. Install Kubernetes client, i.e. kubectl
  3. Install Helm

Installing the chart

  1. Clone waldur-helm repository
1
2
  git clone https://github.com/waldur/waldur-helm.git
  cd waldur-helm
  1. Add the stable repository
1
  helm repo add stable https://charts.helm.sh/stable

  1. Setup database: 3.1 Setup single PostgreSQL DB: instructions or 3.2 Setup PostgreSQL HA DB: instructions or 3.3 Integrate with external DB: instructions

    NB Only one of these two options should be used. Otherwise, DB will be unavailable.

  2. Install minio (for database backups): instructions

  3. Install RabbitMQ for task queue: instructions
  4. Install Helm package:
1
  helm install waldur waldur

NB After this command, Waldur release will run in default namespace. Please, pay attention in which namespace which release is running.

For instance, you can install Waldur release in test namespace in the following way:

  1. Create test namespace:
1
  kubectl create namespace test
  1. Install release:
1
  helm install waldur waldur --namespace test

However, postgresql release and waldur should be installed in the same namespace in order to share a common secret with DB credentials.

Adding admin user

Open waldur-mastermind-worker shell and execute the following command:

  1. Get waldur-mastermind-worker pod name
1
2
3
  # Example:
  kubectl get pods -A | grep waldur-mastermind-worker # -->
  # default waldur-mastermind-worker-6d98cd98bd-wps8n 1/1 Running 0 9m9s
  1. Connect to pod via shell
1
2
  # Example:
  kubectl exec -it deployment/waldur-mastermind-worker -- /bin/bash
  1. Execute command to add admin user
1
  waldur createstaffuser -u user -p password -e admin@example.com

Waldur Helm chart release upgrading

Delete init-whitelabeling job (if exists):

1
  kubectl delete job waldur-mastermind-init-whitelabeling-job || true

Delete load features job (if exists):

1
  kubectl delete job load-features-job || true

Upgrade Waldur dependencies and release:

1
2
  helm dep update waldur/
  helm upgrade waldur waldur/

Restart deployments to apply configmaps changes:

1
2
3
4
  kubectl rollout restart deployment waldur-mastermind-beat
  kubectl rollout restart deployment waldur-mastermind-api
  kubectl rollout restart deployment waldur-mastermind-worker
  kubectl rollout restart deployment waldur-homeport

Private registry setup

A user can use private registry for Docker images. For this, the corresponding credentials should be registered in a secret, name of which should be placed in .Values.imagePullSecrets. A secret can be created trough CLI.

Configuration docs

Configuration documentation: index

Waldur Helm chart configuration

Outline:

Bootstrap configuration

You can create a bootstrapping script and Helm will run it right after Waldur release installation.

Example script:

1
2
3
4
5
6
7
8
  #!/bin/bash
  set -e

  echo "[+] Creating staff user"
  waldur createstaffuser -u admin -p admin -e admin@example.com
  echo "[+] Done"

  exit 0

This script with all necessary additional files should be placed in bootstrap.dir directory.

Additional configuration variables (bootstrap prefix):

  1. enabled - enable/disable bootstrap
  2. script - main script file in bootstrap.dir folder.
  3. dir - directory with all bootstrap files

Moreover, that is better to install release with --wait flag:

1
  helm install waldur waldur/ --wait --timeout 10m0s

This allows running migrations job before a bootstrap one. more info: link, Hooks and the Release Lifecycle section)

NB:

  • A script, which contains interaction with a db can fail due to not all migrations are applied. Automatical reruning of the bootstrap job is normal behaviour in such situations.

  • Hence, the script should be idempotent.

External DB integration

Waldur Helm can use an external PostgreSQL deployed within the same Kubernetes cluster.

For this, you need to set the following variables in values.yaml:

  1. externalDB.enabled - toggler for integration; requires postgresql.enabled and postgresqlha.enabled to be false
  2. externalDB.flavor - a type of the DB management system; currently only zalando (Zalando operator) is supported
  3. externalDB.secretName - name of the secret with PostgreSQL credentials for Waldur user; should include username and password keys
  4. externalDB.serviceName - name of the service linked to PostgreSQL master

Zalando-managed PostgreSQL cluster example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
apiVersion: "acid.zalan.do/v1"
kind: postgresql
metadata:
  name: waldur-postgresql-<UNIQUE_SUFFIX_EG_CURRENT_DATE>
spec:
  teamId: "waldur"
  volume:
    size: 20Gi
  numberOfInstances: 2
  users:
    waldur:
    - superuser
    - createdb
  databases:
    waldur: waldur
  postgresql:
    version: "14"
  resources:
    requests:
      cpu: '500m'
      memory: 500Mi
    limits:
      cpu: '1'
      memory: 2Gi

Backup setup

Enable backups for a cluster with the following addition to a manifest file:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
apiVersion: "acid.zalan.do/v1"
kind: postgresql
metadata:
  name: waldur-postgresql-<UNIQUE_SUFFIX_EG_CURRENT_DATE>
spec:
  # ...
  env:
    - name: AWS_ENDPOINT # S3-like storage endpoint
      valueFrom:
        secretKeyRef:
          key: URL
          name: postgres-cluster-backups-minio
    - name: AWS_ACCESS_KEY_ID # Username for S3-like storage
      valueFrom:
        secretKeyRef:
          key: username
          name: postgres-cluster-backups-minio
    - name: AWS_SECRET_ACCESS_KEY # Password for the storage
      valueFrom:
        secretKeyRef:
          key: password
          name: postgres-cluster-backups-minio
    - name: WAL_S3_BUCKET # Bucket name for the storage
      valueFrom:
        secretKeyRef:
          key: bucket
          name: postgres-cluster-backups-minio
    - name: USE_WALG_BACKUP # Enable backups to the storage
      value: 'true'
    - name: USE_WALG_RESTORE # Enable restore for replicas using the storage
      value: 'true'
    - name: BACKUP_SCHEDULE # Base backups schedule
      value: "0 2 * * *"

You also need to create a secret file with the credentials for the storage:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# puhuri-core-dev
apiVersion: v1
kind: Secret
metadata:
  name: postgres-cluster-backups-minio
type: Opaque
data:
  URL: "B64_ENCODED_ENDPOINT"
  username: "B64_ENCODED_USERNAME"
  password: "B64_ENCODED_PASSWORD"
  bucket: "B64_ENCODED_BUCKET"

Trigger a base backup manually

Connect to the leader PSQL pod and execute the following commands:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
su postgres
envdir "/run/etc/wal-e.d/env" /scripts/postgres_backup.sh "/home/postgres/pgdata/pgroot/data"
# Output:
# ...
# INFO: 2023/08/24 10:27:05.159175 Wrote backup with name base_00000009000000010000009C
envdir "/run/etc/wal-e.d/env" wal-g backup-list
# Output:
# name                          modified             wal_segment_backup_start
# ...
# base_00000009000000010000009C 2023-08-24T10:27:05Z 00000009000000010000009C

Restore DB from backup

The preferable option is creation a new instance of PostgreSQL cluster cloning data from the original one.

For this, create a manifest with the following content:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
apiVersion: "acid.zalan.do/v1"
kind: postgresql
metadata:
  name: waldur-postgresql-<UNIQUE_SUFFIX_EG_CURRENT_DATE>
spec:
  clone:
    cluster: "waldur-postgresql-<SUFFIX>" # Name of a reference cluster
    timestamp: "2023-08-24T14:23:00+03:00" # Desired db snapshot time
    s3_wal_path: "s3://puhuri-core-dev/spilo/puhuri-core-dev-waldur-postgresql/wal/" # Path to a directory with WALs in S3 bucket
    s3_force_path_style: true # Use the path above
    env:
    # ...
    - name: CLONE_METHOD # Enable clone
      value: "CLONE_WITH_WALE"
    - name: CLONE_AWS_ENDPOINT # S3-like storage endpoint
      valueFrom:
        secretKeyRef:
          key: URL
          name: postgres-cluster-backups-minio
    - name: CLONE_AWS_ACCESS_KEY_ID # Username for S3-like storage
      valueFrom:
        secretKeyRef:
          key: username
          name: postgres-cluster-backups-minio
    - name: CLONE_AWS_SECRET_ACCESS_KEY # Password for the storage
      valueFrom:
        secretKeyRef:
          key: password
          name: postgres-cluster-backups-minio

Then, apply the manifest to the cluster, change externalDB.{secretName, serviceName} after DB bootstrap and upgrade Waldur release.

Official documentation

Documentation of installation link: Helm

Installing Helm

  1. Download and install Helm
1
2
3
  curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
  chmod 700 get_helm.sh
  ./get_helm.sh
  1. Check the version
1
  helm version

Host aliasing

You can specify additional hosts for Waldur containers in the same manner as the /etc/hosts file using host aliasing. To create aliases, a user needs to modify the hostAliases variable in waldur/values.yaml file. Example:

1
2
3
4
hostAliases:
  - ip: "1.2.3.4"
    hostnames:
      - "my.host.example.com"

This will add a record for my.host.example.com to the /etc/hosts file of all the Waldur containers

HPA setup and configuration

It is possible to use cpu-utilization-based HPA for API server (aka waldur-mastermind-api) and Celery executor (aka waldur-mastermind-worker and waldur-mastermind-beat) pods.

Setup

If you use minikube, you need to enable metrics-server using next command: minikube addons enable metrics-server

Configuration

In values.yaml file you can configure HPA for:

  1. API server (hpa.api prefix):

    1.1 enabled - flag for enabling HPA. Possible values: true for enabling and false for disabling.

    1.2 resources - custom resources for server. requests.cpu param is mandatory for proper HPA work.

    1.3 cpuUtilizationBorder - border percentage of average CPU utilization per pod for deployment.

  2. Celery (hpa.celery prefix):

    2.1 enabled - flag for enabling HPA, the same possible values as for API server.

    2.2 workerResources - custom resources for celery worker. requests.cpu param is mandatory for proper HPA work.

    2.3 beatResources - custom resources for celery beat. requests.cpu param is mandatory for proper HPA work.

    2.4 cpuUtilizationBorder - border percentage of average CPU utilization per pod for deployment.

Limiting network access to Mastermind APIs

Waldur Helm allows limiting network access to Mastermind API endpoints - i.e. /api/, /api-auth/, /admin/ - based on whitelisting the subnets from where access is allowed. To define a list of allowed subnets in CIDR format for the all the API endpoint, please use ingress.whitelistSourceRange option in values.yaml. Example:

1
2
3
4
...
ingress:
  whitelistSourceRange: '192.168.22.0/24'
...

Given this value, only IPs from 192.168.22.0/24 subnet are able to access Waldur Mastermind APIs.

In case you want to limit access to /api/admin/ endpoint specifically, there is another option called ingress.whitelistSourceRangeAdmin:

1
2
3
4
...
ingress:
  whitelistSourceRangeAdmin: '192.168.22.1/32'
...

This will limit access to the admin endpoint only for 192.168.22.1 IP. Note: The whitelistSourceRangeAdmin option takes precedence over whitelistSourceRange.

In case of multiple subnets/IPs, comma separated list can be used as a value. E.g.: 192.168.22.1/32,192.168.21.0/24. This works for both options.

Official documentation

Documentation of installation link: doc

Installing kubectl

  1. Download and install latest kubectl
1
  curl -LO https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
  1. Add executable mode for kubectl
1
  chmod +x ./kubectl
  1. Move kubectl binary into your PATH
1
  sudo mv ./kubectl /usr/local/bin/kubectl
  1. Check the version
1
  kubectl version --client
  1. Show running Pods in cluster
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
  kubectl get po -A # -->
  # NAMESPACE     NAME                             READY STATUS  RESTARTS AGE
  # kube-system   coredns-66bff467f8-dcfxn         1/1   Running 0        ??m
  # kube-system   coredns-66bff467f8-tdgpn         1/1   Running 0        ??m
  # kube-system   etcd-minikube                    1/1   Running 0        ??m
  # kube-system   kindnet-4j8t6                    1/1   Running 0        ??m
  # kube-system   kube-apiserver-minikube          1/1   Running 0        ??m
  # kube-system   kube-controller-manager-minikube 1/1   Running 0        ??m
  # kube-system   kube-proxy-ft67m                 1/1   Running 0        ??m
  # kube-system   kube-scheduler-minikube          1/1   Running 0        ??m
  # kube-system   storage-provisioner              1/1   Running 0        ??m

Locust cofiguration

This chart uses Locust tool for stress testing.

Installation

Locust runs as another standalone Helm release.

Install Locust:

1
  helm install locust stable/locust -f locust-values.yaml

After release installation, some instructions regarding access to WEB UI for Locust printed in stdout.See this section for more information about UI interaction.

Configuration

You can change locust config with the folloving variables in locust-values.yaml:

  1. image.repository - repository of locust image
  2. image.tag - tag of locust image
  3. master.config - key-value configuration records for locust master (used as container env vars)
  4. master.config.locust-host - URL of target mastermind service. See this doc for details
  5. master.config.target-host - same as master.config.locust-host
  6. master.config.locust-mode-master - master mode flag. Please, don't change it, because for new versions of locust this flag is mandatory for a master node.
  7. master.config.locust-locustfile - path to the injected locust file. Please, don't change file directory (/locust-tasks/), because it is fixed mountpoint for pods. The filename itself can have any value, but should be the same as key in the configmap (worker.config.configmapName).
  8. worker.config - key-value configuration records for locust worker (used as container env vars).
  9. worker.config.configmapName - name of configmap with locustfile
  10. worker.config.locust-mode-worker - worker mode flag. Please, don't change it, because for new versions of locust this flag is mandatory for a worker node.
  11. worker.config.locust-locustfile - path to the injected locust file. Same rules as for master.config.locust-locustfile.
  12. worker.config.locust-master-node-host - hostname of the locust master service, which is formatted as <locust_release_name>-master-svc
  13. worker.replicaCount - number of locust workers

You can find available variables for master and worker configuration from chart desription and official locust documentation (most of the flags and args can be injected through env vars).

NB: The original helm chart image (greenbirdit/locust:0.9.0) has outdated locust version and doesn't support most of the current env variables from the first link above. Thus master.config.target-host is used only for compatibility and must be equal to master.config.locust-host

In the values.yaml you need to setup the following vars (stressTesting prefix):

  1. enabled - enable/disable stress testing
  2. locustFilePath - path to the locust file (should be in the waldur/ directory)

Waldur Marketplace script plugin setup

Available options in values.yaml:

  • waldur.marketplace.script.enabled - enable/disable plugin
  • waldur.marketplace.script.dockerImages - key-value structure, where key is a programming language and value - a corresponding docker image tag
  • waldur.marketplace.script.k8sNamespace - Kubernetes namespace, where jobs will be executed
  • waldur.marketplace.script.kubeconfigPath - path to local file with kubeconfig content
  • waldur.marketplace.script.kubeconfig - kubeconfig file content takes precedence over .kubeconfigPath option
  • waldur.marketplace.script.jobTimeout - timeout for Kubernetes jobs

Mastermind templates configuration

If you want to configure custom mastermind templates, you should:

  1. Setup waldur.mastermindTemplating.mastermindTemplatesPath in values.yaml (by default, it is equal to mastermind_templates/mastermind-templates.yaml). Alternatively, you can use waldur.mastermindTemplating.mastermindTemplates containing .yaml file strings to get rid of file usage.

  2. Put all the custom templates into the file in a following way:

NB: The keys in the file should have <waldur_application_name>/<event_name>_<postfix>.<extension>, where <postfix> can be either message or subject, and <extension> - either txt or html

1
2
3
4
5
<file-name1>: |
    <Custom content1>
<file-name2>: |
    <Custom content2>
...

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
users/invitation_notification_message.txt: |
    Hi!
users/invitation_notification_message.html: |
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Invitation has been created</title>
    </head>
    <body>
    <p>
        Hi!
    </p>
    </body>
    </html>
...

Migration from Postgresql HA

Plan:

  1. Scale api, beat, worker -> 0
  2. Backup — using backup job
  3. group_vars/puhuri_core_prd - helm_pg_ha_enabled: no ===> CANCEL THE UPDATING PIPELINE!
  4. Run dependency update ==> leads to a working single psql
  5. Restore DB — using recovery job
  6. Run a common update pipeline
  7. Validate that login works
  8. Drop old psql ha, drop pvc
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Backup
kubectl exec -it postgresql-ha-waldur-postgresql-0 -- env PGPASSWORD=waldur pg_dump -h 0.0.0.0 -U waldur waldur | gzip -9 > backup.sql.gz

# Backup restoration
# Locally
kubectl cp backup.sql.gz postgresql-waldur-0:/tmp/backup.sql.gz
kubectl exec -it postgresql-waldur-0 -- bash

# In pgpool pod
gzip -d /tmp/backup.sql.gz
export PGPASSWORD=waldur
psql -U waldur -h 0.0.0.0 -f /tmp/backup.sql

Official documentation

Documentation of installation link: doc

Installing minikub

  1. Download and install minikube

  2. For Debial/Ubuntu:

1
2
  curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube_1.9.1-0_amd64.deb
  sudo dpkg -i minikube_1.9.1-0_amd64.deb
  • For Fedora/Red Hat
1
2
  curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-1.9.1-0.x86_64.rpm
  sudo rpm -ivh minikube-1.9.1-0.x86_64.rpm
  • Others (direct installation)
1
2
  curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
  sudo install minikube-linux-amd64 /usr/local/bin/minikube
  1. Set docker as a default driver
1
2
3
  minikube config set driver docker
  minikube delete # delete previous profile
  minikube config get driver # --> docker
  1. Start local kubernetes cluster
1
2
3
4
5
6
7
  minikube start
  minikube status # -->
  # m01
  # host: Running
  # kubelet: Running
  # apiserver: Running
  # kubeconfig: Configured

Min.io configuration

Min.io storage is used as a database backup storage.

Add bitnami repo to helm:

1
  helm repo add bitnami https://charts.bitnami.com/bitnami

Install minio release:

1
  helm install minio bitnami/minio -f minio-values.yaml

You can change minio config with next vars (in minio.values file):

  1. accessKey.password - access key id for storage
  2. secretKey.password - secret key itself
  3. serviceAccount.name - name of the service account for MinIO
  4. persistence.enabled - persistence enabling flag
  5. persistence.size - size of storage per each pod
  6. ingress - ingress settings
  7. defaultBuckets - default buckets created after release installation (comma-separated list of strings)

For more configuration values follow this link.

In Waldur Helm values.yaml you need to setup:

  1. minio.accessKey - should be same as accessKey in minio.values.yaml
  2. minio.secretKey - should be same as secretKey in minio.values.yaml
  3. minio.bucketName - should be same as a value from defaultBuckets list in minio-values.yaml
  4. minio.endpoint - access URL to minio storage (minio service host and port). See this doc for details.

PostgreSQL backup configuration

There are the following jobs for backups management:

  • CronJob for backups creation (running by a schedule postgresBackup.schedule)

  • CronJob for backups rotation (running by a schedule postgresBackup.rotationSchedule)

Backup configuration values (postgresBackup prefix):

  • enabled - boolean flag for enabling/disabling backups

  • schedule - cron-like schedule for backups

  • rotationSchedule - cron-like schedule for backups rotation

  • maxNumber - maximum number of backups to store

  • image - Docker image containing potgres and minio (client) binaries (opennode/postgres-minio by default)

Backups restoration

To restore backups you need to connect to the restoration pod. The major prerequisite for this is stopping the Waldur backend pods to avoid errors. NB: During restoration process, the site will be unavailable. For this, please execute the following lines in the Kubernetes node:

1
2
3
4
5
6
# Stop all the API pods
kubectl scale --replicas=0 deployment/waldur-mastermind-api
# Stop all the Celery worker pods
kubectl scale --replicas=0 deployment/waldur-mastermind-worker
# Connect to the restoration pod
kubectl exec -it deployment/waldur-db-restore -- bash

This will give you access to a terminal of a restoration pod. In this shell, please, execute the command:

1
db-backup-minio-auth

This will print the recent 5 backups available for restoration. Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
root@waldur-db-restore-ff7f586bb-nb8jt:/# db-backup-minio-auth
[+] LOCAL_PG_BACKUPS_DIR :
[+] MINIO_PG_BACKUPS_DIR : pg/data/backups/postgres
[+] Setting up the postgres alias for minio server (http://minio.default.svc.cluster.local:9000)
[+] Last 5 backups
[2022-12-01 05:00:02 UTC]  91KiB backup-2022-12-01-05-00.sql.gz
[2022-11-30 05:00:02 UTC]  91KiB backup-2022-11-30-05-00.sql.gz
[2022-11-29 05:00:02 UTC]  91KiB backup-2022-11-29-05-00.sql.gz
[2022-11-28 16:30:37 UTC]  91KiB backup-2022-11-28-16-30.sql.gz
[2022-11-28 16:28:27 UTC]  91KiB backup-2022-11-28-16-28.sql.gz
[+] Finished

As you can see, the backup name contains the date and time when it was created in YYYY-mm-dd-HH-MM format. You can freely choose the one you need.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
  db-backup-minio-auth
  export BACKUP_FILENAME=<SELECTED_BACKUP>
  mc cp pg/$MINIO_BUCKET/backups/postgres/$BACKUP_FILENAME backup.sql.gz
  gzip -d backup.sql.gz
  # Be careful: the next lines have potentially danger operations
  psql -d postgres -c "SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = 'waldur' AND pid <> pg_backend_pid();"
  psql -d postgres -c 'DROP DATABASE waldur;'
  createdb waldur
  psql -f backup.sql
  rm backup.sql

Restoration from external backup

If you want to use a pre-created backup from an external system, copy the backup file:

  1. Copy the backup file to your local machine

  2. Copy the file to pod

    1
2
    export RESTORATION_POD_NAME=$(kubectl get pods --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep restore)
kubectl cp <BACKUP_FILE> $RESTORATION_POD_NAME:/tmp/backup.sql.gz

  3. Connect to pod's terminal

    1
    kubectl exec -it $RESTORATION_POD_NAME -- bash

  4. Apply the backup

    1
2
3
4
5
6
7
    gzip -d /tmp/backup.sql.gz
# Be careful: the next lines have potentially danger operations
psql -d postgres -c "SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = 'waldur' AND pid <> pg_backend_pid();"
psql -d postgres -c 'DROP DATABASE waldur;'
createdb waldur
psql -f /tmp/backup.sql
rm /tmp/backup.sql

PostgreSQL HA chart configuration

bitnami/postgresql-ha is used as a highly available database for Waldur.

Standalone installation

Add bitnami repo to helm:

1
  helm repo add bitnami https://charts.bitnami.com/bitnami

Install postgresql-ha release:

1
2
  helm install postgresql-ha bitnami/postgresql-ha \
    -f postgresql-ha-values.yaml --version 11.7.4

NB: the value postgresql.HAEnabled for waldur release must be true.

Chart configuration

You can change default PostgreSQL config with the following variables in values.yaml (postgresql-ha-values.yaml file):

  1. postgresql.database - name of a database. NB: must match postgresql.database value in waldur/values.yaml
  2. postgresql.username - name of a database user. NB: must match postgresql.username value in waldur/values.yaml
  3. postgresql.password - password of a database user
  4. postgresql.replicaCount - number of db replicas
  5. postgresql.syncReplication - enable/disable synchronous replication
  6. postgresql.repmgrUsername - username of repmgr user
  7. postgresql.repmgrPassword - password of repmgr user
  8. persistence.size - size of a database (for each replica)
  9. pgpoolImage.tag - tag of Pgpool image. Possible tags for default image can be found here
  10. postgresqlImage.tag - tag of PostgreSQL image. Possible tags for default image can be found here
  11. pgpoolImage.tag - registry of Pgpool image.
  12. postgresqlImage.tag - registry of PostgreSQL image.

More information related to possible values here.

Dependency installation

Waldur Helm chart supports PostgreSQL HA installation as a dependency. For this, set postgresqlha.enabled to true and update related settings in postgresqlha section in waldur/values.yaml

NB: the value postgresql.enabled and externalDB.enabled must be false.

Prior Waldur installation, update chart dependencies:

1
helm dependency update

PostgreSQL chart configuration (without HA support)

bitnami/postgresql chart is used as a database for Waldur.

Standalone installation

Add bitnami repo to helm:

1
  helm repo add bitnami https://charts.bitnami.com/bitnami

Install postgresql release:

1
  helm install postgresql bitnami/postgresql --version 11.9.1 -f postgresql-values.yaml

NB: the values postgresql.enabled and postgresqlha.enabled must be false.

Chart configuration

You can change default PostgreSQL config with the following variables in postgresql-values.yaml:

  1. auth.database - name of a database. NB: must match postgresql.database value in waldur/values.yaml
  2. auth.username - name of a database user. NB: must match postgresql.username value in waldur/values.yaml
  3. auth.password - password of a database user
  4. primary.persistence.size - size of a database
  5. image.tag - tag of PostgreSQL image. Possible tags for default image can be found here
  6. image.registry - registry of PostgreSQL image.

More information related to possible values here.

Dependency installation

Waldur Helm chart supports PostgreSQL installation as a dependency. For this, set postgresql.enabled to true and update related settings in postgresql section in waldur/values.yaml

NB: the value postgresqlha.enabled and externalDB.enabled must be false.

Prior Waldur installation, update chart dependencies:

1
helm dependency update

Proxy setup for Waldur components

You can setup the proxy environment variables https_proxy, http_proxy and no_proxy for Waldur component containers. For this, please set values for the proxy.httpsProxy, proxy.httpProxy and proxy.noProxy variables in waldur/values.yaml file.

Example:

1
2
3
4
proxy:
  httpsProxy: "https://proxy.example.com/"
  httpProxy: "http://proxy.example.com/"
  noProxy: ".test"

Note: you can set variables separately, i.e. leave some of them blank:

1
2
3
4
proxy:
  httpsProxy: ""
  httpProxy: "http://proxy.example.com/"
  noProxy: ".test"

In the previous example, the https_proxy env variable won't be present in the containers.

RabbitMQ configuration

For rabbitmq installation, bitnami/rabbitmq is used.

Installation

Add bitnami repo to helm:

1
  helm repo add bitnami https://charts.bitnami.com/bitnami

Install rabbitmq-ha release:

1
  helm install rmq bitnami/rabbitmq --version 10.3.5 -f rmq-values.yaml

Configuration

You can change rabbitmq config with the following variables in rmq-values.yaml:

  1. replicaCount - number RMQ instances
  2. persistence.enabled - enable/disable persistence
  3. persistence.size - size for singe PV
  4. persistence.storageClass - storage class for PV
  5. auth.username - username for RMQ user
  6. auth.password - password for RMQ user

For more config values, see this section

In values.yaml file, you need to setup the following vars (rabbitmq prefix):

  1. user - should be same as auth.username in the rmq-values.yaml file
  2. password - should be same as auth.password in the rmq-values.yaml file
  3. host - rabbitmq-ha service hostname (See this doc for details)
  4. customManagementPort - custom port for rabbitmq management interface
  5. customAMQPPort - custom port for AMQP access

SAML2 configuration

To configure SAML2 for Waldur:

  1. Enable SAML2 support in values.yaml: add SAML2 string into waldur.authMethods list
  2. Set source directory in waldur.saml2.dir
  3. Place necessary files in the directory with the following manner (. is the source directory root):
    • sp.crt -> ./
    • sp.pem -> ./
    • saml2.conf.py -> ./

Service endpoints

For communication inside a cluster, pods use services. Usually, that needs to define internal endpoints with service URL format.

NB: It is important to set up namespace part correctly. If not, requests can come to unexpected service, which will cause errors.

Endpoint format

Fully qualified endpoint format is:

1
http://<service-name>.<namespace>.svc.<cluster>:<service-port>

Where

  • <service-name>.<namespace>.svc.<cluster> - hostname of service
  • <service-port> - port of service

For example:

  • hostname is elasticsearch-master.elastic.svc.cluster.local
  • service port is 9200
  • final URL is http://elasticsearch-master.elastic.svc.cluster.local:9200

If pods run in the same namespace and cluster, it can be simplified to:

1
http://<service-name>:<service-port>

For example: http://elasticsearch-master:9200

TLS configuration instructions

To enable tls globally please set ingress.tls.enabled=true in values.yaml

Let’s Encrypt setup

It you want co configure letsencrypt certification, you need to:

  1. Set ingress.tls.source="letsEncrypt" in values.yaml
  2. Create namespace for cert-manager
1
kubectl create namespace cert-manager
  1. Add repository and update repos list
1
2
  helm repo add jetstack https://charts.jetstack.io
  helm repo update
  1. Install cert-manager release
1
2
3
4
5
  helm install \
    cert-manager jetstack/cert-manager \
    --namespace cert-manager \
    --version v1.7.1 \
    --set installCRDs=true
  1. After that, waldur release is ready for installation.

Your own certificate

In case, when you want to use own certificate, you need to:

  1. Set ingress.tls.source="secret" in values.yaml
  2. Set ingress.tls.secretsDir variable to directory with your tls.crt and tls.key files. By default it is set to tls
  3. After that, waldur release is ready for installation

White-labeling instructions

To setup white-labeling, you can define next variables in waldur/values.yaml file:

  • shortPageTitle - custom prefix for page title
  • modePageTitle - custom page title
  • loginLogoPath - path to custom .png image file for login page (should be in waldur/ chart directory)
  • sidebarLogoPath - path to custom .png image file for sidebar header (should be in waldur/ chart directory)
  • sidebarLogoDarkPath - path to custom .png image file for sidebar header in dark mode (should be in waldur/ chart directory)
  • poweredByLogoPath - path to custom .png image file for "powered by" part of login page (should be in waldur/ chart directory)
  • faviconPath - path to custom favicon .png image file
  • tosHtmlPath - path to custom terms of service file (tos.html)
  • privacyHtmlPath - path to custom privacy statement file (privacy.html)
  • brandColor - Hex color definition is used in HomePort landing page for login button.
  • brandLabelColor - Hex color definition is used in HomePort landing page for font color of login button.
  • heroImagePath - Relative path to image rendered at hero section of HomePort landing page.
  • heroLinkLabel - Label for link in hero section of HomePort landing page. It can be lead to support site or blog post.
  • heroLinkUrl - Link URL in hero section of HomePort landing page.
  • siteDescription - text at hero section of HomePort landing page.

NB:

  • the *Path values take place only if respectful *Url values are not specified. If both types are defined, the precedence is taken by URL(*Url) for all cases.
  • all of imported files must be within chart root directory

Alternatively, TOS and PP files content can be provided as multiline values in tosHtml and privacyHtml options respectfully. If defined, they take precedence over the aforementioned ones.

Ended: Docs

Ended: Helm

Ended: Deployment

LDAP

Waldur allows you to authenticate using identities from a LDAP server.

Prerequisites

  • Below it is assumed that LDAP server is provided by FreeIPA. Although LDAP authentication would work with any other LDAP server as well, you may need to customize configuration for Waldur MasterMind.
  • Please ensure that Waldur Mastermind API server has access to the LDAP server. By default LDAP server listens on TCP and UDP port 389, or on port 636 for LDAPS (LDAP over SSL). If this port is filtered out by firewall, you wouldn't be able to authenticate via LDAP.
  • You should know LDAP server URI, for example, FreeIPA demo server has ldap://ipa.demo1.freeipa.org.
  • You should know username and password of LDAP admin user. For example, FreeIPA demo server uses username=admin and password=Secret123.

Add LDAP configuration to Waldur Mastermind configuration

Example configuration is below, please adjust to your specific deployment.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import ldap
from django_auth_ldap.config import LDAPSearch, GroupOfNamesType

# LDAP authentication.
# See also: https://django-auth-ldap.readthedocs.io/en/latest/authentication.html
AUTHENTICATION_BACKENDS += (
    'django_auth_ldap.backend.LDAPBackend',
)

AUTH_LDAP_SERVER_URI = 'ldap://ipa.demo1.freeipa.org'

# Following variables are not used by django-auth-ldap,
# they are used as templates for other variables
AUTH_LDAP_BASE = 'cn=accounts,dc=demo1,dc=freeipa,dc=org'
AUTH_LDAP_USER_BASE = 'cn=users,' + AUTH_LDAP_BASE

# Format authenticating user's distinguished name using template
AUTH_LDAP_USER_DN_TEMPLATE = 'uid=%(user)s,' + AUTH_LDAP_USER_BASE

# Credentials for admin user
AUTH_LDAP_BIND_DN = 'uid=admin,' + AUTH_LDAP_USER_BASE
AUTH_LDAP_BIND_PASSWORD = 'Secret123'

# Populate the Django user from the LDAP directory.
AUTH_LDAP_USER_ATTR_MAP = {
    'full_name': 'displayName',
    'email': 'mail'
}

# Set up the basic group parameters.
AUTH_LDAP_GROUP_BASE = "cn=groups," + AUTH_LDAP_BASE
AUTH_LDAP_GROUP_FILTER = "(objectClass=groupOfNames)"
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(AUTH_LDAP_GROUP_BASE,
    ldap.SCOPE_SUBTREE, AUTH_LDAP_GROUP_FILTER)
AUTH_LDAP_GROUP_TYPE = GroupOfNamesType(name_attr="cn")

AUTH_LDAP_USER_FLAGS_BY_GROUP = {
    'is_staff': 'cn=admins,' + AUTH_LDAP_GROUP_BASE,
    'is_support': 'cn=support,' + AUTH_LDAP_GROUP_BASE,
}

Configuration above is based on LDAP server exposed by FreeIPA. To make it work, there are some things that need to be verified in FreeIPA:

  1. Ensure that admins and support groups exist in LDAP server. You may do it using FreeIPA admin UI. FreeIPA groups
  2. If user is assigned to admins group in LDAP, he becomes staff in Waldur. If user is assigned to support group in LDAP, he becomes support user in Waldur. For example, consider the manager user which belong to both groups:

Manager user

Field mapping

displayName attribute in LDAP is mapped to full_name attribute in Waldur. mail field in LDAP is mapped to email attribute in Waldur.

Consider for example, the following user attributes in LDAP:

LDAP explorer

Here's how it is mapped in Waldur:

Waldur admin

And here's how it is displayed when user initially logs into Waldur via HomePort:

Homeport login

MyAccessID

Waldur supports integration with MyAccessID identity service.

The MyAccessID Identity and Access Management Service is provided by GEANT with the purpose of offering a common Identity Layer for Infrastructure Service Domains (ISDs).

The AAI proxy of MyAccessID connects Identity Providers from eduGAIN, specific IdPs which are delivered in context of ISDs such as HPC IdPs, eIDAS eIDs and potentially other IdPs as requested by ISDs.

MyAccessID delivers the Discovery Service used during the user authentication process for users to choose their IdP. It enables the user to register an account in the Account Registry, to link different identities and it guarantees the uniqueness and persistence of the user identifier towards connected ISDs.

To enable MyAccessID, please register a new client for Waldur deployment and set configuration settings for MyAccessID. Check configuration guide for available settings.

Fetch user data using CUID of a user

You can use CUID of user in order to fetch user permissions from MyAccessID registry. This document describes how to perform it via Waldur shell.

TARA

Waldur supports integration with TARA authentication service.

To enable it, please register a new client for Waldur deployment and set configuration settings for TARA. Check configuration guide for available settings.

eduGAIN

Overview

eduGAIN is a global federation of identity and service providers, based technically on SAML2.

In order to allow eduGAIN users to access Waldur, there are two steps:

  • Waldur deployment must be registered as a service provider in eduGAIN federation.
  • Waldur must get a list of identities that are trusted for authentication.

Tip

SAML is a complicated and fragile technology. GEANT provides an alternative to direct integration of SAML - eduTEAMS, which exposes an OpenID Connect protocol for service providers.

Waldur relies on djangosaml2 for the heavylifting of SAML processing, so for fine tuning configuration, contact corresponding project documentation.

Registering Waldur as Service Provider

Add SAML configuration to Waldur Mastermind configuration

Example configuration is below, please adjust to your specific deployment. Once applied, service metadata will be visible at Waldur deployment URL: https://waldur.example.com/api-auth/saml2/metadata/. That data needs to be propagated to the federation operator for inclusion into the federation.

Tip

Managed ansible simplifies configuration of the eduGAIN integration and should be a preferred method for all supported deployments.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
import datetime

import saml2
from saml2.entity_category.edugain import COC


WALDUR_AUTH_SAML2 = {
    # used for assigning the registration method to the user
    'name': 'saml2',
    # full path to the xmlsec1 binary program
    'xmlsec_binary': '/usr/bin/xmlsec1',
    # required for assertion consumer, single logout services and entity ID
    'base_url': '',
    # directory with attribute mapping
    'attribute_map_dir': '',
    # set to True to output debugging information
    'debug': False,
    # IdPs metadata XML files stored locally
    'idp_metadata_local': [],
    # IdPs metadata XML files stored remotely
    'idp_metadata_remote': [],
    # logging
    # empty to disable logging SAML2-related stuff to file
    'log_file': '',
    'log_level': 'INFO',
    # Indicates if the entity will sign the logout requests
    'logout_requests_signed': 'true',
    # Indicates if the authentication requests sent should be signed by default
    'authn_requests_signed': 'true',
    # Identifies the Signature algorithm URL according to the XML Signature specification
    # SHA1 is used by default
    'signature_algorithm': None,
    # Identifies the Message Digest algorithm URL according to the XML Signature specification
    # SHA1 is used by default
    'digest_algorithm': None,
    # Identified NameID format to use. None means default, empty string ("") disables addition of entity
    'nameid_format': None,
    # PEM formatted certificate chain file
    'cert_file': '',
    # PEM formatted certificate key file
    'key_file': '',
    # SAML attributes that are required to identify a user
    'required_attributes': [],
    # SAML attributes that may be useful to have but not required
    'optional_attributes': [],
    # mapping between SAML attributes and User fields
    'saml_attribute_mapping': {},
    # organization responsible for the service
    # you can set multilanguage information here
    'organization': {},
    # links to the entity categories
    'categories': [COC],
    # attributes required by CoC
    # https://wiki.refeds.org/display/CODE/SAML+2+Profile+for+the+Data+Protection+Code+of+Conduct
    'privacy_statement_url': 'http://example.com/privacy-policy/',
    'display_name': 'Service provider display name',
    'description': 'Service provider description',
    # mdpi attributes
    'registration_policy': 'http://example.com/registration-policy/',
    'registration_authority': 'http://example.com/registration-authority/',
    'registration_instant': datetime.datetime(2017, 1, 1).isoformat(),
    'ENABLE_SINGLE_LOGOUT': False,
    'ALLOW_TO_SELECT_IDENTITY_PROVIDER': True,
    'IDENTITY_PROVIDER_URL': None,
    'IDENTITY_PROVIDER_LABEL': None,
    'DEFAULT_BINDING': saml2.BINDING_HTTP_POST,
    'DISCOVERY_SERVICE_URL': None,
    'DISCOVERY_SERVICE_LABEL': None,
}

Example of generated metadata

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<?xml version="1.0" encoding="UTF-8"?>
<ns0:EntityDescriptor xmlns:ns0="urn:oasis:names:tc:SAML:2.0:metadata" xmlns:ns1="urn:oasis:names:tc:SAML:metadata:attribute" xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns4="urn:oasis:names:tc:SAML:metadata:algsupport" xmlns:ns5="urn:oasis:names:tc:SAML:metadata:rpi" xmlns:ns6="urn:oasis:names:tc:SAML:metadata:ui" xmlns:ns7="http://www.w3.org/2000/09/xmldsig#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" entityID="https://api.etais.ee/api-auth/saml2/metadata/">
   <ns0:Extensions>
      <ns1:EntityAttributes>
         <ns2:Attribute Name="http://macedir.org/entity-category" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
            <ns2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">http://www.geant.net/uri/dataprotection-code-of-conduct/v1</ns2:AttributeValue>
         </ns2:Attribute>
      </ns1:EntityAttributes>
      <ns4:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
      <ns4:DigestMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#sha224" />
      <ns4:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" />
      <ns4:DigestMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#sha384" />
      <ns4:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha512" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2000/09/xmldsig#dsa-sha1" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2009/xmldsig11#dsa-sha256" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha224" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha224" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha384" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha512" />
      <ns5:RegistrationInfo registrationAuthority="http://taat.edu.ee" registrationInstant="2017-01-01T00:00:00">
         <ns5:RegistrationPolicy xml:lang="en">http://taat.edu.ee/main/wp-content/uploads/Federation_Policy_1.3.pdf</ns5:RegistrationPolicy>
      </ns5:RegistrationInfo>
   </ns0:Extensions>
   <ns0:SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol" AuthnRequestsSigned="true" WantAssertionsSigned="true">
      <ns0:Extensions>
         <ns6:UIInfo>
            <ns6:DisplayName xml:lang="en">ETAIS Self-Service</ns6:DisplayName>
            <ns6:Description xml:lang="en">Self-service for users of Estonian Scientific Computing Infrastructure (ETAIS)</ns6:Description>
            <ns6:Logo>https://minu.etais.ee/login-logo.png</ns6:Logo>
            <ns6:PrivacyStatementURL xml:lang="en">https://minu.etais.ee/views/policy/privacy-full.html</ns6:PrivacyStatementURL>
         </ns6:UIInfo>
      </ns0:Extensions>
      <ns0:KeyDescriptor use="signing">
         <ns7:KeyInfo>
            <ns7:X509Data>
               <ns7:X509Certificate>MIIDVzCCAj+gAwIBAgIJAN80zoFR2/UbMA0GCSqGSIb3DQEBCwUAMEIxCzAJBgNV BAYTAlhYMRUwEwYDVQQHDAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQg Q29tcGFueSBMdGQwHhcNMTcwNDIxMDczMzA1WhcNMjcwNDIxMDczMzA1WjBCMQsw CQYDVQQGEwJYWDEVMBMGA1UEBwwMRGVmYXVsdCBDaXR5MRwwGgYDVQQKDBNEZWZh dWx0IENvbXBhbnkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA o87tb/hEU/igqFPtCFKMvC6LozTbH9y3I4lUVH38FDavDzrHAg1sVr5FEqguApeT xr/cmzsFMIB+XkAf9oI8xi2lUdorgeZFPFnUH0um4yXIJwBjrmgofUcybt84ee44 tM7AZKCAhinFDQUbjYV1LQP44QvFdGiklHGoo2NaVEqJwH6ce/8ioG5aFf2ISS6p fh3qOGVuQgansHFn+v+CvX+JU6FHB7mP+h3Xv+AoVjPz7b7E58rxn9qspy/N4LbB iDk7iBidsXEWYwYsSVP2cTrgKFktn5tB4YYZe0pSZNoCeVq05RK7kBy8yYCWTVZN Emkz5avL9Z2SDaGLY/9CTwIDAQABo1AwTjAdBgNVHQ4EFgQUrdY8o4OeseOy7ReD ZEZCKUZTk2gwHwYDVR0jBBgwFoAUrdY8o4OeseOy7ReDZEZCKUZTk2gwDAYDVR0T BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAoaygm+5U4j3/djWGQulXS2gdrPJV AS8zBuzQPVkhH76WcD8wxzuoceM80jPWLcP6Eq5Tma7rrqOE+QHrY8bm7LIYUEn2 fK/whozFyZ+TswEaDRjN6wL/FDuhu472Lnsg3rvE6s0eW1nlOHuqmqBQPb/kIMOj B3KOI6pqEfb+FqiZ2J/u/4KiOWaA8X9JQUo+HzWNEAPnNUoTl/yGr0Ad6z9YFbsu VnvJVTtGcu8pB5cjm7UtfN73ywEm/a/QXplus0U/Kv5XsSqaGa/Gw6pyX8LOc2yq I0XyOzj7DUcvMVZr5Vf/FVO2Od0Pb03+Wv4JRB5vXM1MsU+xAVgCm0pfew==</ns7:X509Certificate>
            </ns7:X509Data>
         </ns7:KeyInfo>
      </ns0:KeyDescriptor>
      <ns0:KeyDescriptor use="encryption">
         <ns7:KeyInfo>
            <ns7:X509Data>
               <ns7:X509Certificate>MIIDVzCCAj+gAwIBAgIJAN80zoFR2/UbMA0GCSqGSIb3DQEBCwUAMEIxCzAJBgNV BAYTAlhYMRUwEwYDVQQHDAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQg Q29tcGFueSBMdGQwHhcNMTcwNDIxMDczMzA1WhcNMjcwNDIxMDczMzA1WjBCMQsw CQYDVQQGEwJYWDEVMBMGA1UEBwwMRGVmYXVsdCBDaXR5MRwwGgYDVQQKDBNEZWZh dWx0IENvbXBhbnkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA o87tb/hEU/igqFPtCFKMvC6LozTbH9y3I4lUVH38FDavDzrHAg1sVr5FEqguApeT xr/cmzsFMIB+XkAf9oI8xi2lUdorgeZFPFnUH0um4yXIJwBjrmgofUcybt84ee44 tM7AZKCAhinFDQUbjYV1LQP44QvFdGiklHGoo2NaVEqJwH6ce/8ioG5aFf2ISS6p fh3qOGVuQgansHFn+v+CvX+JU6FHB7mP+h3Xv+AoVjPz7b7E58rxn9qspy/N4LbB iDk7iBidsXEWYwYsSVP2cTrgKFktn5tB4YYZe0pSZNoCeVq05RK7kBy8yYCWTVZN Emkz5avL9Z2SDaGLY/9CTwIDAQABo1AwTjAdBgNVHQ4EFgQUrdY8o4OeseOy7ReD ZEZCKUZTk2gwHwYDVR0jBBgwFoAUrdY8o4OeseOy7ReDZEZCKUZTk2gwDAYDVR0T BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAoaygm+5U4j3/djWGQulXS2gdrPJV AS8zBuzQPVkhH76WcD8wxzuoceM80jPWLcP6Eq5Tma7rrqOE+QHrY8bm7LIYUEn2 fK/whozFyZ+TswEaDRjN6wL/FDuhu472Lnsg3rvE6s0eW1nlOHuqmqBQPb/kIMOj B3KOI6pqEfb+FqiZ2J/u/4KiOWaA8X9JQUo+HzWNEAPnNUoTl/yGr0Ad6z9YFbsu VnvJVTtGcu8pB5cjm7UtfN73ywEm/a/QXplus0U/Kv5XsSqaGa/Gw6pyX8LOc2yq I0XyOzj7DUcvMVZr5Vf/FVO2Od0Pb03+Wv4JRB5vXM1MsU+xAVgCm0pfew==</ns7:X509Certificate>
            </ns7:X509Data>
         </ns7:KeyInfo>
      </ns0:KeyDescriptor>
      <ns0:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://api.etais.ee/api-auth/saml2/logout/complete/" />
      <ns0:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.etais.ee/api-auth/saml2/logout/complete/" />
      <ns0:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.etais.ee/api-auth/saml2/login/complete/" index="1" />
      <ns0:AttributeConsumingService index="1">
         <ns0:ServiceName xml:lang="en">ETAIS Self-Service</ns0:ServiceName>
         <ns0:RequestedAttribute Name="urn:mace:dir:attribute-def:cn" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="cn" isRequired="true" />
         <ns0:RequestedAttribute Name="urn:oid:0.9.2342.19200300.100.1.3" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="mail" isRequired="true" />
         <ns0:RequestedAttribute Name="schacPersonalUniqueID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" isRequired="true" />
         <ns0:RequestedAttribute Name="urn:oid:1.3.6.1.4.1.5923.1.1.1.6" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="eduPersonPrincipalName" isRequired="true" />
         <ns0:RequestedAttribute Name="schacHomeOrganization" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" isRequired="false" />
         <ns0:RequestedAttribute Name="urn:oid:2.16.840.1.113730.3.1.39" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="preferredLanguage" isRequired="false" />
         <ns0:RequestedAttribute Name="urn:oid:1.3.6.1.4.1.5923.1.1.1.9" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="eduPersonScopedAffiliation" isRequired="false" />
      </ns0:AttributeConsumingService>
   </ns0:SPSSODescriptor>
   <ns0:Organization>
      <ns0:OrganizationName xml:lang="et">ETAIS</ns0:OrganizationName>
      <ns0:OrganizationName xml:lang="en">ETAIS</ns0:OrganizationName>
      <ns0:OrganizationDisplayName xml:lang="et">ETAIS</ns0:OrganizationDisplayName>
      <ns0:OrganizationDisplayName xml:lang="en">ETAIS</ns0:OrganizationDisplayName>
      <ns0:OrganizationURL xml:lang="et">http://etais.ee/</ns0:OrganizationURL>
      <ns0:OrganizationURL xml:lang="en">http://etais.ee/</ns0:OrganizationURL>
   </ns0:Organization>
   <ns0:ContactPerson contactType="technical">
      <ns0:GivenName>Administrator</ns0:GivenName>
      <ns0:EmailAddress>etais@etais.ee</ns0:EmailAddress>
   </ns0:ContactPerson>
</ns0:EntityDescriptor>

Adding trusted identity providers

In order to configure Waldur to use SAML2 authentication you should specify identity provider metadata.

  • If metadata XML is stored locally, it is cached in the local SQL database. Usually metadata XML file is big, so it is necessary to use local cache in this case. But you should ensure that metadata XML file is refreshed via cron on a regular basis. A management command waldur sync_saml2_providers performs refreshing of the data.
  • If metadata XML is accessed remotely, it is not cached in SQL database. Therefore you should ensure that metadata XML is small enough. In this case you should download metadata signing certificate locally and specify its path in Waldur configuration. The certificate is used to retrieve the metadata securely. Please note that security certificates are updated regularly, therefore you should update configuration whenever certificate is updated. By convention, both metadata signing certificate and metadata itself are downloaded to /etc/waldur/saml2 in Waldur Mastermind instances.

References

TAAT configuration

TaaT certificates can be downloaded from: http://taat.edu.ee/main/dokumendid/sertifikaadid/.

Metadata URL for test hub is https://reos.taat.edu.ee/saml2/idp/metadata.php and for production hub is https://sarvik.taat.edu.ee/saml2/idp/metadata.php. Note, the certificate must correspond to the hub you want connect to.

Using Janus

Janus is a self-service for managing Service Provider records.

  • Create a new connection:

Janus

New connection ID must be equal to the base_url in saml.conf.py + /apu-auth/saml2/metadata/

  • Choose SAML 2.0 SP for connection type.
  • Click Create button
  • In connection tab select or create ARP. Fields that ARP include must be in the saml_attribute_mapping.
  • Navigate to the Import metadata tab and paste same URL as in the first step. Click on the Get metadata.
  • Navigate to the Validate tab and check whether all the tests pass. You can fix metadata in Metadata tab.

HAKA configuration

Production hub metadata is described at https://wiki.eduuni.fi/display/CSCHAKA/Haka+metadata.

Test hub metadata is described at https://wiki.eduuni.fi/display/CSCHAKA/Verifying+Haka+compatibility.

FEDI configuration

Production hub metadata is described at https://fedi.litnet.lt/en/metadata.

Discovery is supported: https://discovery.litnet.lt/simplesaml/module.php/discopower/disco.php.

eduTEAMS

Waldur supports integration with eduTEAMS identity service.

To enable it, please register a new client for Waldur deployment and set configuration settings for eduTEAMS. Check configuration guide for available settings.

Fetch user data using CUID of a user

You can use CUID of user in order to fetch user permissions. This file describes how to perform it, you only need to provide CUID as a username.

FreeIPA

Tip

For integrating FreeIPA as source of identities, please see LDAP. This module is about synchronising users from Waldur to FreeIPA

For situations when you would like to provide access to services based on the Linux usernames, e.g. for SLURM deployments, you might want to map users from Waldur (e.g. created through eduGAIN) to an external FreeIPA service.

To do that, you need to enable module and define settings for accessing FreeIPA REST APIs. See Waldur configuration guide for the list of supported FreeIPA settings.

At the moment at most one deployment of FreeIPA per Waldur is supported.

Keycloak

Waldur supports integration with Keycloak identity manager.

Below is a guide to configure Keycloak OpenID Connect client and Waldur intergration.

Configuring Keycloak

Instructions below are aimed to provide a basic configuration of Keycloak, please refer to Keycloak documentation for full details.

  1. Login to admin interface of Keycloak.
  2. Create a new realm (or use existing) New realm
  3. Open a menu with a list of clients. List clients
  4. Add a new client for Waldur. Add client
  5. Change client's access type to "confidential". Set access type
  6. Change client's Valid redirect URIs to "*". Valid redirect URIs
  7. You can get secret code for the client configuration Secret code
  8. You can find the settings required for configuration of Waldur under the following path on your Keycloak deployment (change test-waldur to the realm that you are using): /auth/realms/test-waldur/.well-known/openid-configuration

Configuring Waldur

  1. Add Keycloak related configuration to Mastermind's override.py:

    1
2
3
4
5
6
    WALDUR_AUTH_SOCIAL.update({'KEYCLOAK_AUTH_URL': 'https://KEYCLOAK_ADDRESS:8080/auth/realms/test-waldur/.well-known/openid-configuration',
 'KEYCLOAK_CLIENT_ID': 'CLIENT_ID',
 'KEYCLOAK_SECRET': 'SECRET',
 'KEYCLOAK_TOKEN_URL': 'https://KEYCLOAK_ADDRESS:8080/auth/realms/test-waldur/protocol/openid-connect/token',
 'KEYCLOAK_USERINFO_URL': 'https://KEYCLOAK_ADDRESS:8080/auth/realms/test-waldur/protocol/openid-connect/userinfo'
})

  2. Make sure SOCIAL_SIGNUP is added to the list of available authentication methods:

    1
    WALDUR_CORE['AUTHENTICATION_METHODS'] = ["LOCAL_SIGNIN", "SOCIAL_SIGNUP"]

    Full Keycloak related configuration settings are available at Mastermind configuration file reference

Summary

Name Protocol Description
eduGAIN SAML Federation of research and educational providers supported by Geant
eduTEAMS OIDC Group management service integrated with research and educational providers provided by Geant
FreeIPA REST API Support for synchronisation of Waldur identities with open-source Identity Management server
Keycloak OIDC Open-source identity management server
LDAP LDAP/S Support of identity servers over LDAP protocol
TARA OIDC Estonian State Autentication service

Ended: Identities

CLI guide

axes_list_attempts

List access attempts

axes_reset

Reset all access attempts and lockouts

axes_reset_failure_logs

Reset access failure log records older than given days.

1
2
3
4
usage: waldur axes_reset_failure_logs [--age AGE]

options:
  --age AGE  Maximum age for records to keep in days

axes_reset_ip

Reset all access attempts and lockouts for given IP addresses

1
2
3
4
usage: waldur axes_reset_ip ip [ip ...]

positional arguments:
  ip

axes_reset_logs

Reset access log records older than given days.

1
2
3
4
usage: waldur axes_reset_logs [--age AGE]

options:
  --age AGE  Maximum age for records to keep in days

axes_reset_username

Reset all access attempts and lockouts for given usernames

1
2
3
4
usage: waldur axes_reset_username username [username ...]

positional arguments:
  username

clean_settings_cache

Clean API configuration settings cache.

cleanup_stale_event_types

Cleanup stale event types in all hooks.

copy_category

Copy structure of categories for the Marketplace

1
2
3
4
5
usage: waldur copy_category source_category_uuid target_category_uuid

positional arguments:
  source_category_uuid  UUID of a category to copy metadata from
  target_category_uuid  UUID of a category to copy metadata to

create_provider

Create a service provider with a linked customer and load categories

1
2
3
4
5
usage: waldur create_provider [-n N] [-c C [C ...]]

options:
  -n N          Customer name
  -c C [C ...]  List of categories to load

createstaffuser

Create a user with a specified username and password. User will be created as staff.

1
2
3
4
5
6
usage: waldur createstaffuser -u USERNAME -p PASSWORD -e EMAIL

options:
  -u USERNAME, --username USERNAME
  -p PASSWORD, --password PASSWORD
  -e EMAIL, --email EMAIL

drop_leftover_openstack_projects

Drop leftover projects from remote OpenStack deployment. Leftovers are resources marked as terminated in Waldur but still present in the remote OpenStack. Such inconsistency may be caused by split brain problem in the distributed database.

1
2
3
4
5
6
7
8
9
usage: waldur drop_leftover_openstack_projects [--offering OFFERING]
                                               [--dry-run] [--fuzzy-matching]

options:
  --offering OFFERING  Target marketplace offering name where leftover
                       projects are located.
  --dry-run            Don't make any changes, instead show what projects
                       would be deleted.
  --fuzzy-matching     Try to detect leftovers by name.

dumpusers

Dumps information about users, their organizations and projects.

1
2
3
4
5
6
usage: waldur dumpusers [-o OUTPUT]

options:
  -o OUTPUT, --output OUTPUT
                        Specifies file to which the output is written. The
                        output will be printed to stdout by default.

export_ami_catalog

Export catalog of Amazon images.

export_auth_social

Export OIDC auth configuration as YAML format

1
2
3
4
5
6
usage: waldur export_auth_social [-o OUTPUT]

options:
  -o OUTPUT, --output OUTPUT
                        Specifies file to which the output is written. The
                        output will be printed to stdout by default.

export_offering

Export an offering from Waldur. Export data includes JSON file with an offering data and a thumbnail. Names of this files include offering ID.

1
2
3
4
5
6
7
usage: waldur export_offering -o OFFERING -p PATH

options:
  -o OFFERING, --offering OFFERING
                        An offering UUID.
  -p PATH, --path PATH  Path to the folder where the export data will be
                        saved.

import_ami_catalog

Import catalog of Amazon images.

1
2
3
4
5
6
7
usage: waldur import_ami_catalog [-y] FILE

positional arguments:
  FILE       AMI catalog file.

options:
  -y, --yes  The answer to any question which would be asked will be yes.

import_auth_social

Import OIDC auth configuration in YAML format. The example of auth.yaml:

1
2
3
4
5
6
7
8
9
- provider: "keycloak"   # OIDC identity provider in string format. Valid values are: "tara", "eduteams", "keycloak".
  label: "Keycloak"    # Human-readable IdP name.
  client_id: "waldur"   # A string used in OIDC requests for client identification.
  client_secret: OIDC_CLIENT_SECRET
  discovery_url: "http://localhost/auth/realms/YOUR_KEYCLOAK_REALM/.well-known/openid-configuration" # OIDC discovery endpoint.
  management_url: ""   # Endpoint for user details management.
  protected_fields:    # User fields that are imported from IdP.
    - "full_name"
    - "email"

1
2
3
4
usage: waldur import_auth_social auth_file

positional arguments:
  auth_file  Specifies location of auth configuration file.

import_azure_image

Import Azure image

1
2
3
4
5
6
7
usage: waldur import_azure_image [--sku SKU] [--publisher PUBLISHER]
                                 [--offer OFFER]

options:
  --sku SKU
  --publisher PUBLISHER
  --offer OFFER

import_marketplace_orders

Create marketplace order for each resource if it does not yet exist.

import_offering

Import or update an offering in Waldur. You must define offering for updating or category and customer for creating.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
usage: waldur import_offering -p PATH [-c CUSTOMER] [-ct CATEGORY]
                              [-o OFFERING]

options:
  -p PATH, --path PATH  File path to offering data.
  -c CUSTOMER, --customer CUSTOMER
                        Customer UUID.
  -ct CATEGORY, --category CATEGORY
                        Category UUID.
  -o OFFERING, --offering OFFERING
                        Updated offering UUID.

import_reppu_usages

Import component usages from Reppu for a specified year and month.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
usage: waldur import_reppu_usages [-m MONTH] [-y YEAR]
                                  [--reppu-api-url REPPU_API_URL]
                                  [--reppu-api-token REPPU_API_TOKEN]
                                  [--dry-run | --no-dry-run]

options:
  -m MONTH, --month MONTH
                        Month for which data is imported.
  -y YEAR, --year YEAR  Year for which data is imported.
  --reppu-api-url REPPU_API_URL
                        Reppu API URL.
  --reppu-api-token REPPU_API_TOKEN
                        Reppu API Token.
  --dry-run, --no-dry-run
                        Dry run mode.

import_roles

Import roles configuration in YAML format

1
2
3
4
usage: waldur import_roles roles_file

positional arguments:
  roles_file  Specifies location of roles configuration file.

import_tenant_quotas

Import OpenStack tenant quotas to marketplace.

1
2
3
4
5
usage: waldur import_tenant_quotas [--dry-run]

options:
  --dry-run  Don't make any changes, instead show what objects would be
             created.

initsecuritygroups

Add default security groups with given names to all tenants.

1
2
3
4
usage: waldur initsecuritygroups names [names ...]

positional arguments:
  names

load_categories

Loads a categories for the Marketplace

1
2
3
4
usage: waldur load_categories category [category ...]

positional arguments:
  category  List of categories to load

load_features

Import features in JSON format

1
2
3
4
5
6
7
8
usage: waldur load_features [--dry-run] features_file

positional arguments:
  features_file  Specifies location of features file.

options:
  --dry-run      Don't make any changes, instead show what objects would be
                 created.

load_notifications

Import notifications to DB

1
2
3
4
usage: waldur load_notifications notifications_file

positional arguments:
  notifications_file  Specifies location of notifications file.

load_user_agreements

Imports privacy policy and terms of service into DB

1
2
3
4
5
6
7
8
usage: waldur load_user_agreements [-tos TOS] [-pp PP] [-f FORCE]

options:
  -tos TOS, --tos TOS   Path to a Terms of service file
  -pp PP, --pp PP       Path to a Privacy policy file
  -f FORCE, --force FORCE
                        This flag means force loading agreements even if they
                        are already defined in DB.

move_project

Move Waldur project to a different organization.

1
2
3
4
5
6
7
usage: waldur move_project -p PROJECT_UUID -c CUSTOMER_UUID

options:
  -p PROJECT_UUID, --project PROJECT_UUID
                        UUID of a project to move.
  -c CUSTOMER_UUID, --customer CUSTOMER_UUID
                        Target organization UUID

move_resource

Move a marketplace resource to a different project.

1
2
3
4
5
6
7
usage: waldur move_resource -p PROJECT_UUID -r RESOURCE_UUID

options:
  -p PROJECT_UUID, --project PROJECT_UUID
                        Target project UUID
  -r RESOURCE_UUID, --resource RESOURCE_UUID
                        UUID of a marketplace resource to move.

override_constance_settings

Override settings stored in django-constance. The example of .yaml file:

1
2
3
4
5
6
7
 - WALDUR_SUPPORT_ENABLED: true # Enables support plugin
  WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE: 'zammad' # Specifies zammad as service desk plugin
  ZAMMAD_API_URL: "https://zammad.example.com/api/" # Specifies zammad API URL
  ZAMMAD_TOKEN: "1282361723491" # Specifies zammad token
  ZAMMAD_GROUP: "default-group" # Specifies zammad group
  ZAMMAD_ARTICLE_TYPE: "email" # Specifies zammad article type
  ZAMMAD_COMMENT_COOLDOWN_DURATION: 7 # Specifies zammad comment cooldown duration

1
2
3
4
5
6
usage: waldur override_constance_settings constance_settings_file

positional arguments:
  constance_settings_file
                        Specifies location of file in YAML format containing
                        new settings

override_roles

Override roles configuration in YAML format. The example of roles-override.yaml:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- role: CUSTOMER.OWNER
 description: "Custom owner role"
 is_active: True
 add_permissions:
  - OFFERING.CREATE
  - OFFERING.DELETE
  - OFFERING.UPDATE
 drop_permissions:
  - OFFERING.UPDATE_THUMBNAIL
  - OFFERING.UPDATE_ATTRIBUTES

1
2
3
4
usage: waldur override_roles roles_file

positional arguments:
  roles_file  Specifies location of roles configuration file.

override_templates

Override templates

1
2
3
4
5
6
7
8
9
usage: waldur override_templates [-c CLEAN] templates_file

positional arguments:
  templates_file        Specifies location of templates file.

options:
  -c CLEAN, --clean CLEAN
                        This flag means total synchronization with the
                        template file you pass.

pgmigrate

Load data with disabled signals.

1
2
3
4
usage: waldur pgmigrate [--path PATH]

options:
  --path PATH, -p PATH  Path to dumped database.

print_events_enums

Prints all event types as typescript enums.

print_features_description

Prints all Waldur feature description as typescript code.

print_features_docs

Prints all Waldur feature toggles in markdown format.

print_features_enums

Prints all Waldur feature toggles as typescript enums.

print_notifications

Prints Mastermind notifications with a description and templates

print_permissions_description

Prints all Waldur permissions description as typescript code.

print_settings_description

Prints all Waldur feature description as typescript code.

pull_openstack_volume_metadata

Pull OpenStack volumes metadata to marketplace.

1
2
3
4
5
usage: waldur pull_openstack_volume_metadata [--dry-run]

options:
  --dry-run  Don't make any changes, instead show what objects would be
             created.

pull_support_priorities

Pull priorities from support backend.

pull_support_users

Pull users from support backend.

push_tenant_quotas

Push OpenStack tenant quotas from marketplace to backend.

1
2
3
4
5
usage: waldur push_tenant_quotas [--dry-run]

options:
  --dry-run  Don't make any changes, instead show what objects would be
             created.

rebuild_billing

Create or update price estimates based on invoices.

removestalect

Remove Django event log records with stale content types.

set_constance_image

A custom command to set Constance image configs with CLI

1
2
3
4
5
usage: waldur set_constance_image KEY PATH

positional arguments:
  KEY   Constance settings key
  PATH  Path to a logo

status

Check status of Waldur MasterMind configured services

1
2
3
4
5
6
7
usage: waldur status [--check-api-endpoints-at BASE_URL]

options:
  --check-api-endpoints-at BASE_URL
                        Runs API endpoints check at specified base URL (i.e.
                        http://example.com). If this argument is not provided,
                        check will be skipped.

switching_backend_server

Backend data update if a server was switched.

sync_saml2_providers

Synchronize SAML2 identity providers.

sync_users

Sync users from Waldur to Rancher.

Configuration options

Static options

WALDUR_AUTH_SAML2 plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
WALDUR_AUTH_SAML2 = {'ALLOW_TO_SELECT_IDENTITY_PROVIDER': True,
 'ATTRIBUTE_MAP_DIR': '/etc/waldur/saml2/attributemaps',
 'AUTHN_REQUESTS_SIGNED': 'true',
 'CATEGORIES': ['http://www.geant.net/uri/dataprotection-code-of-conduct/v1'],
 'CERT_FILE': '',
 'DEBUG': False,
 'DEFAULT_BINDING': 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST',
 'DESCRIPTION': 'Service provider description',
 'DIGEST_ALGORITHM': None,
 'DISCOVERY_SERVICE_LABEL': None,
 'DISCOVERY_SERVICE_URL': None,
 'DISPLAY_NAME': 'Service provider display name',
 'ENABLE_SINGLE_LOGOUT': False,
 'IDENTITY_PROVIDER_LABEL': None,
 'IDENTITY_PROVIDER_URL': None,
 'IDP_METADATA_LOCAL': [],
 'IDP_METADATA_REMOTE': [],
 'KEY_FILE': '',
 'LOGOUT_REQUESTS_SIGNED': 'true',
 'LOG_FILE': '',
 'LOG_LEVEL': 'INFO',
 'MANAGEMENT_URL': '',
 'NAME': 'saml2',
 'NAMEID_FORMAT': None,
 'OPTIONAL_ATTRIBUTES': [],
 'ORGANIZATION': {},
 'PRIVACY_STATEMENT_URL': 'http://example.com/privacy-policy/',
 'REGISTRATION_AUTHORITY': 'http://example.com/registration-authority/',
 'REGISTRATION_INSTANT': '2017-01-01T00:00:00',
 'REGISTRATION_POLICY': 'http://example.com/registration-policy/',
 'REQUIRED_ATTRIBUTES': [],
 'SAML_ATTRIBUTE_MAPPING': {},
 'SIGNATURE_ALGORITHM': None,
 'XMLSEC_BINARY': '/usr/bin/xmlsec1'}

ALLOW_TO_SELECT_IDENTITY_PROVIDER

Type: bool

ATTRIBUTE_MAP_DIR

Type: str

Directory with attribute mapping

AUTHN_REQUESTS_SIGNED

Type: str

Indicates if the authentication requests sent should be signed by default

CATEGORIES

Type: list

Links to the entity categories

CERT_FILE

Type: str

PEM formatted certificate chain file

DEBUG

Type: bool

Set to True to output debugging information

DEFAULT_BINDING

Type: str

DESCRIPTION

Type: str

Service provider description (required by CoC)

DIGEST_ALGORITHM

Type: Optional[str]

Identifies the Message Digest algorithm URL according to the XML Signature specification (SHA1 is used by default)

DISCOVERY_SERVICE_LABEL

Type: Optional[str]

DISCOVERY_SERVICE_URL

Type: Optional[str]

DISPLAY_NAME

Type: str

Service provider display name (required by CoC)

ENABLE_SINGLE_LOGOUT

Type: bool

IDENTITY_PROVIDER_LABEL

Type: Optional[str]

IDENTITY_PROVIDER_URL

Type: Optional[str]

IDP_METADATA_LOCAL

Type: list

IdPs metadata XML files stored locally

IDP_METADATA_REMOTE

Type: list

IdPs metadata XML files stored remotely

KEY_FILE

Type: str

PEM formatted certificate key file

LOGOUT_REQUESTS_SIGNED

Type: str

Indicates if the entity will sign the logout requests

LOG_FILE

Type: str

Empty to disable logging SAML2-related stuff to file

LOG_LEVEL

Type: str

Log level for SAML2

MANAGEMENT_URL

Type: str

The endpoint for user details management.

NAME

Type: str

Name used for assigning the registration method to the user

NAMEID_FORMAT

Type: Optional[str]

Identified NameID format to use. None means default, empty string ("") disables addition of entity

OPTIONAL_ATTRIBUTES

Type: list

SAML attributes that may be useful to have but not required

ORGANIZATION

Type: dict

Organization responsible for the service (you can set multilanguage information here)

PRIVACY_STATEMENT_URL

Type: str

URL with privacy statement (required by CoC)

REGISTRATION_AUTHORITY

Type: str

Registration authority required by mdpi

REGISTRATION_INSTANT

Type: str

Registration instant time required by mdpi

REGISTRATION_POLICY

Type: str

Registration policy required by mdpi

REQUIRED_ATTRIBUTES

Type: list

SAML attributes that are required to identify a user

SAML_ATTRIBUTE_MAPPING

Type: dict

Mapping between SAML attributes and User fields

SIGNATURE_ALGORITHM

Type: Optional[str]

Identifies the Signature algorithm URL according to the XML Signature specification (SHA1 is used by default)

XMLSEC_BINARY

Type: str

Full path to the xmlsec1 binary program

WALDUR_AUTH_SOCIAL plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
WALDUR_AUTH_SOCIAL = {'ENABLE_EDUTEAMS_SYNC': False,
 'REMOTE_EDUTEAMS_CLIENT_ID': '',
 'REMOTE_EDUTEAMS_ENABLED': False,
 'REMOTE_EDUTEAMS_REFRESH_TOKEN': '',
 'REMOTE_EDUTEAMS_SECRET': '',
 'REMOTE_EDUTEAMS_SSH_API_PASSWORD': '',
 'REMOTE_EDUTEAMS_SSH_API_URL': '',
 'REMOTE_EDUTEAMS_SSH_API_USERNAME': '',
 'REMOTE_EDUTEAMS_TOKEN_URL': 'https://proxy.acc.researcher-access.org/OIDC/token',
 'REMOTE_EDUTEAMS_USERINFO_URL': 'https://proxy.acc.researcher-access.org/api/userinfo'}

ENABLE_EDUTEAMS_SYNC

Type: bool

Enable eduTEAMS synchronization with remote Waldur.

REMOTE_EDUTEAMS_CLIENT_ID

Type: str

ID of application used for OAuth authentication.

REMOTE_EDUTEAMS_ENABLED

Type: bool

Enable remote eduTEAMS extension.

REMOTE_EDUTEAMS_REFRESH_TOKEN

Type: str

Token is used to authenticate against user info endpoint.

REMOTE_EDUTEAMS_SECRET

Type: str

Application secret key.

REMOTE_EDUTEAMS_SSH_API_PASSWORD

Type: str

Password for SSH API URL

REMOTE_EDUTEAMS_SSH_API_URL

Type: str

API URL SSH keys

REMOTE_EDUTEAMS_SSH_API_USERNAME

Type: str

Username for SSH API URL

REMOTE_EDUTEAMS_TOKEN_URL

Type: str

The token endpoint is used to obtain tokens.

REMOTE_EDUTEAMS_USERINFO_URL

Type: str

It allows to get user data based on userid aka CUID.

WALDUR_CORE plugin

Default value:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
WALDUR_CORE = {'ATTACHMENT_LINK_MAX_AGE': datetime.timedelta(seconds=3600),
 'AUTHENTICATION_METHODS': ['LOCAL_SIGNIN'],
 'BACKEND_FIELDS_EDITABLE': True,
 'COUNTRIES': ['AL',
               'AT',
               'BA',
               'BE',
               'BG',
               'CH',
               'CY',
               'CZ',
               'DE',
               'DK',
               'EE',
               'ES',
               'EU',
               'FI',
               'FR',
               'GB',
               'GE',
               'GR',
               'HR',
               'HU',
               'IE',
               'IS',
               'IT',
               'LT',
               'LU',
               'LV',
               'MC',
               'MK',
               'MT',
               'NL',
               'NO',
               'PL',
               'PT',
               'RO',
               'RS',
               'SE',
               'SI',
               'SK',
               'UA'],
 'CREATE_DEFAULT_PROJECT_ON_ORGANIZATION_CREATION': False,
 'DEFAULT_IDP': '',
 'EMAIL_CHANGE_MAX_AGE': datetime.timedelta(days=1),
 'ENABLE_ACCOUNTING_START_DATE': False,
 'ENABLE_GEOIP': True,
 'ENABLE_STRICT_CHECK_ACCEPTING_INVITATION': False,
 'EXTENSIONS_AUTOREGISTER': True,
 'EXTERNAL_LINKS': [],
 'GROUP_INVITATION_LIFETIME': datetime.timedelta(days=7),
 'HOMEPORT_SENTRY_DSN': None,
 'HOMEPORT_SENTRY_ENVIRONMENT': 'waldur-production',
 'HOMEPORT_SENTRY_TRACES_SAMPLE_RATE': 0.01,
 'HOMEPORT_URL': 'https://example.com/',
 'HTTP_CHUNK_SIZE': 50,
 'INVITATIONS_ENABLED': True,
 'INVITATION_CIVIL_NUMBER_LABEL': '',
 'INVITATION_CREATE_MISSING_USER': False,
 'INVITATION_DISABLE_MULTIPLE_ROLES': False,
 'INVITATION_LIFETIME': datetime.timedelta(days=7),
 'INVITATION_MAX_AGE': None,
 'INVITATION_TAX_NUMBER_LABEL': '',
 'INVITATION_USE_WEBHOOKS': False,
 'INVITATION_WEBHOOK_TOKEN_CLIENT_ID': '',
 'INVITATION_WEBHOOK_TOKEN_SECRET': '',
 'INVITATION_WEBHOOK_TOKEN_URL': '',
 'INVITATION_WEBHOOK_URL': '',
 'LOCAL_IDP_LABEL': 'Local DB',
 'LOCAL_IDP_MANAGEMENT_URL': '',
 'LOCAL_IDP_NAME': 'Local DB',
 'LOCAL_IDP_PROTECTED_FIELDS': [],
 'LOGGING_REPORT_DIRECTORY': '/var/log/waldur',
 'LOGGING_REPORT_INTERVAL': datetime.timedelta(days=7),
 'MASTERMIND_URL': '',
 'MATOMO_SITE_ID': None,
 'MATOMO_URL_BASE': None,
 'NATIVE_NAME_ENABLED': False,
 'NOTIFICATIONS_PROFILE_CHANGES': {'ENABLE_OPERATOR_OWNER_NOTIFICATIONS': False,
                                   'FIELDS': ('email',
                                              'phone_number',
                                              'job_title'),
                                   'OPERATOR_NOTIFICATION_EMAILS': []},
 'NOTIFICATION_SUBJECT': 'Notifications from Waldur',
 'OECD_FOS_2007_CODE_MANDATORY': False,
 'ONLY_STAFF_CAN_INVITE_USERS': False,
 'ONLY_STAFF_MANAGES_SERVICES': False,
 'PROTECT_USER_DETAILS_FOR_REGISTRATION_METHODS': [],
 'REQUEST_HEADER_IMPERSONATED_USER_UUID': 'HTTP_X_IMPERSONATED_USER_UUID',
 'RESPONSE_HEADER_IMPERSONATOR_UUID': 'X-impersonator-uuid',
 'SELLER_COUNTRY_CODE': None,
 'SHOW_ALL_USERS': False,
 'SUPPORT_PORTAL_URL': '',
 'TOKEN_KEY': 'x-auth-token',
 'TOKEN_LIFETIME': datetime.timedelta(seconds=3600),
 'TRANSLATION_DOMAIN': '',
 'USER_MANDATORY_FIELDS': ['first_name', 'last_name', 'email'],
 'USER_REGISTRATION_HIDDEN_FIELDS': ['registration_method',
                                     'job_title',
                                     'phone_number',
                                     'organization'],
 'USE_ATOMIC_TRANSACTION': True,
 'VALIDATE_INVITATION_EMAIL': False}

Type: timedelta

Max age of secure token for media download.

AUTHENTICATION_METHODS

Type: List[str]

List of enabled authentication methods.

BACKEND_FIELDS_EDITABLE

Type: bool

Allows to control /admin writable fields. If this flag is disabled it is impossible to edit any field that corresponds to backend value via /admin. Such restriction allows to save information from corruption.

COUNTRIES

Type: List[str]

It is used in organization creation dialog in order to limit country choices to predefined set.

CREATE_DEFAULT_PROJECT_ON_ORGANIZATION_CREATION

Type: bool

Enables generation of the first project on organization creation.

DEFAULT_IDP

Type: str

Triggers authentication flow at once.

EMAIL_CHANGE_MAX_AGE

Type: timedelta

Max age of change email request.

ENABLE_ACCOUNTING_START_DATE

Type: bool

Allows to enable accounting for organizations using value of accounting_start_date field.

ENABLE_GEOIP

Type: bool

Enable detection of coordinates of virtual machines.

ENABLE_STRICT_CHECK_ACCEPTING_INVITATION

Type: bool

If this is true and user email is pre-validated then accepting invitation to only do that if user’s email and email of the invitation fully match.

EXTENSIONS_AUTOREGISTER

Type: bool

Defines whether extensions should be automatically registered.

Type: List[ExternalLink]

Render external links in dropdown in header. Each item should be object with label and url fields. For example: {"label": "Helpdesk", "url": "https://example.com/"}

GROUP_INVITATION_LIFETIME

Type: timedelta

Defines for how long group invitation remains valid.

HOMEPORT_SENTRY_DSN

Type: Optional[str]

Sentry Data Source Name for Waldur HomePort project.

HOMEPORT_SENTRY_ENVIRONMENT

Type: str

Sentry environment name for Waldur Homeport.

HOMEPORT_SENTRY_TRACES_SAMPLE_RATE

Type: float

Percentage of transactions sent to Sentry for tracing.

HOMEPORT_URL

Type: str

It is used for rendering callback URL in HomePort.

HTTP_CHUNK_SIZE

Type: int

Chunk size for resource fetching from backend API. It is needed in order to avoid too long HTTP request error.

INVITATIONS_ENABLED

Type: bool

Allows to disable invitations feature.

INVITATION_CIVIL_NUMBER_LABEL

Type: str

Custom label for civil number field in invitation creation dialog.

INVITATION_CREATE_MISSING_USER

Type: bool

Allow to create FreeIPA user using details specified in invitation if user does not exist yet.

INVITATION_DISABLE_MULTIPLE_ROLES

Type: bool

Do not allow user to grant multiple roles in the same project or organization using invitation.

INVITATION_LIFETIME

Type: timedelta

Defines for how long invitation remains valid.

INVITATION_MAX_AGE

Type: Optional[timedelta]

Max age of invitation token. It is used in approve and reject actions.

INVITATION_TAX_NUMBER_LABEL

Type: str

Custom label for tax number field in invitation creation dialog.

INVITATION_USE_WEBHOOKS

Type: bool

Allow sending of webhooks instead of sending of emails.

INVITATION_WEBHOOK_TOKEN_CLIENT_ID

Type: str

Client ID to get access token from Keycloak.

INVITATION_WEBHOOK_TOKEN_SECRET

Type: str

Client secret to get access token from Keycloak.

INVITATION_WEBHOOK_TOKEN_URL

Type: str

Keycloak URL to get access token.

INVITATION_WEBHOOK_URL

Type: str

Webhook URL for sending invitations.

LOCAL_IDP_LABEL

Type: str

The label of local auth.

LOCAL_IDP_MANAGEMENT_URL

Type: str

The URL for management of local user details.

LOCAL_IDP_NAME

Type: str

The name of local auth.

LOCAL_IDP_PROTECTED_FIELDS

Type: List[str]

The list of protected fields for local IdP.

LOGGING_REPORT_DIRECTORY

Type: str

Directory where log files are located.

LOGGING_REPORT_INTERVAL

Type: timedelta

Files older that specified interval are filtered out.

MASTERMIND_URL

Type: str

It is used for rendering callback URL in MasterMind.

MATOMO_SITE_ID

Type: Optional[int]

Site ID is used by Matomo analytics application.

MATOMO_URL_BASE

Type: Optional[str]

URL base is used by Matomo analytics application.

NATIVE_NAME_ENABLED

Type: bool

Allows to render native name field in customer and user forms.

NOTIFICATIONS_PROFILE_CHANGES

Type: dict

Configure notifications about profile changes of organization owners.

NOTIFICATION_SUBJECT

Type: str

It is used as a subject of email emitted by event logging hook.

OECD_FOS_2007_CODE_MANDATORY

Type: bool

Field oecd_fos_2007_code must be required for project.

ONLY_STAFF_CAN_INVITE_USERS

Type: bool

Allow to limit invitation management to staff only.

ONLY_STAFF_MANAGES_SERVICES

Type: bool

Allows to restrict provider management only to staff users.

PROTECT_USER_DETAILS_FOR_REGISTRATION_METHODS

Type: List[str]

List of authentication methods for which a manual update of user details is not allowed.

REQUEST_HEADER_IMPERSONATED_USER_UUID

Type: str

The request header, which contains the user UUID of the user to be impersonated.

RESPONSE_HEADER_IMPERSONATOR_UUID

Type: str

The response header, which contains the UUID of the user who requested the impersonation.

SELLER_COUNTRY_CODE

Type: Optional[str]

Specifies seller legal or effective country of registration or residence as an ISO 3166-1 alpha-2 country code. It is used for computing VAT charge rate.

SHOW_ALL_USERS

Type: bool

Indicates whether user can see all other users in api/users/ endpoint.

SUPPORT_PORTAL_URL

Type: str

Support portal URL is rendered as a shortcut on dashboard

TOKEN_KEY

Type: str

Header for token authentication.

TOKEN_LIFETIME

Type: timedelta

Defines for how long user token should remain valid if there was no action from user.

TRANSLATION_DOMAIN

Type: str

Identifier of translation domain applied to current deployment.

USER_MANDATORY_FIELDS

Type: List[str]

List of user profile attributes that would be required for filling in HomePort. Note that backend will not be affected. If a mandatory field is missing in profile, a profile edit view will be forced upon user on any HomePort logged in action. Possible values are: description, email, full_name, job_title, organization, phone_number

USER_REGISTRATION_HIDDEN_FIELDS

Type: List[str]

List of user profile attributes that would be concealed on registration form in HomePort. Possible values are: job_title, registration_method, phone_number

USE_ATOMIC_TRANSACTION

Type: bool

Wrap action views in atomic transaction.

VALIDATE_INVITATION_EMAIL

Type: bool

Ensure that invitation and user emails match.

WALDUR_FREEIPA plugin

Default value:

1
2
3
4
5
6
7
8
9
WALDUR_FREEIPA = {'BLACKLISTED_USERNAMES': ['root'],
 'ENABLED': False,
 'GROUPNAME_PREFIX': 'waldur_',
 'GROUP_SYNCHRONIZATION_ENABLED': True,
 'HOSTNAME': 'ipa.example.com',
 'PASSWORD': 'secret',
 'USERNAME': 'admin',
 'USERNAME_PREFIX': 'waldur_',
 'VERIFY_SSL': True}

BLACKLISTED_USERNAMES

Type: list

List of username that users are not allowed to select

ENABLED

Type: bool

Enable integration of identity provisioning in configured FreeIPA

GROUPNAME_PREFIX

Type: str

Prefix to be appended to all group names created in FreeIPA by Waldur

GROUP_SYNCHRONIZATION_ENABLED

Type: bool

Optionally disable creation of user groups in FreeIPA matching Waldur structure

HOSTNAME

Type: str

Hostname of FreeIPA server

PASSWORD

Type: str

Password of FreeIPA user with administrative privileges

USERNAME

Type: str

Username of FreeIPA user with administrative privileges

USERNAME_PREFIX

Type: str

Prefix to be appended to all usernames created in FreeIPA by Waldur

VERIFY_SSL

Type: bool

Validate TLS certificate of FreeIPA web interface / REST API

WALDUR_HPC plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
WALDUR_HPC = {'ENABLED': False,
 'EXTERNAL_AFFILIATIONS': [],
 'EXTERNAL_CUSTOMER_UUID': '',
 'EXTERNAL_EMAIL_PATTERNS': [],
 'EXTERNAL_LIMITS': {},
 'INTERNAL_AFFILIATIONS': [],
 'INTERNAL_CUSTOMER_UUID': '',
 'INTERNAL_EMAIL_PATTERNS': [],
 'INTERNAL_LIMITS': {},
 'OFFERING_UUID': '',
 'PLAN_UUID': ''}

ENABLED

Type: bool

Enable HPC-specific hooks in Waldur deployment

EXTERNAL_AFFILIATIONS

Type: List[str]

List of user affiliations (eduPersonScopedAffiliation fields) that define if the user belongs to external organization.

EXTERNAL_CUSTOMER_UUID

Type: str

UUID of a Waldur organization (aka customer) where new external users would be added

EXTERNAL_EMAIL_PATTERNS

Type: List[str]

List of user email patterns (as regex) that define if the user belongs to external organization.

EXTERNAL_LIMITS

Type: dict

Overrided default values for SLURM offering to be created for users belonging to external organization.

INTERNAL_AFFILIATIONS

Type: List[str]

List of user affiliations (eduPersonScopedAffiliation fields) that define if the user belongs to internal organization.

INTERNAL_CUSTOMER_UUID

Type: str

UUID of a Waldur organization (aka customer) where new internal users would be added

INTERNAL_EMAIL_PATTERNS

Type: List[str]

List of user email patterns (as regex) that define if the user belongs to internal organization.

INTERNAL_LIMITS

Type: dict

Overrided default values for SLURM offering to be created for users belonging to internal organization.

OFFERING_UUID

Type: str

UUID of a Waldur SLURM offering, which will be used for creating allocations for users

PLAN_UUID

Type: str

UUID of a Waldur SLURM offering plan, which will be used for creating allocations for users

WALDUR_MARKETPLACE plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
WALDUR_MARKETPLACE = {'ANONYMOUS_USER_CAN_VIEW_OFFERINGS': True,
 'ANONYMOUS_USER_CAN_VIEW_PLANS': True,
 'DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE': True,
 'ENABLE_RESOURCE_END_DATE': True,
 'ENABLE_STALE_RESOURCE_NOTIFICATIONS': False,
 'NOTIFY_ABOUT_RESOURCE_CHANGE': True,
 'NOTIFY_STAFF_ABOUT_APPROVALS': False,
 'TELEMETRY_URL': 'https://telemetry.waldur.com/',
 'TELEMETRY_VERSION': 1,
 'THUMBNAIL_SIZE': (120, 120)}

ANONYMOUS_USER_CAN_VIEW_OFFERINGS

Type: bool

Allow anonymous users to see shared offerings in active, paused and archived states

ANONYMOUS_USER_CAN_VIEW_PLANS

Type: bool

Allow anonymous users to see plans

DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE

Type: bool

Disable only resource update events.

ENABLE_RESOURCE_END_DATE

Type: bool

Allow to view and update resource end date.

ENABLE_STALE_RESOURCE_NOTIFICATIONS

Type: bool

Enable reminders to owners about resources of shared offerings that have not generated any cost for the last 3 months.

NOTIFY_ABOUT_RESOURCE_CHANGE

Type: bool

If true, notify users about resource changes from Marketplace perspective. Can generate duplicate events if plugins also log

NOTIFY_STAFF_ABOUT_APPROVALS

Type: bool

If true, users with staff role are notified when request for order approval is generated

TELEMETRY_URL

Type: str

URL for sending telemetry data.

TELEMETRY_VERSION

Type: int

Telemetry service version.

THUMBNAIL_SIZE

Type: tuple

Size of the thumbnail to generate when screenshot is uploaded for an offering.

WALDUR_MARKETPLACE_REMOTE_SLURM plugin

Default value:

1
WALDUR_MARKETPLACE_REMOTE_SLURM = {'USE_WALDUR_USERNAMES': True}

USE_WALDUR_USERNAMES

Type: bool

Fetch usernames from Waldur rather then FreeIPA profiles.

WALDUR_MARKETPLACE_SCRIPT plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
WALDUR_MARKETPLACE_SCRIPT = {'DOCKER_CLIENT': {'base_url': 'unix://var/run/docker.sock'},
 'DOCKER_IMAGES': {'python': {'command': 'python',
                              'image': 'python:3.11-alpine'},
                   'shell': {'command': 'sh', 'image': 'alpine:3'}},
 'DOCKER_REMOVE_CONTAINER': True,
 'DOCKER_RUN_OPTIONS': {'mem_limit': '512m'},
 'DOCKER_SCRIPT_DIR': None,
 'K8S_CONFIG_PATH': '~/.kube/config',
 'K8S_JOB_TIMEOUT': 1800,
 'K8S_NAMESPACE': 'default',
 'SCRIPT_RUN_MODE': 'docker'}

DOCKER_CLIENT

Type: dict

Options for docker client. See also: https://docker-py.readthedocs.io/en/stable/client.html#docker.client.DockerClient

DOCKER_IMAGES

Type: dict

Key is command to execute script, value is a dictionary of image name and command.

DOCKER_REMOVE_CONTAINER

Type: bool

Remove Docker container after script execution

DOCKER_RUN_OPTIONS

Type: dict

Options for docker runtime. See also: https://docker-py.readthedocs.io/en/stable/containers.html#docker.models.containers.ContainerCollection.run

DOCKER_SCRIPT_DIR

Type: Optional[str]

Path to folder on executor machine where to create temporary submission scripts. If None uses OS-dependent location. OS X users, see https://github.com/docker/for-mac/issues/1532

K8S_CONFIG_PATH

Type: str

Path to Kubernetes configuration file

K8S_JOB_TIMEOUT

Type: int

Timeout for execution of one Kubernetes job in seconds

K8S_NAMESPACE

Type: str

Kubernetes namespace where jobs will be executed

SCRIPT_RUN_MODE

Type: str

Type of jobs deployment. Valid values: "docker" for simple docker deployment, "k8s" for Kubernetes-based one

WALDUR_OPENSTACK plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
WALDUR_OPENSTACK = {'ALLOW_CUSTOMER_USERS_OPENSTACK_CONSOLE_ACCESS': True,
 'ALLOW_DIRECT_EXTERNAL_NETWORK_CONNECTION': False,
 'DEFAULT_BLACKLISTED_USERNAMES': ['admin', 'service'],
 'DEFAULT_SECURITY_GROUPS': ({'description': 'Security group for secure shell '
                                             'access',
                              'name': 'ssh',
                              'rules': ({'cidr': '0.0.0.0/0',
                                         'from_port': 22,
                                         'protocol': 'tcp',
                                         'to_port': 22},)},
                             {'description': 'Security group for ping',
                              'name': 'ping',
                              'rules': ({'cidr': '0.0.0.0/0',
                                         'icmp_code': -1,
                                         'icmp_type': -1,
                                         'protocol': 'icmp'},)},
                             {'description': 'Security group for remote '
                                             'desktop access',
                              'name': 'rdp',
                              'rules': ({'cidr': '0.0.0.0/0',
                                         'from_port': 3389,
                                         'protocol': 'tcp',
                                         'to_port': 3389},)},
                             {'description': 'Security group for http and '
                                             'https access',
                              'name': 'web',
                              'rules': ({'cidr': '0.0.0.0/0',
                                         'from_port': 80,
                                         'protocol': 'tcp',
                                         'to_port': 80},
                                        {'cidr': '0.0.0.0/0',
                                         'from_port': 443,
                                         'protocol': 'tcp',
                                         'to_port': 443})}),
 'MAX_CONCURRENT_PROVISION': {'OpenStack.Instance': 4,
                              'OpenStack.Snapshot': 4,
                              'OpenStack.Volume': 4},
 'REQUIRE_AVAILABILITY_ZONE': False,
 'SUBNET': {'ALLOCATION_POOL_END': '{first_octet}.{second_octet}.{third_octet}.200',
            'ALLOCATION_POOL_START': '{first_octet}.{second_octet}.{third_octet}.10'},
 'TENANT_CREDENTIALS_VISIBLE': False}

ALLOW_CUSTOMER_USERS_OPENSTACK_CONSOLE_ACCESS

Type: bool

If true, customer users would be offered actions for accessing OpenStack console

ALLOW_DIRECT_EXTERNAL_NETWORK_CONNECTION

Type: bool

If true, allow connecting of instances directly to external networks

DEFAULT_BLACKLISTED_USERNAMES

Type: list

Usernames that cannot be created by Waldur in OpenStack

DEFAULT_SECURITY_GROUPS

Type: tuple

Default security groups and rules created in each of the provisioned OpenStack tenants

MAX_CONCURRENT_PROVISION

Type: dict

Maximum parallel executions of provisioning operations for OpenStack resources

REQUIRE_AVAILABILITY_ZONE

Type: bool

If true, specification of availability zone during provisioning will become mandatory

SUBNET

Type: dict

Default allocation pool for auto-created internal network

TENANT_CREDENTIALS_VISIBLE

Type: bool

If true, generated credentials of a tenant are exposed to project users

WALDUR_PID plugin

Default value:

1
2
3
4
5
6
WALDUR_PID = {'DATACITE': {'API_URL': 'https://example.com',
              'COLLECTION_DOI': '',
              'PASSWORD': '',
              'PREFIX': '',
              'PUBLISHER': 'Waldur',
              'REPOSITORY_ID': ''}}

DATACITE

Type: dict

Settings for integration of Waldur with Datacite PID service. Collection DOI is used to aggregate generated DOIs.

WALDUR_SLURM plugin

Default value:

1
2
3
4
5
6
WALDUR_SLURM = {'ALLOCATION_PREFIX': 'waldur_allocation_',
 'CUSTOMER_PREFIX': 'waldur_customer_',
 'DEFAULT_LIMITS': {'CPU': 16000, 'GPU': 400, 'RAM': 102400000},
 'ENABLED': False,
 'PRIVATE_KEY_PATH': '/etc/waldur/id_rsa',
 'PROJECT_PREFIX': 'waldur_project_'}

ALLOCATION_PREFIX

Type: str

Prefix for SLURM account name corresponding to Waldur allocation

CUSTOMER_PREFIX

Type: str

Prefix for SLURM account name corresponding to Waldur organization.

DEFAULT_LIMITS

Type: dict

Default limits of account that are set when SLURM account is provisioned.

ENABLED

Type: bool

Enable support for SLURM plugin in a deployment

PRIVATE_KEY_PATH

Type: str

Path to private key file used as SSH identity file for accessing SLURM master.

PROJECT_PREFIX

Type: str

Prefix for SLURM account name corresponding to Waldur project.

Other variables

DEFAULT_FROM_EMAIL

Type: str, default value: webmaster@localhost

Default email address to use for automated correspondence from Waldur.

DEFAULT_REPLY_TO_EMAIL

Type: str

Default email address to use for email replies.

EMAIL_HOOK_FROM_EMAIL

Type: str

Alternative email address to use for email hooks.

IMPORT_EXPORT_USE_TRANSACTIONS

Type: bool, default value: True

Controls if resource importing should use database transactions. Using transactions makes imports safer as a failure during import won’t import only part of the data set.

IPSTACK_ACCESS_KEY

Type: Optional[str]

Unique authentication key used to gain access to the ipstack API.

LANGUAGES

Type: List[tuple[str, str]], default value: (('en', 'English'), ('et', 'Eesti'))

The list is a list of two-tuples in the format (language code, language name) – for example, ('ja', 'Japanese').

LANGUAGE_CODE

Type: str, default value: en

Represents the name of a default language.

USE_PROTECTED_URL

Type: bool, default value: False

Protect media URLs using signed token.

VERIFY_WEBHOOK_REQUESTS

Type: bool, default value: True

When webook is processed, requests verifies SSL certificates for HTTPS requests, just like a web browser.

Dynamic options

Branding

SITE_NAME

Type: str

Default value: Waldur

Human-friendly name of the Waldur deployment.

SHORT_PAGE_TITLE

Type: str

Default value: Waldur

It is used as prefix for page title.

FULL_PAGE_TITLE

Type: str

Default value: Waldur | Cloud Service Management

It is used as default page title if it's not specified explicitly.

SITE_DESCRIPTION

Type: str

Default value: Your single pane of control for managing projects, teams and resources in a self-service manner.

Description of the Waldur deployment.

Marketplace

SITE_ADDRESS

Type: str

It is used in marketplace order header.

SITE_EMAIL

Type: str

It is used in marketplace order header and UI footer.

SITE_PHONE

Type: str

It is used in marketplace order header and UI footer.

CURRENCY_NAME

Type: str

Default value: EUR

It is used in marketplace order details and invoices for currency formatting.

Notifications

COMMON_FOOTER_TEXT

Type: text_field

Common footer in txt format for all emails.

Type: html_field

Common footer in html format for all emails.

DOCS_URL

Type: url_field

Renders link to docs in header

Type: str

Label for link in hero section of HomePort landing page. It can be lead to support site or blog post.

Type: url_field

Link URL in hero section of HomePort landing page.

SUPPORT_PORTAL_URL

Type: url_field

Link URL to support portal. Rendered as a shortcut on dashboard

Theme

SIDEBAR_STYLE

Type: str

Default value: dark

Style of sidebar. Possible values: dark, light, accent.

BRAND_COLOR

Type: color_field

Default value: #3a8500

Hex color definition is used in HomePort landing page for login button.

BRAND_LABEL_COLOR

Type: color_field

Default value: #000000

Hex color definition is used in HomePort landing page for font color of login button.

DISABLE_DARK_THEME

Type: bool

Toggler for dark theme.

Images

Type: image_field

The image used in marketplace order header.

Type: image_field

The image rendered at the top of sidebar menu in HomePort.

SIDEBAR_LOGO_MOBILE

Type: image_field

The image rendered at the top of mobile sidebar menu in HomePort.

SIDEBAR_LOGO_DARK

Type: image_field

The image rendered at the top of sidebar menu in dark mode.

Type: image_field

The image rendered at the bottom of login menu in HomePort.

HERO_IMAGE

Type: image_field

The image rendered at hero section of HomePort landing page.

Type: image_field

A custom .png image file for login page

FAVICON

Type: image_field

A custom favicon .png image file

OFFERING_LOGO_PLACEHOLDER

Type: image_field

Default logo for offering

Service desk integration settings

WALDUR_SUPPORT_ENABLED

Type: bool

Default value: True

Toggler for support plugin.

WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE

Type: str

Default value: atlassian

Type of support backend. Possible values: atlassian, zammad, smax.

WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE

Type: bool

Default value: True

Toggler for request type displaying

Atlassian settings

ATLASSIAN_API_URL

Type: url_field

Default value: http://example.com/

Atlassian API server URL

ATLASSIAN_USERNAME

Type: str

Default value: USERNAME

Username for access user

ATLASSIAN_PASSWORD

Type: secret_field

Default value: PASSWORD

Password for access user

ATLASSIAN_EMAIL

Type: email_field

Email for access user

ATLASSIAN_TOKEN

Type: secret_field

Token for access user

ATLASSIAN_PROJECT_ID

Type: str

Service desk ID or key

ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE

Type: str

Default value: Service Request

Issue type used for request-based item processing.

ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES

Type: str

Comma-separated list of file extenstions not allowed for attachment.

ATLASSIAN_ISSUE_TYPES

Type: str

Default value: Informational, Service Request, Change Request, Incident

Comma-separated list of enabled issue types. First type is the default one.

ATLASSIAN_AFFECTED_RESOURCE_FIELD

Type: str

Affected resource field name

ATLASSIAN_DESCRIPTION_TEMPLATE

Type: str

Template for issue description

ATLASSIAN_SUMMARY_TEMPLATE

Type: str

Template for issue summary

ATLASSIAN_IMPACT_FIELD

Type: str

Default value: Impact

Impact field name

ATLASSIAN_ORGANISATION_FIELD

Type: str

Organisation field name

ATLASSIAN_RESOLUTION_SLA_FIELD

Type: str

Resolution SLA field name

ATLASSIAN_PROJECT_FIELD

Type: str

Project field name

ATLASSIAN_REPORTER_FIELD

Type: str

Default value: Original Reporter

Reporter field name

ATLASSIAN_CALLER_FIELD

Type: str

Default value: Caller

Caller field name

ATLASSIAN_SLA_FIELD

Type: str

Default value: Time to first response

SLA field name

ATLASSIAN_LINKED_ISSUE_TYPE

Type: str

Default value: Relates

Type of linked issue field name

ATLASSIAN_SATISFACTION_FIELD

Type: str

Default value: Customer satisfaction

Customer satisfaction field name

ATLASSIAN_REQUEST_FEEDBACK_FIELD

Type: str

Default value: Request feedback

Request feedback field name

ATLASSIAN_TEMPLATE_FIELD

Type: str

Template field name

ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED

Type: bool

Default value: True

Should extra issue field mappings be applied

ATLASSIAN_SHARED_USERNAME

Type: bool

Is Service Desk username the same as in Waldur

ATLASSIAN_VERIFY_SSL

Type: bool

Toggler for SSL verification

ATLASSIAN_USE_OLD_API

Type: bool

Toggler for legacy API usage.

ATLASSIAN_USE_TEENAGE_API

Type: bool

Toggler for teenage API usage.

ATLASSIAN_USE_AUTOMATIC_REQUEST_MAPPING

Type: bool

Default value: True

Toggler for automatic request mapping.

ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS

Type: bool

Toggler for mapping between waldur user and service desk agents.

ATLASSIAN_STRANGE_SETTING

Type: int

Default value: 1

A constant in the API path, sometimes differs

ATLASSIAN_PULL_PRIORITIES

Type: bool

Default value: True

Toggler for pulling priorities from backend

Zammad settings

ZAMMAD_API_URL

Type: url_field

Zammad API server URL. For example http://localhost:8080/

ZAMMAD_TOKEN

Type: secret_field

Authorization token.

ZAMMAD_GROUP

Type: str

The name of the group to which the ticket will be added. If not specified, the first group will be used.

ZAMMAD_ARTICLE_TYPE

Type: str

Default value: email

Type of a comment. Default is email because it allows support to reply to tickets directly in Zammadhttps://docs.zammad.org/en/latest/api/ticket/articles.html#articles/

ZAMMAD_COMMENT_MARKER

Type: str

Default value: Created by Waldur

Marker for comment. Used for separating comments made via Waldur from natively added comments.

ZAMMAD_COMMENT_PREFIX

Type: str

Default value: User: {name}

Comment prefix with user info.

ZAMMAD_COMMENT_COOLDOWN_DURATION

Type: int

Default value: 5

Time in minutes. Time in minutes while comment deletion is available https://github.com/zammad/zammad/issues/2687/, https://github.com/zammad/zammad/issues/3086/

SMAX settings

SMAX_API_URL

Type: url_field

SMAX API server URL. For example http://localhost:8080/

SMAX_TENANT_ID

Type: str

User tenant ID.

SMAX_LOGIN

Type: str

Authorization login.

SMAX_PASSWORD

Type: secret_field

Authorization password.

SMAX_ORGANISATION_FIELD

Type: str

Organisation field name.

SMAX_PROJECT_FIELD

Type: str

Project field name.

SMAX_AFFECTED_RESOURCE_FIELD

Type: str

Resource field name.

SMAX_REQUESTS_OFFERING

Type: str

Requests offering code for all issues.

SMAX_SECONDS_TO_WAIT

Type: int

Default value: 1

Duration in seconds of delay between pull user attempts.

SMAX_TIMES_TO_PULL

Type: int

Default value: 10

The maximum number of attempts to pull user from backend.

SMAX_CREATION_SOURCE_NAME

Type: str

Creation source name.

SMAX_VERIFY_SSL

Type: bool

Default value: True

Toggler for SSL verification

Proposal settings

PROPOSAL_REVIEW_DURATION

Type: int

Default value: 7

Review duration in days.

Table settings

USER_TABLE_COLUMNS

Type: str

Comma-separated list of columns for users table.

Localization

LANGUAGE_CHOICES

Type: str

Default value: en,et,lt,lv,ru,it,de,da,sv,es,fr,nb,ar,cs

List of enabled languages

User settings

AUTO_APPROVE_USER_TOS

Type: bool

Configure whether a user needs to approve TOS.

Features

customer.payments_for_staff_only

Make payments menu visible for staff users only.

customer.show_domain

Allows to hide domain field in organization detail.

invitations.civil_number_required

Make civil number field mandatory in invitation creation form.

invitations.conceal_civil_number

Conceal civil number in invitation creation dialog.

invitations.require_user_details

Render "Show user details" button in invitation creation form.

invitations.show_tax_number

Show tax number field in invitation creation form.

invitations.tax_number_required

Make tax number field mandatory in invitation creation form.

marketplace.conceal_prices

Do not render prices in order details.

marketplace.import_resources

Allow to import resources from service provider to project.

Enabled LEXIS link integrations for offerings.

marketplace.show_call_management_functionality

Enabled display of call management functionality.

marketplace.show_experimental_ui_components

Enabled display of experimental or mocked components in marketplace.

openstack.hide_volume_type_selector

Allow to hide OpenStack volume type selector when instance or volume is provisioned.

project.estimated_cost

Render estimated cost column in projects list.

project.oecd_fos_2007_code

Enable OECD code.

project.show_description_in_create_dialog

Show description field in project create dialog.

project.show_end_date_in_create_dialog

Show end date field in project create dialog.

project.show_image_in_create_dialog

Show image field in project create dialog.

project.show_industry_flag

Show industry flag.

project.show_start_date_in_create_dialog

Show start date field in project create dialog.

project.show_type_in_create_dialog

Show type field in project create dialog.

rancher.volume_mount_point

Allow to select mount point for data volume when Rancher cluster is provisioned.

slurm.jobs

Render list of SLURM jobs as a separate tab in allocation details page.

support.conceal_change_request

Conceal "Change request" from a selection of issue types for non-staff/non-support users.

support.pricelist

Render marketplace plan components pricelist in support workspace.

support.shared_providers

Render overview of shared marketplace service providers in support workspace.

support.users

Render list of users in support workspace.

support.vm_type_overview

Enable VM type overview in support workspace.

telemetry.send_metrics

Send telemetry metrics.

user.disable_user_termination

Disable user termination in user workspace.

user.notifications

Enable email and webhook notifications management in user workspace.

user.preferred_language

Render preferred language column in users list.

user.show_slug

Enable display of slug field in user summary.

user.ssh_keys

Enable SSH keys management in user workspace.

General Configuration

Outline:

Introduction

Waldur is a Django-based application, so configuration is done by modifying settings.py file.

If you want to configure options related to Django, such as tune caches, database connection, configure custom logging, etc, please refer to Django documentation.

Please consult configuration guide to learn more.

Admin dashboard configuration

An admin dashboard supports custom links on Quick access panel. For instance, a panel below was configured with one additional link to https://waldur.com:

admin example

Configuration of custom links is stored under FLUENT_DASHBOARD_QUICK_ACCESS_LINKS settings key and for current example has following structure:

1
2
3
4
5
6
7
8
9
FLUENT_DASHBOARD_QUICK_ACCESS_LINKS = [
  {
   'title': '[Custom] Waldur - Cloud Service',
   'url': 'https://waldur.com',
   'external': True, # adds an icon specifying that this link is external,
   'description': 'Open-source Cloud Brokerage Platform',
   'attrs': {'target': '_blank'} # add an attribute to generated anchor element which will open link in a new tab.
  },
]

Here is a short description of link parameters:

Name Type Required Description
description string No Tool tip on the link
external boolean No Specifies whether additional icon indicating an external URL has to be added
url URL Yes A URL of the link
title string Yes A title of the generated link
attrs dict No A dictionary of anchor attributes to be added to generated element

It is also possible to omit optional fields and add links by specifying only a title and a URL to the generated link.

1
2
3
4
FLUENT_DASHBOARD_QUICK_ACCESS_LINKS = [
  ['[Custom] Waldur - Cloud Service', 'https://waldur.com'],
  ['Find us on GitHub', 'https://github.com/opennode/waldur-core'],
]

Custom templates configuration

To overwrite default templates you should use django-dbtemplates. It allows creation of templates through /admin.

Local time zone configuration

Set TIME_ZONE setting in /etc/waldur/override.conf.py to use local time zone. By default it is set to UTC. See the list of time zones for possible options.

Configuration of the Google Calendar

Overriding notification templates via admin panel

An admin can override(edit the content) the templates of notifications with the following sequence of actions:

  • Go to admin panel (e.g. http://localhost:8080/admin/)

  • Open Templates: Utilities -> Database templates -> Templates

Go to admin panel

  • Click on Add template on the right side.

Go to admin panel

  • Enter the path to the template file into the Name input field as shown below.

    The name should have a <waldur_application_name>/<event_name>_<postfix>.<extension> format, where <postfix> can be either message or subject, and <extension> - either txt or html.

    You can find a list of all notification templates here

Go to admin panel

  • Scroll down and click on Save and continue editing and you should have the content of the template loaded automatically

Go to admin panel

  • Edit the Content field as you like and Save the changes.

Go to admin panel

Notifications

WALDUR_CORE.STRUCTURE

structure.change_email_request

A notification sent out when an email change is requested. Recipient is the old email address.

Templates

1
    Verify new email address.

1
    To confirm the change of email address from {{ request.user.email }} to {{ request.email }}, follow the {{ link }}.

1
    <p>To confirm the change of email address from {{ request.user.email }} to {{ request.email }}, follow the <a href="{{ link }}">link</a>.</p>

structure.notifications_profile_changes_operator

A notification sent out to notify about profile changes. The recipients are Waldur operators.

Templates

1
    Owner details have been updated

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
    Owner of
    {% for o in organizations %}
        {{ o.name }} {% if o.abbreviation %} ({{ o.abbreviation }}){% endif %}{% if not forloop.last %}, {% endif %}
    {% endfor %}

    {{user.full_name}} (id={{ user.id }}) has changed

    {% for f in fields %}
        {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
    {% endfor %}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
    Owner of
    {% for o in organizations %}
        {{ o.name }} {% if o.abbreviation %} ({{ o.abbreviation }}){% endif %}{% if not forloop.last %}, {% endif %}
    {% endfor %}

    {{user.full_name}} (id={{ user.id }}) has changed

    {% for f in fields %}
        {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
    {% endfor %}

structure.structure_role_granted

A notification sent out when a role is granted. The recipient is the user who received the role.

Templates

1
    Role granted.

1
    Role {{ permission.role }}  for {{ structure }} has been granted.

1
    <p>Role {{ permission.role }}  for {{ structure }} has been granted.</p>

WALDUR_CORE.USERS

users.invitation_approved

A notification sent to notify the user that his invitation has been approved. The recipient is the user who's being invited.

Templates

1
    Account has been created

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    Hello!

    {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.
    Please visit the link below to sign up and accept your invitation:
    {{ link }}

    Your credentials are as following.

    Username is {{ username }}

    Your password is {{ password }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Account has been created</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.<br>
        Please visit <a href="{{ link }}">this page</a> to sign up and accept your invitation.
    </p>
    <p>
      Your credentials are as following.
    </p>
    <p>
      Your username is {{ username }}
    </p>
    <p>
      Your password is {{ password }}
    </p>
    </body>
    </html>

users.invitation_created

A notification sent to the user so that he can accept it and receive permissions. The recipient is the user who's being invited.

Templates

1
2
3
4
5
    {% if reminder %}
    REMINDER: Invitation to {{ name }} {{ type }}
    {% else %}
    Invitation to {{ name }} {{ type }}
    {% endif %}

1
2
3
4
5
6
    Hello!

    {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.
    Please visit the link below to sign up and accept your invitation:
    {{ link }}
    {{ extra_invitation_text }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Invitation to {{ name }} {{ type }}</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.<br>
        Please visit <a href="{{ link }}">this page</a> to sign up and accept your invitation.
        Please note: this invitation expires at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}!
    </p>
    <p>
        {{ extra_invitation_text }}
    </p>
    </body>
    </html>

users.invitation_expired

A notification sent out to notify the user that his invitation has expired. The recipient is the user who's being invited.

Templates

1
    Invitation has expired

1
2
3
4
    Hello!

    An invitation to {{ invitation.email }} has expired.
    This invitation expires at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Invitation to {{ invitation.email }} has expired</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        An invitation to {{ invitation.email }} has expired <br>
        An invitation to {{ invitation.email }} has expired at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}.

    </p>
    </body>
    </html>

users.invitation_rejected

A notification sent to notify the user that his invitation has been rejected. The recipient is the user who's being invited.

Templates

1
    Invitation has been rejected

1
2
3
4
5
6
7
8
9
    Hello!

    The following invitation has been rejected.

    Full name: {{ invitation.full_name }}

    Target: {{ name }} {{ type }}

    Role: {{ role }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Invitation to {{ name }} {{ type }}</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
      The following invitation has been rejected.
    </p>

    <p>
      Full name: {{ invitation.full_name }}
    </p>

    <p>
      Target: {{ name }} {{ type }}
    </p>

    <p>
      Role: {{ role }}
    </p>
    </body>
    </html>

users.invitation_requested

A notification sent to staff users so that they can approve or reject invitation. The recipients are active staff users.

Templates

1
    Invitation request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
    Hello!

    {{ sender }} has created invitation request for the following user
    to join {{ name }} {{ type }} in {{ role }} role.

    {% if invitation.civil_number %}
    Civil number: {{ invitation.civil_number }}
    {% endif %}

    {% if invitation.tax_number %}
    Tax number: {{ invitation.tax_number }}
    {% endif %}

    {% if invitation.phone_number %}
    Phone number: {{ invitation.phone_number }}
    {% endif %}

    E-mail: {{ invitation.email }}

    {% if invitation.full_name %}
    Full name: {{ invitation.full_name }}
    {% endif %}

    {% if invitation.native_name %}
    Native name: {{ invitation.native_name }}
    {% endif %}

    {% if invitation.organization %}
    Organization: {{ invitation.organization }}
    {% endif %}

    {% if invitation.job_title %}
    Job title: {{ invitation.job_title }}
    {% endif %}

    Please visit the link below to approve invitation: {{ approve_link }}

    Alternatively, you may reject invitation: {{ reject_link }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
    <html>
    <head lang="en">
      <meta charset="UTF-8">
      <title>Invitation request</title>
    </head>
    <body>
    <p>
      Hello!
    </p>
    <p>
      {{ sender }} has created invitation request for the following user
      to join {{ name }} {{ type }} in {{ role }} role.
    </p>

    {% if invitation.civil_number %}
      <p>
        Civil number: {{ invitation.civil_number }}
      </p>
    {% endif %}

    {% if invitation.tax_number %}
      <p>
        Tax number: {{ invitation.tax_number }}
      </p>
    {% endif %}

    {% if invitation.phone_number %}
      <p>
        Phone number: {{ invitation.phone_number }}
      </p>
    {% endif %}

    <p>
      E-mail: {{ invitation.email }}
    </p>

    {% if invitation.full_name %}
      <p>
        Full name: {{ invitation.full_name }}
      </p>
    {% endif %}

    {% if invitation.native_name %}
      <p>
        Native name: {{ invitation.native_name }}
      </p>
    {% endif %}

    {% if invitation.organization %}
      <p>
        Organization: {{ invitation.organization }}
      </p>
    {% endif %}

    {% if invitation.job_title %}
      <p>
        Job title: {{ invitation.job_title }}
      </p>
    {% endif %}

    <p>
      Please <a href="{{ approve_link }}">approve</a> or <a href="{{ reject_link }}">reject</a> invitation.
    </p>
    </body>
    </html>

users.permission_request_submitted

A notification sent out to notify about submitted permission request. The recipients are active staff users or customer owners.

Templates

1
    Permission request has been submitted.

1
2
3
4
5
    Hello!

    User {{ permission_request.created_by }} with email {{ permission_request.created_by.email }} created permission request for {{ permission_request.invitation }}.

    Please visit the link below to approve or reject permission request: {{ requests_link }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
    <html>
    <head lang="en">
      <meta charset="UTF-8">
      <title>Permission request has been submitted.</title>
    </head>
    <body>
    <p>
      Hello!
    </p>
    <p>
      User {{ permission_request.created_by }} with email {{ permission_request.created_by.email }} created permission request for {{ permission_request.invitation }}.
    </p>
    <p>
      Please visit the <a href="{{ requests_link }}">link</a> to approve or reject permission request.
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.BOOKING

booking.notification

A notification sent out to notify about upcoming bookings. The recipients are users who have upcoming bookings.

Templates

1
    Reminder about upcoming booking.

1
2
3
4
5
6
    Hello!

    Please do not forget about upcoming booking:
    {% for resource in resources %}
        {{ resource.name }}{% if not forloop.last %}, {% endif %}
    {% endfor %}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Reminder about upcoming booking.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Please do not forget about upcoming booking: <br />
        {% for resource in resources %}
            {{ resource.name }}
            {% if not forloop.last %}
                <br />
            {% endif %}
        {% endfor %}
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.INVOICES

invoices.notification

A notification of invoice. The recipients are organization owners.

Templates

1
    {{ customer }}'s invoice for {{ month }}/{{ year }}

1
2
3
4
    Hello,

    Please follow the link below to see {{ customer }}'s accounting information for {{ month }}/{{ year }}:
    {{ link }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html xmlns="http://www.w3.org/1999/html">
    <head lang="en">
        <meta charset="UTF-8">
        <title>{{ customer }}'s invoice for {{ month }}/{{ year }}</title>
    </head>
    <body>
    <p>
        Dear Sir or Madam,
    </p>
    <p>
        Attached is invoice for services consumed by {{ customer }}'s during {{ month }}/{{ year }}.
    </p>
    </body>
    </html>

invoices.upcoming_ends_notification

A notification about upcoming contract ending. The recipients are organization owners.

Templates

1
    {{ organization_name }}'s fixed price contract {{ contract_number }} is coming to an end

1
2
3
    Hello,

    this is a reminder that {{ organization_name }}'s fixed price contract {{ contract_number }} is ending on {{ end }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>{{ organization_name }}'s fixed price contract {{ contract_number }} is coming to an end.</title>
    </head>
    <body>
    <p>
        Hello,
        <br/>
        this is a reminder that {{ organization_name }}'s fixed price contract {{ contract_number }} is ending on {{ end }}.
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.MARKETPLACE

marketplace.marketplace_resource_create_failed

A notification of a failed resource creation

Templates

1
    Resource {{ resource_name }} creation has failed.

1
2
3
    Hello!

    Resource {{ resource_name }} creation has failed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} creation has failed.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} creation has failed.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_create_succeeded

A notification of a successful resource creation

Templates

1
    Resource {{ resource_name }} has been created.

1
2
3
    Hello!

    Resource {{ resource_name }} has been created.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} has been created.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} has been created.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_terminate_failed

A notification of a failed resource termination

Templates

1
    Resource {{ resource_name }} deletion has failed.

1
2
3
    Hello!

    Resource {{ resource_name }} deletion has failed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} deletion has failed.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} deletion has failed.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_terminate_succeeded

A notification of a successful resource termination

Templates

1
    Resource {{ resource_name }} has been deleted.

1
2
3
    Hello!

    Resource {{ resource_name }} has been deleted.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} has been deleted.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} has been deleted.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_termination_scheduled

A notification of a scheduled resource termination. The recipients are project administrators and managers

Templates

1
    Resource {{ resource.name }} termination has been scheduled.

1
2
3
    Hello!

    The resource you have - {{ resource.name }} has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}. If you feel that you still want to keep it, please remove the resource end date {{ resource_url }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource.name }} termination has been scheduled.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        The resource you have - <a href="{{ resource_url }}">{{ resource.name }}</a> has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}.
        If you feel that you still want to keep it, please <a href="{{ resource_url }}"></a>remove the resource end date</a>.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_termination_scheduled_staff

A notification of a resource termination. The recipients are project administrators and managers.

Templates

1
    Resource {{ resource.name }} termination has been scheduled.

1
2
3
    Hello!

    The resource you have - {{ resource.name }} has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}. If you feel that you still want to keep it, please remove the resource end date {{ resource_url }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource.name }} termination has been scheduled.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        The resource you have - <a href="{{ resource_url }}">{{ resource.name }}</a> has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}.
        If you feel that you still want to keep it, please <a href="{{ resource_url }}"></a>remove the resource end date</a>.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_update_failed

A notification of failed resource update

Templates

1
    Resource {{ resource_name }} update has failed.

1
2
3
    Hello!

    Resource {{ resource_name }} update has failed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} update has failed.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} update has failed.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_update_limits_failed

A notification of failed resource limits update

Templates

1
    Resource {{ resource_name }} limits update has failed.

1
2
3
    Hello!

    Resource {{ resource_name }} limits update has failed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} limits update has failed.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} limits update has failed.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_update_limits_succeeded

A notification of a successful resource limit update. The recipients are all the users in the project.

Templates

1
    Resource {{ resource_name }} limits have been updated.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    Hello!

    Following request from {{ order_user }}, resource {{ resource_name }} limits have been updated from:
        {{ resource_old_limits }}
    to:
        {{ resource_limits }}.

    {% if support_email or support_phone %}
    If you have any additional questions, please contact support.
    {% if support_email %}
    Email: {{ support_email }}
    {% endif %}
    {% if support_phone %}
    Phone: {{ support_phone }}
    {% endif %}
    {% endif %}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} limits have been updated.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Following request from {{ order_user }}, resource {{ resource_name }} limits have been updated from:<br>
        <blockquote>
            {{ resource_old_limits }}
        </blockquote>
        to:
        <blockquote>
            {{ resource_limits }}
        </blockquote>
    </p>
    {% if support_email or support_phone %}
    <p>
        If you have any additional questions, please contact support.
    </p>
    {% if support_email %}
    <p>
        Email: {{ support_email }}
    </p>
    {% endif %}
    {% if support_phone %}
    <p>
        Phone: {{ support_phone }}
    </p>
    {% endif %}
    {% endif %}
    </body>
    </html>

marketplace.marketplace_resource_update_succeeded

A notification of a successful resource update. The recipients are all the users in the project.

Templates

1
    Resource {{ resource_name }} has been updated.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
    Hello!

    Following request from {{ order_user }}, resource {{ resource_name }} has been updated.

    {% if resource_old_plan %}
    The plan has been changed from {{ resource_old_plan }} to {{ resource_plan }}.
    {% endif %}

    {% if support_email or support_phone %}
    If you have any additional questions, please contact support.
    {% if support_email %}
    Email: {{ support_email }}
    {% endif %}
    {% if support_phone %}
    Phone: {{ support_phone }}
    {% endif %}
    {% endif %}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} has been updated.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Following request from {{ order_user }}, resource {{ resource_name }} has been updated.
    </p>
    {% if resource_old_plan %}
    <p>
        The plan has been changed from {{ resource_old_plan }} to {{ resource_plan }}.
    </p>
    {% endif %}
    {% if support_email or support_phone %}
    <p>
        If you have any additional questions, please contact support.
    </p>
    {% if support_email %}
    <p>
        Email: {{ support_email }}
    </p>
    {% endif %}
    {% if support_phone %}
    <p>
        Phone: {{ support_phone }}
    </p>
    {% endif %}
    {% endif %}
    </body>
    </html>

marketplace.notification_about_project_ending

A notification about project ending. The recipients are project managers and customer owners.

Templates

1
    Project {{ project.name }} will be deleted.

1
2
3
4
5
6
7
    Dear {{ user.full_name }},

    Your project {{ project.name }} is ending {% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}. End of the project will lead to termination of all resources in the project.
    If you are aware of that, then no actions are needed from your side.
    If you need to update project end date, please update it in project details {{ project_url }}.

    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Project {{ project.name }} will be deleted.</title>
    </head>
    <body>
    <p>Dear {{ user.full_name }},</p>

    <p>Your project {{ project.name }} is ending
        {% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.
        End of the project will lead to termination of all resources in the project. <br />
        If you are aware of that, then no actions are needed from your side. <br />
        If you need to update project end date, please update it in project details {{ project_url }}.
    </p>

    <p>Thank you!</p>
    </body>
    </html>

marketplace.notification_about_resource_ending

A notification about resource ending. The recipients are project managers and customer owners.

Templates

1
    Resource {{ resource.name }} will be deleted.

1
2
3
4
5
6
7
    Dear {{ user.full_name }},

    Termination date of your {{ resource.name }} is approaching and it will be deleted{% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.
    If you are aware of that, then no actions are needed from your side.
    If you need to update resource end date, please update it in resource details {{ resource_url }}.

    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource.name }} will be deleted.</title>
    </head>
    <body>
    <p>Dear {{ user.full_name }},</p>

    <p>
        Termination date of your {{ resource.name }} is approaching and it will be
        deleted{% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.<br />
        If you are aware of that, then no actions are needed from your side. <br />
        If you need to update resource end date, please update it in resource details {{ resource_url }}.
    </p>

    <p>Thank you!</p>
    </body>
    </html>

marketplace.notification_about_stale_resources

A notification about stale resources. The recipients are organization owners.

Templates

1
    Reminder about stale resources.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
    Hello!

    We noticed that you have stale resources that have not cost you anything for the last 3 months.
    Perhaps some of them are not needed any more?

    The resource names are:
    {% for resource in resources %}
        {{ resource.resource.name }} {{ resource.resource_url }}
    {% endfor %}
    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Reminder about stale resources.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        We noticed that you have stale resources that have not cost you anything for the last 3 months. <br />
        Perhaps some of them are not needed any more?<br />

        The resource names are:
        <ul>
            {% for resource in resources %}
                <li><a href='{{ resource.resource_url }}'>{{ resource.resource.name }}</a></li>
            {% endfor %}
        </ul>
        Thank you!
    </p>
    </body>
    </html>

marketplace.notification_usages

A notification about usages. The recipients are organization owners.

Templates

1
    Reminder about missing usage reports.

1
2
3
4
5
6
7
8
    Hello!

    Please do not forget to add usage for the resources you provide:
    {% regroup resources by offering as offering_list %}{% for offering in offering_list %}
    {{forloop.counter}}. {{ offering.grouper.name }}:{% for resource in offering.list %}
        - {{ resource.name }}
    {% endfor %}{% endfor %}
    You can submit resource usage via API or do it manually at {{ public_resources_url }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Reminder about missing usage reports.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>Please do not forget to add usage for the resources you provide:</p>
    {% regroup resources by offering as offering_list %}

    <ol>
    {% for offering in offering_list %}
        <li>
            {{ offering.grouper.name }}:
            <ul>
                {% for resource in offering.list %}
                <li>{{ resource.name }}</li>
                {% endfor %}
            </ul>
        </li>
    {% endfor %}
    </ol>

    <p>
        You can submit resource usage via API or do it <a href='{{ public_resources_url }}'>manually</a>.
    </p>
    </body>
    </html>

marketplace.notify_consumer_about_pending_order

A notification for consumer about pending order. The recipients are users that have permissions to approve the order.

Templates

1
    A new order by {{ order.created_by.get_full_name }} is waiting for approval.

1
2
3
    Hello!

    A new order by {{ order.created_by.get_full_name }} is waiting for approval.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>A new order by {{ order.created_by.get_full_name }} is waiting for approval.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Please visit <a href="{{ order_link }}">{{ site_name }}</a> to find out more details.
    </p>
    </body>
    </html>

marketplace.notify_provider_about_pending_order

A notification for provider about pending order. The recipients are users that have permissions to approve the order.

Templates

1
    A new order by {{ order.created_by.get_full_name }} is waiting for approval.

1
2
3
    Hello!

    A new order by {{ order.created_by.get_full_name }} is waiting for approval.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>A new order by {{ order.created_by.get_full_name }} is waiting for approval.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Please visit <a href="{{ order_url }}">{{ site_name }}</a> to find out more details.
    </p>
    </body>
    </html>

WALDUR_RANCHER

rancher.notification_create_user

A notification for created rancher user. The recipients is the user who requested the creation.

Templates

1
    New account has been created.

1
2
3
4
    Hello!

    User with login {{ user.username }} and temporary password {{ password }} has been created.
    Please go to management console {{ rancher_url }} to change the password.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>A new user account has been created for you.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        User with login {{ user.username }} and temporary password {{ password }} has been created.<br />
        Please go to <a href="{{ rancher_url }}">management console</a> to change the password.
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.MARKETPLACE_REMOTE

marketplace_remote.notification_about_pending_project_updates

A notification about pending project updates. The recipients are customer owners

Templates

1
    Reminder about pending project updates.

1
2
3
4
5
6
7
8
    Hello!

    We noticed that you have pending project update requests.
    Perhaps you would like to have a look at them?

    The project is:
        {{ project_update_request.project.name }} {{ project_url }}
    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Reminder about pending project updates.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        We noticed that you have pending project update requests.<br />
        Perhaps you would like to have a look at them?<br />

        The project is:
        <ul>
            <li><a href='{{ project_url }}'>{{ project_update_request.project.name }}</a></li>
        </ul>
        Thank you!
    </p>
    </body>
    </html>

marketplace_remote.notification_about_project_details_update

A notification about project details update. The recipients the user who requested project details update and the user that reviewed it.

Templates

1
    A notification about project details update.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
    Hello!

    We would like to notify you about recent updates in project details.
    Perhaps you would like to have a look at them?

    The project is:
        {{ new_name }} {{ project_url }}

        Details after the update are below:
            {% if new_description %}
                Old description: {{ old_description }}
                New description: {{ new_description }}
            {% endif %}

            {% if new_name %}
                Old name: {{ old_name }}
                New name: {{ new_name }}
            {% endif %}

            {% if new_end_date %}
               Old end date: {{ old_end_date }}
               New end date: {{ new_end_date }}
            {% endif %}

            {% if new_oecd_fos_2007_code %}
               Old OECD FOS 2007 code: {{ old_oecd_fos_2007_code }}
               New OECD FOS 2007 code: {{ new_oecd_fos_2007_code }}
            {% endif %}

            {% if new_is_industry %}
               Old is_industry: {{ old_is_industry }}
               New is_industry: {{ new_is_industry }}
            {% endif %}

        Reviewed by: {{ reviewed_by }}
    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>A notification about project details update.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        We would like to notify you about recent updates in project details.<br />
        Perhaps you would like to have a look at them?<br />

        The project is:
        <ul>
            <li><a href='{{ project_url }}'>{{ new_name }}</a></li>
        </ul>

        <div>
            Details after the update are below:
            <ul>
                {% if new_description %}
                    <li>Old description: {{ old_description }}</li>
                    <li>New description: {{ new_description }}</li>
                {% endif %}

                {% if new_name %}
                    <li>Old name: {{ old_name }}</li>
                    <li>New name: {{ new_name }}</li>
                {% endif %}

                {% if new_end_date %}
                    <li>Old end date: {{ old_end_date }}</li>
                    <li>New end date: {{ new_end_date }}</li>
                {% endif %}

                {% if new_oecd_fos_2007_code %}
                    <li>Old OECD FOS 2007 code: {{ old_oecd_fos_2007_code }}</li>
                    <li>New OECD FOS 2007 code: {{ new_oecd_fos_2007_code }}</li>
                {% endif %}

                {% if new_is_industry %}
                    <li>Old is_industry: {{ old_is_industry }}</li>
                    <li>New is_industry: {{ new_is_industry }}</li>
                {% endif %}
                <li>Reviewed by: {{ reviewed_by }}</li>
            </ul>

        </div>
        Thank you!
    </p>
    </body>
    </html>

marketplace_policy.notification_about_project_cost_exceeded_limit

Notification about project cost exceeded limit. The recipients are all customer owners of the project.

Templates

1
    {{ scope_class }} {{ scope_name }} cost has exceeded the limit.

1
2
    Hello!
    {{ scope_class }} {{ scope_name }} ({{ scope_url }}) cost has exceeded the limit of {{ limit }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>{{ scope_class }} {{ scope_name }} cost has exceeded the limit.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        {{ scope_class }} <a href='{{ scope_url }}'>{{ scope_name }}</a> cost has exceeded the limit of {{ limit }}.
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.SUPPORT

support.description

A notification used for issue creation.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    {{issue.description}}

    Additional Info:
    {% if issue.customer %}- Organization: {{issue.customer.name}}{% endif %}
    {% if issue.project %}- Project: {{issue.project.name}}{% endif %}
    {% if issue.resource %}
        {% if issue.resource.service_settings %}
            {% if issue.resource.service_settings.type %}- Service type: {{issue.resource.service_settings.type}}{% endif %}
            - Offering name: {{ issue.resource.service_settings.name }}
            - Offering provided by: {{ issue.resource.service_settings.customer.name }}
        {% endif %}
        - Affected resource: {{issue.resource}}
        - Backend ID: {{issue.resource.backend_id}}
    {% endif %}
    - Site name: {{ settings.WALDUR_CORE.SITE_NAME }}
    - Site URL: {{ settings.WALDUR_CORE.HOMEPORT_URL }}

support.notification_comment_added

Notification about a new comment in the issue. The recipient is issue caller.

Templates

1
2
3
    Hello!

    The issue you have created has a new comment. Please go to {{issue_url}} to see it.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>The issue you have created ({{ issue.key }}) has a new comment</title>
    </head>
    <body>
    <p>
        {% if is_system_comment %}
            Added a new comment.
        {% else %}
            {{ comment.author.name }} added a new comment.
        {% endif %}
    </p>
    <p>
        <a href="{{ issue_url }}">[{{ issue.key }}] {{ issue.summary }}</a>
    </p>
    <div>
        {{ description|safe }}
    </div>
    </body>
    </html>

1
    The issue ({{ issue.key }}) you have created has a new comment

support.notification_comment_updated

Notification about an update in the issue comment. The recipient is issue caller.

Templates

1
2
3
    Hello!

    The comment has been updated. Please go to {{issue_url}} to see it.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>The comment has been updated ({{ issue.key }})</title>
    </head>
    <body>
    <p>
        {{ comment.author.name }} updated comment.
    </p>
    <p>
        <a href="{{ issue_url }}">[{{ issue.key }}] {{ issue.summary }}</a>
    </p>
    <p>
        Old comment:
    </p>
    <p>
        {{ old_description|safe }}
    </p>
    <p>
        New comment:
    </p>
    <p>
        {{ description|safe }}
    </p>
    </body>
    </html>

1
    Issue {{ issue.key }}. The comment has been updated

support.notification_issue_feedback

Notification about a feedback related to the issue. The recipient is issue caller.

Templates

1
2
3
4
5
6
7
8
9
    Hello, {{issue.caller.full_name}}!

    We would like to hear your feedback regarding your recent experience with support for {{issue_url}}.

    Click on the evaluations below to provide the feedback.

    {% for link in feedback_links%}
        {{link.label}}: {{link.link}}
    {% endfor %}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>The issue you have ({{ issue.key }}) has been updated</title>

        <style>
            * {
              font-family: sans-serif;
            }
            .rating {
              unicode-bidi: bidi-override;
              direction: rtl;
              width: 500px;
            }
            .rating > a {
              display: inline-block;
              position: relative;
              width: 1.1em;
              text-decoration: none;
              font-size: xx-large;
              color: rgba(180, 179, 178, 1);
            }
            .rating > a:hover:before,
            .rating > a:hover ~ a:before {
               content: "\2605";
               position: absolute;
               color: rgba(224, 194, 75, 1);
            }
        </style>

    </head>
    <body>
    <p>Hello, {{issue.caller.full_name}}!</p>
    <p>We would like to hear your feedback regarding your recent experience with support for
        <a href='{{issue_url}}'>{{ issue.summary }}</a>.
    </p>
    <p>Click the stars below to provide your feedback:</p>
    <div class="rating">
        {% for link in feedback_links reversed %}
            <a href='{{link.link}}'>☆</a>
        {% endfor %}
    </div>
    </body>
    </html>

1
    Please share your feedback: {{issue.key}} {{issue.summary}}

support.notification_issue_updated

Notification about an update in the issue. The recipient is issue caller.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    Hello!

    The issue you have has been updated.

    {% if changed.status %}
    Status has been changed from {{ changed.status }} to {{ issue.status }}.
    {% endif %}
    {% if changed.description %}
    Description has been changed from {{ changed.description }} to {{ issue.description }}.
    {% endif %}
    {% if changed.summary %}
    Summary has been changed from {{ changed.summary }} to {{ issue.summary }}.
    {% endif %}
    {% if changed.priority %}
    Priority has been changed from {{ changed.priority }} to {{ issue.priority }}.
    {% endif %}

    Please go to {{issue_url}} to see it.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>The issue you have ({{ issue.key }}) has been updated</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    {% if changed.status %}
    <p>
        Status has been changed from <strong>{{ changed.status }}</strong> to <strong>{{ issue.status }}</strong>.
    </p>
    {% endif %}
    {% if old_description %}
    <p>
        Description has been changed from <strong>{{ old_description|safe }}</strong> to <strong>{{ description|safe }}</strong>.
    </p>
    {% endif %}
    {% if changed.summary %}
    <p>
        Summary has been changed from <strong>{{ changed.summary }}</strong> to <strong>{{ issue.summary }}</strong>.
    </p>
    {% endif %}
    {% if changed.priority %}
    <p>
        Priority has been changed from <strong>{{ changed.priority }}</strong> to <strong>{{ issue.priority }}</strong>.
    </p>
    {% endif %}
    <p>
        Please visit <a href="{{ issue_url }}">{{ site_name }}</a> to find out more details.
    </p>
    </body>
    </html>

1
    Updated issue: {{issue.key}} {{issue.summary}}

support.summary

A notification used for issue creation.

Templates

1
    {% if issue.customer.abbreviation %}{{issue.customer.abbreviation}}: {% endif %}{{issue.summary}}

Message templates

waldur_core.logging

email.html (waldur_core.logging)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Notifications from waldur_core</title>
</head>
<body>
<ul>
    {% for event in events %}
    <li>
        {{ event.message }}
        <div>{{ event.created|date:"M d H:i e"}}</div>
    </li>
    {% endfor %}
</ul>
</body>
</html>

waldur_core.structure

notifications_profile_changes_operator_subject.txt (waldur_core.structure)

1
Owner details have been updated

notifications_profile_changes.html (waldur_core.structure)

1
2
3
4
5
User {{user.full_name}} (id={{ user.id }}) profile has been updated:

{% for f in fields %}
    {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
{% endfor %}

change_email_request_subject.txt (waldur_core.structure)

1
Verify new email address.

notifications_profile_changes_operator_message.html (waldur_core.structure)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Owner of
{% for o in organizations %}
    {{ o.name }} {% if o.abbreviation %} ({{ o.abbreviation }}){% endif %}{% if not forloop.last %}, {% endif %}
{% endfor %}

{{user.full_name}} (id={{ user.id }}) has changed

{% for f in fields %}
    {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
{% endfor %}

structure_role_granted_message.txt (waldur_core.structure)

1
Role {{ permission.role }}  for {{ structure }} has been granted.

structure_role_granted_subject.txt (waldur_core.structure)

1
Role granted.

change_email_request_message.html (waldur_core.structure)

1
<p>To confirm the change of email address from {{ request.user.email }} to {{ request.email }}, follow the <a href="{{ link }}">link</a>.</p>

change_email_request_message.txt (waldur_core.structure)

1
To confirm the change of email address from {{ request.user.email }} to {{ request.email }}, follow the {{ link }}.

notifications_profile_changes_operator_message.txt (waldur_core.structure)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Owner of
{% for o in organizations %}
    {{ o.name }} {% if o.abbreviation %} ({{ o.abbreviation }}){% endif %}{% if not forloop.last %}, {% endif %}
{% endfor %}

{{user.full_name}} (id={{ user.id }}) has changed

{% for f in fields %}
    {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
{% endfor %}

structure_role_granted_message.html (waldur_core.structure)

1
<p>Role {{ permission.role }}  for {{ structure }} has been granted.</p>

waldur_core.users

invitation_approved_subject.txt (waldur_core.users)

1
Account has been created

invitation_created_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Invitation to {{ name }} {{ type }}</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.<br>
    Please visit <a href="{{ link }}">this page</a> to sign up and accept your invitation.
    Please note: this invitation expires at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}!
</p>
<p>
    {{ extra_invitation_text }}
</p>
</body>
</html>

permission_request_submitted_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
<html>
<head lang="en">
  <meta charset="UTF-8">
  <title>Permission request has been submitted.</title>
</head>
<body>
<p>
  Hello!
</p>
<p>
  User {{ permission_request.created_by }} with email {{ permission_request.created_by.email }} created permission request for {{ permission_request.invitation }}.
</p>
<p>
  Please visit the <a href="{{ requests_link }}">link</a> to approve or reject permission request.
</p>
</body>
</html>

invitation_approved_message.txt (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
Hello!

{{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.
Please visit the link below to sign up and accept your invitation:
{{ link }}

Your credentials are as following.

Username is {{ username }}

Your password is {{ password }}

invitation_created_message.txt (waldur_core.users)

1
2
3
4
5
6
Hello!

{{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.
Please visit the link below to sign up and accept your invitation:
{{ link }}
{{ extra_invitation_text }}

invitation_expired_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Invitation to {{ invitation.email }} has expired</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    An invitation to {{ invitation.email }} has expired <br>
    An invitation to {{ invitation.email }} has expired at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}.

</p>
</body>
</html>

invitation_approved_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Account has been created</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.<br>
    Please visit <a href="{{ link }}">this page</a> to sign up and accept your invitation.
</p>
<p>
  Your credentials are as following.
</p>
<p>
  Your username is {{ username }}
</p>
<p>
  Your password is {{ password }}
</p>
</body>
</html>

invitation_expired_subject.txt (waldur_core.users)

1
Invitation has expired

invitation_expired_message.txt (waldur_core.users)

1
2
3
4
Hello!

An invitation to {{ invitation.email }} has expired.
This invitation expires at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}.

invitation_rejected_message.txt (waldur_core.users)

1
2
3
4
5
6
7
8
9
Hello!

The following invitation has been rejected.

Full name: {{ invitation.full_name }}

Target: {{ name }} {{ type }}

Role: {{ role }}

invitation_rejected_subject.txt (waldur_core.users)

1
Invitation has been rejected

invitation_created_subject.txt (waldur_core.users)

1
2
3
4
5
{% if reminder %}
REMINDER: Invitation to {{ name }} {{ type }}
{% else %}
Invitation to {{ name }} {{ type }}
{% endif %}

permission_request_submitted_subject.txt (waldur_core.users)

1
Permission request has been submitted.

invitation_requested_message.txt (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Hello!

{{ sender }} has created invitation request for the following user
to join {{ name }} {{ type }} in {{ role }} role.

{% if invitation.civil_number %}
Civil number: {{ invitation.civil_number }}
{% endif %}

{% if invitation.tax_number %}
Tax number: {{ invitation.tax_number }}
{% endif %}

{% if invitation.phone_number %}
Phone number: {{ invitation.phone_number }}
{% endif %}

E-mail: {{ invitation.email }}

{% if invitation.full_name %}
Full name: {{ invitation.full_name }}
{% endif %}

{% if invitation.native_name %}
Native name: {{ invitation.native_name }}
{% endif %}

{% if invitation.organization %}
Organization: {{ invitation.organization }}
{% endif %}

{% if invitation.job_title %}
Job title: {{ invitation.job_title }}
{% endif %}

Please visit the link below to approve invitation: {{ approve_link }}

Alternatively, you may reject invitation: {{ reject_link }}

invitation_rejected_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Invitation to {{ name }} {{ type }}</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
  The following invitation has been rejected.
</p>

<p>
  Full name: {{ invitation.full_name }}
</p>

<p>
  Target: {{ name }} {{ type }}
</p>

<p>
  Role: {{ role }}
</p>
</body>
</html>

permission_request_submitted_message.txt (waldur_core.users)

1
2
3
4
5
Hello!

User {{ permission_request.created_by }} with email {{ permission_request.created_by.email }} created permission request for {{ permission_request.invitation }}.

Please visit the link below to approve or reject permission request: {{ requests_link }}.

invitation_requested_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<html>
<head lang="en">
  <meta charset="UTF-8">
  <title>Invitation request</title>
</head>
<body>
<p>
  Hello!
</p>
<p>
  {{ sender }} has created invitation request for the following user
  to join {{ name }} {{ type }} in {{ role }} role.
</p>

{% if invitation.civil_number %}
  <p>
    Civil number: {{ invitation.civil_number }}
  </p>
{% endif %}

{% if invitation.tax_number %}
  <p>
    Tax number: {{ invitation.tax_number }}
  </p>
{% endif %}

{% if invitation.phone_number %}
  <p>
    Phone number: {{ invitation.phone_number }}
  </p>
{% endif %}

<p>
  E-mail: {{ invitation.email }}
</p>

{% if invitation.full_name %}
  <p>
    Full name: {{ invitation.full_name }}
  </p>
{% endif %}

{% if invitation.native_name %}
  <p>
    Native name: {{ invitation.native_name }}
  </p>
{% endif %}

{% if invitation.organization %}
  <p>
    Organization: {{ invitation.organization }}
  </p>
{% endif %}

{% if invitation.job_title %}
  <p>
    Job title: {{ invitation.job_title }}
  </p>
{% endif %}

<p>
  Please <a href="{{ approve_link }}">approve</a> or <a href="{{ reject_link }}">reject</a> invitation.
</p>
</body>
</html>

invitation_requested_subject.txt (waldur_core.users)

1
Invitation request

waldur_mastermind.booking

notification_message.txt (waldur_mastermind.booking)

1
2
3
4
5
6
Hello!

Please do not forget about upcoming booking:
{% for resource in resources %}
    {{ resource.name }}{% if not forloop.last %}, {% endif %}
{% endfor %}.

notification_message.html (waldur_mastermind.booking)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Reminder about upcoming booking.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Please do not forget about upcoming booking: <br />
    {% for resource in resources %}
        {{ resource.name }}
        {% if not forloop.last %}
            <br />
        {% endif %}
    {% endfor %}
</p>
</body>
</html>

notification_subject.txt (waldur_mastermind.booking)

1
Reminder about upcoming booking.

waldur_mastermind.invoices

monthly_invoicing_reports.html (waldur_mastermind.invoices)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{% load i18n %}
{% load static %}
{% load humanize %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <style type="text/css">
        {% include "./style.css" %}
    </style>
</head>
<body>
<h2>{% trans 'Fixed price contracts:' %}</h2>
{% if contracts %}
    <table class="invoice-table">
        <thead>
            <tr>
                <th></th>
                <th>{% trans 'Organization' %}</th>
                <th>{% trans 'Contract end date' %}</th>
                <th>{% trans 'Till the end of contract. [days]' %}</th>
                <th>{% trans 'Contract sum' %}</th>
                <th>{% trans 'Payment sum' %}</th>
            </tr>
        </thead>
        <tbody>
            {% for contract in contracts %}
                <tr>
                    <th>{{ forloop.counter }}</th>
                    <td>{{ contract.name }}</td>
                    <td>{{ contract.end|date:"Y-m-d"|default_if_none:"" }}</td>
                    <td {% if contract.end_date_alarm %} class="text-danger" {% endif %}>{{ contract.till_end|default_if_none:"" }}</td>
                    <td {% if contract.payments_alarm %} class="text-danger" {% endif %}>
                        {{ contract.contract_sum|default_if_none:0|floatformat:"2"|intcomma }}
                    </td>
                    <td {% if contract.payments_alarm %} class="text-danger" {% endif %}>
                        {{ contract.payments_sum|default_if_none:0|floatformat:"2"|intcomma }}
                    </td>
                </tr>
            {% endfor %}
        </tbody>
    </table>
{% else %}
    <p>{% trans 'Contracts do not exist.' %}</p>
{% endif %}

<h2>{% blocktrans %}Invoices for month {{ month }}-{{ year }}:{% endblocktrans %}</h2>

<table class="invoice-table">
    <thead>
        <tr>
            <th></th>
            <th>{% trans 'Organization' %}</th>
            <th>{% trans 'Invoice date' %}</th>
            <th>{% trans 'Invoice sum' %}</th>
        </tr>
    </thead>
    <tbody>
        {% for invoice in invoices %}
            <tr>
                <th>{{ forloop.counter }}</th>
                <td>{% if invoice.customer.abbreviation %}
                        {{ invoice.customer.abbreviation }}
                    {% else %}
                        {{ invoice.customer.name }}
                    {% endif %}</td>
                <td>{{ invoice.invoice_date|date:"Y-m-d" }}</td>
                <td>{{ invoice.total|floatformat:"2"|intcomma }}</td>
            </tr>
        {% endfor %}
    </tbody>
</table>

</body>
</html>

report_body.txt (waldur_mastermind.invoices)

1
Attached is an accounting report for {{ month }}/{{ year }}.

invoice.html (waldur_mastermind.invoices)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
{% load i18n %}
{% load humanize %}

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Invoice</title>
    <style type="text/css">
      {% include "waldur_core/font.css" %}
      {% include "./style.css" %}
    </style>
  </head>
  <body>
      {% if deployment_logo %}
      <div id="logo">
        <img src="data:image/png;base64,{{ deployment_logo }}">
      </div>
      {% endif %}
      <h1>{% trans "Invoice No." %} {{ invoice.number|upper }}</h1>
      <br>
      <div class="text-right">
          <strong>{% trans "Invoice date" %}:</strong> {% if invoice.invoice_date %}
        {{ invoice.invoice_date|date:"Y-m-d" }} {% else %} {% trans "Pending" %} {% endif %}<br/>
          {% if invoice.due_date %}<strong>{% trans "Due date" %}:</strong> {{ invoice.due_date|date:"Y-m-d" }}<br/>{% endif %}
          <strong>{% trans "Invoice period" %}:</strong> {{ invoice.year }}-{{ invoice.month }}<br/>
      </div>

      <div>
        <h3 class="name">From</h3>
        <div><strong>{{ issuer_details.company }}</strong></div>
        <div>{{ issuer_details.address }}</div>
        <div>{{ issuer_details.country }}, {{ issuer_details.postal }}</div>
        <div><abbr>P:</abbr> ({{ issuer_details.phone.country_code }}) {{ issuer_details.phone.national_number }}</div>
        <div>{{ issuer_details.bank }}, {{ issuer_details.account }}</div>
        <div><abbr>{% trans "VAT" %}:</abbr>{{ issuer_details.vat_code }}</div>
        <div>{{ issuer_details.email }}</div>
      </div>
      <div>
        <h3 class="name">To</h3>
        <div><strong>{{ invoice.customer.name }}</strong></div>

        {% if invoice.customer.address %}
          <div>{{ invoice.customer.address }}</div>
        {% endif %}

        {% if invoice.customer.country and invoice.customer.postal %}
          <div>{{ invoice.customer.country }}, {{ invoice.customer.postal }}</div>
        {% endif %}

        {% if invoice.customer.phone_number %}
          <div><abbr>P:</abbr> {{ invoice.customer.phone_number }}</div>
        {% endif %}

        {% if invoice.customer.bank_name and invoice.customer.bank_account %}
          <div>{{ invoice.customer.bank_name }}, {{ invoice.customer.bank_account }}</div>
        {% endif %}

        {% if customer.vat_code %}
          <div><abbr>{% trans "VAT" %}:</abbr> {{ customer.vat_code }}</div>
        {% endif %}

        <div>{{ invoice.customer.email }}</div>

      </div>
      <div class="m-t">
        <table class="invoice-table">
          <tr>
            <th>Item</th>
            <th>Quantity</th>
            <th>Unit price</th>
            <th>Total price</th>
          </tr>

          {% regroup items|dictsort:"project_name" by project_name as project_list %}
          {% for project in project_list %}
          <tr>
              <td colspan="4"><h3>{{ project.grouper }}</h3></td>
          </tr>
            {% for item in project.list %}
              <tr>
                <td>
                  <strong>{{ item.name }}</strong>
                  <div>
                    <small>
                      {% trans "Start time" %}: {{ item.start | date:"Y-m-d H:i" }}.
                      {% trans "End time" %}: {{ item.end | date:"Y-m-d H:i" }}.
                    </small>
                  </div>
                </td>
                <td>{{ item.quantity }}</td>
                <td>{{ currency }} {{ item.unit_price | floatformat:2 | intcomma }}</td>
                <td>{{ currency }} {{ item.total | floatformat:2 | intcomma }}</td>
              </tr>
            {% endfor %}
          {% endfor %}
        </table>
      </div>
      <table class="m-t invoice-total">
        <tr>
          <td><strong>{% trans "Subtotal" %}</strong></td>
          <td>{{ currency }} {{ invoice.price | floatformat:2 | intcomma}}</td>
        </tr>
        {% if invoice.tax %}
          <tr>
            <td><strong>{% trans "VAT" %}</strong></td>
            <td>{{ currency }} {{ invoice.tax | floatformat:2 | intcomma}}</td>
          </tr>
        {% endif %}
        <tr>
          <td><strong>{% trans "TOTAL" %}</strong></td>
          <td>{{ currency }} {{ invoice.total | floatformat:2 | intcomma}}</td>
      </tr>
      </table>
  </body>
</html>

notification_message.txt (waldur_mastermind.invoices)

1
2
3
4
Hello,

Please follow the link below to see {{ customer }}'s accounting information for {{ month }}/{{ year }}:
{{ link }}

upcoming_ends_notification_message.txt (waldur_mastermind.invoices)

1
2
3
Hello,

this is a reminder that {{ organization_name }}'s fixed price contract {{ contract_number }} is ending on {{ end }}.

upcoming_ends_notification_subject.txt (waldur_mastermind.invoices)

1
{{ organization_name }}'s fixed price contract {{ contract_number }} is coming to an end

report_subject.txt (waldur_mastermind.invoices)

1
Waldur accounting report for {{ month }}/{{ year }}

notification_message.html (waldur_mastermind.invoices)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html xmlns="http://www.w3.org/1999/html">
<head lang="en">
    <meta charset="UTF-8">
    <title>{{ customer }}'s invoice for {{ month }}/{{ year }}</title>
</head>
<body>
<p>
    Dear Sir or Madam,
</p>
<p>
    Attached is invoice for services consumed by {{ customer }}'s during {{ month }}/{{ year }}.
</p>
</body>
</html>

upcoming_ends_notification_message.html (waldur_mastermind.invoices)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>{{ organization_name }}'s fixed price contract {{ contract_number }} is coming to an end.</title>
</head>
<body>
<p>
    Hello,
    <br/>
    this is a reminder that {{ organization_name }}'s fixed price contract {{ contract_number }} is ending on {{ end }}.
</p>
</body>
</html>

notification_subject.txt (waldur_mastermind.invoices)

1
{{ customer }}'s invoice for {{ month }}/{{ year }}

waldur_mastermind.marketplace

notification_about_project_ending_subject.txt (waldur_mastermind.marketplace)

1
Project {{ project.name }} will be deleted.

marketplace_resource_update_limits_succeeded_message.txt (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
Hello!

Following request from {{ order_user }}, resource {{ resource_name }} limits have been updated from:
    {{ resource_old_limits }}
to:
    {{ resource_limits }}.

{% if support_email or support_phone %}
If you have any additional questions, please contact support.
{% if support_email %}
Email: {{ support_email }}
{% endif %}
{% if support_phone %}
Phone: {{ support_phone }}
{% endif %}
{% endif %}

marketplace_resource_update_limits_succeeded_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} limits have been updated.

notification_about_stale_resources_message.txt (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Hello!

We noticed that you have stale resources that have not cost you anything for the last 3 months.
Perhaps some of them are not needed any more?

The resource names are:
{% for resource in resources %}
    {{ resource.resource.name }} {{ resource.resource_url }}
{% endfor %}
Thank you!

marketplace_plan_template.txt (waldur_mastermind.marketplace)

1
2
3
Plan: {{ plan.name }}{% for component in components %}
{{component.name}}; amount: {{component.amount}}; price: {{component.price|floatformat }};
{% endfor %}

notification_usages_message.txt (waldur_mastermind.marketplace)

1
2
3
4
5
6
7
8
Hello!

Please do not forget to add usage for the resources you provide:
{% regroup resources by offering as offering_list %}{% for offering in offering_list %}
{{forloop.counter}}. {{ offering.grouper.name }}:{% for resource in offering.list %}
    - {{ resource.name }}
{% endfor %}{% endfor %}
You can submit resource usage via API or do it manually at {{ public_resources_url }}.

notify_consumer_about_pending_order_subject.txt (waldur_mastermind.marketplace)

1
A new order by {{ order.created_by.get_full_name }} is waiting for approval.

marketplace_resource_termination_scheduled_staff_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource.name }} termination has been scheduled.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    The resource you have - <a href="{{ resource_url }}">{{ resource.name }}</a> has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}.
    If you feel that you still want to keep it, please <a href="{{ resource_url }}"></a>remove the resource end date</a>.
</p>
</body>
</html>

marketplace_resource_update_succeeded_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} has been updated.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Following request from {{ order_user }}, resource {{ resource_name }} has been updated.
</p>
{% if resource_old_plan %}
<p>
    The plan has been changed from {{ resource_old_plan }} to {{ resource_plan }}.
</p>
{% endif %}
{% if support_email or support_phone %}
<p>
    If you have any additional questions, please contact support.
</p>
{% if support_email %}
<p>
    Email: {{ support_email }}
</p>
{% endif %}
{% if support_phone %}
<p>
    Phone: {{ support_phone }}
</p>
{% endif %}
{% endif %}
</body>
</html>

marketplace_resource_update_failed_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} update has failed.

notify_provider_about_pending_order_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>A new order by {{ order.created_by.get_full_name }} is waiting for approval.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Please visit <a href="{{ order_url }}">{{ site_name }}</a> to find out more details.
</p>
</body>
</html>

marketplace_resource_terminate_failed_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} deletion has failed.

marketplace_resource_update_succeeded_message.txt (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
Hello!

Following request from {{ order_user }}, resource {{ resource_name }} has been updated.

{% if resource_old_plan %}
The plan has been changed from {{ resource_old_plan }} to {{ resource_plan }}.
{% endif %}

{% if support_email or support_phone %}
If you have any additional questions, please contact support.
{% if support_email %}
Email: {{ support_email }}
{% endif %}
{% if support_phone %}
Phone: {{ support_phone }}
{% endif %}
{% endif %}

marketplace_resource_update_failed_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} update has failed.

notification_about_stale_resources_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Reminder about stale resources.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    We noticed that you have stale resources that have not cost you anything for the last 3 months. <br />
    Perhaps some of them are not needed any more?<br />

    The resource names are:
    <ul>
        {% for resource in resources %}
            <li><a href='{{ resource.resource_url }}'>{{ resource.resource.name }}</a></li>
        {% endfor %}
    </ul>
    Thank you!
</p>
</body>
</html>

marketplace_resource_create_failed_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} creation has failed.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} creation has failed.
</p>
</body>
</html>

notify_consumer_about_pending_order_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

A new order by {{ order.created_by.get_full_name }} is waiting for approval.

marketplace_resource_create_succeeded_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} has been created.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} has been created.
</p>
</body>
</html>

marketplace_resource_update_limits_failed_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} limits update has failed.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} limits update has failed.
</p>
</body>
</html>

marketplace_resource_update_limits_succeeded_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} limits have been updated.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Following request from {{ order_user }}, resource {{ resource_name }} limits have been updated from:<br>
    <blockquote>
        {{ resource_old_limits }}
    </blockquote>
    to:
    <blockquote>
        {{ resource_limits }}
    </blockquote>
</p>
{% if support_email or support_phone %}
<p>
    If you have any additional questions, please contact support.
</p>
{% if support_email %}
<p>
    Email: {{ support_email }}
</p>
{% endif %}
{% if support_phone %}
<p>
    Phone: {{ support_phone }}
</p>
{% endif %}
{% endif %}
</body>
</html>

marketplace_resource_update_failed_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} update has failed.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} update has failed.
</p>
</body>
</html>

notification_about_resource_ending_message.txt (waldur_mastermind.marketplace)

1
2
3
4
5
6
7
Dear {{ user.full_name }},

Termination date of your {{ resource.name }} is approaching and it will be deleted{% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.
If you are aware of that, then no actions are needed from your side.
If you need to update resource end date, please update it in resource details {{ resource_url }}.

Thank you!

notification_about_project_ending_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Project {{ project.name }} will be deleted.</title>
</head>
<body>
<p>Dear {{ user.full_name }},</p>

<p>Your project {{ project.name }} is ending
    {% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.
    End of the project will lead to termination of all resources in the project. <br />
    If you are aware of that, then no actions are needed from your side. <br />
    If you need to update project end date, please update it in project details {{ project_url }}.
</p>

<p>Thank you!</p>
</body>
</html>

marketplace_resource_create_failed_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} creation has failed.

marketplace_resource_update_limits_failed_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} limits update has failed.

marketplace_resource_terminate_failed_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} deletion has failed.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} deletion has failed.
</p>
</body>
</html>

notification_usages_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Reminder about missing usage reports.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>Please do not forget to add usage for the resources you provide:</p>
{% regroup resources by offering as offering_list %}

<ol>
{% for offering in offering_list %}
    <li>
        {{ offering.grouper.name }}:
        <ul>
            {% for resource in offering.list %}
            <li>{{ resource.name }}</li>
            {% endfor %}
        </ul>
    </li>
{% endfor %}
</ol>

<p>
    You can submit resource usage via API or do it <a href='{{ public_resources_url }}'>manually</a>.
</p>
</body>
</html>

marketplace_resource_terminate_succeeded_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} has been deleted.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} has been deleted.
</p>
</body>
</html>

marketplace_resource_termination_scheduled_staff_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource.name }} termination has been scheduled.

notification_about_stale_resources_subject.txt (waldur_mastermind.marketplace)

1
Reminder about stale resources.

notify_provider_about_pending_order_subject.txt (waldur_mastermind.marketplace)

1
A new order by {{ order.created_by.get_full_name }} is waiting for approval.

marketplace_resource_terminate_succeeded_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} has been deleted.

marketplace_resource_termination_scheduled_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

The resource you have - {{ resource.name }} has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}. If you feel that you still want to keep it, please remove the resource end date {{ resource_url }}.

notification_about_resource_ending_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource.name }} will be deleted.</title>
</head>
<body>
<p>Dear {{ user.full_name }},</p>

<p>
    Termination date of your {{ resource.name }} is approaching and it will be
    deleted{% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.<br />
    If you are aware of that, then no actions are needed from your side. <br />
    If you need to update resource end date, please update it in resource details {{ resource_url }}.
</p>

<p>Thank you!</p>
</body>
</html>

notification_about_project_ending_message.txt (waldur_mastermind.marketplace)

1
2
3
4
5
6
7
Dear {{ user.full_name }},

Your project {{ project.name }} is ending {% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}. End of the project will lead to termination of all resources in the project.
If you are aware of that, then no actions are needed from your side.
If you need to update project end date, please update it in project details {{ project_url }}.

Thank you!

notification_about_resource_ending_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource.name }} will be deleted.

marketplace_resource_update_succeeded_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} has been updated.

marketplace_resource_update_limits_failed_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} limits update has failed.

marketplace_resource_termination_scheduled_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource.name }} termination has been scheduled.

notify_consumer_about_pending_order_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>A new order by {{ order.created_by.get_full_name }} is waiting for approval.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Please visit <a href="{{ order_link }}">{{ site_name }}</a> to find out more details.
</p>
</body>
</html>

marketplace_resource_terminate_failed_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} deletion has failed.

marketplace_resource_termination_scheduled_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource.name }} termination has been scheduled.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    The resource you have - <a href="{{ resource_url }}">{{ resource.name }}</a> has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}.
    If you feel that you still want to keep it, please <a href="{{ resource_url }}"></a>remove the resource end date</a>.
</p>
</body>
</html>

marketplace_resource_create_failed_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} creation has failed.

marketplace_resource_termination_scheduled_staff_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

The resource you have - {{ resource.name }} has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}. If you feel that you still want to keep it, please remove the resource end date {{ resource_url }}.

marketplace_resource_create_succeeded_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} has been created.

marketplace_resource_terminate_succeeded_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} has been deleted.

notify_provider_about_pending_order_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

A new order by {{ order.created_by.get_full_name }} is waiting for approval.

marketplace_resource_create_succeeded_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} has been created.

notification_usages_subject.txt (waldur_mastermind.marketplace)

1
Reminder about missing usage reports.

waldur_mastermind.marketplace_remote

notification_about_pending_project_updates_message.txt (waldur_mastermind.marketplace_remote)

1
2
3
4
5
6
7
8
Hello!

We noticed that you have pending project update requests.
Perhaps you would like to have a look at them?

The project is:
    {{ project_update_request.project.name }} {{ project_url }}
Thank you!

notification_about_pending_project_updates_subject.txt (waldur_mastermind.marketplace_remote)

1
Reminder about pending project updates.

notification_about_project_details_update_message.txt (waldur_mastermind.marketplace_remote)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Hello!

We would like to notify you about recent updates in project details.
Perhaps you would like to have a look at them?

The project is:
    {{ new_name }} {{ project_url }}

    Details after the update are below:
        {% if new_description %}
            Old description: {{ old_description }}
            New description: {{ new_description }}
        {% endif %}

        {% if new_name %}
            Old name: {{ old_name }}
            New name: {{ new_name }}
        {% endif %}

        {% if new_end_date %}
           Old end date: {{ old_end_date }}
           New end date: {{ new_end_date }}
        {% endif %}

        {% if new_oecd_fos_2007_code %}
           Old OECD FOS 2007 code: {{ old_oecd_fos_2007_code }}
           New OECD FOS 2007 code: {{ new_oecd_fos_2007_code }}
        {% endif %}

        {% if new_is_industry %}
           Old is_industry: {{ old_is_industry }}
           New is_industry: {{ new_is_industry }}
        {% endif %}

    Reviewed by: {{ reviewed_by }}
Thank you!

notification_about_project_details_update_message.html (waldur_mastermind.marketplace_remote)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>A notification about project details update.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    We would like to notify you about recent updates in project details.<br />
    Perhaps you would like to have a look at them?<br />

    The project is:
    <ul>
        <li><a href='{{ project_url }}'>{{ new_name }}</a></li>
    </ul>

    <div>
        Details after the update are below:
        <ul>
            {% if new_description %}
                <li>Old description: {{ old_description }}</li>
                <li>New description: {{ new_description }}</li>
            {% endif %}

            {% if new_name %}
                <li>Old name: {{ old_name }}</li>
                <li>New name: {{ new_name }}</li>
            {% endif %}

            {% if new_end_date %}
                <li>Old end date: {{ old_end_date }}</li>
                <li>New end date: {{ new_end_date }}</li>
            {% endif %}

            {% if new_oecd_fos_2007_code %}
                <li>Old OECD FOS 2007 code: {{ old_oecd_fos_2007_code }}</li>
                <li>New OECD FOS 2007 code: {{ new_oecd_fos_2007_code }}</li>
            {% endif %}

            {% if new_is_industry %}
                <li>Old is_industry: {{ old_is_industry }}</li>
                <li>New is_industry: {{ new_is_industry }}</li>
            {% endif %}
            <li>Reviewed by: {{ reviewed_by }}</li>
        </ul>

    </div>
    Thank you!
</p>
</body>
</html>

notification_about_pending_project_updates_message.html (waldur_mastermind.marketplace_remote)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Reminder about pending project updates.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    We noticed that you have pending project update requests.<br />
    Perhaps you would like to have a look at them?<br />

    The project is:
    <ul>
        <li><a href='{{ project_url }}'>{{ project_update_request.project.name }}</a></li>
    </ul>
    Thank you!
</p>
</body>
</html>

notification_about_project_details_update_subject.txt (waldur_mastermind.marketplace_remote)

1
A notification about project details update.

waldur_mastermind.marketplace_support

terminate_resource_template.txt (waldur_mastermind.marketplace_support)

1
2
3
{% load waldur_marketplace %}[Terminate resource {{order.resource.scope.name}}|{{request_url}}].
{% plan_details order.resource.plan %}
Marketplace resource UUID: {{order.resource.uuid.hex}}

update_resource_template.txt (waldur_mastermind.marketplace_support)

1
2
3
[Switch plan for resource {{order.resource.scope.name}}|{{request_url}}].
Switch from {{order.resource.plan.name}} plan to {{order.plan.name}}.
Marketplace resource UUID: {{order.resource.uuid.hex}}

create_resource_template.txt (waldur_mastermind.marketplace_support)

1
2
3
4
5
6
7
8
9
{% load waldur_marketplace %}[Order|{{order_url}}].
Provider: {{order.offering.customer.name}}
Resource UUID: {{resource.uuid}}
Resource name: {{resource.name}}
Plan details:
    {% plan_details order.plan %}
Full name: {{order.created_by.full_name|default:"none"}}
Civil code: {{order.created_by.civil_number|default:"none"}}
Email: {{order.created_by.email}}

update_limits_template.txt (waldur_mastermind.marketplace_support)

1
2
3
4
[Update limits for resource {{order.resource.scope.name}}|{{request_url}}].
Marketplace resource UUID: {{order.resource.uuid.hex}}
Old limits: {{ old_limits }}.
New limits: {{ new_limits }}.

waldur_mastermind.support

notification_comment_updated.txt (waldur_mastermind.support)

1
2
3
Hello!

The comment has been updated. Please go to {{issue_url}} to see it.

notification_issue_feedback.txt (waldur_mastermind.support)

1
2
3
4
5
6
7
8
9
Hello, {{issue.caller.full_name}}!

We would like to hear your feedback regarding your recent experience with support for {{issue_url}}.

Click on the evaluations below to provide the feedback.

{% for link in feedback_links%}
    {{link.label}}: {{link.link}}
{% endfor %}

description.txt (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{{issue.description}}

Additional Info:
{% if issue.customer %}- Organization: {{issue.customer.name}}{% endif %}
{% if issue.project %}- Project: {{issue.project.name}}{% endif %}
{% if issue.resource %}
    {% if issue.resource.service_settings %}
        {% if issue.resource.service_settings.type %}- Service type: {{issue.resource.service_settings.type}}{% endif %}
        - Offering name: {{ issue.resource.service_settings.name }}
        - Offering provided by: {{ issue.resource.service_settings.customer.name }}
    {% endif %}
    - Affected resource: {{issue.resource}}
    - Backend ID: {{issue.resource.backend_id}}
{% endif %}
- Site name: {{ settings.WALDUR_CORE.SITE_NAME }}
- Site URL: {{ settings.WALDUR_CORE.HOMEPORT_URL }}

summary.txt (waldur_mastermind.support)

1
{% if issue.customer.abbreviation %}{{issue.customer.abbreviation}}: {% endif %}{{issue.summary}}

notification_issue_updated_subject.txt (waldur_mastermind.support)

1
Updated issue: {{issue.key}} {{issue.summary}}

notification_comment_added.html (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>The issue you have created ({{ issue.key }}) has a new comment</title>
</head>
<body>
<p>
    {% if is_system_comment %}
        Added a new comment.
    {% else %}
        {{ comment.author.name }} added a new comment.
    {% endif %}
</p>
<p>
    <a href="{{ issue_url }}">[{{ issue.key }}] {{ issue.summary }}</a>
</p>
<div>
    {{ description|safe }}
</div>
</body>
</html>

notification_issue_updated.html (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>The issue you have ({{ issue.key }}) has been updated</title>
</head>
<body>
<p>
    Hello!
</p>
{% if changed.status %}
<p>
    Status has been changed from <strong>{{ changed.status }}</strong> to <strong>{{ issue.status }}</strong>.
</p>
{% endif %}
{% if old_description %}
<p>
    Description has been changed from <strong>{{ old_description|safe }}</strong> to <strong>{{ description|safe }}</strong>.
</p>
{% endif %}
{% if changed.summary %}
<p>
    Summary has been changed from <strong>{{ changed.summary }}</strong> to <strong>{{ issue.summary }}</strong>.
</p>
{% endif %}
{% if changed.priority %}
<p>
    Priority has been changed from <strong>{{ changed.priority }}</strong> to <strong>{{ issue.priority }}</strong>.
</p>
{% endif %}
<p>
    Please visit <a href="{{ issue_url }}">{{ site_name }}</a> to find out more details.
</p>
</body>
</html>

notification_comment_added.txt (waldur_mastermind.support)

1
2
3
Hello!

The issue you have created has a new comment. Please go to {{issue_url}} to see it.

notification_issue_feedback_subject.txt (waldur_mastermind.support)

1
Please share your feedback: {{issue.key}} {{issue.summary}}

notification_issue_feedback.html (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>The issue you have ({{ issue.key }}) has been updated</title>

    <style>
        * {
          font-family: sans-serif;
        }
        .rating {
          unicode-bidi: bidi-override;
          direction: rtl;
          width: 500px;
        }
        .rating > a {
          display: inline-block;
          position: relative;
          width: 1.1em;
          text-decoration: none;
          font-size: xx-large;
          color: rgba(180, 179, 178, 1);
        }
        .rating > a:hover:before,
        .rating > a:hover ~ a:before {
           content: "\2605";
           position: absolute;
           color: rgba(224, 194, 75, 1);
        }
    </style>

</head>
<body>
<p>Hello, {{issue.caller.full_name}}!</p>
<p>We would like to hear your feedback regarding your recent experience with support for
    <a href='{{issue_url}}'>{{ issue.summary }}</a>.
</p>
<p>Click the stars below to provide your feedback:</p>
<div class="rating">
    {% for link in feedback_links reversed %}
        <a href='{{link.link}}'>☆</a>
    {% endfor %}
</div>
</body>
</html>

notification_comment_added_subject.txt (waldur_mastermind.support)

1
The issue ({{ issue.key }}) you have created has a new comment

notification_issue_updated.txt (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
Hello!

The issue you have has been updated.

{% if changed.status %}
Status has been changed from {{ changed.status }} to {{ issue.status }}.
{% endif %}
{% if changed.description %}
Description has been changed from {{ changed.description }} to {{ issue.description }}.
{% endif %}
{% if changed.summary %}
Summary has been changed from {{ changed.summary }} to {{ issue.summary }}.
{% endif %}
{% if changed.priority %}
Priority has been changed from {{ changed.priority }} to {{ issue.priority }}.
{% endif %}

Please go to {{issue_url}} to see it.

notification_comment_updated.html (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>The comment has been updated ({{ issue.key }})</title>
</head>
<body>
<p>
    {{ comment.author.name }} updated comment.
</p>
<p>
    <a href="{{ issue_url }}">[{{ issue.key }}] {{ issue.summary }}</a>
</p>
<p>
    Old comment:
</p>
<p>
    {{ old_description|safe }}
</p>
<p>
    New comment:
</p>
<p>
    {{ description|safe }}
</p>
</body>
</html>

notification_comment_updated_subject.txt (waldur_mastermind.support)

1
Issue {{ issue.key }}. The comment has been updated

Ended: Mastermind configuration

Azure

Warning

Documentation is in progress. Plugin development is in progress.

Setting up Tenant

https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant

Setting up a Client

https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app

Add permissions

Make sure that client is able to perform operations on the different resources.

https://stackoverflow.com/questions/42134892/the-client-with-object-id-does-not-have-authorization-to-perform-action-microso

Collecting Azure credentials for Waldur

You need to provide following Azure credentials to Waldur: subscription ID, tenant ID, client ID and client secret.

Get Subscription ID

  • Login into your Azure account.
  • Select Subscriptions in the left sidebar.
  • Select whichever subscription is needed.
  • Click on Overview.
  • Copy the Subscription ID.

Get Tenant ID

  • Login into your Azure account.
  • Select Azure Active Directory in the left sidebar.
  • Click Properties.
  • Copy the Directory ID.

Get Client ID

  • Login into your Azure account.
  • Select Azure Active Directory in the left sidebar.
  • Click Enterprise applications.
  • Click All applications.
  • Select the application which you have created.
  • Click Properties.
  • Copy the Application ID.

Get Client secret

  • Login into your Azure account.
  • Select Azure Active Directory in the left sidebar.
  • Click App registrations.
  • Select the application which you have created.
  • Click on All settings.
  • Click on Keys.
  • Type Key description and select the Duration.
  • Click save.
  • Copy and store the key value. You won’t be able to retrieve it after you leave this page.

See also: How to: Use the portal to create an Azure AD application and service principal that can access resources

Custom scripts

Custom scripts is a type of plugin that allows defining custom scripts that are executed at different lifecycle events of the resource. The scripts are executed in one time containers. Depending on the deployment type, it can be either a docker container for docker-compose-based, or Kubernetes Jobs for Helm-based deployments.

The following lifecycle events are supported:

  • Creation;
  • Update - change of plans or limits;
  • Termination;
  • Regular updates - executed once per hour, aka pull script.

Script output format

It is possible to control certain aspects of resource management with outputs of the custom scripts. Below we list currently supported conventions and their impact.

Creation script

You can set the the backend_id of the created resource by passing a single string as the last line of the output.

1
2
3
# for python-based scripts
UUID = "12345abcd"
print(UUID)

If you want to save additional metadata, then last line of output should consist of 2 strings:

  • ID of the created resource that will be saved as backend_id;
  • Base64 encoded metadata object.
1
2
3
4
5
6
# for python-based scripts
import base64

UUID = "12345abcd"
metadata = {"backend_metadata": {"cpu": 1}}
print(UUID + ' ' + base64.b64encode(metadata))

Regular updates script

The script for regular updates allows to update usage information as well as provide updates of reporting. In all cases the last line should include a base64-encoded string containing a dictionary with keywords:

  • "usages" for usage reporting;
  • "report" for updating resource report.

Examples of Python-based scripts are:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# for python-based scripts
import base64

info = {
  "usages":
    {
      "type": "cpu",
      "amount": 10
    }
}
print(base64.b64encode(info))

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# for python-based scripts
import base64

info = {
  "report":
    {
      "header": "header",
      "body": "body"
    }
}
print(base64.b64encode(info))

MOAB

MOAB is a scheduling engine for HPC centers from Adaptive Computing.

Waldur implementation of support for MOAB is done via the Waldur site agent.

OpenStack (Tenant)

Requirements for OpenStack (Tenant)

OpenStack versions tested:

  • Queens
  • Rocky
  • Stein
  • Train
  • Ussuri
  • Victoria

In order to integrate an OpenStack-based cloud as a shared provider, the following data is required:

  • URL of Keystone's public endpoint (v3).
  • Access to public interfaces of Keystone, Nova, Cinder, Neutron and Glance should be opened to Waldur MasterMind server.
  • Admin credentials (username/password) as well as domain name (in case non-default domain is used).
  • External network UUID - the network will be by default connected to all created OpenStack Projects (Tenants).

Advanced settings

It's possible to override some settings for OpenStack in MasterMind admin interface. To do that, please go to Waldur MasterMind Admin interface with a staff account.

Go to Structure → Shared provider settings and select the one you want to update.

Define specific customisation options. To add an option select append on item block under the object tree. Most typical are:

  • external_network_id – external network to connect to when creating a VPC from this provider.
  • access_url - a URL to access OpenStack Horizon dashboard from a public network. Typically a reverse proxy URL in production deployments.
  • flavor_exclude_regex - flavors matching this regex expression will not be pulled from the backend.
  • dns_nameservers - default value for new subnets DNS name servers. Should be defined as list.
  • create_ha_routers - create highly available Neutron routers when creating Tenants.

Support for Organization specific OpenStack networks

You can provide specific external network for all OpenStack Tenants created by Organiztion by providing external network UUIDs in Organization configuration in Waldur Mastermind admin portal.

Organization specific OS networks

Remote Offering

Warning

Documentation is in progress. Plugin development is in progress.

Introduction

It is possible to import into a Waldur offerings from a remote Waldur.

Pre-requisites

  • An organization in the remote Waldur, which will contain requests and projects from the local Waldur.
  • Account with owner role that will be used for integration.
  • Access to APIs of remote Waldur.

High level process

  • In local Waldur, make sure that you have a service provider organization available.
  • Click on "Import offering".
  • Input remote Waldur API and authentication token.
  • Select the remote organization and offering to be imported.
  • Review and activate the offering.

eduTEAMS account SYNC

In case both local and remote Waldurs are relying on a common set of identities from eduTEAMS, it is possible to configure synchronisation of the identities as well, i.e. when a resource is provisioned in a remote Waldur, local accounts from organization and project are pushed and mapped to the remote project.

Note

For this to work, remote Waldur must be integrated with eduTEAMS registry and integration user must have identity_manager role.

Remote offering actions

Remote offering actions are available in the integration section of the offering edit page.

Remote Offering Actions

SLURM provider

SLURM plugin enables sharing of access to a SLURM cluster. SLURM is a scheduling system used typically for managing High-performance clusters. Waldur allows to share access by creating Slurm accounts and managing permission rights of users.

Configure Waldur SLURM plugin

By default, Waldur creates a hierarchical account structure in SLURM, where:

  • Organization gets an account under a default account, defined when configuring SLURM service offering;
  • Each project is created as a an allocation, which is a child of organization's account.
  • Each resource created in Waldur (aka SLURM Allocation) gets its own SLURM account with project account as a parent.

These accounts get standard prefixes along with unique values and user provided input. It is possible to customize prefixes in Waldur configuration. Check WALDUR_SLURM variables in Waldur configuration guide.

Add SLURM provider

To add SLURM as a provider to Waldur, you will need the following information:

  • SSH host address to a node, from where SLURM commands could be executed.
  • Username that has Slurm operator role. Operator is needed as Waldur dynamically creates accounts based on user's choice of FreeIPA account.
  • Waldur public key must be added as authorized_key for the operator's username.
  • Slurm login node must be configured to authenticate users coming from FreeIPA connected to Waldur.

SLURM auto-provisioning hooks

It is possible to streamline creation of SLURM allocations for new users based on affiliation of a user profile. Configuration settings are described in Waldur configuration guide under WALDUR_HPC settings.

The logic is as follows:

  • Once a user is created (e.g. via eduGAIN login), user's affiliation and email are checked to see if user belongs to internal or external organization.
  • If so, a project is created for the user in a corresponding organization.
  • For users belonging to internal organization, SLURM request is pre-filled and created using account limits of internal organizations.
  • For users belonging to external organization, SLURM request is pre-filled only - it would require a manual confirmation from the organization owner of the external organization to be provisioned. Default limits of SLURM apply.

Configure SLURM cluster

Waldur might work out of the box with most of the reasonably modern deployments of SLURM, which have accounting enabled and limits enforced.

Please refer to SLURM documentation for details:

We provide a snapshot of instructions for the convenience of the reader.

Add SLURM cluster

SLURM accounting plugin assumes that at least one cluster is configured. For example:

1
sacctmgr add cluster linux

Enforce SLURM accounting limits

In order to enforce limits set on associations and QoS, please modify slurm.conf:

1
AccountingStorageEnforce=limits

Please note, that when AccountingStorageEnforce is changed, a restart of the slurmctld daemon is required (not just a scontrol reconfig):

1
systemctl restart slurmctld

Enable SLURM Multi Priority plugin

In order to enable ordering for the queue of jobs waiting to be scheduled, please modify slurm.conf:

1
PriorityType=priority/multifactor

When slurm.conf is changed, you should reload configuration:

1
scontrol reconfig

Waldur Site Agent

Agent for Mastermind integration with a provider's site. The main purpose of the agent is data syncronization between Waldur and an application (for example SLURM or MOAB cluster). The agent uses order-related information from Waldur to manage accounts in the site and accounting-related info from the site (backend) to update usage data in Waldur. For now, the agent supports only SLURM and MOAB clusters as a site.

Architecture

Agent is a stateless application, which is deployed on a machine having access to a backend data. It consists of three sub-applications:

  • agent-order-process, which fetches ordering data from Waldur and updates a state of a backend correspondingly; (e.g. creates/updates/deletes SLURM accounts);
  • agent-report, which reports computing usage and limits info from a backend to Waldur (e.g. update of resource usages);
  • agent-membership-sync, which syncs membership info between Waldur and a backend (e.g. adds users to a SLURM allocation).

Integration with Waldur

For this, the agent uses Waldur client based on Python and REST communication with Waldur backend. Agent-order-process application pulls data of orders created in Waldur and creates/updates/removes backend resources based on this info. Agent-report fetches usage data pushes it to Waldur. Agent-membership-sync fetches associations from a backend and syncronizes it with remote ones.

Integration with the site

SLURM cluster

The agent relies on SLURM command line utilities (e.g. sacct and sacctmgr) and should run on a headnode of the SLURM cluster.

MOAB cluster

The agent relies on MOAB command line utilities (e.g. mam-list-accounts and mam-create-account) and should run on a headnode of the MOAB cluster as a root user.

Agent configuration

The application supports the following CLI arguments:

  • -m, --mode - mode of agent; supported values: order_process, report and membership_sync; default is order_process.
  • -c, --config-file - path to the config file with provider settings.

Optional environment variables:

  • WALDUR_SITE_AGENT_ORDER_PROCESS_PERIOD_MINUTES - trigger period for order_process mode in minutes (default is 5);
  • WALDUR_SITE_AGENT_REPORT_PERIOD_MINUTES - trigger period for report mode in minutes (default is 30);
  • WALDUR_SITE_AGENT_MEMBERSHIP_SYNC_PERIOD_MINUTES - trigger period for membership_sync mode in minutes (default is 5).
  • REQUESTS_VERIFY_SSL - flag for SSL verification for Waldur client, default is true.
  • SENTRY_ENVIRONMENT - name of the Sentry environment.

The primary config for the agent is a waldur-site-agent-config.yaml. Using it, the agent can serve several offerings and setup backend-related data, for example computing component settings. File example and reference.

NB: for MOAB, the only acceptable component is deposit. All other specified components are ignored by the agent.

Deployment

A user should deploy 3 separate instances of the agent. The first one (called agent-order-process) fetches data from Waldur with further processing, the second one (called agent-report) sends usage data from the backend to Waldur and the third one syncs membership information between Waldur and the backend. All the instances must be configured with CLI variables and provider config file.

To deploy them, you need to setup and start the systemd services.