Top
Enterprise Postgres 18 for Kubernetes Reference

1.2.8 FEPRestore Custom Resource Parameters

Field

Default

Details

apiVersion

fep.fujitsu.io/v1

Fixed

kind

FEPRestore

Fixed

metadata.name

-

Enter the CR name.

spec.fepVersion

Optional

To use FEPRestore image of given version. Possible values: 14, 15, 16, 17 & 18

spec.image

<current-released-image>

FEP restore container image to be used

quay.io/fujitsu/fujitsu-enterprise-postgres-18-restore:ubi9-18-1.0

It is optional.

Image is left blank by default. In such a case, it will pick up URL of image from operator container environment.

If you specify the image, Operator will take that image to deploy container

spec.imagePullPolicy

IfNotPresent

spec.mcSpec.limits

cpu: 0.2

memory: "300Mi"

spec.mcSpec.requests

cpu: 0.1

memory: "200Mi"

spec.fromFEPcluster

<from_clustername>

The name of the FEPcluster from which to restore

spec.toFEPcluster

<to_clustername>

Specifies the name of the FEP cluster to restore to.

When restoring to an existing cluster, do not specify the line of this parameter.

spec.restoretype

latest/PITR

latest - Restore Latest State

PITR - Date-Time Restore

spec.restoredate

-

If spec.restoretype is PITR, specify the day of PITR (UTC) in YYYY-MM-DD format

Be sure to use single quotes.

Example) '2020-11-25'

spec.restoretime

-

If spec.restoretype is PITR, specifies the PITR time (UTC) in HH: MM: SS format

Be sure to use single quotes.

Example) '02:50:43'

spec.restoreTargetRepo

Optional

If you are using multiple repositories, specify the repository from which to restore.

If not specified, "1" is substituted.

spec.changeParams.fepChildCrVal.backup.pgbackrestParams

Optional

Specify this to change the spec.fepChildCrVal.backup.pgbackrestParams setting in FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.backup.pgbackrestKeyParams

Optional

Specify this to change the spec.fepChildCrVal.backup.pgbackrestKeyParams setting in FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.backup.caName

Optional

Specify if you want to change the spec.fepChildCrVal.backup.caName setting of FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.backup.repoKeySecretName

Optional

Specify if you want to change the spec.fepChildCrVal.backup.repoKeySecretName setting of FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.storage.backupVol

Optional

Specify this to change the spec.fepChildCrVal.storage.backupVol setting in FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.storage.archivewalVol

Optional

Specify this option to change the spec.fepChildCrVal.storage.archivewalVol setting for FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.storage.dataVol

Optional

Specify this to change the spec.fepChildCrVal.storage.dataVol setting for FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.storage.walVol

Optional

Specify this to change the spec.fepChildCrVal.storage.walVol setting for FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.storage.logVol

Optional

Specify this to change the spec.fepChildCrVal.storage.logVol setting for FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fepChildCrVal.storage.tablespaceVol

Optional

Specify this to change the spec.fepChildCrVal.storage.tablespaceVol setting for FEPClusterCR when restoring to a new DB cluster.

spec.changeParams.fep.monitoring.fepExporter.tls.certificateName

Optional

Specify this to change the spec.fep.monitoring.fepExporter.tls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.monitoring.fepExporter.tls.caName

Optional

Specify this to change the spec.fep.monitoring.fepExporter.tls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.monitoring.prometheus.tls.certificateName

Optional

Specify this to change the spec.fep.monitoring.prometheus.tls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.monitoring.prometheus.tls.caName

Optional

Specify this to change the spec.fep.monitoring.prometheus.tls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.remoteLogging.tls.certificateName

Optional

Specify this to change the spec.fep.remoteLogging.tls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.remoteLogging.tls.caName

Optional

Specify this to change the spec.fep.remoteLogging.tls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.patroni.tls.certificateName

Optional

Specify this to change the spec.fep.patroni.tls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.patroni.tls.caName

Optional

Specify this to change the spec.fep.patroni.tls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.patroni.tls.privateKeyPassword

Optional

Specify this to change the spec.fep.patroni.tls.privateKeyPassword setting of FEPClusterCR when restoring to a new database cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.postgres.tls.certificateName

Optional

Specify this to change the spec.fep.postgres.tls.certificateName setting of FEPClusterCR when restoring to a new database cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.postgres.tls.caName

Optional

Specify this to change the spec.fep.postgres.tls.caName setting of FEPClusterCR when restoring to a new database cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.postgres.tls.privateKeyPassword

Optional

Specify this to change the spec.fep.postgres.tls.privateKeyPassword setting of FEPClusterCR when restoring to a new database cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgAdminTls.certificateName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgAdminTls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgAdminTls.caName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgAdminTls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgAdminTls.sslMode

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgAdminTls.sslMode setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgAdminTls.privateKeyPassword

