Percona

https://docs.percona.com/
Admin
Percona provides open source database solutions and tools for PostgreSQL, MongoDB, and MySQL,...
Tokens:3,569,039
Snippets:28,813
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Quick start: Install PMM Server with Helm

Source: https://docs.percona.com/percona-monitoring-and-management/3/install-pmm/HA-kubernetes-single-instance.html

Quick start installation steps: add the Percona Helm repository, create a namespace, install PMM Server with default settings, and get the external IP address. The external IP may take a minute to provision; look for the EXTERNAL-IP column.

```bash
helm repo add percona https://percona.github.io/percona-helm-charts/
helm repo update
```

```bash
kubectl create namespace monitoring
```

```bash
helm install pmm percona/pmm \
  --namespace monitoring \
  --set service.type=LoadBalancer
```

```bash
kubectl get svc -n monitoring pmm-service
```

--------------------------------

### Example output of percona-release installation

Source: https://docs.percona.com/percona-server-for-mongodb/8.0/install/amazon-linux.html?q=

Shows the expected output when installing percona-release. The output confirms the package is retrieved and installed successfully.

```text
Retrieving https://repo.percona.com/yum/percona-release-latest.noarch.rpm
Preparing...                ########################################### [100%]
1:percona-release        ########################################### [100%]
```

--------------------------------

### pmm.livenessProbe.httpGet subdoc example

Source: https://docs.percona.com/percona-operator-for-mongodb/1.23.1/operator.html

Custom Kubernetes liveness probe for the pmm-client sidecar container. When not set, the Operator uses its built-in HTTP GET call on port 7777 (:7777/local/Status). Available starting with Operator version 1.23.0.

```yaml
path: /local/Status
port: 7777
```

--------------------------------

### Create and enter the otel-quickstart directory

Source: https://docs.percona.com/percona-server/9.7/quickstart-opentelemetry.html?q=

Commands to create a working directory named otel-quickstart and change into it. Required before creating the Compose files.

```bash
mkdir otel-quickstart
cd otel-quickstart

```

--------------------------------

### Start MySQL service

Source: https://docs.percona.com/percona-distribution-for-mysql/9.7/install-pdpxc.html

Starts the MySQL service manually on RHEL/CentOS because it is not started automatically after installation.

```bash
sudo systemctl start mysql

```

--------------------------------

### Step-by-step install: create namespace, export NAMESPACE, apply RBAC

Source: https://docs.percona.com/percona-operator-for-postgresql/3.1.0/openshift.html

Create the namespace, export it as an environment variable, and apply RBAC configuration. Your user must have cluster-admin privileges for the RBAC step.

```bash
oc create namespace postgres-operator

```

```bash
export NAMESPACE=postgres-operator

```

```bash
oc apply -f deploy/rbac.yaml -n $NAMESPACE

```

--------------------------------

### Start the restore process (Approach 1)

Source: https://docs.percona.com/percona-operator-for-xtradb-cluster/latest/backups-restore-to-new-cluster.html

Command to apply the restore configuration defined in the deploy/backup/restore.yaml file. Run this after configuring the restore object.

```bash
kubectl apply -f deploy/backup/restore.yaml -n <namespace>

```

--------------------------------

### Install Victoria Metrics stack with example values

Source: https://docs.percona.com/percona-operator-for-mongodb/1.23.1/monitor-kubernetes.html

Example installation command using a sample PMM server URL, cluster ID, and namespace.

```bash
$ helm install vm-k8s vm/victoria-metrics-k8s-stack \
-f https://raw.githubusercontent.com/Percona-Lab/k8s-monitoring/refs/tags/v0.1.3/vm-operator-k8s-stack/values.yaml \
--set external.vm.write.url=https://pmm-example.com/victoriametrics/api/v1/write \
--set vmagent.spec.externalLabels.k8s_cluster_id=test-cluster \
-n monitoring-system

```

--------------------------------

