Configuring File Storage for PAS

This topic provides instructions for configuring file storage for PAS (Pivotal Application Service) based on your IaaS and installation method. See the section that applies to your use case.

To minimize system downtime, Pivotal recommends using highly resilient and redundant external filestores for your PAS file storage. For more factors to consider when selecting file storage, see Considerations for Selecting File Storage in Pivotal Platform.

Internal File Storage

Internal file storage is only appropriate for small, non-production deployments.

To use the Pivotal Platform internal filestore:

  1. Select Internal WebDAV.

  2. Click Save.

AWS

This section describes how to configure file storage for AWS.

Note: If you followed the instructions in Installing Pivotal Platform on AWS Manually, you created the necessary resources for external S3-compatible file storage.

For production-level Pivotal Platform deployments on AWS, Pivotal recommends selecting the External S3-compatible filestore. For more information about production-level Pivotal Platform deployments on AWS, see the Reference Architecture for Pivotal Platform on AWS.

To use an external S3-compatible filestore for PAS file storage:

  1. Select External S3-compatible filestore and complete the following fields:

    • Enter the https:// URL endpoint for your region. For example, https://s3-us-west-2.amazonaws.com/.
    • If you use an AWS instance profile to manage role information for your filestore, enable the S3 AWS with instance profile checkbox. For more information, see AWS Identity and Access Management in the AWS documentation.
      At the top of the image is an enabled checkbox labeled 'S3 AWS with instance profile'. Below this checkbox are two fields labeled 'Access key' and 'Secret key'. The 'Secret key' field contains the ghost text 'Secret'.
    • If your Application Service deployment is on AWS, you can alternatively enter the Access key and Secret key of the pcf-user you created when configuring AWS for Pivotal Platform. If you enable the S3 AWS with instance profile checkbox and also enter an Access key and Secret key, the instance profile will overrule the access key and secret key.
    • From the S3 signature version dropdown, select V4 signature. For more information about S3 signatures, see Signing AWS API Requests in the AWS documentation.
    • For Region, enter the region in which your S3 buckets are located. For example, us-west-2.
    • Select Server-side encryption to encrypt the contents of your S3 filestore. This option is only available for AWS S3.
    • (Optional) If you selected Server-side encryption, you can also specify a KMS key ID. PAS uses the KMS key to encrypt files uploaded to the blobstore. If you do not provide a KMS Key ID, PAS uses the default AWS key. For more information, see Protecting Data Using Server-Side Encryption with AWS KMS–Managed Keys (SSE-KMS) in the AWS documentation.
    • Enter names for your S3 buckets:
      Ops Manager Field Value Description
      Buildpacks bucket name pcf-buildpacks-bucket
      This S3 bucket stores app buildpacks.
      Droplets bucket name pcf-droplets-bucket This S3 bucket stores app droplets. Pivotal recommends that you use a unique bucket name for droplets, but you can also use the same name as above.
      Packages bucket name pcf-packages-bucket This S3 bucket stores app packages. Pivotal recommends that you use a unique bucket name for packages, but you can also use the same name as above.
      Resources bucket name pcf-resources-bucket This S3 bucket stores app resources. Pivotal recommends that you use a unique bucket name for app resources, but you can also use the same name as above.
    • Configure the following depending on whether your S3 buckets have versioning enabled:
      • For versioned S3 buckets, enable the Use versioning for backup and restore checkbox to archive each bucket to a version.
      • For unversioned S3 buckets, disable the Use versioning for backup and restore checkbox, and enter a backup bucket name for each active bucket. The backup bucket name must be different from the name of the active bucket it backs up.
        At the top of the image is a disabled checkbox labeled 'Use versioning for backup and restore'. Below this checkbox are four fields labeled, from top to bottom: 'Backup region', 'Backup buildpacks bucket name', 'Backup droplets bucket name', and 'Backup packages bucket name'. The 'Backup region' field contains the ghost text 'us-east-1'.
        For more information about setting up external S3 blobstores, see Backup and Restore with External Blobstores in the Cloud Foundry documentation.
    • Enter the name of the region in which your backup S3 buckets are located. For example, us-west-2. These are the buckets used to back up and restore the contents of your S3 filestore.
    • (Optional) Enter names for your backup S3 buckets:
      Ops Manager Field Value Description
      Backup buildpacks bucket name buildpacks-backup-bucket
      This S3 bucket is used to back up and restore your buildpacks bucket. This bucket name must be different from the buckets you named above.
      Backup droplets bucket name droplets-backup-bucket This S3 bucket is used to back up and restore your droplets bucket. Pivotal recommends that you use a unique bucket name for droplet backups, but you can also use the same name as above.
      Backup packages bucket name packages-backup-bucket This S3 bucket is used to back up and restore your packages bucket. Pivotal recommends that you use a unique bucket name for package backups, but you can also use the same name as above.
  2. Click Save.

