Add VS2017 demo: building containers from Sitecore images #1

Ben-m-s · 2018-03-26T21:30:31Z

Included Changes:

VS2017 Demo with the following features:
- Website folder as volume with files stored in the development machine, at debugging time (no need for synchronization)
- Website folder embedded in the image at runtime.
- Website folder files automatically copied from image to Development environment (if missing) (same as databases).
- Attach to IIS process from VS2017 for debugging

Caveats:

Not documented yet
Requires changes that have just been submitted as pull request with the following features:
- Data folder out of Website folder
- Data folder defined as a volume for persistence and to support license.xml file out of the image
- Data folder is emptied to support becoming a volume
- license.xml file is deleted from the image (along with other content in Data folder)
- Support to make Website folder also a volume (only at debugging time)

…eds to be manually started)

Ben-m-s · 2018-03-26T21:33:49Z

Pull request with dependencies: Sitecore/docker-images#13

jeanfrancoislarente · 2018-03-27T01:02:58Z

Awesome work @Ben-m-s - thanks for the contribution. I've posted something on #docker just to get some input from the Community on how we could structure this repo. Please weigh in there! If any changes are recommended from that discussion you can make a quick refactor and pushÉ

jeanfrancoislarente

You mentioned on Slack that docker-demo/demo would be redundant. I'm not sure if you noticed - you have VS2017/Website/Website.
Any chance we can rename the first Website to be ExampleWebsite or some solution name that might be more relevant?
Not critical, just a thought.

jeanfrancoislarente

I think it would be ok for .gitattributes and .gitignore to be at the root of the repo

jeanfrancoislarente · 2018-03-27T12:48:04Z

sitecore/9.0.1 rev. 171219 XM1/VS2017/Website/.gitignore

@@ -0,0 +1,271 @@
+## Ignore Visual Studio temporary files, build results, and


Can put at the root of the repo

Did you consider governance? This repository will end up having different projects with different technologies. File types and folders to be ignored may be different among them. Also, you may want to grant permissions to collaborators based on the demos/technologies to review/approve. Keeping the ".gitignore" and the ".gitattributes" local to projects provides easier governance and less dependencies interactions among projects. For instance, this demo is ignoring a whole folder named "storage", this may not be wanted in other project made by somebody else. Happy to change it if you still prefer it. :-)

Sorry, I'm confused. Shall I do the changes? or, will the change request be removed?

No, leave as-is. I agree with you to leave it.

Ben-m-s · 2018-03-27T13:16:19Z

I do agree about the redundancy and am happy to change it into something that provides more value. The demo is to showcase how to create a Sitecore project with VS2017. Using Demo, Example, Sample, VS2017, Site or Website is redundant as well.

As it is a project without actual .NET code, what if We call it "Seed" or "Scaffolding"? Other ideas?

Ben-m-s · 2018-03-27T20:44:26Z

Some documentation has been added.

sshushliapin · 2018-03-28T08:57:57Z

sitecore/9.0.1 rev. 171219 XM1/VS2017/Website/README.md

+
+## Development Environment Setup
+
+1. Clone [this repository](https://github.com/Ben-m-s/docker-demo) into a folder such as �c:\Docker\Sitecore\docker-demo� (next steps will asume this folder has been used):


Shouldn't it be https://github.com/Sitecore/docker-demo instead of https://github.com/Ben-m-s/docker-demo?

Sure. It should. The same way that all paths will need to change in order to accommodate naming changes being currently discussed in Slack. I used that temporary URL in order to facilitate the testing before the pull takes place.

Thanks for flagging it up. It will work as a reminder.

Please let me know whether is better to change it already.

Agreed - If it's a PR to Sitecore/docker-demo but the README points to Ben-m-s/docker-demo I'd say it should be changed before getting merged

The URL has been updated in the README file. :-)

jeanfrancoislarente · 2018-03-28T13:37:11Z

sitecore/9.0.1 rev. 171219 XM1/VS2017/Website/Website/Website.csproj

+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="Global.asax" />
+    <Content Include="Web.config" />


I think having Web.config as content will overwrite Sitecore's web.config. Should mark this as "None" and generate transform files if necessary.

Not sure whether I understand the requirement. This sample is showcasing a Sitecore concrete project. All projects (Sitecore sites), as far as I know, need to modify their Web.config file. A typical example is using while developing and something else in a production release.

It is also typical to use standard VS transform files such as "Web.Debug.config" for those transformations, as it is done in this project (setting the "Web.config" file as content). With this settings, the Web.config in the container is overwritten with the transformed version generated by the project.

Can you please elaborate a bit more about what change should be done?

I was just thinking of the "Habitat way" where you don't deploy the Web.config file but apply transforms using gulp. Helps during upgrades and prevents overwriting of Sitecore-specific web.config items. I'm not sure what it would mean when deploying to containers.

If you look at Habitat Website Project the web project has the web.config set to None.