### Start mongod service

Source: https://docs.percona.com/percona-server-for-mongodb/8.0/install/amazon-linux.html

Starts the mongod service manually after installation.

```bash
sudo systemctl start mongod
```

--------------------------------

### Create otel-quickstart.cnf configuration file

Source: https://docs.percona.com/percona-server/9.7/quickstart-opentelemetry.html?q=

Creates a configuration file with telemetry settings. These are startup-only variables and must be added after installing the component.

```ini
[mysqld]
telemetry.metrics_enabled=ON
telemetry.otel_exporter_otlp_metrics_endpoint=http://otel-collector:4318/v1/metrics

```

--------------------------------

### Sample output of switching to admin database

Source: https://docs.percona.com/percona-server-for-mongodb/8.0/connect.html

Example output when switching to the admin database.

```text
switched to db admin
```

--------------------------------

### Install pg_tde for PostgreSQL 18

Source: https://docs.percona.com/pg-tde/apt.html

Example command to install pg_tde for PostgreSQL 18.

```bash
sudo apt-get install -y percona-pg-tde18

```

--------------------------------

### Quick install: create namespace, export NAMESPACE, apply bundle

Source: https://docs.percona.com/percona-operator-for-postgresql/3.1.0/openshift.html

These commands create the namespace, export it as an environment variable, and apply the bundle file to install the Operator with default parameters. Replace the v3.1.0 tag with a specific version if needed.

```bash
oc create namespace postgres-operator

```

```bash
export NAMESPACE=postgres-operator

```

```bash
oc apply --server-side -f https://raw.githubusercontent.com/percona/percona-postgresql-operator/v3.1.0/deploy/bundle.yaml -n $NAMESPACE

```

--------------------------------

### Sample output after switchover

Source: https://docs.percona.com/percona-operator-for-postgresql/3.1.0/change-primary.html

Example output showing the new primary (master) and the previous primary now as a replica.

```text
cluster1-instance1-bmdp-0             4/4     Running     0          24m   cluster1-instance1-bmdp   master
cluster1-instance1-fm7w-0             4/4     Running     0          24m   cluster1-instance1-fm7w   replica
cluster1-instance1-ttm9-0             4/4     Running     0          23m   cluster1-instance1-ttm9   replica

```

--------------------------------

### Expected output of percona-release installation

Source: https://docs.percona.com/percona-xtrabackup/9.7/apt-repo.html

Expected output when installing Percona XtraBackup through percona-release, showing package installation and setup messages.

```text
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
The following additional packages will be installed:
libaio1 libcurl4-openssl-dev libdbd-mysql-perl libdbi-perl libev4 libgdbm-compat4
libgdbm6 libmysqlclient21 libperl5.34 libpopt0 mysql-common netbase perl
perl-modules-5.34 rsync zstd
...
Setting up libdbd-mysql-perl:amd64 (4.050-5ubuntu0.22.04.1) ...##############.......] 
Setting up percona-xtrabackup-97 (9.7.1-rc1.jammy) ...#########################.....] 
Processing triggers for libc-bin (2.35-0ubuntu3.8) ...###########################...] 
```

--------------------------------

### Upgrade to a specific version on Debian/Ubuntu

Source: https://docs.percona.com/percona-backup-mongodb/latest/manage/upgrading.html

These commands stop pbm-agent, install a specific version of percona-backup-mongodb (example shows 1.7.0-1.stretch), and start pbm-agent. Run as root or via sudo. For filesystem-based backup storage, grant read/write permissions to the backup directory for the mongod user.

```bash
sudo systemctl stop pbm-agent

```

```bash
sudo apt install percona-backup-mongodb=1.7.0-1.stretch

```

```bash
sudo systemctl start pbm-agent

```

--------------------------------

### Start Valkey container with RDB file

Source: https://docs.percona.com/valkey/migration-guide/migration.html