Note: For more information about AWS S3 signatures, see Authenticating Requests in the AWS documentation.

GCP

This section describes how to configure file storage for GCP. Follow the instructions that correspond to your installation method: Manual or Terraform.

For production-level Pivotal Platform deployments on GCP, Pivotal recommends selecting External Google Cloud Storage. For more information about production-level Pivotal Platform deployments on GCP, see the Reference Architecture for Pivotal Platform on GCP.

Manual

This section describes how to configure file storage for GCP if you installed Pivotal Platform manually.

PAS can use Google Cloud Storage (GCS) as its external filestore by using either a GCP interoperable storage access key or your GCS Service Account.

To configure file storage for GCP, do one of the following:

Note: The Pivotal Application Service for Windows (PASW) tile is incompatible with Google Cloud Platform (GCP) configured with a Google Cloud Storage (GCS) filestore. If you are deploying PASW in your GCP environment, Pivotal recommends that you select the S3-compatible filestore for your environment.

External Google Cloud Storage with Access Key and Secret Key

  1. Select External Google Cloud Storage with access key and secret key. At the top of the image is the text 'Configure your Cloud Controller's filesystem:', with a red asterisk to denote that it is a required configuration. Below this text are three radio buttons: two buttons labeled 'Internal WebDAV' and 'External S3-compatible file store', and one selected radio button labeled 'External Google Cloud Storage with access key and secret key'. Below the selected radio button are six fields with red asterisks labeled, from top to bottom: 'Access key', 'Secret key', 'Buildpacks bucket name', Droplets bucket name', 'Packages bucket name', and 'Resources bucket name'.

  2. Enter values for Access key and Secret key. To obtain the values for these fields:

    1. In the GCP Console, navigate to the Storage tab, then click Settings.
    2. Click Interoperability.
    3. If necessary, click Enable interoperability access. If interoperability access is already enabled, confirm that the default project matches the project where you are installing Pivotal Platform.
    4. Click Create a new key. Gcp key secret create
    5. Copy and paste the generated values into the corresponding PAS fields. Pivotal Platform uses these values for authentication when connecting to Google Cloud Storage.
  3. Enter the names of the storage buckets you created in Preparing to Deploy Ops Manager on GCP Manually:

    • Buildpacks bucket name: YOUR-PCF-buildpacks
    • Droplets bucket name: YOUR-PCF-droplets
    • Resources bucket name: YOUR-PCF-resources
    • Packages bucket name: YOUR-PCF-packages
  4. Click Save.

External Google Cloud Storage with Service Account

Note: You can either use the same service account that you created for Ops Manager, or create a separate service account for PAS file storage. To create a separate service account for PAS file storage, follow the procedure in Set up IAM Service Accounts, but only select the Storage > Storage Admin role.

  1. Select External Google Cloud Storage with service account. At the top of the image is the text 'Configure your Cloud Controller's filesystem:', with a red asterisk to denote that it is a required configuration. Below this text are four radio buttons: three buttons labeled 'Internal WebDAV', 'External S3-compatible file store', and 'External Google Cloud Storage with access key and secret key'; and one selected radio button labeled 'External Google Cloud Storage with service account'. Below the selected radio button are two fields with red asterisks labeled, from top to bottom: 'GCP project ID' and 'GCP service account email'. Next is a text area with a red asterisk labeled 'GCP service account key JSON'. Next are five fields with red asterisks labeled, from top to bottom: 'Buildpacks bucket name', 'Droplets bucket name', 'Packages bucket name', 'Resources bucket name', and' Backup bucket name'.

  2. For GCP project ID, enter the Project ID on your GCP Console that you want to use for your PAS file storage.

  3. For GCP service account email enter the email address associated with your GCP account.

  4. For GCP service account JSON enter the account key that you use to access the specified GCP project, in JSON format.

  5. Enter the names of the storage buckets you created in Preparing to Deploy Ops Manager on GCP Manually:

    • Buildpacks bucket name: YOUR-PCF-buildpacks
    • Droplets bucket name: YOUR-PCF-droplets
    • Resources bucket name: YOUR-PCF-resources
    • Packages bucket name: YOUR-PCF-packages
    • Backup bucket name: YOUR-PCF-backup
  6. Click Save.

