From 47332353b39051f9d55f99318875c549668190ed Mon Sep 17 00:00:00 2001 From: Nik Charlebois Date: Wed, 31 Oct 2018 15:52:47 -0400 Subject: [PATCH 1/4] Initial Draft --- ...NNN-Extract DSC from Existing Environments | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 1-Draft/RFCNNNN-Extract DSC from Existing Environments diff --git a/1-Draft/RFCNNNN-Extract DSC from Existing Environments b/1-Draft/RFCNNNN-Extract DSC from Existing Environments new file mode 100644 index 00000000..205992ff --- /dev/null +++ b/1-Draft/RFCNNNN-Extract DSC from Existing Environments @@ -0,0 +1,28 @@ +-- +RFC: RFC00xx +Author: Nik Charlebois +--- + +# Reverse Engineering Existing Environment into DSC + +Users have been complaining about the learning curve to get started with DSC and about the amount of work it takes for them to re-write their existing technology investment onto DSC for monitoring purposes. There have been various community projects to solve this issue by extracting DSC configurations out of existing environments, such as ReverseDSC, which had incredible success with clients wanting to adopt Configuration as Code practices within their organizations. + +The purpose of this RFC is to propose that a fourth method that would retrieve all instances of a resource against an existing environment be included in DSC resources for them to be identified as HQRM. + +# Motivation + +* Reduce amount of work required to on-board existing environments onto DSC +* Reduce learning curve to get started with DSC +* Provide an automated path to migrate on-premises environments onto Azure +* Allow users to easily document their environment’s configuration as code +* Quickly compare configuration deltas between two environments + +# Specifications + +There are three components to the requested solution: +* Component 1 needs to iterate through all instances of the current resource and provide the Get-TargetResource function the key parameters for it to be able to retrieve all other parameters associated with this resource instance. +* Component 2 needs to retrieve the Hash tables received back from the Get-TargetResource and convert them into a DSC string. This is already automated and handled by the existing ReverseDSC Core module https://github.com/microsoft/reversedsc +* Component 3 needs to orchestrate the calls to the resources’ Component 1 and 2 and collect the results into a resulting file, which will be a DSC script that can be used to replicate the environment. + +The vision is as follow: +Component 1 and 2 would be combined into a new fourth function required by every HQRM, call it Export-TargetResource. Component 3 would be a global utility module, contained within the DSC module, which would orchestrate all the calls to the module’s Export-TargetResource methods (see SharePointDSC.Reverse at https://github.com/microsoft/sharepointdsc.reverse for a reference) From 217b58c2ab6228c5d35d2930e23b7e13e4fd1da1 Mon Sep 17 00:00:00 2001 From: Nik Charlebois Date: Wed, 31 Oct 2018 15:55:26 -0400 Subject: [PATCH 2/4] Moved to Draft_Accepted --- .../RFCNNNN-Extract DSC from Existing Environments | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {1-Draft => 2-Draft-Accepted}/RFCNNNN-Extract DSC from Existing Environments (100%) diff --git a/1-Draft/RFCNNNN-Extract DSC from Existing Environments b/2-Draft-Accepted/RFCNNNN-Extract DSC from Existing Environments similarity index 100% rename from 1-Draft/RFCNNNN-Extract DSC from Existing Environments rename to 2-Draft-Accepted/RFCNNNN-Extract DSC from Existing Environments From f2f18066820e0ffcc71515a29878003ade340560 Mon Sep 17 00:00:00 2001 From: Nik Charlebois Date: Wed, 31 Oct 2018 15:58:48 -0400 Subject: [PATCH 3/4] Moved back to Draft...I guess The RFC instructions are saying to put it in Draft_Accepted.....but that seems wrong --- .../RFCNNNN-Extract DSC from Existing Environments | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {2-Draft-Accepted => 1-Draft}/RFCNNNN-Extract DSC from Existing Environments (100%) diff --git a/2-Draft-Accepted/RFCNNNN-Extract DSC from Existing Environments b/1-Draft/RFCNNNN-Extract DSC from Existing Environments similarity index 100% rename from 2-Draft-Accepted/RFCNNNN-Extract DSC from Existing Environments rename to 1-Draft/RFCNNNN-Extract DSC from Existing Environments From 30d37dd21d52390e7daca9f7b9a070ebf5426c10 Mon Sep 17 00:00:00 2001 From: Nik Charlebois Date: Thu, 1 Nov 2018 13:46:39 -0400 Subject: [PATCH 4/4] Updated Template --- .../RFCNNNN-Extract DSC from Existing Environments | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/1-Draft/RFCNNNN-Extract DSC from Existing Environments b/1-Draft/RFCNNNN-Extract DSC from Existing Environments index 205992ff..df0832c6 100644 --- a/1-Draft/RFCNNNN-Extract DSC from Existing Environments +++ b/1-Draft/RFCNNNN-Extract DSC from Existing Environments @@ -1,6 +1,13 @@ --- +-- RFC: RFC00xx Author: Nik Charlebois +Status: Draft +SupercededBy: N/A +Version: 0.0 +Area: DSC +Comments Due: December 1st +Plan to implement: Yes + --- # Reverse Engineering Existing Environment into DSC @@ -26,3 +33,7 @@ There are three components to the requested solution: The vision is as follow: Component 1 and 2 would be combined into a new fourth function required by every HQRM, call it Export-TargetResource. Component 3 would be a global utility module, contained within the DSC module, which would orchestrate all the calls to the module’s Export-TargetResource methods (see SharePointDSC.Reverse at https://github.com/microsoft/sharepointdsc.reverse for a reference) + +## Alternate Proposals and Considerations + +N/A \ No newline at end of file