Start a Valkey container, mounting the RDB file from the host to the container's data directory. Replace <path/on/host> with your path.

```bash
$ docker run -d --name somevalkey -v <path/on/host>:/data valkey/valkey
```

--------------------------------

### Kubernetes (Helm): Example deployment

Source: https://docs.percona.com/percona-monitoring-and-management/3/install-pmm/install-pmm-server/deployment-options/docker/backup_container.html

Installs PMM Server on Kubernetes using the Percona Helm chart.

```bash
helm install pmm percona/pmm

```

--------------------------------

### Expected output for APT installation of ProxySQL 2

Source: https://docs.percona.com/proxysql/install-v2.html

Example output when installing proxysql2 via APT, showing package installation details.

```text
Reading package lists... Done
Building dependency tree
Reading state information... Done
The following additional packages will be installed:
  debconf-utils logrotate
The following NEW packages will be installed:
  debconf-utils logrotate proxysql2
0 upgraded, 3 newly installed, 0 to remove and 3 not upgraded.
Need to get 7259 kB of archives.
...

```

--------------------------------

### Illustrative InnoDB and WSREP log excerpt

Source: https://docs.percona.com/percona-xtradb-cluster/8.4/crash-recovery.html?q=

Example log lines showing InnoDB startup progress and the WSREP ready message. Timestamps are illustrative only.

```log
2024-11-08T12:35:05.890123Z 0 [Note] InnoDB: Waiting for purge to start
2024-11-08T12:35:06.901234Z 0 [Note] InnoDB: Purge done
2024-11-08T12:35:07.012345Z 0 [Note] InnoDB: Buffer pool(s) load completed at 2024-11-08T12:35:07.012345Z
2024-11-08T12:35:07.123456Z 0 [Note] WSREP: Ready for connections.

```

--------------------------------

### Expected output of Percona XtraBackup installation

Source: https://docs.percona.com/percona-xtrabackup/9.7/apt-repo.html?q=

Shows the expected terminal output when installing percona-xtrabackup-97, including package installation and setup messages.

```text
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
The following additional packages will be installed:
libaio1 libcurl4-openssl-dev libdbd-mysql-perl libdbi-perl libev4 libgdbm-compat4
libgdbm6 libmysqlclient21 libperl5.34 libpopt0 mysql-common netbase perl
perl-modules-5.34 rsync zstd
...
Setting up libdbd-mysql-perl:amd64 (4.050-5ubuntu0.22.04.1) ...##############.......] 
Setting up percona-xtrabackup-97 (9.7.1-rc1.jammy) ...#########################.....] 
Processing triggers for libc-bin (2.35-0ubuntu3.8) ...###########################...] 

```

--------------------------------

### Apply backup configuration and check progress

Source: https://docs.percona.com/percona-operator-for-mongodb/latest/backups-storage-s3.html

Apply the backup configuration to start the backup, then check the backup progress.

```bash
kubectl apply -f deploy/backup/backup.yaml -n $namespace

```

```bash
kubectl get psmdb-backup -n $namespace

```

--------------------------------

### Start Percona Server for MySQL with service mysql start

Source: https://docs.percona.com/percona-server/9.7/yum-run.html?q=

Starts the Percona Server for MySQL service. Required because the server is not started automatically on RHEL distributions and derivatives after installation.

```bash
sudo service mysql start

```

--------------------------------

### Install required packages

Source: https://docs.percona.com/percona-xtradb-cluster/8.4/apt.html?q=

Installs wget, gnupg2, lsb-release, and curl needed for repository setup.

```bash
sudo apt install -y wget gnupg2 lsb-release curl

```

--------------------------------

### Sample output of backup start

Source: https://docs.percona.com/percona-backup-mongodb/features/multi-storage.html

Sample output showing the start of a backup to an external storage.

```text
Starting backup '2024-06-25T11:25:30Z'....Backup '2024-06-25T11:25:30Z' to remote store 's3://http://minio:9000/backup' has started

```