Terraform

This section describes how to configure file storage for GCP if you installed Pivotal Platform with Terraform.

PAS can use Google Cloud Storage (GCS) as its external filestore by using either a GCP interoperable storage access key or your GCS Service Account.

To configure file storage for GCP, do one of the following:

Note: The Pivotal Application Service for Windows (PASW) tile is incompatible with Google Cloud Platform (GCP) configured with a Google Cloud Storage (GCS) filestore. If you are deploying PASW in your GCP environment, Pivotal recommends that you select the S3-compatible filestore for your environment.

External Google Cloud Storage with Access Key and Secret Key

  1. Select External Google Cloud Storage with access key and secret key. At the top of the image is the text 'Configure your Cloud Controller's filesystem:', with a red asterisk to denote that it is a required configuration. Below this text are three radio buttons: two buttons labeled 'Internal WebDAV' and 'External S3-compatible file store', and one selected radio button labeled 'External Google Cloud Storage with access key and secret key'. Below the selected radio button are six fields with red asterisks labeled, from top to bottom: 'Access key', 'Secret key', 'Buildpacks bucket name', Droplets bucket name', 'Packages bucket name', and 'Resources bucket name'.

  2. Enter values for Access key and Secret key. To obtain the values for these fields:

    1. In the GCP Console, navigate to the Storage tab, then click Settings.
    2. Click Interoperability.
    3. If necessary, click Enable interoperability access. If interoperability access is already enabled, confirm that the default project matches the project where you are installing Pivotal Platform.
    4. Click Create a new key. Gcp key secret create
    5. Copy and paste the generated values into the corresponding PAS fields. Pivotal Platform uses these values for authentication when connecting to Google Cloud Storage.
  3. Enter the names of the storage buckets you created in Deploying Ops Manager on GCP Using Terraform:

    • Buildpacks bucket name: Enter the value of buildpacks_bucket from your Terraform output.
    • Droplets bucket name: Enter the value of droplets_bucket from your Terraform output.
    • Resources bucket name: Enter the value of packages_bucket from your Terraform output.
    • Packages bucket name: Enter the value of resources_bucket from your Terraform output.
  4. Click Save.

External Google Cloud Storage with Service Account

Note: You can either use the same service account that you created for Ops Manager, or create a separate service account for PAS file storage. To create a separate service account for PAS file storage, follow the procedure in Set up IAM Service Accounts, but only select the Storage > Storage Admin role.

  1. Select External Google Cloud Storage with service account. At the top of the image is the text 'Configure your Cloud Controller's filesystem:', with a red asterisk to denote that it is a required configuration. Below this text are four radio buttons: three buttons labeled 'Internal WebDAV', 'External S3-compatible file store', and 'External Google Cloud Storage with access key and secret key'; and one selected radio button labeled 'External Google Cloud Storage with service account'. Below the selected radio button are two fields with red asterisks labeled, from top to bottom: 'GCP project ID' and 'GCP service account email'. Next is a text area with a red asterisk labeled 'GCP service account key JSON'. Next are five fields with red asterisks labeled, from top to bottom: 'Buildpacks bucket name', 'Droplets bucket name', 'Packages bucket name', 'Resources bucket name', and' Backup bucket name'.

  2. For GCP project ID, enter the Project ID on your GCP Console that you want to use for your PAS file storage.

  3. For GCP service account email enter the email address associated with your GCP account.

  4. For GCP service account JSON enter the account key that you use to access the specified GCP project, in JSON format.

  5. Enter the names of the storage buckets you created in Deploying Ops Manager on GCP Using Terraform:

    • Buildpacks bucket name: Enter the value of buildpacks_bucket from your Terraform output.
    • Droplets bucket name: Enter the value of droplets_bucket from your Terraform output.
    • Resources bucket name: Enter the value of packages_bucket from your Terraform output.
    • Packages nucket name: Enter the value of resources_bucket from your Terraform output.
    • Backup bucket name: Enter the value of backup_bucket from your Terraform output.
  6. Click Save.

