VK Cloud logo

Container Storage Interface for S3 (S3-CSI)

Preparatory steps

  1. Review the system requirements of the add-on to make sure you have enough resources to install it.

  2. (Optional) Perform manual scaling of worker node groups or set up automatic scaling.

  3. Create a VK Object Storage account and save the Access Key ID and Secret Key values on your device. Use these values when installing the addon so that it has access to the required VK Object Storage.

    If you want to use another S3-compatible storage, get this authorization data from your vendor.

Installing add-on

Several installation options are available for the S3-CSI add-on.

  1. Install the add-on:

    1. Go to your VK Cloud management console.

    2. Select the project that contains the required cluster.

    3. Go to ContainersKubernetes clusters.

    4. Click on the name of the required cluster.

    5. Go to Addons tab.

    6. If there are already installed add-ons in the cluster, click the Add addon button.

    7. Click the Install button on the s3-csi add-on card.

    8. Select the required version from the drop-down list.

    9. Click the Install addon button.

    10. Edit if necessary:

      • selected version
      • application name
      • the name of the namespace where the add-on will be installed
    11. Configure the addon code to work with the S3-compatible storage. To do this, add the required values to the secret block:

      secret: ... # S3 Access Key ID accessKey: "<ACCESS_KEY_ID>" # S3 Secret Key secretKey: "<SECRET_KEY>" # The endpoint of the S3 service to be used. You can provide a custom S3 endpoint address. # Defaults to the VK Object Storage URL. endpoint: "{{ <STORAGE_URL> }}" # The S3 service region to be used. region: "<REGION>"

      Here:

      • <ACCESS_KEY_ID> ans <SECRET_KEY> are the values you copied when creating the VK Object Storage account.
      • <STORAGE_URL> is the endpoint of the S3-compatible storage API. If you are using VK Object Storage, you do not need to specify this parameter, it is set by default.
      • <REGION> is the region of the object storage. If you are using VK Object Storage, you do not need to specify this parameter. For other object storages, refer to the official documentation of your vendor to learn whether this parameter is required.
    12. If necessary, add other changes to the add-on settings code.

    13. Click the Install addon button.

      The installation of the add-on in the cluster will begin. This process can take a long time.

  2. (Optional) Learn more about S3-CSI in its official documentation.

Editing add-on settings code during installation

Editing the add-on code is applicable for standard installation and installation on dedicated worker nodes.

The full add-on settings code along with the description of the fields is available on GitHub.

After editing the add-on code continue installing the add-on.