Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Documentation location
  • Loading branch information
nyanhp committed Jul 7, 2020
1 parent 6edb485 commit 4f50087
Show file tree
Hide file tree
Showing 23 changed files with 60 additions and 20 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
25 changes: 25 additions & 0 deletions Help/Wiki/Advanced/resourcenaming.md
@@ -0,0 +1,25 @@
# Renaming used resources

AutomatedLab offers the ability to select different resource names for your lab machines as well as virtual switches.
While this feature is mainly intended for on-premises hypervisors like Hyper-V, Azure-based labs can also make
use of the new resource naming.

This feature is very useful for classroom deployments if students are using a shared hypervisor, as the same lab
can be deployed multiple times.

Both `Add-LabVirtualNetworkDefinition` as well as `Add-LabMachineDefinition` can use the `ResourceName` parameter.

## Example

```powershell
foreach ($studentNumber in (1..10))
{
New-LabDefinition -Name $($studentNumber)POSH -DefaultVirtualizationEngine HyperV
Add-LabMachineDefinition -Name DC01 -ResourceName $($studentNumber)DC01 -Roles RootDC -Domain contoso.com
Install-Lab
}
```

In the sample, the resources deployed on Hyper-V will be prefixed with Studentxx, while each student uses
the VM host name to interact with the machine. Specifying a resource name for the virtual network adapter
in this case would not be necessary, as the default adapter name is equal to the lab name.
File renamed without changes.
13 changes: 13 additions & 0 deletions Help/Wiki/Basic/addazuresubscription.md
@@ -0,0 +1,13 @@
Generally speaking AutomatedLab takes care of everything for you when deploying your labs on Azure. Since additional authentication is required it is possible that you need to login to your Azure account before using AutomatedLab.
AutomatedLab works with Azure Resource Manager, so you can either execute the cmdlet `Connect-AzAccount` before deploying your lab or save your Azure Resource Manager profile.

If you choose to login to your Azure account before a lab deployment your profile is being saved for you to be able to import the lab at a later stage. Since it is possible that your profile expires you might see an error message indicating your profile expiration. In that case, simply login to your Azure account again.

```powershell
New-LabDefinition -Name 'MyLab' -DefaultVirtualizationEngine Azure
# Optional to set e.g. your preferred location
Add-LabAzureSubscription -DefaultLocation 'West Europe'
```

This will enable AutomatedLab to create a lab sources resource group for you as well as a separate resource group for each lab you deploy. Your lab resource group will contain the entire lab deployment and will be removed when you call `Remove-Lab`.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
42 changes: 22 additions & 20 deletions mkdocs.yml
Expand Up @@ -2,16 +2,17 @@ copyright: AutomatedLab is licensed under the <a href='https://github.com/Automa
repo_url: https://github.com/AutomatedLab/AutomatedLab
nav:
- Home: index.md
- Installation: Wiki/install.md
- Installation: Wiki/Basic/install.md
- Getting started:
- First steps: Wiki/gettingstarted.md
- Advanced configuration : Wiki/automatedlabconfig.md
- First steps: Wiki/Basic/gettingstarted.md
- Advanced configuration : Wiki/Advanced/automatedlabconfig.md
- Defining your lab:
- Creating a new lab: Wiki/createnewlab.md
- Networks and IP Addresses: Wiki/networksandaddresses.md
- Adding machines: Wiki/addmachines.md
- Preparing a fully offline environment: Wiki/fullyoffline.md
- Joining lab VMs to existing domain: Wiki/joindomain.md
- Creating a new lab: Wiki/Basic/createnewlab.md
- Networks and IP Addresses: Wiki/Basic/networksandaddresses.md
- Adding machines: Wiki/Basic/addmachines.md
- Preparing a fully offline environment: Wiki/Basic/fullyoffline.md
- Joining lab VMs to existing domain: Wiki/Basic/joindomain.md
- Parallel deployments: Wiki/Advanced/resourcenaming.md
- Roles:
- About roles: Wiki/Roles/roles.md
- ActiveDirectory: Wiki/Roles/activedirectory.md
Expand All @@ -23,20 +24,21 @@ nav:
- SQL Server: Wiki/Roles/sql.md
- DSC Pull Server: Wiki/Roles/dscpull.md
- Lab Builder REST API : Wiki/Roles/restapi.md
- Custom roles: Wiki/customroles.md
- Custom roles: Wiki/Advanced/customroles.md
- Customizing your lab:
- Installing Windows features: Wiki/installwindowsfeatures.md
- Installing software: Wiki/installsoftware.md
- Run remote commands: Wiki/invokelabcommand.md
- Use DSC: Wiki/usedsc.md
- Exchanging data: Wiki/exchangedata.md
- Notification system: Wiki/notifications.md
- Connecting two labs: Wiki/connectlabs.md
- Installing Windows features: Wiki/Basic/installwindowsfeatures.md
- Installing software: Wiki/Basic/installsoftware.md
- Run remote commands: WikiBasic//invokelabcommand.md
- Use DSC: Wiki/Advanced/usedsc.md
- Exchanging data: Wiki/Basic/exchangedata.md
- Notification system: Wiki/Advanced/notifications.md
- Connecting two labs: Wiki/Advanced/connectlabs.md
- Azure labs:
- Adding a subscription: Wiki/addazuresubscription.md
- Synchronise local lab sources: Wiki/synclabsources.md
- Mounting ISO files : Wiki/mountazureisos.md
- Lab telemetry: Wiki/telemetry.md
- Adding a subscription: Wiki/Basic/addazuresubscription.md
- Synchronise local lab sources: Wiki/Basic/synclabsources.md
- Mounting ISO files : Wiki/Basic/mountazureisos.md
- Using the Bastion host: Wiki/Basic/useazurebastion.md
- Lab telemetry: Wiki/About/telemetry.md
- Version history: https://github.com/AutomatedLab/AutomatedLab/blob/master/CHANGELOG.md
- Module help:
- AutomatedLab:
Expand Down

0 comments on commit 4f50087

Please sign in to comment.