Azure

This section describes how to configure file storage for Azure.

For production-level Pivotal Platform deployments on Azure, the recommended selection is Azure Storage. For more information about production-level Pivotal Platform deployments on Azure, see the Reference Architecture for Pivotal Platform on Azure.

For more factors to consider when selecting file storage, see Considerations for Selecting File Storage in Pivotal Platform.

To use external Azure file storage for your PAS filestore:

  1. Select the External Azure storage option. At the top of the image is the text 'Configure your Cloud Controller's filesystem:', with a red asterisk to denote that it is a required configuration. Below this text are five radio buttons: four buttons labeled 'Internal WebDAV', 'External S3-compatible file store', 'External Google Cloud Storage with access key and secret key', and 'External Google Cloud Storage with service account'; and one selected radio button labeled 'External Azure Storage'. Below the selected radio button are seven fields with red asterisks labeled, from top to bottom: 'Account name', 'Access key', 'Environment', 'Buildpacks container name', 'Droplets container name', 'Packages container name', and 'Resources container name'. The 'Environment' field contains the text 'AzureCloud'. Next is a disabled checkbox labeled 'Enable backup and restore'. Next are two fields labeled, from top to bottom, 'Restore from storage account' and 'Restore using access key'.

  2. To create a new storage account and storage containers for the PAS filestore:

    • In the Azure Portal, navigate to the Storage accounts tab.
    • Click on the plus icon to add a new storage account.
    • In the Name field, enter a unique name for the storage account. This name must be all lowercase and contain 3 to 24 alphanumeric characters.
    • For the Deployment model, select Resource manager.
    • For Account kind, select General purpose.
    • For Performance, select Standard.
    • From the Replication dropdown, select Locally-redundant storage (LRS).
    • For Storage service encryption, select Disabled.
    • From the Subscription dropdown, select the subscription where you want to deploy Pivotal Platform resources.
    • For Resource group, select Use existing and enter the name of the resource group where you deployed PAS.
    • From Location the dropdown, select the Location where you are deploying Pivotal Platform.
    • Click Create.
    • After the storage account is created, select the new storage account from the dashboard.
    • Navigate to the Blob Service section of the storage account, and then click on Containers to create one or more containers in this storage account for buildpacks, droplets, resources, and packages.
    • In Blob Service, select Soft Delete. In Soft Delete, click Enabled to enable soft delete in your Azure storage account.

      Note: BBR requires that you enable soft delete in your Azure storage account before you enable backup and restore for your Azure blobstores in Ops Manager. You should set a reasonable retention policy to minimize storage costs. For more information on enabling soft delete in your Azure storage account, see the Azure documentation.

    • For each container that you create, set the Access type to Private.
  3. In PAS, enter the name of the storage account you created for Account name.

  4. In the Access key field, enter one of the access keys provided for the storage account. To obtain a value for this fields, visit the Azure Portal, navigate to the Storage accounts tab, and click on Access keys.

  5. For Environment, enter the name of the Azure Cloud environment that contains your storage. This value defaults to AzureCloud, but other options include AzureChinaCloud, AzureUSGovernment, and AzureGermanCloud.

  6. For Buildpacks container name, enter the container name for storing your app buildpacks.

  7. For Droplets container name, enter the container name for your app droplet storage. Pivotal recommends that you use a unique container name, but you can use the same container name as the previous step.

  8. For Packages container name, enter the container name for packages. Pivotal recommends that you use a unique container name, but you can use the same container name as the previous step.

  9. For Resources container name, enter the container name for resources. Pivotal recommends that you use a unique container name, but you can use the same container name as the previous step.

  10. (Optional) To enable backup and restore for your Azure blobstores in PAS, enable the Enable backup and restore checkbox.

    Note: Soft deletes must be enabled for all storage containers listed.

  11. (Optional) To enable PAS to restore your containers to a different Azure storage account than the account where you take backups:

    1. Under Restore from storage account, enter the name of the Azure storage account you want to restore your containers from. Leave this field blank if restoring to the same storage account where you take backups.
    2. Under Restore using access key, enter the access key for the Azure storage account you specified in Restore from storage account. Leave this field blank if restoring to the same storage account where you take backups.
  12. Click Save.

