ClusterControl Documentation
Use the menu below or the search below to learn everything you need to know about ClusterControl
- 1. Introduction
- 2. Getting Started
- 3. Requirements
- 4. Installation
- 5. User Guide
- 5.1. ClusterControl GUI
- 5.1.1. Dashboard
- 5.1.2. Deploy Database Cluster
- 5.1.3. Import Existing Server/Cluster
- 5.1.4. Deploy in the Cloud
- 5.1.5. Sidebar
- 5.1.5.1. Spotlight Search
- 5.1.5.2. Clusters
- 5.1.5.3. Operational Reports
- 5.1.5.4. Email Notifications
- 5.1.5.5. Integrations
- 5.1.5.6. Key Management
- 5.1.5.7. User Management
- 5.1.5.8. Documentation
- 5.1.5.9. Give us Feedback
- 5.1.5.10. What’s New?
- 5.1.5.11. Support Forum
- 5.1.5.12. Switch Theme
- 5.1.5.13. Close Menu
- 5.1.6. User Guide for MySQL
- 5.1.7. User Guide for MongoDB
- 5.1.8. User Guide for PostgreSQL
- 5.1.9. User Guide for TimeScaleDB
- 5.2. ClusterControl CLI
- 5.2.1. s9s account
- 5.2.2. s9s alarm
- 5.2.3. s9s backup
- 5.2.4. s9s cluster
- 5.2.5. s9s container
- 5.2.6. s9s controller
- 5.2.7. s9s job
- 5.2.8. s9s maintenance
- 5.2.9. s9s metatype
- 5.2.10. s9s node
- 5.2.11. s9s process
- 5.2.12. s9s replication
- 5.2.13. s9s report
- 5.2.14. s9s script
- 5.2.15. s9s server
- 5.2.16. s9s user
- 5.2.17. Limitations
- 5.1. ClusterControl GUI
- 6. Components
- 6.1. ClusterControl Controller (CMON)
- 6.2. ClusterControl UI
- 6.3. ClusterControl SSH
- 6.4. ClusterControl Notifications
- 6.5. ClusterControl Cloud
- 6.6. ClusterControl Cloud File Manager (CLUD)
- 6.7. ClusterControl CLI
- 7. Administration
- 7.1. Upgrading ClusterControl
- 7.2. Backing Up and Restoring ClusterControl
- 7.3. Resetting ClusterControl Admin Login
- 7.4. Securing ClusterControl
- 7.5. Housekeeping
- 7.6. Health Checks
- 7.7. Migrating IP Address or Hostname
- 7.8. Standby ClusterControl Server for High Availability
- 7.9. Changing ‘cmon’ or ‘root’ Password
- 7.10. Graceful Shutdown
- 7.11. Uninstall
- 8. Developer Guide
- 8.1. CMON RPC
- 8.2. ClusterControl DSL
- 8.2.1. Introduction
- 8.2.2. Language basics
- 8.2.3. Functions
- 8.2.3.1. JSON Functions
- 8.2.3.2. Controller Functions
- 8.2.3.3. Input/Output Functions
- 8.2.3.4. General Tag Functions
- 8.2.3.5. Mathematical Functions
- 8.2.3.6. Functions providing information about values
- 8.2.3.7. String Functions
- 8.2.3.8. String Tag Functions
- 8.2.3.9. General Array Functions
- 8.2.3.10. Statistical Functions
- 8.2.3.11. Regular Expression Functions
- 8.2.3.12. Date and Time Functions
- 8.2.3.13. CmonHost Tag Functions
- 8.2.3.14. CmonMySqlHost Tag Functions
- 8.2.3.15. CmonClusterConfig Tag Functions
- 8.2.3.16. CmonAdvice Tag Functions
- 8.2.3.17. CmonJob Functions
- 8.2.3.18. General Job Functions
- 8.2.3.19. Backup Handling
- 8.2.3.20. CmonGraph Tag Functions
- 8.2.3.21. Cluster Functions
- 8.2.3.22. Cmon Functions
- 8.2.3.23. General alarm functions
- 8.2.3.24. Mail functions
- 8.2.3.25. License functions
- 8.2.3.26. Cmon Database functions
- 8.2.4. Examples
- 8.2.5. To-do
- 9. Tutorials
- 10. Troubleshooting
- 11. FAQ
- 11.1. General
- 11.1.1. Is ClusterControl free?
- 11.1.2. Is there a live demo site where I can try out ClusterControl?
- 11.1.3. Can I purchase the license for the first year only?
- 11.1.4. My 30-day demo license has expired but I haven’t had enough time to test ClusterControl. Can I request for extension?
- 11.1.5. I would like to subscribe as paid user but have limited budget. What should I do?
- 11.1.6. Can I resell your product?
- 11.1.7. Who uses ClusterControl?
- 11.2. Technical
- 11.2.1. Do I need to be a DBA to use ClusterControl?
- 11.2.2. Does ClusterControl run on Windows?
- 11.2.3. How do I upgrade ClusterControl?
- 11.2.4. I’m using ClusterControl community version. Which support channel should I use?
- 11.2.5. Can I install ClusterControl on RHEL based system but my database cluster is running on Debian?
- 11.2.6. Can I use ClusterControl in an internetless environment?
- 11.2.7. Can I have a mix of different SSH users per cluster?
- 11.2.8. Can I use non-privileged SSH user for ClusterControl?
- 11.2.9. What is difference of MySQL Galera Cluster, Percona XtraDB Cluster and MariaDB Galera Cluster?
- 11.2.10. I found a bug. Where should I report it?
- 11.2.11. My cluster is down. What should I do?
- 11.2.12. How can I submit a feature request?
- 11.1. General
- 12. Change Logs
- 12.1. Changes in v1.7.6
- 12.1.1. Maintenance Release: July 5th, 2020
- 12.1.2. Maintenance Release: June 28th, 2020
- 12.1.3. Maintenance Release: June 20th, 2020
- 12.1.4. Maintenance Release: June 16th, 2020
- 12.1.5. Maintenance Release: June 8th, 2020
- 12.1.6. Maintenance Release: May 15th, 2020
- 12.1.7. Maintenance Release: May 6th, 2020
- 12.1.8. Maintenance Release: May 3rd, 2020
- 12.1.9. Maintenance Release: April 27th, 2020
- 12.1.10. Maintenance Release: April 22nd, 2020
- 12.1.11. Initial Release: April 10th, 2020
- 12.2. Changes in v1.7.5
- 12.2.1. Maintenance Release: April 8th, 2020
- 12.2.2. Maintenance Release: April 7th, 2020
- 12.2.3. Maintenance Release: April 1st, 2020
- 12.2.4. Maintenance Release: March 31st, 2020
- 12.2.5. Maintenance Release: March 30th, 2020
- 12.2.6. Maintenance Release: March 23rd, 2020
- 12.2.7. Maintenance Release: March 4th, 2020
- 12.2.8. Maintenance Release: March 3rd, 2020
- 12.2.9. Maintenance Release: March 1st, 2020
- 12.2.10. Maintenance Release: February 9th, 2020
- 12.2.11. Maintenance Release: January 20th, 2020
- 12.2.12. Maintenance Release: January 7th, 2020
- 12.2.13. Initial Release: December 18th, 2019
- 12.3. Changes in v1.7.4
- 12.3.1. Maintenance Release: December 16th, 2019
- 12.3.2. Maintenance Release: December 1st, 2019
- 12.3.3. Maintenance Release: November 23rd, 2019
- 12.3.4. Maintenance Release: November 18th, 2019
- 12.3.5. Maintenance Release: November 17th, 2019
- 12.3.6. Maintenance Release: November 9th, 2019
- 12.3.7. Maintenance Release: November 6th, 2019
- 12.3.8. Maintenance Release: November 1st, 2019
- 12.3.9. Initial Release: October 28th, 2019
- 12.4. Changes in v1.7.3
- 12.4.1. Maintenance Release: October 21th, 2019
- 12.4.2. Maintenance Release: October 20th, 2019
- 12.4.3. Maintenance Release: October 13th, 2019
- 12.4.4. Maintenance Release: September 29th, 2019
- 12.4.5. Maintenance Release: September 24th, 2019
- 12.4.6. Maintenance Release: September 17th, 2019
- 12.4.7. Maintenance Release: September 10th, 2019
- 12.4.8. Maintenance Release: September 8th, 2019
- 12.4.9. Maintenance Release: August 24th, 2019
- 12.4.10. Maintenance Release: August 17th, 2019
- 12.4.11. Maintenance Release: August 15th, 2019
- 12.4.12. Maintenance Release: July 29th, 2019
- 12.4.13. Maintenance Release: July 24th, 2019
- 12.4.14. Maintenance Release: July 18th, 2019
- 12.4.15. Maintenance Release: July 16th, 2019
- 12.4.16. Maintenance Release: July 12th, 2019
- 12.4.17. Initial Release: July 2nd, 2019
- 12.5. Changes in v1.7.2
- 12.5.1. Maintenance Release: June 12th, 2019
- 12.5.2. Maintenance Release: May 24th, 2019
- 12.5.3. Maintenance Release: May 24th, 2019
- 12.5.4. Maintenance Release: May 16th, 2019
- 12.5.5. Maintenance Release: May 7th, 2019
- 12.5.6. Maintenance Release: May 6th, 2019
- 12.5.7. Maintenance Release: April 30th, 2019
- 12.5.8. Maintenance Release: April 19th, 2019
- 12.5.9. Initial Release: April 4th, 2019
- 12.6. Changes in v1.7.1
- 12.6.1. Maintenance Release: March 25th, 2019
- 12.6.2. Maintenance Release: March 18th, 2019
- 12.6.3. Maintenance Release: March 5th, 2019
- 12.6.4. Maintenance Release: February 27th, 2019
- 12.6.5. Maintenance Release: February 20th, 2019
- 12.6.6. Maintenance Release: February 18th, 2019
- 12.6.7. Maintenance Release: February 13th, 2019
- 12.6.8. Maintenance Release: February 6th, 2019
- 12.6.9. Maintenance Release: January 22nd, 2019
- 12.6.10. Maintenance Release: January 13th, 2019
- 12.6.11. Maintenance Release: December 29th, 2018
- 12.6.12. Initial Release: December 21st, 2018
- 12.7. Changes in v1.7.0
- 12.7.1. Maintenance Release: December 21st, 2018
- 12.7.2. Maintenance Release: December 12th, 2018
- 12.7.3. Maintenance Release: December 10th, 2018
- 12.7.4. Maintenance Release: December 7th, 2018
- 12.7.5. Maintenance Release: November 27th, 2018
- 12.7.6. Maintenance Release: November 13th, 2018
- 12.7.7. Maintenance Release: October 30th, 2018
- 12.7.8. Maintenance Release: October 19th, 2018
- 12.7.9. Maintenance Release: October 16th, 2018
- 12.7.10. Maintenance Release: October 10th, 2018
- 12.7.11. Maintenance Release: September 26th, 2018
- 12.7.12. Initial Release: September 24th, 2018
- 12.8. Changes in v1.6.2
- 12.9. Changes in v1.6.1
- 12.10. Changes in v1.6.0
- 12.11. Changes in v1.5.1
- 12.11.1. Maintenance Release: April 9th, 2018
- 12.11.2. Maintenance Release: March 7th, 2018
- 12.11.3. Maintenance Release: March 6th, 2018
- 12.11.4. Maintenance Release: Feb 24th, 2018
- 12.11.5. Maintenance Release: Feb 6th, 2018
- 12.11.6. Maintenance Release: Jan 29th, 2018
- 12.11.7. Maintenance Release: Jan 23rd, 2018
- 12.11.8. Initial Release: Dec 22nd, 2017
- 12.12. Changes in v1.5.0
- 12.13. Changes in v1.4.2
- 12.13.1. Patch Release: Oct 30th, 2017
- 12.13.2. Patch Release: Oct 25th, 2017
- 12.13.3. Patch Release: Oct 3rd, 2017
- 12.13.4. Patch Release: Sept 11th, 2017
- 12.13.5. Patch Release: August 25th, 2017
- 12.13.6. Patch Release: August 24th, 2017
- 12.13.7. Patch Release: August 22nd, 2017
- 12.13.8. Patch Release: August 14th, 2017
- 12.13.9. Patch Release: August 1st, 2017
- 12.13.10. Patch Release: July 31st, 2017
- 12.13.11. Patch Release: July 27th, 2017
- 12.13.12. Patch Release: July 24th, 2017
- 12.13.13. Patch Release: July 11th, 2017
- 12.13.14. Patch Release: July 4th, 2017
- 12.13.15. Initial Release: June 21st, 2017
- 12.14. Changes in v1.4.1
- 12.14.1. Patch Release: June 20th, 2017
- 12.14.2. Patch Release: June 19th, 2017
- 12.14.3. Patch Release: May 24th, 2017
- 12.14.4. Patch Release: May 20th, 2017
- 12.14.5. Patch Release: May 12th, 2017
- 12.14.6. Patch Release: Apr 24th, 2017
- 12.14.7. Patch Release: Apr 12th, 2017
- 12.14.8. Initial Release: Apr 4th, 2017
- 12.15. Changes in v1.4.0
- 12.15.1. Patch Release: Mar 29th, 2017
- 12.15.2. Patch Release: Mar 13th, 2017
- 12.15.3. Patch Release: Feb 28th, 2017
- 12.15.4. Patch Release: Feb 15th, 2017
- 12.15.5. Patch Release: Feb 8th, 2017
- 12.15.6. Patch Release: Feb 5th, 2017
- 12.15.7. Patch Release: Jan 24th, 2017
- 12.15.8. Patch Release: Jan 20th, 2017
- 12.15.9. Patch Release: Jan 13th, 2017
- 12.15.10. Patch Release: Jan 11th, 2017
- 12.15.11. Patch Release: Jan 3rd, 2017
- 12.15.12. Patch Release: Dec 22nd, 2016
- 12.15.13. Initial Release: Dec 12th, 2016
- 12.16. Changes in v1.3.2
- 12.17. Changes in v1.3.1
- 12.18. Changes in v1.3.0
- 12.18.1. Patch release: May 9th, 2016
- 12.18.2. Patch release: May 3rd, 2016
- 12.18.3. Patch release: May 2nd, 2016
- 12.18.4. Patch release: May 25th, 2016
- 12.18.5. Patch release: Apr 24th, 2016
- 12.18.6. Patch release: Apr 21st, 2016
- 12.18.7. Patch release: Apr 19th, 2016
- 12.18.8. Initial Release: Apr 18th, 2016
- 12.19. Changes in v1.2.12
- 12.20. Changes in v1.2.11
- 12.21. Changes in v1.2.10
- 12.22. Changes in v1.2.9
- 12.23. Changes in v1.2.8
- 12.24. Changes in v1.2.6
- 12.25. Changes in v1.2.5
- 12.26. Changes in v1.2.4c (maintenance release)
- 12.27. Changes in v1.2.4
- 12.28. Changes in v1.2.3
- 12.29. Changes in v1.2.2
- 12.30. Changes in v1.2.1
- 12.31. Changes in v1.2.0
- 12.32. Changes in v1.1.33
- 12.33. Changes in v1.1.32
- 12.1. Changes in v1.7.6
- 13. Glossary
Follow Us
Signup for our newsletter
Severalnines and the Severalnines logo(s) as well as ClusterControl and the ClusterControl logo(s) are trademarks of Severalnines AB. Other names may be or are trademarks of their respective owners.
© Copyright 2014-2019 Severalnines AB. All rights reserved.