diff --git a/docs/preliminary/azure_storage/_category_.json b/docs/preliminary/azure_storage/_category_.json new file mode 100644 index 0000000..02fcc53 --- /dev/null +++ b/docs/preliminary/azure_storage/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Azure Storage", + "position": 4 +} diff --git a/docs/preliminary/azure_storage/azure-account.mdx b/docs/preliminary/azure_storage/azure-account.mdx new file mode 100644 index 0000000..2fa726a --- /dev/null +++ b/docs/preliminary/azure_storage/azure-account.mdx @@ -0,0 +1,20 @@ +--- +sidebar_position: 4 +title: Creating a Microsoft Azure Account +--- + +If you don’t already have a Microsoft Account: + +- Visit: https://azure.microsoft.com/en-us/free/ +- Choose the Free Tier to start; it becomes pay-as-you-go after the trial period. + A credit card is required for identity verification, but no charges apply unless usage exceeds the free limits. + +
+ +
Add your profile details
+
+ +
+ +
Add your credit card details
+
diff --git a/docs/preliminary/azure_storage/azure-container.mdx b/docs/preliminary/azure_storage/azure-container.mdx new file mode 100644 index 0000000..87f78f8 --- /dev/null +++ b/docs/preliminary/azure_storage/azure-container.mdx @@ -0,0 +1,37 @@ +--- +sidebar_position: 6 +title: Azure Container Creation +--- + +### Create a Blob Storage Container + +At this point we now need a place to put the files. As the [Microsoft documentation](https://learn.microsoft.com/en-us/azure/storage/blobs/blob-containers-portal) states "Azure Blob Storage allows you to store large amounts of unstructured object data." This will be where the AI-READI files will be ultimately delivered. If you already have a container you can skip to the next step to [create a SAS token](./azure-token.mdx). + +1. In the Azure Portal, go to "Storage accounts" and click your storage account. +2. In the left sidebar under "Data storage", click "Containers". + +
+ +
Containers menu item
+
+ +3. Click "+ Add Container" tab. + +
+ +
Tab to create container
+
+ +4. Set the container details + +- **Name**: Must be lowercase, no spaces. +- **Public access level**: Select "Private (no anonymous access)". + +
+ +
Tab to create container
+
+ +5. Click the "Create" button. + +**Note**: Save your Container Name along with the Storage Account name for use in the dataset request. diff --git a/docs/preliminary/azure_storage/azure-storage.mdx b/docs/preliminary/azure_storage/azure-storage.mdx new file mode 100644 index 0000000..907264f --- /dev/null +++ b/docs/preliminary/azure_storage/azure-storage.mdx @@ -0,0 +1,55 @@ +--- +sidebar_position: 5 +title: Azure Storage Account Creation +--- + +### Create an Azure Storage Account + +Next, create an [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview) that will house the storage container. Below is a summarized version of the [full documentation](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-create). If you already have an Azure Storage Account you can [skip to creating the container](./azure-container.mdx). + +1. Log in to the Azure Portal: https://portal.azure.com +2. Search for "Storage accounts" in the top search bar and click "+ Create". + +{' '} + +
+ +
Locate the Storage account item from the menu in the upper left
+
+ +3. Fill out the form: + +- **Subscription**: Select your plan. +- **Resource group**: Use an existing one or create a new one. +- **Storage account name**: Choose a globally unique, lowercase name. +- **Region**: Choose a region closest to you. +- **Performance**: Standard (default). +- **Redundancy**: Locally-redundant storage (LRS) is recommended. + +
+ +
Form elements to complete
+
+ +4. Click "Review + create", then "Create". + + **Note**: Take note of your Storage Account Name. You’ll need this when requesting the dataset. + +{' '} + +
+ +
Review the details
+
+
+ +
Overview while the storage account is created
+
+
+ +
Once complete you can go to the storage account
+
+
+ +
Storage account home page
+
diff --git a/docs/preliminary/azure_storage/azure-token.mdx b/docs/preliminary/azure_storage/azure-token.mdx new file mode 100644 index 0000000..9fbc424 --- /dev/null +++ b/docs/preliminary/azure_storage/azure-token.mdx @@ -0,0 +1,53 @@ +--- +sidebar_position: 7 +title: Azure Container SAS Token Generation +description: Instructions for generating a SAS token for an Azure Blob Storage container. +--- + +### Generate a SAS Token + +Now that we have a Storage Account and a Blob Container, create a Shared Access Signature (SAS) token. This token will allow the AI-READI pipeline to write files to your container. See the [Microsoft documentation](https://learn.microsoft.com/en-us/azure/storage/blobs/blob-containers-portal#generate-a-shared-access-signature) for more details. + +1. From the container, expand the "Settings" menu item and select "Shared access tokens". + +
+ +
Access container settings
+
+ +2. Set the following options: + + - **Permissions**: Check only the box for "Write". + +
+ +
Set the token permissions
+
+ + - **Expiry**: Choose a date several weeks or months in the future (e.g., 2 to 3 weeks). +
+ +
Set the token exipration date
+
+ +3. Click "**Generate SAS token and URL**". + +
+ +
+ +4. Copy only the "Blob SAS token". It will be in the following format: + + _`sp=w&st=2025-06-02T23:28:30Z&se=2025-07-04T07:28:30Z&spr=https&sv=2024-11-04&sr=c sig=KBj2FOV...`_ + +**Important**: Only submit the SAS token (do not include the full SAS URL). + +### Final Checklist + +Make sure you have all three of the following: + +- Storage Account Name +- Blob Container Name +- Blob SAS Token (Write permission) + +Provide this information while requesting access to the AI-READI dataset during the Azure credentials step. diff --git a/docs/preliminary/azure_storage/azure.mdx b/docs/preliminary/azure_storage/azure.mdx new file mode 100644 index 0000000..69524ab --- /dev/null +++ b/docs/preliminary/azure_storage/azure.mdx @@ -0,0 +1,12 @@ +--- +sidebar_position: 1 +title: Azure Storage Overview +--- + +Due to the size of the AI-READI dataset, we require requestors to provide an Azure storage container to receive the processed data. Specifically, at the end of the request process you will need to provide: + +1. Storage Account Name +1. Blob Container Name +1. Blob SAS Token (with "Write" permission only) + +Follow the steps over the next few pages to create your Azure storage environment. Please do this before you attempt to request the AI-READI dataset as it can lead to delays in processing your request. diff --git a/static/img/azure/azure-container-1.png b/static/img/azure/azure-container-1.png new file mode 100644 index 0000000..042eb43 Binary files /dev/null and b/static/img/azure/azure-container-1.png differ diff --git a/static/img/azure/azure-container-2.png b/static/img/azure/azure-container-2.png new file mode 100644 index 0000000..58421d3 Binary files /dev/null and b/static/img/azure/azure-container-2.png differ diff --git a/static/img/azure/azure-container-3.png b/static/img/azure/azure-container-3.png new file mode 100644 index 0000000..57fa72c Binary files /dev/null and b/static/img/azure/azure-container-3.png differ diff --git a/static/img/azure/azure-signup-credit.png b/static/img/azure/azure-signup-credit.png new file mode 100644 index 0000000..52c126d Binary files /dev/null and b/static/img/azure/azure-signup-credit.png differ diff --git a/static/img/azure/azure-signup-profile.png b/static/img/azure/azure-signup-profile.png new file mode 100644 index 0000000..7959ede Binary files /dev/null and b/static/img/azure/azure-signup-profile.png differ diff --git a/static/img/azure/azure-storage-1.png b/static/img/azure/azure-storage-1.png new file mode 100644 index 0000000..fa3d266 Binary files /dev/null and b/static/img/azure/azure-storage-1.png differ diff --git a/static/img/azure/azure-storage-2.png b/static/img/azure/azure-storage-2.png new file mode 100644 index 0000000..f45cf5d Binary files /dev/null and b/static/img/azure/azure-storage-2.png differ diff --git a/static/img/azure/azure-storage-3.png b/static/img/azure/azure-storage-3.png new file mode 100644 index 0000000..af08a40 Binary files /dev/null and b/static/img/azure/azure-storage-3.png differ diff --git a/static/img/azure/azure-storage-4.png b/static/img/azure/azure-storage-4.png new file mode 100644 index 0000000..15b8858 Binary files /dev/null and b/static/img/azure/azure-storage-4.png differ diff --git a/static/img/azure/azure-storage-5.png b/static/img/azure/azure-storage-5.png new file mode 100644 index 0000000..f727f09 Binary files /dev/null and b/static/img/azure/azure-storage-5.png differ diff --git a/static/img/azure/azure-token-10.png b/static/img/azure/azure-token-10.png new file mode 100644 index 0000000..bee3c13 Binary files /dev/null and b/static/img/azure/azure-token-10.png differ diff --git a/static/img/azure/azure-token-6.png b/static/img/azure/azure-token-6.png new file mode 100644 index 0000000..f6d7a83 Binary files /dev/null and b/static/img/azure/azure-token-6.png differ diff --git a/static/img/azure/azure-token-8.png b/static/img/azure/azure-token-8.png new file mode 100644 index 0000000..32b047a Binary files /dev/null and b/static/img/azure/azure-token-8.png differ diff --git a/static/img/azure/azure-token-9.png b/static/img/azure/azure-token-9.png new file mode 100644 index 0000000..b5b2fb1 Binary files /dev/null and b/static/img/azure/azure-token-9.png differ