Optional

Specify this to change the spec.fepChildCrVal.sysUsers.pgAdminTls.privateKeyPassword setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgrepluserTls.certificateName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgrepluserTls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgrepluserTls.caName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgrepluserTls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgrepluserTls.sslMode

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgrepluserTls.sslMode setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgrepluserTls.privateKeyPassword

Optional

Specify this to change the spec.fepChildCrVal.sysUsers.pgrepluserTls.privateKeyPassword setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgMetricsUserTls.certificateName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgMetricsUserTls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgMetricsUserTls.caName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgMetricsUserTls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgMetricsUserTls.sslMode

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgMetricsUserTls.sslMode setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgMetricsUserTls.privateKeyPassword

Optional

Specify this to change the spec.fepChildCrVal.sysUsers.pgMetricsUserTls.privateKeyPassword setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgRewindUserTls.certificateName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgRewindUserTls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgRewindUserTls.caName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgRewindUserTls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgRewindUserTls.sslMode

Optional

Specify to change the spec.fepChildCrVal.sysUsers.pgRewindUserTls.sslMode setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.pgRewindUserTls.privateKeyPassword

Optional

Specify this to change the spec.fepChildCrVal.sysUsers.pgRewindUserTls.privateKeyPassword setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.vectorizerTls.certificateName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.vectorizerTls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.vectorizerTls.caName

Optional

Specify to change the spec.fepChildCrVal.sysUsers.vectorizerTls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.vectorizerTls.sslMode

Optional

Specify to change the spec.fepChildCrVal.sysUsers.vectorizerTls.sslMode setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.sysUsers.vectorizerTls.privateKeyPassword

Optional

Specify this to change the spec.fepChildCrVal.sysUsers.vectorizerTls.privateKeyPassword setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.secretStore.azureProvider.fepSecrets

Optional

Specify this to change the spec.fepChildCrVal.secretStore.azureProvider.fepSecrets setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.secretStore.awsProvider.fepSecrets

Optional

Specify this to change the spec.fepChildCrVal.secretStore. awsProvider.fepSecrets setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.secretStore.csi.gcpProvider.fepSecrets

Optional

Specify this to change the spec.fepChildCrVal.secretStore.csi.gcpProvider.fepSecrets setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fepChildCrVal.secretStore.csi.vaultProvider.fepSecrets

Optional

Specify this to change the spec.fepChildCrVal.secretStore.csi.vaultProvider.fepSecrets setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.autoTuning.prometheus.tls.certificateName

Optional

Specify this to change the spec.fep.autoTuning.prometheus.tls.certificateName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.

spec.changeParams.fep.autoTuning.prometheus.tls.caName

Optional

Specify this to change the spec.fep.autoTuning.prometheus.tls.caName setting of FEPClusterCR when restoring to a new DB cluster. If the restore source FEP cluster uses an automatically generated certificate and the restore destination FEP cluster also uses an automatically generated certificate, do not specify this parameter line itself.


Example of FEPRestore CR created

apiVersion: fep.fujitsu.io/v1
kind: FEPRestore
metadata:
  name: feprestore
spec:
  mcSpec:
    limits:
      cpu: 200m
      memory: 300Mi
    requests:
      cpu: 100m
      memory: 200Mi
  fromFEPcluster: fepcluster1
  toFEPcluster: fepcluster2
  restoretype: latest
  imagePullPolicy: IfNotPresent

Example of Point-In-Time-Recovery using FEPRestore CR

apiVersion: fep.fujitsu.io/v1
kind: FEPRestore
metadata:
  name: feprestore
spec:
  mcSpec:
    limits:
      cpu: 300m
      memory: 700Mi
    requests:
      cpu: 200m
      memory: 512Mi
  fromFEPcluster: fepclusterA
  toFEPcluster: fepclusterB
  restoretype: PITR
  restoredate: 2020-11-25
  restoretime: 02:50:43
  imagePullPolicy: IfNotPresent

Note

Upon successful completion, custom resources in FEPRestore are automatically deleted.

You can specify spec.changeParams in the FEPRestore custom resource to modify the definition from the source to build a new FEPCluster and restore the data.

This allows you to mount another storage in the new cluster, for example, to expand the PVC size, even if you are using storage that does not support PVC extensions.

Example of a FEPRestore Custom Resource for Modifying the Storage Class and Storage Capacity of a FEPCluster "source-cluster"

apiVersion: fep.fujitsu.io/v1
kind: FEPRestore
metadata:
  name: feprestore
spec:
  mcSpec:
    limits:
      cpu: 300m
      memory: 700Mi
    requests:
      cpu: 200m
      memory: 512Mi
  fromFEPcluster: source-cluster
  toFEPcluster: new-cluster
  restoretype: latest
  changeParams:
    fepChildCrVal:
      storage:
        dataVol:
          size: 50 Gi
          storageClass: new-storage