Note: To enable backup and restore of your PAS tile that uses an S3-compatible blobstore, see Enable External Blobstore Backups.

Openstack

For production-level Pivotal Platform deployments on OpenStack, the recommended selection is External S3-compatible filestore.

For more factors to consider when selecting file storage, see Considerations for Selecting File Storage in Pivotal Platform.

To use an external S3-compatible filestore for PAS file storage:

  1. Select External S3-compatible filestore and complete the following fields:

    • Enter the https:// URL endpoint for your region. For example, https://s3-us-west-2.amazonaws.com/.
    • If you use an AWS instance profile to manage role information for your filestore, enable the S3 AWS with instance profile checkbox. For more information, see AWS Identity and Access Management in the AWS documentation.
      At the top of the image is an enabled checkbox labeled 'S3 AWS with instance profile'. Below this checkbox are two fields labeled 'Access key' and 'Secret key'. The 'Secret key' field contains the ghost text 'Secret'.
    • From the S3 signature version dropdown, select V4 signature. For more information about S3 signatures, see Signing AWS API Requests in the AWS documentation.
    • For Region, enter the region in which your S3 buckets are located. For example, us-west-2.
    • Select Server-side encryption to encrypt the contents of your S3 filestore. This option is only available for AWS S3.
    • (Optional) If you selected Server-side encryption, you can also specify a KMS key ID. PAS uses the KMS key to encrypt files uploaded to the blobstore. If you do not provide a KMS Key ID, PAS uses the default AWS key. For more information, see Protecting Data Using Server-Side Encryption with AWS KMS–Managed Keys (SSE-KMS) in the AWS documentation.
    • Enter names for your S3 buckets:
      Ops Manager Field Value Description
      Buildpacks bucket name pcf-buildpacks-bucket
      This S3 bucket stores app buildpacks.
      Droplets bucket name pcf-droplets-bucket This S3 bucket stores app droplets. Pivotal recommends that you use a unique bucket name for droplets, but you can also use the same name as above.
      Packages bucket name pcf-packages-bucket This S3 bucket stores app packages. Pivotal recommends that you use a unique bucket name for packages, but you can also use the same name as above.
      Resources bucket name pcf-resources-bucket This S3 bucket stores app resources. Pivotal recommends that you use a unique bucket name for app resources, but you can also use the same name as above.
    • Configure the following depending on whether your S3 buckets have versioning enabled:
      • For versioned S3 buckets, enable the Use versioning for backup and restore checkbox to archive each bucket to a version.
      • For unversioned S3 buckets, disable the Use versioning for backup and restore checkbox, and enter a backup bucket name for each active bucket. The backup bucket name must be different from the name of the active bucket it backs up.
        At the top of the image is a disabled checkbox labeled 'Use versioning for backup and restore'. Below this checkbox are four fields labeled, from top to bottom: 'Backup region', 'Backup buildpacks bucket name', 'Backup droplets bucket name', and 'Backup packages bucket name'. The 'Backup region' field contains the ghost text 'us-east-1'.
        For more information about setting up external S3 blobstores, see Backup and Restore with External Blobstores in the Cloud Foundry documentation.
    • Enter the name of the region in which your backup S3 buckets are located. For example, us-west-2. These are the buckets used to back up and restore the contents of your S3 filestore.
    • (Optional) Enter names for your backup S3 buckets:
      Ops Manager Field Value Description
      Backup buildpacks bucket name buildpacks-backup-bucket
      This S3 bucket is used to back up and restore your buildpacks bucket. This bucket name must be different from the buckets you named above.
      Backup droplets bucket name droplets-backup-bucket This S3 bucket is used to back up and restore your droplets bucket. Pivotal recommends that you use a unique bucket name for droplet backups, but you can also use the same name as above.
      Backup packages bucket name packages-backup-bucket This S3 bucket is used to back up and restore your packages bucket. Pivotal recommends that you use a unique bucket name for package backups, but you can also use the same name as above.
  2. Click Save.

