BlueBanquise Documentation

Welcome on BlueBanquise documentation.

This documentation provides information on:

• How to use Ansible (generic, not related to the stack)

• How to deploy, configure, and maintain BlueBanquise on different scenario clusters

• Detailed documentation on each roles provided with the stack

Details are also given for each Ansible role of the stack.

Please report us any issues in this documentation.

Documentation authors:

• LEVEUGLE Benoît

• KEATS Johnny

• TRAVOUILLON Bruno

• GELLNER Tim

• RIBEIRO Adrien

• MERZOUKI Hamid

• PEROTIN Matthieu

Contents:

• 1. Introduction
• 2. Vocabulary
  • 2.1. Ansible vocabulary
    • 2.1.1. Host
    • 2.1.2. Group
    • 2.1.3. Variables
    • 2.1.4. Inventory, roles, and playbooks
    • 2.1.5. Variables precedence
    • 2.1.6. Replace
    • 2.1.7. Jinja2
  • 2.2. Stack vocabulary
    • 2.2.1. Icebergs
    • 2.2.2. Equipment profiles
• 3. Install first management
  • 3.1. Install operating system
  • 3.2. Prepare for Ansible
    • 3.2.1. Repositories
    • 3.2.2. Install Ansible
• 4. Learn Ansible
  • 4.1. Minimal inventory
  • 4.2. Ansible commands
    • 4.2.1. ansible
    • 4.2.2. ansible-inventory
    • 4.2.3. ansible-playbook
    • 4.2.4. Debug
  • 4.3. Variables and groups
    • 4.3.1. Adding variables
    • 4.3.2. Configuring groups
    • 4.3.3. Variables precedence
  • 4.4. Roles and playbooks
    • 4.4.1. Role
    • 4.4.2. Playbook
    • 4.4.3. Jinja2
    • 4.4.4. Task again
• 5. Containers
  • 5.1. Podman
    • 5.1.1. Install podman and grab base image
    • 5.1.2. Generic ansible ready image
    • 5.1.3. Example: repositories container
• 6. Configure BlueBanquise
  • 6.1. Get BlueBanquise
  • 6.2. Configure inventory
    • 6.2.1. Check example inventory
    • 6.2.2. Review nodes
    • 6.2.3. Review logical networks
    • 6.2.4. Review general configuration
    • 6.2.5. Review Default parameters
    • 6.2.6. Review groups parameters
• 7. Deploy BlueBanquise
  • 7.1. Management configuration
    • 7.1.1. Get managements playbook
    • 7.1.2. Ansible-playbook
    • 7.1.3. Apply management1 configuration
  • 7.2. PXE
    • 7.2.1. bootset
    • 7.2.2. SSH public key
    • 7.2.3. OS deployment
  • 7.3. Apply other nodes configuration
  • 7.4. Diskless
• 8. Manage multiple icebergs
  • 8.1. Iceberg elements
  • 8.2. Configuring top iceberg
    • 8.2.1. Understanding mechanism
    • 8.2.2. Enabling iceberg mechanism
    • 8.2.3. Create iceberg 1
    • 8.2.4. Create iceberg 2
    • 8.2.5. Deploy sub management configuration
    • 8.2.6. Interconnect and job scheduler (HPC only)
• 9. Monitoring
  • 9.1. Introduction
  • 9.2. Prometheus
    • 9.2.1. Prerequisites
    • 9.2.2. Installation
    • 9.2.3. Prometheus.yml
    • 9.2.4. Variables
    • 9.2.5. Queries
    • 9.2.6. Alerts
  • 9.3. Grafana
    • 9.3.1. Installation
    • 9.3.2. Useful Files
    • 9.3.3. Dashboard
    • 9.3.4. Types of Visualization
    • 9.3.5. Extra
  • 9.4. Exporters
    • 9.4.1. Node_exporter
    • 9.4.2. Ipmi_exporter
    • 9.4.3. Snmp_exporter
    • 9.4.4. Ha_cluster_exporter
    • 9.4.5. Slurm_exporter
  • 9.5. Node_exporter
    • 9.5.1. Alerts
    • 9.5.2. Start service
    • 9.5.3. Dashboard
  • 9.6. Ipmi_exporter
    • 9.6.1. Alerts
    • 9.6.2. Start service
    • 9.6.3. Dashboard
  • 9.7. Ha_cluster_exporter
    • 9.7.1. Alerts
    • 9.7.2. Start service
    • 9.7.3. Dashboards
  • 9.8. Snmp_exporter
    • 9.8.1. Snmp_exporter setup
    • 9.8.2. Setup targets
    • 9.8.3. Switch setup
    • 9.8.4. Start service
    • 9.8.5. Dashboard
  • 9.9. Slurm_exporter
    • 9.9.1. Metrics
    • 9.9.2. Start service
    • 9.9.3. Alerts
    • 9.9.4. Dashboard
• 10. Stories
  • 10.1. Management and main configuration
    • 10.1.1. Versioning the inventory
    • 10.1.2. Adding a new repository
    • 10.1.3. Update management nodes configuration
  • 10.2. Nodes
    • 10.2.1. Adding a new node
    • 10.2.2. Adding a new range of nodes
    • 10.2.3. Adding a new master group
    • 10.2.4. Adding a new equipment_profile group
    • 10.2.5. Adding a custom group
    • 10.2.6. Replacing/Updating a node
    • 10.2.7. Deploying nodes
    • 10.2.8. Apply or update nodes configuration
    • 10.2.9. Changing equipment_profile group of some nodes
    • 10.2.10. Manage multiple distribution versions
  • 10.3. Roles and playbooks
    • 10.3.1. Create a custom role
  • 10.4. Security
    • 10.4.1. Update root password
    • 10.4.2. Use vault to enhance inventory security
    • 10.4.3. Externalize Ansible
• 11. Roles
  • 11.1. CORE
    • 11.1.1. Access control
    • 11.1.2. BlueBanquise
    • 11.1.3. Conman
    • 11.1.4. Display_tuning
    • 11.1.5. DHCP server
    • 11.1.6. DNS server
    • 11.1.7. DNS client
    • 11.1.8. Firewall
    • 11.1.9. Hosts file
    • 11.1.10. Log server
    • 11.1.11. Log client
    • 11.1.12. NFS server
    • 11.1.13. NFS client
    • 11.1.14. NIC
    • 11.1.15. PXE Stack
    • 11.1.16. Repositories server
    • 11.1.17. Repositories client
    • 11.1.18. Set Hostname
    • 11.1.19. SSH master
    • 11.1.20. SSH slave
    • 11.1.21. Time server
  • 11.2. ADVANCED CORE
    • 11.2.1. Advanced DHCP server
    • 11.2.2. Advanced DNS server
  • 11.3. ADDONS
    • 11.3.1. Cloning
    • 11.3.2. ClusterShell
    • 11.3.3. Diskless
    • 11.3.4. OFED
    • 11.3.5. OFED_SM
    • 11.3.6. OpenLDAP client
    • 11.3.7. OpenLDAP server
    • 11.3.8. NIC with nmcli
    • 11.3.9. Powerman
    • 11.3.10. Prometheus server
    • 11.3.11. Prometheus client
    • 11.3.12. Grafana
    • 11.3.13. Report
    • 11.3.14. Root password
    • 11.3.15. Singularity
    • 11.3.16. SSSD
    • 11.3.17. Slurm
    • 11.3.18. Users basic
    • 11.3.19. lmod
• 12. References
  • 12.1. External Graphics

Indices and tables

• Index

• Module Index

• Search Page