SOSAPI Configuration

Veeam Smart Object Storage API (SOSAPI) allows ARTESCA to optimize the interaction between on-premises object storage and Veeam products, by reporting on a regular basis metrics about the S3 Buckets, including their maximum capacity.

SOSAPI enables the following functionalities

Functionality	Description
Space Reporting	Low Space Warnings: Veeam backups processing issues warnings when low space is available. Scale-out Backup Repository (SOBR): Placement and load-balancing decisions within Veeam SOBRs.
IAM/STS settings	Set Endpoints for IAM and STS processing.
Storage controlled Veeam default settings	Enforce best practice settings for Veeam product interaction.

ARTESCA supports SOSAPI with a set of internal jobs that periodically report the S3 Buckets data usage and metrics by updating the Veeam-specific configuration files. It allows Veeam 12 to be aware of the S3 bucket maximum and current capacities.

Supported Operations

Veeam Backup & Replication SOSAPI support is disabled for all S3 Buckets by default when ARTESCA is deployed.

However, when provisioning a bucket using the Veeam VBR assistant, the SOSAPI feature will be automatically enabled.

When the SOSAPI support is enabled, a configurable ARTESCA cronjob refreshes all S3 Buckets metrics every four minutes.

Enable the SOSAPI Feature

The command below enables SOSAPI in ARTESCA. S3 Buckets metrics collection and SOSAPI configuration file routes are enabled.

[artesca-os@bootstrap ~]$

sudo kubectl --kubeconfig=/etc/kubernetes/admin.conf patch zenko artesca-data \
  --namespace zenko --type=json \
  --patch='[{"op": "replace", "path": "/spec/veeamSosApi", "value": { enable: true }}]'

Once SOSAPI is enabled for ARTESCA, it then needs to be initialized for S3 Buckets.

Disable the SOSAPI Feature

The command below disables SOSAPI in ARTESCA. S3 Buckets metrics collection and SOSAPI configuration file routes are disabled.

[artesca-os@bootstrap ~]$

sudo kubectl --kubeconfig=/etc/kubernetes/admin.conf patch zenko artesca-data \
  --namespace zenko --type=json \
  --patch='[{"op": "replace", "path": "/spec/veeamSosApi", "value": { enable: false }}]'

Change the Frequency of S3 Bucket Capacity Reporting

ARTESCA udpates S3 Bucket capacity metrics every hour.

The command below changes the frequency of the capacity metrics cronjob to ten minutes:

[artesca-os@bootstrap ~]$

sudo kubectl  --kubeconfig=/etc/kubernetes/admin.conf -n zenko \
  patch cronjob/artesca-data-ops-count-items \
  -p '{"spec":{"schedule": "*/10 * * * *"}}'

Warning

Running the capacity metrics cronjob more than six times per hour can affect the ARTESCA cluster performance.