Skip to content

Commit be6a81c

Browse files
rberlindrberlind
committed
Updated and added README.md files
1 parent fcc823e commit be6a81c

File tree

9 files changed

+57
-8
lines changed

9 files changed

+57
-8
lines changed

‎README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
1-
# terraform-guides
2-
Example usage of HashiCorp Terraform
1+
# Terraform Guides
2+
This repository contains sample Terraform configurations, Sentinel policies, and automation scripts that can be used with Terraform Enterprise.
3+
4+
## infrastructure-as-code
5+
This directory contains sample Terraform configurations to provision VMs into AWS, Azure, and Google Cloud Platoform (GCP) as well as Kubernetes clusters into Azure Container Service (ACS) and Google Kubernetes Engine (GKE).
6+
7+
## self-serve-infrastructure
8+
This directory contains sample Terraform configurations to enable self service infrastructure. In particular, it illustrates how developers can deploy applications to Kubernetes clusters provisioned by an operations team.
9+
10+
## governance
11+
This directory contains some sample Sentinel policies for several clouds which ensure that all infrastructure provisioned with Terraform Enterprise complies with an organization's provisioning rules.
12+
13+
## operations
14+
This directory provides artifacts that can be used by operations teams using Terraform Enterprise. In particular, it includes a scripy that shows how the Terraform Enterprise REST API can be used to automate interactions with Terraform Enterprise.
15+
16+
## cloud-management-platform
17+
This directory provides samples of how Terraform can be used to support cloud management platforms.

‎cloud-management-platform/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
# To be implemented
1+
# Cloud Management Platform
2+
To be implemented.

‎governance/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
# To be implemented
1+
# Governance with Terraform Sentinel Policies
2+
The files under this directory provide some sample Sentinel policies for several clouds including AWS, Microsoft Azure, and Google Cloud Platform (GCP). Sentinel gives operations teams the governance capabilities they need to ensure that all infrastructure provisioned with Terraform Enterprise complies with their organization's provisioning rules.

‎governance/aws/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
# To be implemented
1+
# Sentinel Policies for AWS
2+
The sample Sentinel policy files in this directory can be used with Terraform Enterprise to ensure that provisioned AWS VPCs and EC2 instances comply with your organization's provisioning rules.

‎governance/azure/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Sentinel Policies for Azure
2+
The sample Sentinel policy files in this directory can be used with Terraform Enterprise to ensure that provisioned Azure security groups, VMs, and ACS clusters comply with your organization's provisioning rules.

‎governance/gcp/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Sentinel Policies for Google Cloud Platform
2+
The sample Sentinel policy files in this directory can be used with Terraform Enterprise to ensure that provisioned GCP VMs, firewalls, and GKE clusters comply with your organization's provisioning rules.

‎infrastructure-as-code/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
# To be implemented
1+
# Infrastructure as Code Examples
2+
The Terraform code in the directories under this one provide examples for provisioning infrastructure into AWS, Azure, and Google Cloud Platform (GCP).
3+
4+
## aws-ec2-instance
5+
This example provides a simple example to provision an EC2 instance running Ubuntu in AWS.
6+
7+
## azure-vm
8+
This example provides a simple example to provision an Azure Windows VM and required resources in Azure. Note that it uses a module from the public [Terraform Module Registry](https://registry.terraform.io/).
9+
10+
## gcp-compute-instance
11+
This example provides a simple example to provision a Google compute instance in GCP.
12+
13+
## k8s-cluster-acs
14+
This example illustrates how you can provision an Azure Container Service (ACS) cluster. If you use this, also check out the [k8s-services](../self-serve-infrastructure) directory which lets you provision a web app and redis database as Kubernetes pods to the cluster.
15+
16+
## k8s-cluster-gke
17+
This example illustrates how you can provision a Google Kubernetes Engine (GKE) cluster. If you use this, also check out the [k8s-services](../self-serve-infrastructure) directory which lets you provision a web app and redis database as Kubernetes pods to the cluster.

‎operations/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
# To be implemented
1+
# Operations
2+
This directory contains artifacts that can be used by operations teams using Terraform Enterprise.
3+
4+
## Automation-Script
5+
The automation-script directory contains a bash script and associated files that illustrate how the Terraform Enterprise REST API can be used to automate interactions with Terraform Enterprise. It simulates what an operations team might do with Jenkins or other tools.

‎self-serve-infrastructure/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
1-
# To be implemented
1+
# Self Service Infrastructure
2+
The examples in this directory illustrate how Terraform can be used to support self service Infrastructure.
3+
4+
## k8s-services
5+
This Terraform example can be used to provision a web application and redis database as Kubernetes pods to a Kubernetes cluster. It is intended to be used with the [k8s-cluster-acs](../infrastructure-as-code/k8s-cluster-acs) and [k8s-cluster-gke](../infrastructure-as-code/k8s-cluster-gke) examples which provision Kubernetes clusters into Azure Container Service and Google Kubernetes Engine. But it could be used with other Kubernetes clusters too.
6+
7+
## cats-and-dogs
8+
This directory contains the source code and docker files for the cats-and-dogs frontend and backend pods provisioned by the k8s-services Terraform code.

0 commit comments

Comments
 (0)