You can customize your backup and restore settings.

MinIO gateway mode

The backup and restore operator and MinIO are deployed with the default settings. The MinIO can be deployed as a statefulset or it can be deployed as a proxy (gateway) to the external datastore. The default behavior is to deploy the MinIO as the statefulset.
Note: When the MinIO is deployed as the statefulset the backup are stored in MinIO Persistent Volumes (PV), and the backups are not externalized. Which means when the Kubernetes cluster or the MinIO PV is deleted the backups will be erased. To avoid this, you must deploy MinIO as a gateway.
Procedure to deploy MinIO as gateway using Deployment Container:
  1. Update gateway.enabled=true, accesskey, and secretkey parameters along with the bucket name for the br operator in the merged_yamls.yaml file which is generated in step 3 as shown in the following snippet:
    minio:
    helmChartName: minio-custom
    helmOverrides:
      minio:
        gateway:
          auth:
            s3:
              accessKey: null
              secretKey: null
          enabled: false
          type: s3
        persistence:
          size: 8Gi
        statefulset:
          replicaCount: 4
brOperator:
    helmOverrides:
      metric:
        backupEnabled: false
      minio:
        backupBucketName: <your-bucket-name>
    Note: You can add MinIO and custom bucket configuration in a single command.
  2. Set the DEPLOYMENT_ACTION to deploy-apps in the deploy.settings file.
  3. Run the tcx_app_deployment.sh script in the Deployment Container, which triggers the Helm upgrade.
Procedure to deploy MinIO as gateway using VMware Telco Cloud Automation UI:
  1. For deploying MinIO as a gateway, ensure that you have already extracted the VMware Telco Cloud Service Assurance bundle. If you do not have the bundle, you can refer to steps in Extract the Downloaded Package and Installer topic.
  2. Ensure that you use the same Deployment Container used during base deployment. If you do not have the Deployment Container, you must download and launch it. For procedure, see Download and Launch the Deployment Container section.
  3. Run the merge-product-yaml-files.sh script as described in Generate a Single Merged YAML File required for MinIO deployment and copy the resulting merged_yamls.yaml file to your local machine.
    Note: Retain the same footprint value used during initial deployment.
  4. Update the values for the parameters in the updated merged_yamls.yaml file which is generated in step 3. The following snippet is an example of demo footprint.
    elasticsearch:
  retentionInterval: ''
footprint: demo
grafana:
  accessIp: null
ingressHostname:
  edgeServices: null
  product: null
privateNetwork: false
registryRootUrl: null
statusChecker:
  enabled: true

    Set them to the same values used during initial VMware Telco Cloud Service Assurance deployment.

    1. ingressHostname.product=<LoadBalancerIP>
    2. grafana.accessIP=<LoadBalancerIP>
    3. registryRootUrl=<your-registry-url/your-project-name/tcx>
    4. Update the statusChecker.enabled parameter. The default value is true. Set the value as false.
    5. Update the retentionInterval value with the same value used during initial CNF instantiation.
    6. Update the additionalValuesFile parameter in the merged_yamls.yaml file based on the retention interval value.
      elasticsearch:
    additionalValuesFile: ''
    7. Update the following parameters in the merged_yamls.yaml file to the required footprint.
      • footprint
      • helmOverride.productInfo.footPrints
      Note: Based on the footprint size of deployment, update the value for footprint.
  5. If you are configuring MinIO as gateway using AWS S3 or vSAN, update the parameters accordingly.
    • For AWS S3, update gateway.enabled=true, accesskey, and secretkey in the merged_yamls.yaml which is generated in step3 as shown in the following snippet.
      minio:
    helmChartName: minio-custom
    helmOverrides:
      minio:
        gateway:
          auth:
            s3:
              accessKey: null
              secretKey: null
          enabled: false
          type: s3
        persistence:
          size: 8Gi
        statefulset:
          replicaCount: 4
    • For vSAN, update gateway.enabled=true, type=nas, accesskey, and secretkey in the merged_yamls.yaml which is generated in step3 as shown in the following snippet.
      minio:
    helmChartName: minio-custom
    helmOverrides:
      minio:
        gateway:
          auth:
            s3:
              accessKey: null
              secretKey: null
          enabled: false
          type: nas
        persistence:
          size: 8Gi
        statefulset:
          replicaCount: 4
      For NFS Provisioner, update nfsProvisioner.enabled=true, nfs.path, and nfs.server parameters. 
      nfsProvisioner:
    enabled: false
    helmChartName: nfs-provisioner
    helmOverrides:
      nfs-subdir-external-provisioner:
        nfs:
          path: null
          server: null
    Note: The backups taken on the previous StatefulSet MinIO are not available in the updated MinIO as a gateway.
  6. Launch the VMware Telco Cloud Automation and navigate to Inventory > Network Function.
  7. Click TCSA CNF and select Reconfigure.
  8. Upload the updated merged_yamls.yaml file which is generated in step 3 VMware Telco Cloud Automation.
  9. Click Next > Finish.