--------------------------------

### Apply bundle.yaml for simplified installation

Source: https://docs.percona.com/percona-operator-for-xtradb-cluster/latest/kubernetes.html

Alternative to steps 2 and 4: applies deploy/bundle.yaml to automatically create the Custom Resource Definition, set up RBAC, and install the operator in one action.

```bash
kubectl apply --server-side -f deploy/bundle.yaml
```

--------------------------------

### Upgrade to a specific version on RHEL derivatives

Source: https://docs.percona.com/percona-backup-mongodb/latest/manage/upgrading.html

These commands stop pbm-agent, install a specific version of percona-backup-mongodb (example shows 1.7.1-1.el7), and start pbm-agent. Run as root or via sudo. For filesystem-based backup storage, grant read/write permissions to the backup directory for the mongod user.

```bash
sudo systemctl stop pbm-agent

```

```bash
sudo yum install percona-backup-mongodb-1.7.1-1.el7

```

```bash
sudo systemctl start pbm-agent

```

--------------------------------

### Install component_telemetry

Source: https://docs.percona.com/percona-server/9.7/quickstart-opentelemetry.html?q=

Installs the component_telemetry component. The INSTALL COMPONENT statement stores the component in the mysql.component table, and the next server start loads it from that table.

```sql
INSTALL COMPONENT 'file://component_telemetry';

```

--------------------------------

### Configured /etc/default/garb example

Source: https://docs.percona.com/percona-xtradb-cluster/8.4/garbd-howto.html

Example of a configured /etc/default/garb file with cluster node addresses, group name, SSL options, and log file. Remove the '# REMOVE THIS AFTER CONFIGURATION' line before starting the service.

```bash
This config file is to be sourced by garb service script.
A comma-separated list of node addresses (address[:port]) in the cluster
GALERA_NODES="<NODE1_IP>:4567,<NODE2_IP>:4567,<NODE3_IP>:4567"
Galera cluster name, should be the same as on the rest of the nodes.
GALERA_GROUP="<CLUSTER_NAME>"
Optional Galera internal options string (e.g. SSL settings)
see http://galeracluster.com/documentation-webpages/galeraparameters.html
GALERA_OPTIONS="socket.ssl_key=<SSL_KEY_PATH>;socket.ssl_cert=<SSL_CERT_PATH>;socket.ssl_ca=<SSL_CA_PATH>;socket.ssl_cipher=AES128-SHA256"
Log file for garbd. Optional, by default logs to syslog
LOG_FILE="/var/log/garbd.log"
```

--------------------------------

### Quick install: apply bundle.yaml

Source: https://docs.percona.com/percona-operator-for-xtradb-cluster/latest/openshift.html

Apply the deploy/bundle.yaml file to create the CRD, RBAC, and Operator deployment in one action.

```bash
oc apply --server-side -f deploy/bundle.yaml

```

--------------------------------

### Install percona-release on Rocky Linux

Source: https://docs.percona.com/percona-server-for-mongodb/8.0/install/rocky-linux.html

Installs the percona-release configuration tool from the Percona repository. The example output shows the expected installation progress messages.

```bash
sudo yum install https://repo.percona.com/yum/percona-release-latest.noarch.rpm
```

```text
Retrieving https://repo.percona.com/yum/percona-release-latest.noarch.rpm
Preparing...                ########################################### [100%]
1:percona-release        ########################################### [100%]
```

--------------------------------

### Set up Python virtual environment and install Poetry

Source: https://docs.percona.com/percona-server-for-mongodb/8.0/install/source.html?q=

Create and activate a virtual environment for Poetry, then install Poetry version 1.5.1. The --prompt flag helps distinguish the environment.

```bash
python3 -m venv <venv_path> --prompt mongo
source <venv_path>/bin/activate 

```

```bash
python3 -m pip install 'poetry==1.5.1'

```
Tokens:
Raw