Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Overview] Add Gruntwork Production Framework content #107

Merged
merged 21 commits into from
Dec 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _docs-sources/intro/next-steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Grid from "/src/components/Grid"

# Next Steps

Now that your foundational knowledge is in place and your workspace is configured, you’re ready to dive in and learn how to deploy production-grade infrastructure. If you’ve purchased a Gruntwork Reference Architecture, use [this guide](/docs/guides/reference-architecture/overview/overview) to get started. Otherwise, view our [courses](/docs/courses) and [guides](/docs/guides/welcome), or check out the [Service Catalog API reference](/docs/reference/services/intro) to learn what's available.
Now that your foundational knowledge is in place and your workspace is configured, you’re ready to dive in and learn how to deploy production-grade infrastructure. If you’ve purchased a Gruntwork Reference Architecture, use [this guide](/docs/guides/reference-architecture/overview/overview) to get started. Otherwise, view our [courses](/docs/courses) and [guides](/docs/guides/welcome), or check out the [Service Catalog API reference](/docs/reference/services/intro) to learn whats available.

<Grid cols={2}>
<Card
Expand Down
5 changes: 0 additions & 5 deletions _docs-sources/intro/overview/account-baselines.md

This file was deleted.

5 changes: 0 additions & 5 deletions _docs-sources/intro/overview/app-catalog.md

This file was deleted.

5 changes: 0 additions & 5 deletions _docs-sources/intro/overview/auto-updates.md

This file was deleted.

30 changes: 30 additions & 0 deletions _docs-sources/intro/overview/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import Card from "/src/components/Card"
import Grid from "/src/components/Grid"

# Getting started

In this introductory guide we’ll cover the fundamentals you'll need in order to be successful with Gruntwork. After setting up your account to gain access to Gruntwork products, we’ll help you install necessary tools and understand how they fit into the Gruntwork development workflow. Once finished, you’ll have the knowledge required to dive into our [guides](/docs/guides/welcome) and make full use of the IaC Library.

<Grid cols={1}>
<Card
title="1. Gain access to Gruntwork’s products"
href="/docs/intro/dev-portal/create-account"
>
Create an account with our Developer Portal to access the IaC Library and
training courses.
</Card>
<Card
title="2. Set up your environment"
href="/docs/intro/environment-setup/recommended_tools"
>
Prepare your local development environment for efficiently working with the
industry standard DevOps tools.
</Card>
<Card
title="3. Learn the tools of the trade"
href="/docs/intro/tool-fundamentals/docker"
>
Learn how to leverage these tools with Gruntwork products to realize your
infrastructure needs.
</Card>
</Grid>
32 changes: 32 additions & 0 deletions _docs-sources/intro/overview/gruntwork-production-framework.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Gruntwork Production Framework

The Gruntwork Production Framework is our opinionated, step-by-step framework for achieving a world-class DevOps setup. At Gruntwork, we've had the privilege to work with software teams from tiny startups to massive Fortune 50 companies to some of the world's largest government agencies, and this framework captures the common patterns we've seen that actually worked.

This document is a high-level summary of the Gruntwork Production Framework. We will post and link to the full version in the future.

## The ingredients of success

There are a core set of raw primitives your company will need to put in place to achieve a world-class DevOps setup. We consider these the ingredients of success:

1. Service catalog
1. Application catalog
1. CI/CD pipeline
1. Developer self-service

### How Gruntwork helps

The Gruntwork product is designed to help customers implement this framework. For more information, see [how it works](how-it-works).

## Ingredient #1: Service catalog

This is an overloaded term, so let's dive into the details of what we mean by a Service Catalog in this guide.

## Ingredient #2: Application catalog
...

## Ingredient #3: CI/CD pipeline
...

## Ingredient #4: Developer self-service
...

1 change: 1 addition & 0 deletions _docs-sources/intro/overview/gruntwork-vs-other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Grunwork vs. other
54 changes: 54 additions & 0 deletions _docs-sources/intro/overview/how-it-works.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# How it works

## Overview

There are two fundamental ways to engage Gruntwork:

1. **Gruntwork builds your architecture.** We generate the [Reference Architecture](https://gruntwork.io/reference-architecture/) based on your needs, deploy into your AWS accounts, and give you 100% of the code. Since you have all the code, you can extend, enhance, and customize the environment exactly according to your needs. The deploy process takes about one day.
2. **Build it yourself.** The Gruntwork IaC library empowers you to [construct your own bespoke architecture](/docs/guides/build-it-yourself/overview) in record time. By mix-and-matching our modules and services you can quickly define a custom architecture to suit your needs, all with the confidence of having world-class, battle-tested code running under the hood.

## What we provide

The Gruntwork product suite is designed to help you implement a world-class DevOps setup. It includes a combination of products, services, and support.

### Gruntwork IaC Library

A battle-tested, production-grade _catalog_ of infrastructure code that contains the core "building blocks" of infrastructure. It includes everything you’ll need to set up:

- A Multi-account structure
- An infrastrucutre CI/CD Pipeline
- Networking and VPCs
- App orchestration — ECS, EC2, Kubernetes, and more
- Data storage — Aurora, Elasticache, RDS, and more
- Best-practice security baselines
- _and more…_

### Gruntwork Compliance

An optional _catalog extension_ that contains building blocks that implement various compliance standards. Today we support CIS compliance; SOC 2 is coming soon, and we plan on adding additional standards in the future.

### Professional Services

A team of experienced Gruntwork engineers who can help you:

- **Learn Gruntwork.** Pair directly with Gruntwork engineers to understand how Gruntwork products work in depth.
- **Customize Gruntwork.** Pay us to update our product to support the features you need to achieve your use case.

### Support

Gruntwork offers three levels of support:

- **[Community support](/docs/guides/support#get-support).** Get help via a [Gruntwork Community Slack](https://gruntwork-community.slack.com/archives/CHH9Y3Z62) and our [Knowledge Base](https://github.com/gruntwork-io/knowledge-base/discussions).
- **[Paid support](/docs/guides/support#paid-support-tiers).** Get help via email, a private Slack channel, or scheduled Zoom calls, with response times backed by SLAs.

## What you provide

Gruntwork products and services can help you quickly achieve world-class infrastrcuture. However, we aren’t a consulting company. To suceced, you (or your trusted DevOps consultant/contractor) must commit to learning how to leverage our products for your use cases, making any additional customizations, and deploying or migrating your apps and services.

### Learn how to use our products

To work effectively with our products, you’ll need to understand our opinionated stance on DevOps best practices and how to apply it for your purposes. You'll also need to learn how to use the Gruntwork products themselves. Our guides and support remain available to assist you in these endeavors.

### Implement the “last mile”

Gruntwork products strike a balance between opinionatedness and configurability. They’ll get you most of the way to your goal, but you may need to make some customizations to suit your use case. You may also need to adapt your apps and services to run in your new infrastructure. Our [Knowledge Base](https://github.com/gruntwork-io/knowledge-base/discussions) and [Community Slack Channel](https://gruntwork-community.slack.com/archives/CHH9Y3Z62) provide great resources to assist you in this effort.
5 changes: 0 additions & 5 deletions _docs-sources/intro/overview/iac-pipeline.md

This file was deleted.

17 changes: 17 additions & 0 deletions _docs-sources/intro/overview/intro-to-gruntwork.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Introduction to Gruntwork

### What is Gruntwork?

**Gruntwork is a "DevOps accelerator" designed to make it possible to achieve a world-class DevOps setup based completely on infrastructure-as-code in just a few days.**

All Gruntwork products exist within a framework we’ve devised specifically to emphasize DevOps industry best-practices and maximize your team’s efficiency. In the [how it works](how-it-works) section, we’ll cover how Gruntwork can help your team implement your infrastructure using this framework.

Gruntwork works best for teams building new infrastructure ("greenfield"), either from scratch or as part of a migration. However, it can also be used by teams with existing infrastructure ("brownfield") if they have sufficient DevOps experience.

### Supported public clouds

Gruntwork products focus on Amazon Web Services (AWS). Support for other public clouds such as GCP and Azure may be added in the future.

### Gruntwork uses Terraform

All Gruntwork products are built on and fully compatible with [open source Terraform](https://terraform.io). The one exception to this is the [Gruntwork Reference Architecture](https://gruntwork.io/reference-architecture/), which uses [Terragrunt](https://terragrunt.gruntwork.io/) (one of our open source tools) to implement an end-to-end architecture.
5 changes: 0 additions & 5 deletions _docs-sources/intro/overview/self-service.md

This file was deleted.

5 changes: 0 additions & 5 deletions _docs-sources/intro/overview/service-catalog.md

This file was deleted.

1 change: 1 addition & 0 deletions _docs-sources/intro/overview/use-cases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Use cases
5 changes: 0 additions & 5 deletions _docs-sources/intro/overview/world-class-devops.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/intro/next-steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Grid from "/src/components/Grid"

# Next Steps

Now that your foundational knowledge is in place and your workspace is configured, you’re ready to dive in and learn how to deploy production-grade infrastructure. If you’ve purchased a Gruntwork Reference Architecture, use [this guide](/docs/guides/reference-architecture/overview/overview) to get started. Otherwise, view our [courses](/docs/courses) and [guides](/docs/guides/welcome), or check out the [Service Catalog API reference](/docs/reference/services/intro) to learn what's available.
Now that your foundational knowledge is in place and your workspace is configured, you’re ready to dive in and learn how to deploy production-grade infrastructure. If you’ve purchased a Gruntwork Reference Architecture, use [this guide](/docs/guides/reference-architecture/overview/overview) to get started. Otherwise, view our [courses](/docs/courses) and [guides](/docs/guides/welcome), or check out the [Service Catalog API reference](/docs/reference/services/intro) to learn whats available.

<Grid cols={2}>
<Card
Expand All @@ -28,5 +28,5 @@ Now that your foundational knowledge is in place and your workspace is configure


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"3be9fc14f5ea3094b46f510cc85fa921"}
{"sourcePlugin":"Local File Copier","hash":"54def7033a6c3bb2ea9024939d9c315a"}
##DOCS-SOURCER-END -->
10 changes: 0 additions & 10 deletions docs/intro/overview/account-baselines.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/intro/overview/app-catalog.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/intro/overview/auto-updates.md

This file was deleted.

35 changes: 35 additions & 0 deletions docs/intro/overview/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import Card from "/src/components/Card"
import Grid from "/src/components/Grid"

# Getting started

In this introductory guide we’ll cover the fundamentals you'll need in order to be successful with Gruntwork. After setting up your account to gain access to Gruntwork products, we’ll help you install necessary tools and understand how they fit into the Gruntwork development workflow. Once finished, you’ll have the knowledge required to dive into our [guides](/docs/guides/welcome) and make full use of the IaC Library.

<Grid cols={1}>
<Card
title="1. Gain access to Gruntwork’s products"
href="/docs/intro/dev-portal/create-account"
>
Create an account with our Developer Portal to access the IaC Library and
training courses.
</Card>
<Card
title="2. Set up your environment"
href="/docs/intro/environment-setup/recommended_tools"
>
Prepare your local development environment for efficiently working with the
industry standard DevOps tools.
</Card>
<Card
title="3. Learn the tools of the trade"
href="/docs/intro/tool-fundamentals/docker"
>
Learn how to leverage these tools with Gruntwork products to realize your
infrastructure needs.
</Card>
</Grid>


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"18ca9f647d6968d68b1a9cf1f891f5f7"}
##DOCS-SOURCER-END -->
37 changes: 37 additions & 0 deletions docs/intro/overview/gruntwork-production-framework.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Gruntwork Production Framework

The Gruntwork Production Framework is our opinionated, step-by-step framework for achieving a world-class DevOps setup. At Gruntwork, we've had the privilege to work with software teams from tiny startups to massive Fortune 50 companies to some of the world's largest government agencies, and this framework captures the common patterns we've seen that actually worked.

This document is a high-level summary of the Gruntwork Production Framework. We will post and link to the full version in the future.

## The ingredients of success

There are a core set of raw primitives your company will need to put in place to achieve a world-class DevOps setup. We consider these the ingredients of success:

1. Service catalog
1. Application catalog
1. CI/CD pipeline
1. Developer self-service

### How Gruntwork helps

The Gruntwork product is designed to help customers implement this framework. For more information, see [how it works](how-it-works).

## Ingredient #1: Service catalog

This is an overloaded term, so let's dive into the details of what we mean by a Service Catalog in this guide.

## Ingredient #2: Application catalog
...

## Ingredient #3: CI/CD pipeline
...

## Ingredient #4: Developer self-service
...



<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"ebca2e605787776f91971e9c55972a74"}
##DOCS-SOURCER-END -->
6 changes: 6 additions & 0 deletions docs/intro/overview/gruntwork-vs-other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Grunwork vs. other


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"c8aeff437ffbf0d5134c70daf339a109"}
##DOCS-SOURCER-END -->
59 changes: 59 additions & 0 deletions docs/intro/overview/how-it-works.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# How it works

## Overview

There are two fundamental ways to engage Gruntwork:

1. **Gruntwork builds your architecture.** We generate the [Reference Architecture](https://gruntwork.io/reference-architecture/) based on your needs, deploy into your AWS accounts, and give you 100% of the code. Since you have all the code, you can extend, enhance, and customize the environment exactly according to your needs. The deploy process takes about one day.
2. **Build it yourself.** The Gruntwork IaC library empowers you to [construct your own bespoke architecture](/docs/guides/build-it-yourself/overview) in record time. By mix-and-matching our modules and services you can quickly define a custom architecture to suit your needs, all with the confidence of having world-class, battle-tested code running under the hood.

## What we provide

The Gruntwork product suite is designed to help you implement a world-class DevOps setup. It includes a combination of products, services, and support.

### Gruntwork IaC Library

A battle-tested, production-grade _catalog_ of infrastructure code that contains the core "building blocks" of infrastructure. It includes everything you’ll need to set up:

- A Multi-account structure
- An infrastrucutre CI/CD Pipeline
- Networking and VPCs
- App orchestration — ECS, EC2, Kubernetes, and more
- Data storage — Aurora, Elasticache, RDS, and more
- Best-practice security baselines
- _and more…_

### Gruntwork Compliance

An optional _catalog extension_ that contains building blocks that implement various compliance standards. Today we support CIS compliance; SOC 2 is coming soon, and we plan on adding additional standards in the future.

### Professional Services

A team of experienced Gruntwork engineers who can help you:

- **Learn Gruntwork.** Pair directly with Gruntwork engineers to understand how Gruntwork products work in depth.
- **Customize Gruntwork.** Pay us to update our product to support the features you need to achieve your use case.

### Support

Gruntwork offers three levels of support:

- **[Community support](/docs/guides/support#get-support).** Get help via a [Gruntwork Community Slack](https://gruntwork-community.slack.com/archives/CHH9Y3Z62) and our [Knowledge Base](https://github.com/gruntwork-io/knowledge-base/discussions).
- **[Paid support](/docs/guides/support#paid-support-tiers).** Get help via email, a private Slack channel, or scheduled Zoom calls, with response times backed by SLAs.

## What you provide

Gruntwork products and services can help you quickly achieve world-class infrastrcuture. However, we aren’t a consulting company. To suceced, you (or your trusted DevOps consultant/contractor) must commit to learning how to leverage our products for your use cases, making any additional customizations, and deploying or migrating your apps and services.

### Learn how to use our products

To work effectively with our products, you’ll need to understand our opinionated stance on DevOps best practices and how to apply it for your purposes. You'll also need to learn how to use the Gruntwork products themselves. Our guides and support remain available to assist you in these endeavors.

### Implement the “last mile”

Gruntwork products strike a balance between opinionatedness and configurability. They’ll get you most of the way to your goal, but you may need to make some customizations to suit your use case. You may also need to adapt your apps and services to run in your new infrastructure. Our [Knowledge Base](https://github.com/gruntwork-io/knowledge-base/discussions) and [Community Slack Channel](https://gruntwork-community.slack.com/archives/CHH9Y3Z62) provide great resources to assist you in this effort.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"d9fa8619fd1365ab8a3f7b1bd56a14b2"}
##DOCS-SOURCER-END -->
10 changes: 0 additions & 10 deletions docs/intro/overview/iac-pipeline.md

This file was deleted.

Loading