Skip to content


TFS can provide an S3 endpoint for interacting with its volumes and files. In the context of S3, a TFS volume corresponds to an S3 bucket. Each bucket automatically contains two sub-folders snapshots and data which correspond to the current state TFS volume (data) and any snapshots of the volume which which have been taken.

Activating the S3 Endpoint

Presuming you have an existing TFS installation the primary means of enabling access to the S3 endpoint is to enable an ingress to the TFS services. Since S3 clients do not normally tolerate the S3 endpoint being located in a subpath the ingress should be configured such that the / path of the ingress points to the S3 service, and a subpath, e.g. /tfs, points to the service for the TFS native API, i.e. the default. For example, the following ingress configuration will enable access to the S3 API behind a hostname of

  enabled: true
  path: /tfs
  annotations: "nginx"
    - path: /
      pathType: ImplementationSpecific
          name: mydeployment-tfs-tfs-on-sawtooth
            number: 8001

NOTE mydeployment above should be replaced with your deployment name

Connecting to the S3 API

For the purposes of this example we will be using the MinIO Client from MinIO which may be obtained and installed using instructions found here.

The S3 Base URL used to connect to the api is the URL of the ingress that you configured above. For example if your Ingress hostname is then the the S3 Base URL you will use is or depending on whether the ingress or ingress controller is configured to use TLS (this is always recommended).

NOTE: As of this writing encrypted volumes are not supported via the S3 API, even though they will be displayed.

Now we set an alias for mc to use:

mc alias set example "" ""

Now we can list the currently available volumes via

$ mc ls example
[2021-09-30 16:24:42 EDT]     0B exampleVolume/

And if we look into the exampleVolume listed we will see the following:

$ mc ls -r example /exampleVolume
[2021-09-30 16:26:22 EDT]     0B exampleVolume/data/
[2021-09-30 16:26:22 EDT]     0B exampleVolume/snapshot/

Notice the data and snapshot folders that were mentioned earlier.

All write operations must take place in the data folder. For example:

$ mc cp ./debug.log.gz example/exampleVolume/data/
./debug.log.gz:                326.89 KiB / 326.89 KiB