Merge pull request #3 from xoap-io/dev

fix: adjusted readme, renamed quickstart resource
xoap-io · Oct 23, 2023 · 9cdb8da · 9cdb8da
2 parents c536bcb + d9c320f
commit 9cdb8da
Show file tree

Hide file tree

Showing 10 changed files with 5 additions and 461 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/DSCResources/Services/Services.psd1 b/DSCResources/Services/Services.psd1
diff --git a/DSCResources/Services/Services.schema.psm1 b/DSCResources/Services/Services.schema.psm1
diff --git a/...uration/XOAP_QuickStartConfiguration.psd1 → ...tion/XOAP_RDSQuickStartConfiguration.psd1 b/...uration/XOAP_QuickStartConfiguration.psd1 → ...tion/XOAP_RDSQuickStartConfiguration.psd1
@@ -1,5 +1,5 @@
 #
-# Module manifest for module 'XOAP_QuickStartConfiguration'
+# Module manifest for module 'XOAP_RDSQuickStartConfiguration'
 #
 # Generated by: XOAP.io
 #
@@ -9,7 +9,7 @@
 @{
 
 # Script module or binary module file associated with this manifest.
-RootModule = 'XOAP_QuickStartConfiguration.schema.psm1'
+RootModule = 'XOAP_RDSQuickStartConfiguration.schema.psm1'
 
 # Version number of this module.
 ModuleVersion = '0.0.1'

diff --git a/.../XOAP_QuickStartConfiguration.schema.psm1 → ...AP_RDSQuickStartConfiguration.schema.psm1 b/.../XOAP_QuickStartConfiguration.schema.psm1 → ...AP_RDSQuickStartConfiguration.schema.psm1
@@ -1,4 +1,4 @@
-Configuration 'XOAP_QuickStartConfiguration'
+Configuration 'XOAP_RDSQuickStartConfiguration'
 {
     Import-DSCResource -ModuleName 'PSDesiredStateConfiguration'
     Import-DscResource -ModuleName 'xRemoteDesktopSessionHost' -ModuleVersion '2.1.0'

diff --git a/Examples/Resources/_dummy b/Examples/Resources/_dummy
diff --git a/Examples/XOAPModuleTemplateDSC.ps1 b/Examples/XOAPModuleTemplateDSC.ps1
diff --git a/Examples/XOAPRemoteDesktopServicesDSC.ps1 b/Examples/XOAPRemoteDesktopServicesDSC.ps1
@@ -1,6 +1,6 @@
 Configuration 'XOAPRemoteDesktopServicesDSC'
 {
-	Import-DSCResource -Module 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_QuickStartConfiguration' -ModuleVersion '0.0.1'
+	Import-DSCResource -Module 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_RDSQuickStartConfiguration' -ModuleVersion '0.0.1'
 
     param
         (
@@ -11,7 +11,7 @@ Configuration 'XOAPRemoteDesktopServicesDSC'
 
 	Node 'XOAPRemoteDesktopServicesDSC'
 	{
-        XOAP_QuickConfiguration 'Example'
+        XOAP_RDSQuickStartConfiguration 'Example'
             {
                 ConnectionBrokerServerName = $ConnectionBrokerServerName
                 SessionHostServerName = $$SessionHostServerName

diff --git a/Readme.md b/Readme.md
@@ -394,101 +394,3 @@ Configuration 'XOAPRemoteDesktopServicesDSC'
 }
 XOAPRemoteDesktopServicesDSC -OutputPath 'C:\XOAPRemoteDesktopServicesDSC'
 ```
-## Quick deployment with XOAP and config.XO
-
-For a basic installation, you need a minimum of two Windows Server 2016 nodes. One node will be the RD Connection Broker, and the other node will be the RD Session Host.
-Additionally, you need to open the following ports on your nodes to our backend API at https://api.xoap.io.
-
-### Create new parameter for your domain user with admin rights on the nodes
-
-Go to Configuration Management --> Parameters-->
-
-Add Parameter and fill in required information. 
-
-![1.png](docs%2Fimg%2F1.png)
-
-### Adjust existing configuration with your values
-
-Go to Configuration Management --> Configurations --> 
-
-Find **XOAP_RDS_Infrastructure** configuration.
-
-![2.png](docs%2Fimg%2F2.png)
-
-Click on the action menu--> Click **Edit**
-
-![3.png](docs%2Fimg%2F3.png)
-
-Set PsDscRunAsCredential parameter --> From the drop-down menu select your previously created user.
-
-Set ConnectionBrokerServerName --> FQDN of the server which will be connection broker.
-
-Set SessionHostServerName--> FQDN of the server which will be session host.
-
-Set AllowedUserGroup--> Active Directory name of the group of users which will have access to the published applications.
-
-![4.png](docs%2Fimg%2F4.png)
-
-## Register Nodes
-
-Download the registration script for the infrastructure node:
-
-![5.png](docs%2Fimg%2F5.png)
-
-Run the script on your infrastructure node.
-
-> Be sure to run the script as administrator in PowerShell 5.1
-
-Download the registration script for the session host node:
-
-![6.png](docs%2Fimg%2F6.png)
-
-> Be sure to run the script as administrator in PowerShell 5.1
-
-After a few minutes, your nodes should show up as compliant in XOAP.
-
-A full list of changes in each version can be found in the [Releases](https://github.com/xoap-io/XOAPRemoteDesktopServicesDSC/releases).
-
-## Documentation
-
-This script is used to easily create new DSC modules and resources.
-
-## Prerequisites
-
-Please install Plaster first and make sure it's present.
-
-```powershell
-Install-Module Plaster
-Import-Module Plaster
-```
-
-## Create new DSC modules
-
-Modules will be automatically created once you are creating a new DSC resource.
-
-## Create new DSC resources
-
-DSC resources can easily be deployed via the invocation of
-
-```powershell
-.\New-CompositeResource.ps1
-```
-
-with parameters
-
-```powershell
-.\New-CompositeResource.ps1 -Module XOAPModuleTemplateDSC -Version 0.0.1 -Resource ScheduledTasks
-```
-
-The parameter list is as followed:
-
-| Parameter | Description                            | Note |
-|-----------|----------------------------------------|------|
-| Module    | Name of the outer module part          | -    |
-| Version   | Target version of the module           | -    |
-| Ressource | The name of the ressource /config part | -    |
-
-### Examples
-
-You can review the [Examples](/Examples/Resources) directory in the **XOAPModuleTemplateDSC** module
-for some general use scenarios for all the resources that are in the module.