Changing the backup bucket

The backup and restore operator is deployed with a default bucket vmware-tcsa-backup.

Procedure to override the bucket name using Deployment Container:
  1. Update bucket name for the br operator in the merged_yamls.yaml file which is generated in step 3 as shown in the following snippet:
    brOperator:
    helmOverrides:
      metric:
        backupEnabled: false
      minio:
        backupBucketName: <your-bucket-name>
  2. Set the DEPLOYMENT_ACTION to deploy-apps in the deploy.settings file and run the tcx_app_deployment script, which triggers the Helm upgrade to modify the bucket nsme.
Procedure to override the bucket name using VMware Telco Cloud Automation UI:
  1. For deploying MinIO as a gateway, ensure that you have already extracted the VMware Telco Cloud Service Assurance bundle. If you do not have the bundle, you can refer to steps in Extract the Downloaded Package and Installer topic.
  2. Ensure that you use the same Deployment Container used during base deployment. If you do not have the Deployment Container, you must download and launch it. For procedure, see Download and Launch the Deployment Container section.
  3. Run the merge-product-yaml-files.sh script as described in Generate a Single Merged YAML File required for MinIO deployment and copy the resulting merged_yamls.yaml file to your local machine.
    Note: Retain the same footprint value used during initial deployment.
  4. Update the values for the parameters in the updated merged_yamls.yaml file which is generated in step 3. The following snippet is an example of demo footprint.
    elasticsearch:
  retentionInterval: ''
footprint: demo
grafana:
  accessIp: null
ingressHostname:
  edgeServices: null
  product: null
privateNetwork: false
registryRootUrl: null
statusChecker:
  enabled: true

    Set them to the same values used during initial VMware Telco Cloud Service Assurance deployment.

    1. ingressHostname.product=<LoadBalancerIP>
    2. grafana.accessIP=<LoadBalancerIP>
    3. registryRootUrl=<your-registry-url/your-project-name/tcx>
    4. Update the statusChecker.enabled parameter. The default value is true. Set the value as false.
    5. Update the retentionInterval value with the same value used during initial CNF instantiation.
    6. Update the additionalValuesFile parameter in the merged_yamls.yaml file based on the retention interval value.
      elasticsearch:
    additionalValuesFile: ''
    7. Update the following parameters in the merged_yamls.yaml file to the required footprint.
      • footprint
      • helmOverride.productInfo.footPrints
      Note: Based on the footprint size of deployment, update the value for footprint.
  5. If you are configuring MinIO as gateway using AWS S3 or vSAN, update the parameters accordingly.
    • For AWS S3, update gateway.enabled=true, accesskey, and secretkey in the merged_yamls.yaml which is generated in step3 as shown in the following snippet.
      minio:
    helmChartName: minio-custom
    helmOverrides:
      minio:
        gateway:
          auth:
            s3:
              accessKey: null
              secretKey: null
          enabled: false
          type: s3
        persistence:
          size: 8Gi
        statefulset:
          replicaCount: 4
    • For vSAN, update gateway.enabled=true and type=nas in the merged_yamls.yaml which is generated in step3 as shown in the following snippet.
      minio:
    helmChartName: minio-custom
    helmOverrides:
      minio:
        gateway:
          auth:
            s3:
              accessKey: null
              secretKey: null
          enabled: false
          type: nas
        persistence:
          size: 8Gi
        statefulset:
          replicaCount: 4
      For NFS Provisioner, update nfsProvisioner.enabled=true, nfs.path, and nfs.server parameters. 
      nfsProvisioner:
    enabled: false
    helmChartName: nfs-provisioner
    helmOverrides:
      nfs-subdir-external-provisioner:
        nfs:
          path: null
          server: null
    Note: The backups taken on the previous StatefulSet MinIO are not available after the mode change to AWS S3 or vSAN.
  6. Update the bucket name in the merged_yamls.yaml file which is generated in step 3 as shown in the following snippet:
    brOperator:
    helmOverrides:
      metric:
        backupEnabled: false
      minio:
        backupBucketName: <your-bucket-name>
  7. Launch the VMware Telco Cloud Automation and navigate to Inventory > Network Function.
  8. Click TCSA CNF and select Reconfigure.
  9. Upload the updated merged_yamls.yaml file which is generated in step 3 in VMware Telco Cloud Automation.
  10. Click Next > Finish.
Note: The backups taken on the previous bucket will not be available in the new bucket.