Skip to content
main
Go to file
Code

README.md

superwerker - automated best practises for AWS

The 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 is brought to you by AWS Advanced Partners kreuzwerker and superluminar.

Project state / Roadmap

This project is currently under heavy development. We are working towards 1.0 milestone.

There is a Long term roadmap and list of ideas as well. Feel free to comment and add ideas.

Quick install

You can install the current main branch via CloudFormation in the following AWS regions:

Installation Next steps
🇪🇺 eu-west-1 Documentation / next steps
🇪🇺 eu-central-1 Documentation / next steps
🇪🇺 eu-north-1 Documentation / next steps
🇬🇧 eu-west-2 Documentation / next steps
🇨🇦 ca-central-1 Documentation / next steps
🇺🇸 us-east-1 Documentation / next steps
🇺🇸 us-east-2 Documentation / next steps
🇺🇸 us-west-2 Documentation / next steps
🇸🇬 ap-southeast-1 Documentation / next steps
🇦🇺 ap-southeast-2 Documentation / next steps

What's included in the setup?

In the initial release, 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

Say what again? (the non-technical what's included)

AWS provides all the building blocks. superwerker adds the wiring and "how to" so you can start right ahead with a well-architected AWS foundation:

  • Manage multiple AWS accounts and perform access management
  • Sign in to your AWS accounts with your existing login provider (usually your email infrastructure provider, e.g. Office 365 or Google Workspace)
  • Security built-in:
    • Protect superuser ("root") access to your AWS accounts
    • Scanning for best practise violations and active threats against your infrastructure
    • Backups enabled for all database and file systems
  • Billing best practices built-in:
    • Automatic cost control and budget alarms
    • Prevents your from using inappropriate AWS regions
  • Low total cost of ownership: native and maintenance-free AWS service are used (no third-party tooling required)
  • Notification centre: aggregates notifications from several services in a single place
  • Gradual roll-out: features can be enabled/disabled individually
  • Living quickstart dashboard with status overview (which features are active?) and actionable links to e.g. the notification center, or your security findings

Help & Feedback

FAQ

Should I use superwerker?

superwerker is ideal for quickly getting 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.

What does superwerker cost?

superwerker itself is free and open source under an MIT licence. Costs may be incurred by the AWS services you set up. Smaller set-ups and test set-ups cost less than $10/month.

You can find more information about the costs on the detailed pricing pages for the services used, e.g. Control Tower, Security Hub, GuardDuty, AWS Backup

How do I install superwerker?

superwerker uses the proven infrastructure-as-code service AWS CloudFormation for installation. Here installation can be launched with a click.

Can I activate and deactivate the features of superwerker individually?

superwerker features can be activated individually. This enables a gradual roll-out and also facilitates installation into an existing AWS set-up.

How do I receive updates?

We plan to roll-out releases via GitHub releases. The update is then deployed via the current CloudFormation template.

Can I use superwerker for existing AWS set-ups?

superwerker is primarily designed for new AWS set-ups and can be used if AWS Control Tower is available in the respective region or was previously installed. superwerker will then try to set up services including Security Hub and GuardDuty. Depending on whether you already have them, you may need to clear the set-up accordingly beforehand.

Which regions is superwerker available in?

Since superwerker uses AWS Control Tower as a basis, it is available in all regions where Control Tower is supported.

What is the difference compared to Control Tower/Landing Zone?

AWS Control Tower and Landing Zone also use AWS fundamentally, but leave a lot of free scope. Building on AWS Control Tower, superwerker provides further guide rails and facilitates a quick-start with AWS even further.

What is the difference compared to AWS Proton, AWS Amplify or AWS Copilot, for example?

AWS Proton, Amplify, and Copilot are tools for developing workloads. superwerker provides a secure AWS foundation in which these tools can be used.

How can I expand superwerker?

superwerker deliberately offers few parameters for adjustment. It has been designed to coexist with solutions like AWS Control Tower (+ Customizations) or with CloudFormation StackSets. These can be used to customise the AWS set-up.

If I no longer want to use superwerker, will my AWS set-up stop working?

superwerker uses AWS CloudFormation for installation and updates. If the CloudFormation stack is deleted, the superwerker components will also be deleted. This can negatively affect the running AWS set-up.

How does superwerker differ from the Well-Architected Framework?

It’s complementary. You can consider superwerker a “well set-up”. At the same time, the underlying design decisions take into account the pillars of WAF. superwerker pushes the workloads into the Well-Architected direction using certain guardrails.

Do you have access to our AWS account?

No, superwerker runs exclusively in your AWS account and does not communicate with the internet.

Is there a roadmap?

Yes, a roadmap is available on GitHub and you can submit and vote on proposals. To do so, you can open a new GitHub issue or one-up existing feature requests.

What happens if AWS offers features of superwerker itself?

superwerker always aims to build on AWS services and features. If a superwerker feature becomes obsolete because AWS releases it as a service or feature itself, we will adapt superwerker.

Can using superwerker break existing workloads?

Some of the infrastructure that superwerker sets up carries out changes to existing set-ups, for example Control Tower and Service Control Policies, which restrict services and regions. For this reason, we cannot rule out the possibility of impacting existing workloads. We will be happy to help you when evaluating this issue.

Can superwerker also handle network/VPC and workloads?

superwerker is initially specialised in a basic AWS set-up. An extension to best practices in the network and workload area is planned. Please send us feedback/feature requests in our GitHub repository.

Design decisions

Forward compability and adoption

As soon as AWS releases a feature/service which makes parts of superwerker obsolete, we will adopt. In an ideal world this project would not have to exist.

Low total cost of ownership

  • use native AWS services when possible
  • use functionless / managed runtimes when possible
  • whenever the cost of a service or option (e.g. logging to S3 as opposed to logging to CloudWatch Logs) is negligible it will be added without opt-out

Preferred services: CloudFormation, Systems Manager Parameter Store / Automation, Lambda, CodePipeline / Build

Tested code

All features need to have tests. We prefer integration tests which tests the correct end state. This usually results in the use of real AWS APIs for tests and no mocks.

Idempotent and convergent

All code has to be idempotent so we ensure that tasks can be re-run without breaking and without changing the result. All code has to be convergent so we ensure that tasks which have been interrupted formerly can re-run and converge to the final state.

Event-driven

We use CloudWatch Events where possible in order to decouple architecture. We acknowledge this decision makes end-to-end testing harder sometimes.

Thanks

About

Open-source solution to automate the setup of an AWS Cloud environment with prescriptive best practices.

Topics

Resources

License

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  
You can’t perform that action at this time.