Skip to content
logo
Percona Monitoring and Management
Databases
Initializing search
    percona/pmm-doc
    percona/pmm-doc
    • Welcome
    • Setting up
      • Server
        • Network
        • Docker
        • Podman
        • Helm
        • Virtual Appliance
        • AWS Marketplace
        • Easy-install script
      • Client
        • MySQL
        • MongoDB
        • PostgreSQL
        • ProxySQL
        • Amazon RDS
        • Microsoft Azure
        • Google Cloud Platform
        • Linux
        • External Services
        • HAProxy
        • Remote instances
    • Get started
      • User Interface
      • Percona Alerting
      • Backup and Restore
        • Prepare a storage location
        • MongoDB backups
          • MongoDB backup prerequisites
          • Create MongoDB on-demand and scheduled backups
          • Create MongoDB PITR backups
          • Restore a MongoDB backup
          • MongoDB Backup and Restore support matrix
        • MySQL backups
          • MySQL backup prerequisites
          • Create a MySQL backup
          • Restore a MySQL backup
        • Edit a scheduled backup
        • Delete a backup
      • Roles and permissions
        • Configure access control
        • Labels for access control
        • Create access roles
        • Manage access roles
        • Assign roles to users
        • Use Case
      • Query Analytics
      • Working with Advisors
    • How to
      • Configure
      • Manage users
      • Upgrade
      • Secure
      • Optimize
      • Annotate
      • Share dashboards and panels
      • Extend Metrics
      • Resolve issues
      • Integrate with Percona Platform
        • Check Percona Portal account information
    • Details
      • Architecture
      • UI components
      • PMM components and versions
      • Data handling in PMM
      • Develop Advisor checks
      • PMM Inventory
      • Dashboards
        • Manage dashboards
          • Insight
            • Advanced Data Exploration
            • VictoriaMetrics
            • VictoriaMetrics Agents Overview
          • Environments
            • Environment Summary
          • Kubernetes
            • Kubernetes Pods Status
            • Kubernetes Volumes
            • Kubernetes monitoring for Percona Operators
            • DB clusters managed with Percona Kubernetes Operators
          • DBaas
          • OS Dashboards
            • Disk Details
            • Network Details
            • Memory Details
            • Node Temperature Details
            • Nodes Compare
            • Nodes Overview
            • Node Summary
            • NUMA Details
            • Processes Details
          • Prometheus Dashboards
            • Prometheus Exporters Overview
          • MySQL Dashboards
            • MySQL Command/Handler Counters Compare
            • MySQL InnoDB Compression Details
            • MySQL InnoDB Details
            • MySQL MyISAM/Aria Details
            • MySQL MyRocks Details
            • MySQL Instance Summary
            • MySQL Instances Compare
            • MySQL Instances Overview
            • MySQL Wait Event Analyses Details
            • MySQL Performance Schema Details
            • MySQL Query Response Time Details
            • MySQL Replication Summary
            • MySQL Group Replication Summary
            • MySQL Table Details
            • MySQL User Details
            • MySQL TokuDB Details
          • MongoDB Dashboards
            • Experimental MongoDB Collection Details
            • Experimental MongoDB Oplog Details
            • MongoDB Cluster Summary
            • MongoDB Instance Summary
            • MongoDB Instances Overview
            • MongoDB Instances Compare
            • MongoDB ReplSet Summary
            • MongoDB InMemory Details
            • MongoDB MMAPv1 Details
            • MongoDB WiredTiger Details
          • PostgreSQL Dashboards
            • PostgreSQL Instance Summary
            • PostgreSQL Instances Compare
            • Experimental PostgreSQL Vacuum Monitoring
          • ProxySQL Dashboards
          • HA Dashboards
            • PXC/Galera Cluster Summary
            • Experimental PXC/Galera Cluster Summary
            • PXC/Galera Nodes Compare
            • HAProxy Instance Summary
      • Commands
        • pmm-admin - PMM Administration Tool
        • pmm-agent - PMM Client agent
      • API
      • VictoriaMetrics
      • ClickHouse
      • PostgreSQL
      • Glossary
      • Introduction
      • DBaaS architecture
        • Setting up DBaaS
        • Create a Kubernetes Cluster
        • Deleting Kubernetes clusters
        • Activating DBaaS
        • Add a Kubernetes cluster automatically
        • Add a Kubernetes cluster manually
        • Manage allowed component versions
          • OLM installation
          • Operators installation
        • Add a DB Cluster
        • Manage a DB Cluster
        • Delete a DB Cluster
        • Create a database cluster from a template
      • Backup and restore
    • FAQ
    • Release Notes
      • PMM 2.40.1
      • PMM 2.40.0
      • PMM 2.39.0
      • PMM 2.38.1
      • PMM 2.38.0
      • PMM 2.37.1
      • PMM 2.37.0
      • PMM 2.36.0
      • PMM 2.35.0
      • PMM 2.34.0
      • PMM 2.33.0
      • PMM 2.32.0
      • PMM 2.31.0
      • PMM 2.30.0
      • PMM 2.29.1
      • PMM 2.29.0
      • PMM 2.28.0
      • PMM 2.27.0
      • PMM 2.26.0
      • PMM 2.25.0
      • PMM 2.24.0
      • PMM 2.23.0
      • PMM 2.22.0
      • PMM 2.21.0
      • PMM 2.20.0
      • PMM 2.19.0
      • PMM 2.18.0
      • PMM 2.17.0
      • PMM 2.16.0
      • PMM 2.15.1
      • PMM 2.15.0
      • PMM 2.14.0
      • PMM 2.13.0
      • PMM 2.12.0
      • PMM 2.11.1
      • PMM 2.11.0
      • PMM 2.10.1
      • PMM 2.10.0
      • PMM 2.9.1
      • PMM 2.9.0
      • PMM 2.8.0
      • PMM 2.7.0
      • PMM 2.6.1
      • PMM 2.6.0
      • PMM 2.5.0
      • PMM 2.4.0
      • PMM 2.3.0
      • PMM 2.2.2
      • PMM 2.2.1
      • PMM 2.2.0
      • PMM 2.1.0
      • PMM 2.0.1
      • PMM 2.0.0
      • Copyright and licensing information
      • Trademark policy

    • DB clusters
      • Add a DB Cluster
      • Delete a DB Cluster
      • Edit a DB Cluster
      • Restart a DB Cluster
      • Suspend or resume a DB Cluster
      • Update a DB Cluster

    Databases

    DB clusters¶

    Caution

    DBaaS functionality is currently in technical preview and is subject to change.

    Add a DB Cluster¶

    In order to create a database cluster you must have at least one Kubernetes cluster registered to PMM. Start here if you haven’t done that yet.

    Important

    In order for PMM to collect metrics from your DB clusters, you must first set the public address of your PMM server.

    You can create a DB cluster with the click of a button! We have populated all needed fields with suitable defaults but you can customize many aspects of your DB cluster’s configuration.

    To create a DB cluster, do the following:

    1. Select the DB Cluster tab.

    2. Click Create DB Cluster.

    3. From the drop-down menu, select the values for the following:

      • Kubernetes Cluster
      • Database Type
      • Database Version
    4. Optionally expand Advanced Settings panel for further customization.

      1. Select the number of nodes. (1 is the minimum)

      2. Select a preset Resources per Node.

        Small, Medium and Large are fixed preset values for Memory, CPU, and Disk.

        Values for the Custom preset can be edited.

        Beside each resource type is an estimate of the required and available resources represented numerically in absolute and percentage values, and graphically as a colored, segmented bar showing the projected ratio of used to available resources. A red warning triangle is shown if the requested resources exceed those available.

        !

      3. Enter the following on the Database Configurations panel:

      4. Storage Class - Select the storage class from the drop-down. Storage classes allow dynamic provisioning of persistent storage for PMM. Using storage classes, you can create and attach volumes on-demand without manually managing the underlying storage infrastructure.

      5. Database configuration- Enter the config string into the Configuration text box to configure the database engine.

        !

      6. Enter the following on the Network and Security panel:

      7. Expose - Select this checkbox to make this DB cluster available outside of the kubernetes cluster.

      8. Internet Facing - Select this checkbox if you want the cluster to be accessible on the Internet.
      9. Source Range - For security, you can control the exposure level by providing the IP address in the Source Range field. This allows you to choose the IP addresses that can access your DB cluster. To add more than one source range, click Add New.
    5. Click Create Cluster to create your cluster.

    6. A row appears with information on your cluster:

      !

      • Name: The cluster name.
      • Database: The cluster database type and version.
      • Connection:
        • Host: The hostname.
        • Port: The port number.
        • Username: The connection username.
        • Password: The connection password (click the eye icon to reveal).
      • DB Cluster Parameters:
        • K8s cluster name: The Kubernetes cluster name.
        • CPU: The number of CPUs allocated to the cluster.
        • Memory: The amount of memory allocated to the cluster.
        • Disk: The amount of disk space allocated to the cluster.
      • Cluster Status:
        • PENDING: The cluster is being created.
        • ACTIVE: The cluster is active.
        • FAILED: The cluster could not be created.
        • DELETING: The cluster is being deleted.
        • UPDATING: The cluster is being updated.

    Delete a DB Cluster¶

    1. Select the DB Cluster tab.

    2. Find the row with the database cluster you want to delete.

    3. In the Actions column, open the menu and click Delete.

    4. Confirm the action by clicking Proceed, or abandon by clicking Cancel.

      !

    Danger

    Deleting a cluster also deletes any attached volumes. Please proceed with caution.

    Edit a DB Cluster¶

    1. Select the DB Cluster tab.

    2. Find the row with the database cluster you want to change.

    3. In the Actions column, open the menu and click Edit.

    A paused cluster can’t be edited.

    Restart a DB Cluster¶

    1. Select the DB Cluster tab.

    2. Identify the database cluster to be changed.

    3. In the Actions column, open the menu and click Restart.

    Suspend or resume a DB Cluster¶

    1. Select the DB Cluster tab.

    2. Identify the DB cluster to suspend or resume.

    3. In the Actions column, open the menu and click the required action:

      • For active clusters, click Suspend.

        !DBaaS Suspend

      • For paused clusters, click Resume.

        !DBaaS Resume

    Update a DB Cluster¶

    1. Select the DB Cluster tab.

    2. Identify the DB cluster to update.

    3. In the Actions column, open the menu and click Update:

      !DBaaS Update

    4. Confirm the update by clicking on Update, or abandon by clicking Cancel.

      !DBaaS Update Confirmation

    See also

    Setting up a development environment for DBaaS

    Contact us

    For free technical help, visit the Percona Community Forum.

    To report bugs or submit feature requests, open a JIRA ticket.

    For paid support and managed or consulting services , contact Percona Sales.


    Last update: 2023-12-01
    Percona LLC, © 2023
    Made with Material for MkDocs

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. Read more about Percona Cookie Policy.