Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 9ad6479

Browse files
author
jluk
committedSep 18, 2017
fixing headers, typos, content for bash, and metadata/images
1 parent f8f50f4 commit 9ad6479

11 files changed

+82
-56
lines changed
 

‎articles/cloud-shell/features-powershell.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Capability to let you easily discover and navigate all Azure resources.
4646

4747
> [!NOTE]
4848
> [TODO: replace old gif]
49+
> [TODO: note limitations of file writing etc. in Azure drive]
4950
5051
### Interaction with VMs
5152

‎articles/cloud-shell/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Files outside of `$Home` and machine state are not persisted across sessions.
5050
|Category |Name |
5151
|---|---|
5252
|Linux shell interpreter|Bash<br> sh |
53-
|Azure tools |[Azure CLI 2.0](https://github.com/Azure/azure-cli) and [1.0](https://github.com/Azure/azure-xplat-cli)<br> [AzCopy](https://docs.microsoft.com/azure/storage/storage-use-azcopy)<br> [Batch Shipyard](https://github.com/Azure/batch-shipyard) |
53+
|Azure tools |[Azure CLI 2.0](https://github.com/Azure/azure-cli) and [1.0](https://github.com/Azure/azure-xplat-cli)<br> [AzCopy](https://docs.microsoft.com/azure/storage/storage-use-azcopy)<br> [Batch Shipyard](https://github.com/Azure/batch-shipyard) <br> |
5454
|Text editors |vim<br> nano<br> emacs |
5555
|Source control |git |
5656
|Build tools |make<br> maven<br> npm<br> pip |

‎articles/cloud-shell/limitations.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,28 @@ ms.author: juluk
2020
# Limitations of Azure Cloud Shell
2121
Azure Cloud Shell has the following known limitations:
2222

23-
## System state and persistence
23+
## General Limitations
24+
25+
### System state and persistence
2426
The machine that provides your Cloud Shell session is temporary, and it is recycled after your session is inactive for 20 minutes. Cloud Shell requires a file share to be mounted. As a result, your subscription must be able to set up storage resources to access Cloud Shell. Other considerations include:
2527
* With mounted storage, only modifications within the `clouddrive` directory are persisted. In Bash your `$Home` directory is also persisted.
2628
* File shares can be mounted only from within your [assigned region](persisting-shell-storage.md#mount-a-new-clouddrive).
2729
* In Bash, run `env` to find your region set as `ACC_LOCATION`.
2830
* Azure Files supports only locally redundant storage and geo-redundant storage accounts.
2931

30-
## Browser support
32+
### Browser support
3133
Cloud Shell supports the latest versions of Microsoft Edge, Microsoft Internet Explorer, Google Chrome, Mozilla Firefox, and Apple Safari. Safari in private mode is not supported.
3234

33-
## Copy and paste
35+
### Copy and paste
3436
Ctrl+C and Ctrl+V do not function as copy/paste shortcuts in Cloud Shell on Windows machines, use Ctrl+Insert and Shift+Insert to copy and paste respectively. <br>
3537
Right-click copy-and-paste options are also available, but right-click function is subject to browser-specific clipboard access.
3638

37-
## For a given user, only one shell can be active
38-
Users can only launch one type of shell at a time, either **Bash** or **PowerShell**. However you may have multiple instances of Bash or PowerShell running at one time.
39+
### For a given user, only one shell can be active
40+
Users can only launch one type of shell at a time, either **Bash** or **PowerShell**. However, you may have multiple instances of Bash or PowerShell running at one time. Swapping between Bash or PowerShell will trigger a Cloud Shell restart which terminates existing sessions.
3941

40-
## Usage limits
42+
### Usage limits
4143
Cloud Shell is intended for interactive use cases. As a result, any long-running non-interactive sessions are ended without warning.
4244

43-
## Network connectivity
44-
Any latency in Cloud Shell is subject to local internet connectivity, Cloud Shell continues to attempt to carry out any instructions sent.
45-
4645
## Bash Limitations
4746

4847
### User permissions
@@ -64,5 +63,6 @@ PowerShell in Azure Cloud Shell could take up to 60 seconds to initialize during
6463
Any application (such as: git, vim, and others) that writes data to $Home will not be persisted across PowerShell sessions. For a workaround [see here TODO]()
6564

6665
## Next steps
66+
[Troubleshooting Cloud Shell](troubleshooting.md) <br>
6767
[Quickstart for Bash](quickstart.md) <br>
6868
[Quickstart for PowerShell](quickstart-powershell.md)
Loading

‎articles/cloud-shell/persisting-shell-storage-powershell.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Persist files in Azure Cloud Shell (Preview) | Microsoft Docs
3-
description: Walkthrough of how Azure Cloud Shell persists files.
2+
title: Persist files for PowerShell in Azure Cloud Shell (Preview) | Microsoft Docs
3+
description: Walkthrough of how PowerShell in Azure Cloud Shell persists files.
44
services: azure
55
documentationcenter: ''
66
author: maertendmsft
@@ -13,23 +13,27 @@ ms.workload: infrastructure-services
1313
ms.tgt_pltfrm: vm-linux
1414
ms.devlang: na
1515
ms.topic: article
16-
ms.date: 07/17/2017
16+
ms.date: 09/25/2017
1717
ms.author: damaerte
1818
---
1919
[!include [features-introblock](../../includes/cloud-shell-persisting-shell-storage-introblock.md)]
2020

21+
## How to get to clouddrive
22+
TODO: cd into $Home to see clouddrive
23+
TODO: What folders are inside of clouddrive (.pscloudshell, .module, etc.) automatically, where do modules get saved?
24+
2125
## How Cloud Shell works
2226
Cloud Shell persists files through the following method:
2327
* Mounting your specified file share as `clouddrive` in your `$Home` directory for direct file-share interaction.
2428

25-
## List Cloud Drive file shares
29+
## List `clouddrive`
2630
The `Get-CloudDrive` command retrieves the file share information currently mounted by the Cloud Drive in the Cloud Shell. <br>
2731
![Running Get-CloudDrive](media/persisting-shell-storage-powershell/Get-Clouddrive.png)
2832

29-
## Unmount Cloud Drive
33+
## Unmount `clouddrive`
3034
You can unmount a file share that's mounted to Cloud Shell at any time. If the file share has been removed, you will be prompted to create and mount a new file share at the next session.
3135

32-
The `Dismount-CloudDrive` command unmounts a file share from the current storage account. Dismounting the Cloud Drive terminates the current session. The user will be prompted to create and mount a new file share during the next session.
36+
The `Dismount-CloudDrive` command unmounts a file share from the current storage account. Dismounting the Cloud Drive terminates the current session. The user will be prompted to create and mount another file share during the next session.
3337
![Running Dismount-CloudDrive](media/persisting-shell-storage-powershell/Dismount-Clouddrive.png)
3438

3539
[!include [features-endblock](../../includes/cloud-shell-persisting-shell-storage-endblock.md)]

‎articles/cloud-shell/persisting-shell-storage.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Persist files in Azure Cloud Shell (Preview) | Microsoft Docs
3-
description: Walkthrough of how Azure Cloud Shell persists files.
2+
title: Persist files for Bash in Azure Cloud Shell (Preview) | Microsoft Docs
3+
description: Walkthrough of how Bash in Azure Cloud Shell persists files.
44
services: azure
55
documentationcenter: ''
66
author: jluk
@@ -13,13 +13,13 @@ ms.workload: infrastructure-services
1313
ms.tgt_pltfrm: vm-linux
1414
ms.devlang: na
1515
ms.topic: article
16-
ms.date: 07/17/2017
16+
ms.date: 09/25/2017
1717
ms.author: juluk
1818
---
1919

2020
[!include [features-introblock](../../includes/cloud-shell-persisting-shell-storage-introblock.md)]
2121

22-
## How Cloud Shell works
22+
## How Cloud Shell storage works
2323
Cloud Shell persists files through both of the following methods:
2424
* Creating a disk image of your `$Home` directory to persist all contents within the directory. The disk image is saved in your specified file share as `acc_<User>.img` at `fileshare.storage.windows.net/fileshare/.cloudconsole/acc_<User>.img`, and it automatically syncs changes.
2525
* Mounting your specified file share as `clouddrive` in your `$Home` directory for direct file-share interaction. `/Home/<User>/clouddrive` is mapped to `fileshare.storage.windows.net/fileshare`.
@@ -28,7 +28,7 @@ Cloud Shell persists files through both of the following methods:
2828
> All files in your `$Home` directory, such as SSH keys, are persisted in your user disk image, which is stored in your mounted file share. Apply best practices when you persist information in your `$Home` directory and mounted file share.
2929
3030
## Use the `clouddrive` command
31-
With Cloud Shell, you can run a command called `clouddrive`, which enables you to manually update the file share that's mounted to Cloud Shell.
31+
With Bash in Cloud Shell, you can run a command called `clouddrive`, which enables you to manually update the file share that is mounted to Cloud Shell.
3232
![Running the "clouddrive" command](media/persisting-shell-storage/clouddrive-h.png)
3333

3434
## Mount a new `clouddrive`
@@ -43,7 +43,7 @@ If you mount an existing file share, the storage accounts must be:
4343
### The `clouddrive mount` command
4444

4545
> [!NOTE]
46-
> If you're mounting a new file share, a new user image is created for your `$Home` directory, because your previous `$Home` image is kept in the previous file share.
46+
> If you're mounting a new file share, a new user image is created for your `$Home` directory. Your previous `$Home` image is kept in your previous file share.
4747
4848
Run the `clouddrive mount` command with the following parameters:
4949

@@ -56,25 +56,20 @@ To view more details, run `clouddrive mount -h`, as shown here:
5656
![Running the `clouddrive mount`command](media/persisting-shell-storage/mount-h.png)
5757

5858
## Unmount `clouddrive`
59-
You can unmount a file share that's mounted to Cloud Shell at any time. However, because Cloud Shell requires a mounted file share, you will be prompted to create and mount a new file share at the next session if it has been removed.
59+
You can unmount a file share that's mounted to Cloud Shell at any time. Since Cloud Shell requires a mounted file share to be used, you will be prompted to create and mount another file share on the next session.
6060

61-
### The `clouddrive unmount` command
62-
63-
To remove a file share from Cloud Shell:
6461
1. Run `clouddrive unmount`.
65-
2. Acknowledge and confirm the prompts.
66-
67-
Your file share will continue to exist unless you delete it manually. Cloud Shell will no longer search for this file share on subsequent sessions.
62+
2. Acknowledge and confirm prompts.
6863

69-
To view more details, run `clouddrive unmount -h`, as shown here:
64+
Your file share will continue to exist unless you delete it manually. Cloud Shell will no longer search for this file share on subsequent sessions. To view more details, run `clouddrive unmount -h`, as shown here:
7065

7166
![Running the `clouddrive unmount`command](media/persisting-shell-storage/unmount-h.png)
7267

7368
> [!WARNING]
7469
> Although running this command will not delete any resources, manually deleting a resource group, storage account, or file share that's mapped to Cloud Shell will erase your `$Home` directory disk image and any files in your file share. This action cannot be undone.
7570
76-
## List `clouddrive` file shares
77-
To discover which file share is mounted as `clouddrive`, run the following `df` command.
71+
## List `clouddrive`
72+
To discover which file share is mounted as `clouddrive`, run the `df` command.
7873

7974
The file path to clouddrive will show your storage account name and file share in the URL. For example, `//storageaccountname.file.core.windows.net/filesharename`
8075

‎articles/cloud-shell/quickstart-powershell.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
1-
# PowerShell in Azure Cloud Shell quickstart
1+
---
2+
title: PowerShell in Azure Cloud Shell (Preview) quickstart | Microsoft Docs
3+
description: Quickstart for PowerShell in Cloud Shell
4+
services:
5+
documentationcenter: ''
6+
author: maertendmsft
7+
manager: timlt
8+
tags: azure-resource-manager
9+
10+
ms.assetid:
11+
ms.service: azure
12+
ms.workload: infrastructure-services
13+
ms.tgt_pltfrm: vm-linux
14+
ms.devlang: na
15+
ms.topic: article
16+
ms.date: 09/25/2017
17+
ms.author: damaerte
18+
---
19+
20+
# Quickstart for PowerShell in Azure Cloud Shell
221

322
This document details how to use the PowerShell in Cloud Shell in the [Azure portal](https://aka.ms/PSCloudPreview).
423

524
> [!NOTE]
6-
> A [Bash in Azure Cloud Shell](quickstart.md) guide is also available.
25+
> A [Bash in Azure Cloud Shell](quickstart.md) quickstart is also available.
726
827
## Start Cloud Shell
928

@@ -17,7 +36,7 @@ This document details how to use the PowerShell in Cloud Shell in the [Azure por
1736

1837
3. Select PowerShell
1938

20-
4. The `Azure PS drive` appears as follows
39+
4. The `Azure drive` appears as follows
2140

2241
```powershell
2342
Requesting a Cloud Shell... Succeeded.

‎articles/cloud-shell/quickstart.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Azure Cloud Shell (Preview) quickstart | Microsoft Docs
3-
description: Quickstart for Bash Cloud Shell
2+
title: Bash in Azure Cloud Shell (Preview) quickstart | Microsoft Docs
3+
description: Quickstart for Bash in Cloud Shell
44
services:
55
documentationcenter: ''
66
author: jluk
@@ -13,16 +13,16 @@ ms.workload: infrastructure-services
1313
ms.tgt_pltfrm: vm-linux
1414
ms.devlang: na
1515
ms.topic: article
16-
ms.date: 08/28/2017
16+
ms.date: 09/25/2017
1717
ms.author: juluk
1818
---
1919

20-
# Quickstart for using Bash in Cloud Shell
20+
# Quickstart for Bash in Azure Cloud Shell
2121

2222
This document details how to use Bash in Azure Cloud Shell in the [Azure portal](https://ms.portal.azure.com/).
2323

2424
> [!NOTE]
25-
> A [PowerShell in Azure Cloud Shell](quickstart-powershell.md) guide is also available.
25+
> A [PowerShell in Azure Cloud Shell](quickstart-powershell.md) quickstart is also available.
2626
2727
## Start Cloud Shell
2828
1. Launch **Cloud Shell** from the top navigation of the Azure portal <br>
@@ -33,9 +33,9 @@ This document details how to use Bash in Azure Cloud Shell in the [Azure portal]
3333
> [!TIP]
3434
> You are automatically authenticated for Azure CLI 2.0 in every sesssion.
3535
36-
### Select the Bash Environment
36+
### Select the Bash environment
3737
1. Select the environment drop down from the the left hand side of shell window <br>
38-
![](media/quickstart/Environment-Bash.png)
38+
![](media/quickstart/env-selector.png)
3939
2. Select Bash
4040

4141
### Set your subscription
@@ -74,6 +74,6 @@ Delete your resource group and any resources within it: <br>
7474
Run `az group delete -n MyRG`
7575

7676
## Next steps
77-
[Learn about persisting storage on Cloud Shell](persisting-shell-storage.md) <br>
77+
[Learn about persisting files for Bash in Cloud Shell](persisting-shell-storage.md) <br>
7878
[Learn about Azure CLI 2.0](https://docs.microsoft.com/cli/azure/) <br>
7979
[Learn about Azure File storage](../storage/files/storage-files-introduction.md) <br>

‎articles/cloud-shell/troubleshooting.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,12 @@ ms.workload: infrastructure-services
1313
ms.tgt_pltfrm: vm-linux
1414
ms.devlang: na
1515
ms.topic: article
16-
ms.date: 09/05/2017
16+
ms.date: 09/25/2017
1717
ms.author: damaerte
1818
---
1919

2020
# Troubleshooting Azure Cloud Shell
21-
Known resolutions for issues in Azure Cloud Shell:
22-
23-
## An error about [MissingSubscriptionRegistration](media/troubleshooting/storageRP-error.jpg) occurs during persistent storage creation
24-
- **Details**: The selected subscription does not have Storage RP registered.
25-
- **Resolution**: [Register your Storage resource provider](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-common-deployment-errors#noregisteredproviderfound).
21+
Known resolutions for issues in Azure Cloud Shell include:
2622

2723
## Error: 400 DisallowedOperation
2824
- **Details**: When using an Azure Active Directory subscription, you cannot create storage.

‎includes/cloud-shell-persisting-shell-storage-introblock.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,45 @@
11
# Persist files in Azure Cloud Shell
2-
Cloud Shell takes advantage of Azure File storage to persist files across sessions.
2+
Cloud Shell utilizes of Azure File storage to persist files across sessions.
33

44
## Set up a `clouddrive` file share
55
On initial start, Cloud Shell prompts you to associate a new or existing file share to persist files across sessions.
66

77
> [!NOTE]
8-
> Bash and PowerShell share the same file share. Meaning only one file share can be associated with automatic mounting in Cloud Shell.
8+
> Bash and PowerShell share the same file share. Only one file share can be associated with automatic mounting in Cloud Shell.
99
1010
### Create new storage
1111

1212
When you use basic settings and select only a subscription, Cloud Shell creates three resources on your behalf in the supported region that's nearest to you:
1313
* Resource group: `cloud-shell-storage-<region>`
14-
* Storage account: `cs-uniqueGuid`
15-
* File share: `cs-<user>-<domain>-com-uniqueGuid`
14+
* Storage account: `cs<uniqueGuid>`
15+
* File share: `cs-<user>-<domain>-com-<uniqueGuid>`
1616

1717
![The Subscription setting](../articles/cloud-shell/media/persisting-shell-storage/basic-storage.png)
1818

19-
The file share mounts as `clouddrive` in your `$Home` directory. In Bash, he file share is also used to store a 5-GB image that's created for you and that automatically updates and persists your `$Home` directory. This is a one-time action, and the file share mounts automatically in subsequent sessions.
19+
The file share mounts as `clouddrive` in your `$Home` directory. This is a one-time action, and the file share mounts automatically in subsequent sessions.
20+
21+
In Bash, the file share also contains a 5-GB image that is created for you which automatically persists data in your `$Home` directory.
2022

2123
### Use existing resources
2224

23-
By using the advanced option, you can associate existing resources. When the storage setup prompt appears, select **Show advanced settings** to view additional options. In Bash, existing file shares receive a 5-GB user image to persist your `$Home` directory. The drop-down menus are filtered for your assigned Cloud Shell region and the locally redundant storage and geo-redundant storage accounts.
25+
By using the advanced option, you can associate existing resources. When the storage setup prompt appears, select **Show advanced settings** to view additional options. The drop-down menus are filtered for your assigned Cloud Shell region and the locally redundant storage and geo-redundant storage accounts.
26+
27+
In Bash, existing file shares receive a 5-GB image created for you to persist your `$Home` directory.
2428

2529
![The Resource group setting](../articles/cloud-shell/media/persisting-shell-storage/advanced-storage.png)
2630

2731
### Restrict resource creation with an Azure resource policy
2832
Storage accounts that you create in Cloud Shell are tagged with `ms-resource-usage:azure-cloud-shell`. If you want to disallow users from creating storage accounts in Cloud Shell, create an [Azure resource policy for tags](https://docs.microsoft.com/azure/azure-resource-manager/resource-manager-policy-tags) that are triggered by this specific tag.
2933

3034
## Supported storage regions
31-
The Azure files must reside in the same region as the Cloud Shell machine that you're mounting them to. Cloud Shell machines exist in the following regions:
35+
Associated Azure storage accounts must reside in the same region as the Cloud Shell machine that you're mounting them to.
36+
37+
To find your assigned region you may:
38+
* View the note on the "Advanced storage settings" dialog
39+
* Refer to the name of the storage account created for you (ex: `cloud-shell-storage-westus`)
40+
* Run `env` and locate the variable `ACC_LOCATION`
41+
42+
Cloud Shell machine exist in the following regions:
3243
|Area|Region|
3344
|---|---|
3445
|Americas|East US, South Central US, West US|

0 commit comments

Comments
 (0)
Please sign in to comment.