Merge pull request #140 from superwerker/copy-files-from-quickstart

Copy files from quickstart

.gitignore

@@ -1,2 +1,5 @@
+.taskcat/*
+docs/index.html
 .DS_Store
-__pycache__
+__pycache__
+tmp

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/boilerplate"]
+	path = docs/boilerplate
+	url = https://github.com/aws-quickstart/quickstart-documentation-base-common.git

docs/generated/parameters/index.adoc

@@ -0,0 +1 @@
+// placeholder

docs/generated/regions/index.adoc

@@ -0,0 +1 @@
+// placeholder

docs/generated/services/index.adoc

@@ -0,0 +1 @@
+// placeholder

docs/generated/services/metadata.adoc

@@ -0,0 +1 @@
+// placeholder

docs/partner_editable/_settings.adoc

@@ -0,0 +1,27 @@
+// Change the following attributes.
+:quickstart-project-name: quickstart-superwerker
+:partner-product-name: superwerker
+// For the following attribute, if you have no short name, enter the same name as partner-product-name.
+:partner-product-short-name: superwerker
+// If there's no partner, comment partner-company-name and partner-contributors.
+:partner-company-name: link:https://kreuzwerker.de[kreuzwerker GmbH] & link:https://superluminar.io[superluminar GmbH]
+:doc-month: January
+:doc-year: 2021
+// For the following two "contributor" attributes, if the partner agrees to include names in the byline, 
+// enter names for both partner-contributors and quickstart-contributors. 
+// If partner doesn't want to include names, delete all placeholder names and keep only  
+// "{partner-company-name}" and "AWS Quick Start team." 
+// Use the comma before "and" only when three or more names.
+:partner-contributors: Joern Barthel, Sönke Ruempler, and Sebastian Müller, {partner-company-name}
+:quickstart-contributors: AWS Quick Start team
+// For deployment_time, use minutes if deployment takes an hour or less, 
+// for example, 30 minutes or 60 minutes. 
+// Use hours for deployment times greater than 60 minutes (rounded to a quarter hour),
+// for example, 1.25 hours, 2 hours, 2.5 hours.
+:deployment_time: 1.5 hours
+:default_deployment_region: eu-central-1
+:parameters_as_appendix:
+// Uncomment the following two attributes if you are using an AWS Marketplace listing.
+// Additional content will be generated automatically based on these attributes.
+// :marketplace_subscription:
+// :marketplace_listing_url: https://example.com/

docs/partner_editable/additional_info.adoc

@@ -0,0 +1,7 @@
+// Add steps as necessary for accessing the software, post-configuration, and testing. Don’t include full usage instructions for your software, but add links to your product documentation for that information.
+//Should any sections not be applicable, remove them
+
+== Other useful information
+
+{partner-product-name} is a living project. The development team documents their link:https://github.com/superwerker/superwerker/tree/main/docs/adrs[architectural decisions (ADR) in the Github repository]
+The ADRs and the link:https://github.com/superwerker/superwerker/issues[Github issues] also the best place to follow future development directions on a high level without looking at the actual source code.

docs/partner_editable/architecture.adoc

@@ -0,0 +1,22 @@
+Deploying this Quick Start builds the following {partner-product-short-name} environment in the
+AWS Cloud.
+
+// Replace this example diagram with your own. Send us your source PowerPoint file. Be sure to follow our guidelines here : http://(we should include these points on our contributors giude)
+:xrefstyle: short
+[#architecture1]
+.Quick Start architecture for {partner-product-short-name} on AWS
+image::../images/architecture_diagram.svg[Architecture,width=100%,height=100%]
+
+As shown in <<architecture1>>, the Quick Start configures the following AWS services and features in a fully automated way:
+
+- AWS Control Tower and AWS Single Sign-On as the basis for a future-proof multi-account setup
+- Amazon GuardDuty for automatic detection of possible threats breaches
+- AWS Security Hub to ensure established security standards
+- AWS Backup for automated creation of backups
+- Budget alarm for cost control
+- Service control policies to protect the infrastructure from intentional or unintentional mistakes, e.g. deny use of non allowed AWS regions, deletion of backup copies, deactivation of security features
+- AWS Systems Manager OpsCenter/Items notification aggregation and incident response handling
+- Secure mailboxes and service catalogue aliases for all root accounts
+- A CloudWatch dashboard with more information and deep-links to resources, e.g. setting up SSO with existing identity providers, GuardDuty/Security Hub dashboards, AWS account setup
+
+Feature flippers can be used to gradually opt into functionality.

docs/partner_editable/deploy_steps.adoc

@@ -0,0 +1,44 @@
+// We need to work around Step numbers here if we are going to potentially exclude the AMI subscription
+=== Sign in to your AWS Management account
+
+. Sign in to your AWS Management account at https://aws.amazon.com with an IAM user role that has the necessary permissions. For details, see link:#_planning_the_deployment[Planning the deployment] earlier in this guide.
+. Make sure that your AWS account is configured correctly, as discussed in the link:#_technical_requirements[Technical requirements] section.
+
+// Optional based on Marketplace listing. Not to be edited
+ifdef::marketplace_subscription[]
+=== Subscribe to the {partner-product-short-name} AMI
+
+This Quick Start requires a subscription to the AMI for {partner-product-short-name} in AWS Marketplace.
+
+. Sign in to your AWS account.
+. Open the page for the {marketplace_listing_url}[{partner-product-short-name} AMI in AWS Marketplace^], and then choose *Continue to Subscribe*.
+. Review the terms and conditions for software usage, and then choose *Accept Terms*. +
+  A confirmation page loads, and an email confirmation is sent to the account owner. For detailed subscription instructions, see the https://aws.amazon.com/marketplace/help/200799470[AWS Marketplace documentation^].
+
+. When the subscription process is complete, exit out of AWS Marketplace without further action. *Do not* provision the software from AWS Marketplace—the Quick Start deploys the AMI for you.
+endif::marketplace_subscription[]
+// \Not to be edited
+
+=== Launch the Quick Start
+// Adapt the following warning to your Quick Start.
+This Quick Start is intended to be installed into an empty, freshly created AWS account which is not a member of an AWS Organization.
+
+Each deployment takes about {deployment_time} to complete.
+
+TIP: As soon as step 7 has started, a living documentation will be deployed. Please go to link:https://console.aws.amazon.com/cloudwatch/home#dashboards:name=superwerker[the living documentation], and follow the instructions to finish the deployment.
+
+. Sign in to your AWS account, and choose one of the following options to launch the AWS CloudFormation template. For help with choosing an option, see link:#_deployment_options[Deployment options] earlier in this guide.
+
+[cols="3,1"]
+|===
+^|http://qs_launch_permalink[Deploy {partner-product-short-name}^]
+^|http://qs_template_permalink[View template^]
+
+|===
+
+[start=2]
+. Check the AWS Region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This Region is where the infrastructure for {partner-product-short-name} is built. The template is launched in the {default_deployment_region} Region by default. For other choices, see link:#_supported_regions[Supported Regions] earlier in this guide.
+
+[start=3]
+. On the *Create stack* page, keep the default setting for the template URL, and then choose *Next*.
+. On the *Specify stack details* page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. For details on each parameter, see the link:#_parameter_reference[Parameter reference] section of this guide. When you finish reviewing and customizing the parameters, choose *Next*.

docs/partner_editable/deployment_options.adoc

@@ -0,0 +1,6 @@
+// Edit this placeholder text to accurately describe your architecture.
+
+This Quick Start provides two deployment options:
+
+* Deploy {partner-product-short-name} at once: All features are enabled by default and will be installed.
+* Deploy {partner-product-short-name} iteratively with feature flippers: recommended if you only want to use certain features or you want to test the impact of particular features.

docs/partner_editable/faq_troubleshooting.adoc

@@ -0,0 +1,18 @@
+// Add any tips or answers to anticipated questions.
+
+== FAQ
+
+*Q.* I encountered a *CREATE_FAILED* error when I launched the Quick Start.
+
+*A.* If AWS CloudFormation fails to create the stack, relaunch the template with *Rollback on failure* set to *Disabled*. This setting is under *Advanced* in the AWS CloudFormation console on the *Configure stack options* page. With this setting, the stack’s state is retained.
+
+WARNING: When you set *Rollback on failure* to *Disabled*, you continue to incur AWS charges for this stack. Delete the stack when you finish troubleshooting.
+
+For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html[Troubleshooting AWS CloudFormation^].
+
+== Troubleshooting
+
+To get help:
+
+- Join our link:https://groups.google.com/forum/#!forum/superwerker/join[mailing list]
+- Chat with us on the link:https://og-aws.slack.com/archives/C01CQ34TC93[#superwerker] channel in the OG-AWS Slack (link:http://slackhatesthe.cloud/[invite link]).

docs/partner_editable/licenses.adoc

@@ -0,0 +1,12 @@
+// Include details about any licenses and how to sign up. Provide links as appropriate. If no licenses are required, clarify that. The following paragraphs provide examples of details you can provide. Remove italics, and rephrase as appropriate.
+
+MIT License
+
+Copyright (c) 2021 superwerker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

docs/partner_editable/overview_target_and_usage.adoc

@@ -0,0 +1,12 @@
+// Replace the content in <>
+// Identify your target audience and explain how/why they would use this Quick Start.
+//Avoid borrowing text from third-party websites (copying text from AWS service documentation is fine). Also, avoid marketing-speak, focusing instead on the technical aspect.
+
+This guide provides instructions for deploying the {partner-product-short-name} Quick Start reference architecture on the AWS Cloud.
+
+This Quick Start is for users who want to quickly get started with the AWS Cloud with preconceived decisions based on years of experience. Start-ups and small to medium-sized companies, where time-to-market and financial aspects play an especially important role, can benefit in particular.
+
+As a rule of thumb: if you have no dedicated AWS team or cloud centre of excellence in-house, you should use superwerker.
+
+But also large companies can use superwerker as a basis. Since superwerker is open source, it can also be tailored to individual needs.
+

docs/partner_editable/pre-reqs.adoc

@@ -0,0 +1,11 @@
+// If no preperation is required, remove all content from here
+
+==== Prepare your AWS account
+
+You need to be signed in as an administrator (IAM User or Role with `AdministratorAccess` policy attached, or the AWS root user) into an AWS Account. This account must not be a member of an AWS Organization.
+
+==== Prepare for the deployment
+
+The superwerker quickstart works best with a dedicated DNS subdomain, so it can handle email inboxes of created AWS sub-accounts securely.
+
+You will be asked to provide a domain (e.g. `mycompany.com`) and subdomain (e.g. `aws`) for a DNS zone which superwerker creates. You can choose those freely. The installation will provide you with `NS` entries for this newly created DNS zone. You have to create an `NS` entry within your DNS provider so that the DNS zone is delegated (these records will be made available at a later point in the so called "living documentation"). The superwerker installation will wait until the delegation is properly configured.

docs/partner_editable/product_description.adoc

@@ -0,0 +1,18 @@
+// Replace the content in <>
+// Briefly describe the software. Use consistent and clear branding. 
+// Include the benefits of using the software on AWS, and provide details on usage scenarios.
+
+The link:https://superwerker.cloud[superwerker] open source solution automates the setup of an AWS Cloud environment with prescriptive best practises. It enables startups and SMBs to focus on their core business - by saving setup and maintenance time and money.
+
+superwerker configures the following AWS services and features in a fully automated way:
+
+- AWS Control Tower and AWS Single Sign-On as the basis for a future-proof multi-account setup
+- Amazon GuardDuty for automatic detection of possible threats breaches
+- AWS Security Hub to ensure established security standards
+- AWS Backup for automated creation of backups
+- Budget alarms for cost control
+- Service control policies to protect the infrastructure from intentional or unintentional mistakes, e.g. deny use of non allowed AWS regions, deletion of backup copies, deactivation of security features
+- AWS Systems Manager OpsCenter/Items notification aggregation and incident response handling
+- Secure mailboxes and service catalogue aliases for all root accounts
+- Feature flippers to gradually opt into functionality
+- A dashboard with more information and deep-links to resources, e.g. setting up SSO with existing identity providers, GuardDuty/Security Hub dashboards, AWS account setup

docs/partner_editable/regions.adoc

@@ -0,0 +1,14 @@
+This Quick Start supports the following Regions:
+
+- eu-west-1, Europe (Ireland)
+- eu-central-1, Europe (Frankfurt)
+- eu-north-1, Europe (Stockholm)
+- eu-west-2, Europe (London)
+- ca-central-1, Canada (Central)
+- us-east-1, US East (N. Virginia)
+- us-east-2, US East (Ohio)
+- us-west-2, US West (Oregon)
+- ap-southeast-1, Asia Pacific (Tokyo)
+- ap-southeast-2, Asia Pacific (Sydney)
+
+//Full list: https://docs.aws.amazon.com/general/latest/gr/rande.html

docs/partner_editable/service_limits.adoc

@@ -0,0 +1,11 @@
+// Replace the <n> in each row to specify the number of resources used in this deployment. Remove the rows for resources that aren’t used.
+|===
+|Resource |This deployment creates
+
+// Space needed to maintain table headers
+|CloudWatch alarms |2
+|Budgets reports |1
+|Config rules |3
+|S3 buckets |3
+|Route 53 hosted zones |1 
+|===

docs/partner_editable/specialized_knowledge.adoc

@@ -0,0 +1,6 @@
+// Replace the content in <>
+// For example: “familiarity with basic concepts in networking, database operations, and data encryption” or “familiarity with <software>.”
+// Include links if helpful. 
+// You don't need to list AWS services or point to general info about AWS; the boilerplate already covers this.
+
+This Quick Start also assumes familiarity with configuring DNS.

scripts/quickstart.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+CWD=$(cd `dirname $0` && pwd)
+TMP=$CWD/../tmp
+
+rm -rf $TMP
+mkdir -p $TMP
+cd $TMP
+
+git clone git@github.com:superwerker/quickstart-superwerker.git . 
+git checkout develop
+git pull origin develop
+
+BRANCH_NAME=update-$(date +'%Y-%m-%dT%H-%M-%S')
+
+git checkout -b $BRANCH_NAME
+
+rsync -avr \
+    --exclude='.git' \
+    --exclude='.github' \
+    --exclude='.releaserc' \
+    --exclude='package.json' \
+    --exclude='pull_request_template.md' \
+    --exclude="scripts" \
+    --exclude="tests" \
+    --exclude='tmp' \
+    ../ .
+
+echo "Use https://github.com/superwerker/superwerker for Pull Requests!" > pull_request_template.md
+echo "Use https://github.com/superwerker/superwerker for Issues!" > issue_template.md
+
+git add .
+
+git commit -m 'Synced files from https://github.com/superwerker/superwerker'
+
+git push origin $BRANCH_NAME