Skip to content

Update Azure Storage blobstore documentation #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jochenehret wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Azure Storage blobstore documentation #214

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 31 additions & 15 deletions common/cc-blobstore-config.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The [`cf-deployment`](https://github.com/cloudfoundry/cf-deployment/blob/master/
By default, `cf-deployment` uses the WebDAV blobstore, and no additional ops files are needed.
If you want to configure your blobstore manually, see the topics below for guidance.

The Cloud Controller has four types of objects that need to be stored in a blobstore: <code>buildpacks</code>, <code>droplets</code>, <code>packages</code>, and <code>resource_pool</code>. By default, the blobstore configuration uses the Fog Ruby gem, but can also use the WebDAV protocol.
The Cloud Controller has four types of objects that need to be stored in a blobstore: <code>buildpacks</code>, <code>droplets</code>, <code>packages</code>, and <code>resource_pool</code>. By default, the blobstore configuration uses the Fog Ruby gem, but can also use the WebDAV protocol. Note that the Ruby Fog implementation is deprecated and will be gradually replaced with the new [`Storage CLI`](https://github.com/cloudfoundry/storage-cli) implementations.

This document describes the following common blobstore configurations:

Expand All @@ -22,7 +22,7 @@ This document describes the following common blobstore configurations:
* [Fog with AWS IAM Instance Profiles](#fog-aws-iam)
* [Fog with Google Cloud Storage](#fog-gcs)
* [Fog with Google Cloud Storage Service Accounts](#fog-gcs-service-account)
* [Fog with Azure Storage](#fog-azure)
* [Storage CLI with Azure Storage](#storage-cli-azure)
* [Fog with Other S3 Compatible Stores](#fog-s3-other)
* [Fog with NFS](#fog-local-nfs)
* [WebDAV](#webdav) internal blobstore
Expand Down Expand Up @@ -355,7 +355,7 @@ You need this key to configure your blobstore.
resource_pool: *resource_pool
```

##<a id="fog-azure"></a>Fog with Azure Storage
##<a id="storage-cli-azure"></a>Storage CLI with Azure Storage

To configure your blobstores to use Azure Storage credentials, do the following:

Expand All @@ -364,25 +364,41 @@ To configure your blobstores to use Azure Storage credentials, do the following:
```
cc:
buildpacks:
blobstore_type: fog
blobstore_provider: AzureRM
blobstore_type: storage-cli
buildpack_directory_key: YOUR-AZURE-BUILDPACK-CONTAINER
fog_connection: &fog_connection
provider: AzureRM
environment: AzureCloud
azure_storage_account_name: YOUR-AZURE-STORAGE-ACCOUNT-NAME
connection_config:
azure_storage_access_key: YOUR-AZURE-STORAGE-ACCESS-KEY
azure_storage_account_name: YOUR-AZURE-STORAGE-ACCOUNT-NAME
container_name: YOUR-AZURE-BUILDPACK-CONTAINER
environment: AzureCloud
droplets:
blobstore_type: fog
blobstore_provider: AzureRM
blobstore_type: storage-cli
droplet_directory_key: YOUR-AZURE-DROPLET-CONTAINER
fog_connection: *fog_connection
connection_config:
azure_storage_access_key: YOUR-AZURE-STORAGE-ACCESS-KEY
azure_storage_account_name: YOUR-AZURE-STORAGE-ACCOUNT-NAME
container_name: YOUR-AZURE-DROPLET-CONTAINER
environment: AzureCloud
packages:
blobstore_type: fog
blobstore_provider: AzureRM
blobstore_type: storage-cli
app_package_directory_key: YOUR-AZURE-PACKAGE-CONTAINER
fog_connection: *fog_connection
connection_config:
azure_storage_access_key: YOUR-AZURE-STORAGE-ACCESS-KEY
azure_storage_account_name: YOUR-AZURE-STORAGE-ACCOUNT-NAME
container_name: YOUR-AZURE-PACKAGE-CONTAINER
environment: AzureCloud
resource_pool:
blobstore_type: fog
blobstore_provider: AzureRM
blobstore_type: storage-cli
resource_directory_key: YOUR-AZURE-RESOURCE-CONTAINER
fog_connection: *fog_connection
connection_config:
azure_storage_access_key: YOUR-AZURE-STORAGE-ACCESS-KEY
azure_storage_account_name: YOUR-AZURE-STORAGE-ACCOUNT-NAME
container_name: YOUR-AZURE-RESOURCE-CONTAINER
environment: AzureCloud
```

1. Replace `YOUR-AZURE-STORAGE-ACCOUNT-NAME` and `YOUR-AZURE-STORAGE-ACCESS-KEY` with your Azure Storage credentials.
Expand All @@ -394,7 +410,7 @@ To configure your blobstores to use Azure Storage credentials, do the following:
only lowercase alphanumeric characters and hyphens.
See [Azure's storage name restrictions][azure-name-restrictions].

1. You can provide further configuration through the `fog_connection` hash, which is passed through to the Fog gem.
1. You can provide further configuration through the `connection_config` hash, which is passed through to the [`Storage CLI`](https://github.com/cloudfoundry/storage-cli) implementation.

##<a id="fog-s3-other"></a> Fog with Other S3 Compatible Stores

Expand Down