<None Include="web.config" /> <None Include="web.Debug.config"> <DependentUpon>web.config</DependentUpon> </None> <None Include="web.Release.config"> <DependentUpon>web.config</DependentUpon> </None>

Then in the Habitat project, the gulpfile takes care of applying all of the transforms required by the various projects:

gulp.task("04-Apply-Xml-Transform")

Since this sample project is specific to one version of Sitecore it's probably okay to leave it like that, keep in mind that your web.config will overwrite the installed web.config and any Sitecore-specific items will be lost if not also included in your project's web.config.

I see your point now. It is actually a good idea.

This sample is meant to be simple. I wanted to use the bare minimum infrastructure to integrate Docker in VS2017 which is the main development environment for Sitecore at the moment (at least the one we use in ClearPeople, where I work). The intention is showcasing the bare minimum required to run Sitecore in a container.

I am thinking of a new demo including a TDS sample project and gulp with some automation such as automatically updating the "host" file in de development environment in order to access the Sitecore site through its URL (instead of the IP). Once we have gulp, the web.config transform can be easily included.

Other samples may include installation of modules such as SXA or EXM, or other proposals from the community that we find interesting.

May I suggest that these ideas are added to the list of "Issues/enhancements"?

Anyway, the progress will depend on time availability, which is not guaranteed, so let's progress bit by bit.

Ben-m-s · 2018-03-28T20:58:23Z

The folder structure and the solution name, along with its associated references in the README file have been updated following discussions in Slack.

Ben-m-s added 2 commits March 25, 2018 20:44

Initial solution with a default Sitecore running (known issue: IIS ne…

91f224f

…eds to be manually started)

Add support to work with local Website folder at debug time

3adb869

Ben-m-s mentioned this pull request Mar 26, 2018

Data folder (and license.xml) as volume among other Sitecore/docker-images#13

Merged

bmoles added 4 commits March 27, 2018 11:09

Add initial README draft (not finished)

fa2786f

Change folder structure as agreed in Slack

19f6cd4

Merge branch 'master' into documentation

7be55f3

Relocate README.md file where it should be

fdd963d

jeanfrancoislarente reviewed Mar 27, 2018

View reviewed changes

jeanfrancoislarente requested changes Mar 27, 2018

View reviewed changes

Finish, by now, the documentation

20c0909

sshushliapin reviewed Mar 28, 2018

View reviewed changes

jeanfrancoislarente reviewed Mar 28, 2018

View reviewed changes

Ben-m-s added 2 commits March 28, 2018 17:07

Change repository URL in README.md file

de2cb53

Rename solution's folder and *.sln file as agreed in Slack

1dd102e

jeanfrancoislarente approved these changes Mar 29, 2018

View reviewed changes

jeanfrancoislarente merged commit d945294 into Sitecore:master Mar 29, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add VS2017 demo: building containers from Sitecore images #1

Add VS2017 demo: building containers from Sitecore images #1

Ben-m-s commented Mar 26, 2018

Ben-m-s commented Mar 26, 2018

jeanfrancoislarente commented Mar 27, 2018

jeanfrancoislarente left a comment

jeanfrancoislarente left a comment

jeanfrancoislarente Mar 27, 2018

Ben-m-s Mar 27, 2018

jeanfrancoislarente Mar 27, 2018

Ben-m-s Mar 28, 2018

jeanfrancoislarente Mar 28, 2018

Ben-m-s commented Mar 27, 2018

Ben-m-s commented Mar 27, 2018

sshushliapin Mar 28, 2018 •

edited

Loading

Ben-m-s Mar 28, 2018

jeanfrancoislarente Mar 28, 2018

Ben-m-s Mar 28, 2018 •

edited

Loading

jeanfrancoislarente Mar 28, 2018

Ben-m-s Mar 28, 2018

jeanfrancoislarente Mar 28, 2018

Ben-m-s Mar 28, 2018

Ben-m-s commented Mar 28, 2018

		@@ -0,0 +1,271 @@
		## Ignore Visual Studio temporary files, build results, and


		## Development Environment Setup

		1. Clone [this repository](https://github.com/Ben-m-s/docker-demo) into a folder such as �c:\Docker\Sitecore\docker-demo� (next steps will asume this folder has been used):

Add VS2017 demo: building containers from Sitecore images #1

Add VS2017 demo: building containers from Sitecore images #1

Conversation

Ben-m-s commented Mar 26, 2018

Ben-m-s commented Mar 26, 2018

jeanfrancoislarente commented Mar 27, 2018

jeanfrancoislarente left a comment

Choose a reason for hiding this comment

jeanfrancoislarente left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ben-m-s commented Mar 27, 2018

Ben-m-s commented Mar 27, 2018

sshushliapin Mar 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ben-m-s Mar 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ben-m-s commented Mar 28, 2018

sshushliapin Mar 28, 2018 •

edited

Loading

Ben-m-s Mar 28, 2018 •

edited

Loading