Skip to content

Commit e42f236

Browse files
authored
Temporarily hide the cicd pipeline guide (#661)
* chore: temporarily hide the cicd pipeline guide
1 parent 6a52694 commit e42f236

File tree

3 files changed

+6
-191
lines changed

3 files changed

+6
-191
lines changed

_docs-sources/guides/build-it-yourself/pipelines/index.md

Lines changed: 2 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -3,86 +3,12 @@ sidebar_label: What you’ll learn in this guide
33
pagination_label: Set Up an Infrastructure CI/CD Pipeline
44
---
55

6-
import { CardList } from "/src/components/CardGroup"
7-
86
# Set Up an Infrastructure CI/CD Pipeline
97

108
:::info
119

12-
This document is an excellent resource for understanding the problem space of CI/CD and the design choices that Gruntwork Pipelines makes.
10+
We are in the process of updating this document.
1311

14-
If you are looking to get hands-on with Gruntwork Pipelines and deploy it yourself, see [the official examples in our service catalog](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/gruntwork-pipelines)
12+
In the meantime, if you are a Gruntwork customer looking to get hands-on with Gruntwork Pipelines, see [the official examples in our service catalog](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/gruntwork-pipelines)
1513

1614
:::
17-
18-
## Overview
19-
20-
This is a comprehensive guide explaining the problem space of CI/CD, its threat vectors, and the design decisions that Gruntwork Pipelines
21-
makes in order to keep your sensitive credentials secure.
22-
23-
## What this guide will not cover
24-
25-
This guide is not hands-on! If you're looking to explore and play around with Gruntwork Pipelines, you should instead view and deploy [our official
26-
examples in our service catalog](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/gruntwork-pipelines).
27-
28-
CI/CD for infrastructure code is a large topic and a single guide cannot cover everything. There
29-
are several items that this guide will not cover, including:
30-
31-
<div className="dlist">
32-
33-
#### A pipeline for setting up new environments
34-
35-
This guide will focus on a CI/CD workflow for making changes to infrastructure in an environment that is already set
36-
up. In other words, the design and implementation of the pipeline covered in this guide intentionally does not solve
37-
the use case of infrastructure code for setting up an environment from scratch. Setting up new environments typically
38-
require complex deployment orders and permissions modeling that complicate the task. This makes it hard to automate in
39-
a reasonable fashion that still respects the threat model we cover here.
40-
41-
#### Automated testing and feature toggling strategies for infrastructure code
42-
43-
An important factor of CI/CD pipelines is the existence of automated testing and feature toggles. Automated tests give
44-
you confidence in the code before it is deployed to production. Similarly, feature toggles allow you to partially
45-
integrate and deploy code for a feature without enabling it. By doing so, you are able to continuously integrate new
46-
developments over time. This guide will briefly introduce automated testing and feature toggles for infrastructure
47-
code, but will not do a deep dive on the subject. You can learn more about best practices for automated testing in our
48-
talk
49-
[Automated
50-
testing for Terraform, Docker, Packer, Kubernetes, and More](https://blog.gruntwork.io/new-talk-automated-testing-for-terraform-docker-packer-kubernetes-and-more-cba312171aa6) and blog post
51-
[Agility requires safety](https://www.ybrikman.com/writing/2016/02/14/agility-requires-safety/).
52-
53-
</div>
54-
55-
## Sections
56-
57-
Feel free to read this guide from start to finish or skip around to whatever sections interest you.
58-
59-
<CardList>
60-
<Card
61-
title="Core Concepts"
62-
href="/guides/build-it-yourself/pipelines/core-concepts/why-is-it-important-to-have-ci-cd"
63-
>
64-
An overview of the core concepts you need to understand what a typical CI/CD pipeline entails for infrastructure code,
65-
including a comparison with CI/CD for application code, a sample workflow, infrastructure to support CI/CD, and threat
66-
models to consider to protect your infrastructure.
67-
</Card>
68-
<Card
69-
title="Production-grade Design"
70-
href="/guides/build-it-yourself/pipelines/production-grade-design/intro"
71-
>
72-
An overview of how to configure a secure, scalable, and robust CI/CD workflow that you can rely on for your
73-
production application and infrastructure code.
74-
</Card>
75-
<Card
76-
title="Deployment Walkthrough"
77-
href="/guides/build-it-yourself/pipelines/deployment-walkthrough/pre-requisites"
78-
>
79-
A step-by-step guide to deploying a production-grade CI/CD pipeline in AWS using code from the Gruntwork
80-
Infrastructure as Code Library.
81-
</Card>
82-
<Card
83-
title="Next Steps"
84-
href="/guides/build-it-yourself/pipelines/next-steps"
85-
>
86-
What to do once you’ve got your CI/CD pipeline set up.
87-
</Card>
88-
</CardList>

docs/guides/build-it-yourself/pipelines/index.md

Lines changed: 3 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -3,94 +3,20 @@ sidebar_label: What you’ll learn in this guide
33
pagination_label: Set Up an Infrastructure CI/CD Pipeline
44
---
55

6-
import { CardList } from "/src/components/CardGroup"
7-
86
# Set Up an Infrastructure CI/CD Pipeline
97

108
:::info
119

12-
This document is an excellent resource for understanding the problem space of CI/CD and the design choices that Gruntwork Pipelines makes.
10+
We are in the process of updating this document.
1311

14-
If you are looking to get hands-on with Gruntwork Pipelines and deploy it yourself, see [the official examples in our service catalog](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/gruntwork-pipelines)
12+
In the meantime, if you are a Gruntwork customer looking to get hands-on with Gruntwork Pipelines, see [the official examples in our service catalog](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/gruntwork-pipelines)
1513

1614
:::
1715

18-
## Overview
19-
20-
This is a comprehensive guide explaining the problem space of CI/CD, its threat vectors, and the design decisions that Gruntwork Pipelines
21-
makes in order to keep your sensitive credentials secure.
22-
23-
## What this guide will not cover
24-
25-
This guide is not hands-on! If you're looking to explore and play around with Gruntwork Pipelines, you should instead view and deploy [our official
26-
examples in our service catalog](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/gruntwork-pipelines).
27-
28-
CI/CD for infrastructure code is a large topic and a single guide cannot cover everything. There
29-
are several items that this guide will not cover, including:
30-
31-
<div className="dlist">
32-
33-
#### A pipeline for setting up new environments
34-
35-
This guide will focus on a CI/CD workflow for making changes to infrastructure in an environment that is already set
36-
up. In other words, the design and implementation of the pipeline covered in this guide intentionally does not solve
37-
the use case of infrastructure code for setting up an environment from scratch. Setting up new environments typically
38-
require complex deployment orders and permissions modeling that complicate the task. This makes it hard to automate in
39-
a reasonable fashion that still respects the threat model we cover here.
40-
41-
#### Automated testing and feature toggling strategies for infrastructure code
42-
43-
An important factor of CI/CD pipelines is the existence of automated testing and feature toggles. Automated tests give
44-
you confidence in the code before it is deployed to production. Similarly, feature toggles allow you to partially
45-
integrate and deploy code for a feature without enabling it. By doing so, you are able to continuously integrate new
46-
developments over time. This guide will briefly introduce automated testing and feature toggles for infrastructure
47-
code, but will not do a deep dive on the subject. You can learn more about best practices for automated testing in our
48-
talk
49-
[Automated
50-
testing for Terraform, Docker, Packer, Kubernetes, and More](https://blog.gruntwork.io/new-talk-automated-testing-for-terraform-docker-packer-kubernetes-and-more-cba312171aa6) and blog post
51-
[Agility requires safety](https://www.ybrikman.com/writing/2016/02/14/agility-requires-safety/).
52-
53-
</div>
54-
55-
## Sections
56-
57-
Feel free to read this guide from start to finish or skip around to whatever sections interest you.
58-
59-
<CardList>
60-
<Card
61-
title="Core Concepts"
62-
href="/guides/build-it-yourself/pipelines/core-concepts/why-is-it-important-to-have-ci-cd"
63-
>
64-
An overview of the core concepts you need to understand what a typical CI/CD pipeline entails for infrastructure code,
65-
including a comparison with CI/CD for application code, a sample workflow, infrastructure to support CI/CD, and threat
66-
models to consider to protect your infrastructure.
67-
</Card>
68-
<Card
69-
title="Production-grade Design"
70-
href="/guides/build-it-yourself/pipelines/production-grade-design/intro"
71-
>
72-
An overview of how to configure a secure, scalable, and robust CI/CD workflow that you can rely on for your
73-
production application and infrastructure code.
74-
</Card>
75-
<Card
76-
title="Deployment Walkthrough"
77-
href="/guides/build-it-yourself/pipelines/deployment-walkthrough/pre-requisites"
78-
>
79-
A step-by-step guide to deploying a production-grade CI/CD pipeline in AWS using code from the Gruntwork
80-
Infrastructure as Code Library.
81-
</Card>
82-
<Card
83-
title="Next Steps"
84-
href="/guides/build-it-yourself/pipelines/next-steps"
85-
>
86-
What to do once you’ve got your CI/CD pipeline set up.
87-
</Card>
88-
</CardList>
89-
9016

9117
<!-- ##DOCS-SOURCER-START
9218
{
9319
"sourcePlugin": "local-copier",
94-
"hash": "0d4a701ecaf6b15a54896e84ee9673cf"
20+
"hash": "af79446fd34c141811965f2e708ba157"
9521
}
9622
##DOCS-SOURCER-END -->

sidebars/pipelines-guide.js

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -12,44 +12,7 @@ const sidebar = [
1212
type: "doc",
1313
id: "guides/build-it-yourself/pipelines/index",
1414
},
15-
items: [
16-
{
17-
"Core Concepts": [
18-
"guides/build-it-yourself/pipelines/core-concepts/what-is-continuous-integration-and-continuous-delivery",
19-
"guides/build-it-yourself/pipelines/core-concepts/why-is-it-important-to-have-ci-cd",
20-
"guides/build-it-yourself/pipelines/core-concepts/trunk-based-development-model",
21-
"guides/build-it-yourself/pipelines/core-concepts/types-of-infrastructure-code",
22-
"guides/build-it-yourself/pipelines/core-concepts/ci-cd-workflows",
23-
"guides/build-it-yourself/pipelines/core-concepts/threat-model-of-ci-cd",
24-
"guides/build-it-yourself/pipelines/core-concepts/ci-cd-platforms",
25-
],
26-
},
27-
{
28-
"Production Grade Design": [
29-
"guides/build-it-yourself/pipelines/production-grade-design/intro",
30-
"guides/build-it-yourself/pipelines/production-grade-design/use-generic-ci-cd-platforms-as-a-workflow-engine-but-run-infrastructure-deployments-from-within-your-account",
31-
"guides/build-it-yourself/pipelines/production-grade-design/options-for-deploy-server",
32-
"guides/build-it-yourself/pipelines/production-grade-design/limit-triggers-for-deploy-server",
33-
"guides/build-it-yourself/pipelines/production-grade-design/use-a-vpc-to-lock-down-deploy-server",
34-
"guides/build-it-yourself/pipelines/production-grade-design/use-minimal-iam-permissions-for-a-deployment",
35-
"guides/build-it-yourself/pipelines/production-grade-design/use-approval-flows",
36-
"guides/build-it-yourself/pipelines/production-grade-design/lock-down-vcs-systems",
37-
"guides/build-it-yourself/pipelines/production-grade-design/summary-of-mitigations",
38-
"guides/build-it-yourself/pipelines/production-grade-design/summary-of-deployment-sequence",
39-
],
40-
},
41-
{
42-
"Deployment Walkthrough": [
43-
"guides/build-it-yourself/pipelines/deployment-walkthrough/pre-requisites",
44-
"guides/build-it-yourself/pipelines/deployment-walkthrough/deploy-a-vpc",
45-
"guides/build-it-yourself/pipelines/deployment-walkthrough/deploy-the-ecs-deploy-runner",
46-
"guides/build-it-yourself/pipelines/deployment-walkthrough/try-out-the-ecs-deploy-runner",
47-
"guides/build-it-yourself/pipelines/deployment-walkthrough/define-pipeline-as-code",
48-
"guides/build-it-yourself/pipelines/deployment-walkthrough/configure-ci-server",
49-
],
50-
},
51-
"guides/build-it-yourself/pipelines/next-steps",
52-
],
15+
items: [],
5316
},
5417
]
5518

0 commit comments

Comments
 (0)