Note: For more information about AWS S3 signatures, see Authenticating Requests in the AWS documentation.

vSphere

For production-level Pivotal Platform deployments on vSphere, the recommended selection is External S3-compatible filestore and the use of an external filestore. For more information about production-level Pivotal Platform deployments on vSphere, see the Reference Architecture for Pivotal Platform on vSphere.

For more factors to consider when selecting file storage, see Considerations for Selecting File Storage in Pivotal Platform.

To use an external S3-compatible filestore for PAS file storage:

  1. Select External S3-compatible filestore and complete the following fields:

    • Enter the https:// URL endpoint for your region. For example, https://s3-us-west-2.amazonaws.com/.
    • If you use an AWS instance profile to manage role information for your filestore, enable the S3 AWS with instance profile checkbox. For more information, see AWS Identity and Access Management in the AWS documentation.
      At the top of the image is an enabled checkbox labeled 'S3 AWS with instance profile'. Below this checkbox are two fields labeled 'Access key' and 'Secret key'. The 'Secret key' field contains the ghost text 'Secret'.
    • From the S3 signature version dropdown, select V4 signature. For more information about S3 signatures, see Signing AWS API Requests in the AWS documentation.
    • For Region, enter the region in which your S3 buckets are located. For example, us-west-2.
    • Select Server-side encryption to encrypt the contents of your S3 filestore. This option is only available for AWS S3.
    • (Optional) If you selected Server-side encryption, you can also specify a KMS key ID. PAS uses the KMS key to encrypt files uploaded to the blobstore. If you do not provide a KMS Key ID, PAS uses the default AWS key. For more information, see Protecting Data Using Server-Side Encryption with AWS KMS–Managed Keys (SSE-KMS) in the AWS documentation.
    • Enter names for your S3 buckets:
      Ops Manager Field Value Description
      Buildpacks bucket name pcf-buildpacks-bucket
      This S3 bucket stores app buildpacks.
      Droplets bucket name pcf-droplets-bucket This S3 bucket stores app droplets. Pivotal recommends that you use a unique bucket name for droplets, but you can also use the same name as above.
      Packages bucket name pcf-packages-bucket This S3 bucket stores app packages. Pivotal recommends that you use a unique bucket name for packages, but you can also use the same name as above.
      Resources bucket name pcf-resources-bucket This S3 bucket stores app resources. Pivotal recommends that you use a unique bucket name for app resources, but you can also use the same name as above.
    • Configure the following depending on whether your S3 buckets have versioning enabled:
      • For versioned S3 buckets, enable the Use versioning for backup and restore checkbox to archive each bucket to a version.
      • For unversioned S3 buckets, disable the Use versioning for backup and restore checkbox, and enter a backup bucket name for each active bucket. The backup bucket name must be different from the name of the active bucket it backs up.
        At the top of the image is a disabled checkbox labeled 'Use versioning for backup and restore'. Below this checkbox are four fields labeled, from top to bottom: 'Backup region', 'Backup buildpacks bucket name', 'Backup droplets bucket name', and 'Backup packages bucket name'. The 'Backup region' field contains the ghost text 'us-east-1'.
        For more information about setting up external S3 blobstores, see Backup and Restore with External Blobstores in the Cloud Foundry documentation.
    • Enter the name of the region in which your backup S3 buckets are located. For example, us-west-2. These are the buckets used to back up and restore the contents of your S3 filestore.
    • (Optional) Enter names for your backup S3 buckets:
      Ops Manager Field Value Description
      Backup buildpacks bucket name buildpacks-backup-bucket
      This S3 bucket is used to back up and restore your buildpacks bucket. This bucket name must be different from the buckets you named above.
      Backup droplets bucket name droplets-backup-bucket This S3 bucket is used to back up and restore your droplets bucket. Pivotal recommends that you use a unique bucket name for droplet backups, but you can also use the same name as above.
      Backup packages bucket name packages-backup-bucket This S3 bucket is used to back up and restore your packages bucket. Pivotal recommends that you use a unique bucket name for package backups, but you can also use the same name as above.
  2. Click Save.

Note: For more information about AWS S3 signatures, see Authenticating Requests in the AWS documentation.