Skip to content

Commit 70965f0

Browse files
vburckhardtvburckhardt
authored
Merge pull request #7 from IBM/doc-updates
Doc updates
2 parents cff0457 + 7a9321a commit 70965f0

File tree

87 files changed

+947
-72
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+947
-72
lines changed

‎app-install/main.tf

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ resource "null_resource" "application-install" {
2626

2727
provisioner "remote-exec" {
2828
inline = [
29+
"apt-get update",
2930
"apt-get install apache2 -y"
3031
]
3132
}

‎docs/README.md

+25-13
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,30 @@
1-
# Seamless App Deployment with IBM Cloud's Secure Landing Zone
1+
# Seamless Deployment: From Provisioning to Runtime With the IBM Cloud VPC landing zone
22

3-
With the release of IBM Cloud Deployable Architectures, it is easy to provision an exisiting pre-defined architecture or customize and import.
3+
The introduction of IBM Cloud [deployable architectures](https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-faqs) makes it easy to provision predefined architecture in no time.
44

5-
In this hands-on lab, you will learn to:
5+
## 📖 What you will learn
66

7-
1. Create a customized VPC-based topology using the VPC Landing Zone Deployable Architecture
8-
2. Deploy and expose a web application on top of this secure topology. For this lab, we will use an Apache service as an example.
9-
3. Share this deployable pattern with your enterprise through the IBM Cloud Private Catalog
7+
In this hands-on lab, you will learn how to work with the VPC landing zone deployable architecture to accomplish these goals.
108

11-
The objective of this lab is split into two distinct parts. The first part is built as a stepping stone for the second part.
9+
1. Create a customized VPC-based topology from the VPC landing zone deployable architecture.
10+
2. Deploy and expose a web application on this secure topology. For this lab, we use an Apache service as an example.
11+
3. Share this deployable pattern with your enterprise through the IBM Cloud private catalog.
1212

13-
- Part 1 shows how the end-to-end steps to deploy a sample web application on top of a secure VPC-topology in your own account.
14-
- The secure VPC-based topology will be deployed using the Landing Zone Deployable Architecture.
15-
- Operator access will be provided through a manually deployed jump box VSI
16-
- An Apache server will be deployed in a secure VSI workload VPC
17-
- The web application will be exposed for outside access.
18-
- Part 2 shows how to automate the manual steps in Part 1, and then, how to package, and share the automation as a “Deployable Architecture” with other user through a private IBM Cloud Catalog
13+
The lab also introduces some concepts and background to help you to better get the "bigger" picture at the beginning. However, the hands-on steps are designed to be independent from the concepts and background information.
14+
15+
## Lab structure
16+
17+
Two labs are available. The two labs are independent. However, the first lab is a stepping stone in term of knowledge to the second lab.
18+
19+
In [Lab 1](./part1/00-objectives), you take the perspective of a cloud infrastructure engineer:
20+
21+
1. Use the [landing zone deployable architecture](https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-overview) to automatically deploy a secure VPC-based topology in an IBM Cloud account.
22+
2. Manually customize the deployed infrastructure in the account in the following ways:
23+
a. Provide operator access through a "jump box" VSI.
24+
b. Install an Apache server in one of the workload VPCs that serves the web pages.
25+
c. Expose the web pages that are served by the Apache server through a public VPC load balancer.
26+
27+
In [Lab 2](./part2/00-objectives), you are a DevOps/automation engineer:
28+
29+
1. Automate all the manual steps in lab 1.
30+
2. Package, and share the automation with other users as a **Deployable architecture** through a private IBM Cloud catalog. This packaging in a private catalog helps specific users to find and consume your automation.

‎docs/about/10-fs-cloud.md

+4-20
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,9 @@
1-
# VPC Landing Zone
1+
# IBM Cloud for Financial Cloud Services Framework
22

3-
IBM VPC Landing Zone (“SLZ”) is a set of [Infrastructure-As-Code](https://en.wikipedia.org/wiki/Infrastructure_as_code) automation that enables creating a fully customizable VPC environment within a single region. The VPC Landing Zone is implemented in terraform and automates the provisioning, configuring, and integration of several services that participates in the realization of a compliant VPC-based topology:
3+
IBM Cloud Framework for Financial Services provides comprehensive and detailed guidance around regulatory compliance, security, and resiliency to help address the needs of enterprises both during initial deployment and with ongoing operations. For more information, see [Getting started with IBM Cloud for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-about).
44

5-
- A resource group for cloud services and for each VPC.
6-
- Cloud Object Storage instances for flow logs and Activity Tracker
7-
- Encryption keys in either a Key Protect or Hyper Protect Crypto Services instance
8-
- A management and workload VPC connected by a transit gateway
9-
- A flow log collector for each VPC
10-
- All necessary networking rules to allow communication.
11-
- Virtual Private Endpoint (VPE) for Cloud Object Storage in each VPC
12-
- A VPN gateway in the management VPC
5+
The framework was initially based on the needs of financial institutions, as its name indicates. However, it can be used as a compliance and security starting point and baseline for most industries.
136

14-
[Available VPC Landing Zone terraform modules](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone)
15-
16-
VPC Landing Zone comes with four fully functional patterns that are strictly following the IBM Cloud Financial Services reference architecture:
17-
18-
- VPC pattern
19-
- VPC with Virtual Servers (“VSIs”) – which the lab will use.
20-
- VPC with OpenShift
21-
- VPC with VSIs and OpenShift (“mixed”) pattern.
22-
23-
Each of the patterns can be used as a starting point to create your own customizable VPC-based topology that matches your enterprise or customer exact needs.
7+
The framework provides secure [VPC reference architectures](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-about) that meet a number of regulatory controls.
248

259
![VPC reference architecture](../images/about-fs-cloud.png)

‎docs/about/20-vpc-landing-zone.md

+25-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,29 @@
1-
# IBM Cloud for Financial Cloud Services Framework
1+
# VPC landing zone
22

3-
The IBM Cloud Financial Cloud Services Framework provides comprehensive and detailed guidance to help address the needs of enterprises with regulatory compliance, security, and resiliency during the initial deployment phase and with ongoing operations.
3+
IBM VPC landing zone (also referred to as "SLZ" for secure landing zone) is [Infrastructure-As-Code](https://en.wikipedia.org/wiki/Infrastructure_as_code) automation that enables you to create a fully customizable VPC environment within a single region. The VPC landing zone is implemented in Terraform and automates the provisioning, configuring, and integration of several services that participate in the realization of a compliant VPC-based topology that is aligned with the documented [IBM Cloud for Financial Cloud Services Framework](./about/10-fs-cloud).
44

5-
Whilst the framework was initially based on the needs of financial institutions, as its name indicates, it can be used as a starting point and baseline for meeting compliance and security for most industries.
5+
The automation is available as a set of [Terraform modules on GitHub](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone). The automation creates and configures all of the resources necessary to create a secure and compliant topology:
6+
- A resource group for cloud services and for each VPC
7+
- Cloud Object Storage instances for flow logs and Activity Tracker (access and audit logs)
8+
- Encryption keys in either a Key Protect or Hyper Protect Crypto Services instance
9+
- A management and workload VPC connected by a transit gateway
10+
- A flow log collector for each VPC
11+
- All necessary networking rules to allow communication.
12+
- Virtual Private Endpoint (VPE) for Cloud Object Storage in each VPC
13+
- A VPN gateway in the management VPC
614

7-
[Getting started with IBM Cloud for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-about)
15+
# Landing zone patterns
816

9-
The framework provides secure [VPC reference architectures](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-about) meeting with a number of regulatory controls.
17+
18+
VPC landing zone comes with four fully functional patterns that follow the IBM Cloud Framework for Financial Services reference architecture:
19+
20+
- VPC pattern
21+
- VPC with Virtual Servers ("VSIs") – which the lab uses.
22+
- VPC with Red Hat OpenShift ("ROKS")
23+
- VPC with VSIs and Red Hat OpenShift ("mixed") pattern.
24+
25+
| VPC pattern | Virtual server pattern | Red Hat OpenShift pattern | Mixed pattern |
26+
| ------------------------------ | -------------------------------- | -------------------------------- | ---------------------------------- |
27+
| [![VPC](https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-landing-zone/main/reference-architectures/vpc.drawio.svg)](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone/blob/main/patterns/vpc/README.md) | [![VSI](https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-landing-zone/main/reference-architectures/vsi-vsi.drawio.svg)](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone/blob/main/patterns/vsi/README.md) | [![ROKS](https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-landing-zone/main/reference-architectures/roks.drawio.svg)](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone/blob/main/patterns/roks/README.md) | [![Mixed](https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-landing-zone/main/.docs/images/mixed.png)](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone/blob/main/patterns/mixed/README.md) |
28+
29+
You can use any pattern as a starting point to create a customizable VPC-based topology that supports your customer needs or the needs of your enterprise.

‎docs/about/30-deployable-arch.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# Deployable Architecture
1+
# Deployable architecture
22

3-
“Deployable Architecture” is officially defined as “Cloud automation for deploying a common architectural pattern that combines one or more cloud resources that is designed for easy deployment, scalability, and modularity.”
3+
A deployable architecture is defined as "Cloud automation for deploying a common architectural pattern that combines one or more cloud resources that is designed for easy deployment, scalability, and modularity.
44

5-
More specifically, and concretely, from a technical perspective, “Deployable Architectures” are essentially terraform modules that are fully integrated into the IBM Cloud experience. Deployable Architecture are:
5+
From a technical perspective, deployable architectures are essentially Terraform modules that are fully integrated into the IBM Cloud experience. Deployable architectures have these characteristics:
66

7-
- Discoverable and available through the IBM Cloud Catalog (and through IBM Cloud search)
8-
- Fully integrated in IBM Cloud Projects and Schematics.
7+
- Discoverable and available through the IBM Cloud catalog (and through IBM Cloud search)
8+
- Fully integrated in IBM Cloud projects and Schematics
99
- Integrated with [IBM Cloud Risk Analyzer](https://cloud.ibm.com/docs/code-risk-analyzer-cli-plugin?topic=code-risk-analyzer-cli-plugin-cra-cli-plugin#terraform-command)
1010

11-
In other words, it is possible for an end-user to execute the terraform automation behind a “Deployable Architecture” just from a few clicks and inputs in the IBM Cloud console.
11+
In other words, a user can run the Terraform automation behind a deployable architecture just from a few clicks and inputs in the IBM Cloud console.
1212

13-
![Deployable Architecture console](../images/about-deployable-arch.png)
13+
![Deployable architecture console](../images/about-deployable-arch.png)
1414

15-
The Landing Zone terraform module and patterns described just above have a corresponding [Deployable Architecture](https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-overview) in IBM Cloud. In this lab, the Secure Landing Zone is consumed through the Deployable Architecture experience for ease of use, rather than using the terraform CLI against the open-source github version.
15+
The landing zone Terraform module and patterns that are described in [🌍 VPC landing zone](./about/20-vpc-landing-zone.md) have a corresponding [deployable architecture](https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-overview) in IBM Cloud. To help you learn about deployable architectures, this lab provides steps for deploying the deployable architecture in IBM Cloud rather than by running Terraform commands against the open source GitHub version.
1616

17-
IBM-maintained Deployable Architectures, like the Landing Zone Deployable Architecture:
17+
IBM-maintained deployable architectures are just like the landing zone deployable architecture in these ways:
1818

1919
- Provide the same level of customer support as any other IBM Cloud product
20-
- [Come with extensive documentation](https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-overview)
21-
- Are maintained and remains current over time
20+
- Come with extensive [documentation](https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-overview)
21+
- Are maintained to stay current

‎docs/about/40-projects.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
# IBM Cloud Projects
1+
# IBM Cloud projects
22

3-
IBM Cloud Projects make it easy to manage Infrastructure-As-Code deployments across accounts, collaborate with team members, and maintain compliance.
3+
IBM Cloud projects make it easy to manage Infrastructure-As-Code (IaC) deployments across accounts, collaborate with team members, and maintain compliance.
44

5-
At its core, an IBM Cloud Project is made up of a collection of configurations that are used to manage related Infrastructure as Code (IaC) deployments (and associated resources) across accounts.
5+
At its core, an IBM Cloud project is made up of a collection of configurations that are used to manage related Infrastructure as Code (IaC) deployments (and associated resources) across accounts.
66

7-
As a concrete example, let’s imagine the scenario of a SRE team responsible for setting up the infrastructure supporting the web application. That SRE team wants to follow best practices and deploy the following environments, all based on the same Deployable Architecture template (but with slight configuration differences for each environment):
7+
For example, let’s imagine the scenario of a SRE team that is responsible for setting up the infrastructure that supports the web application. That SRE team wants to follow best practices and deploy the following environments, which are based on the same deployable architecture template (but with slight configuration differences for each environment):
88

9-
1. A development environment – with scaled down compute resources and no audit event tracking.
10-
2. A staging environment – as close as possible to the production environment
11-
3. 2 production environments: one in America and another one in Europe.
9+
1. A development environment: with scaled down compute resources and no audit event tracking.
10+
2. A staging environment: as close as possible to the production environment
11+
3. Two production environments: one in North America and another one in Europe.
1212

13-
That SRE team can group configurations, and thus centralize the governance, for the 4 different environments in one single Project.
13+
That SRE team can group configurations, and thus centralize the governance and supervision, for the four different environments in one single Project.
1414

15-
Beyond the core configuration grouping capability, IBM Cloud Projects is designed with an IaC and a compliance-first approach. Projects also seemingly integrate with IBM Cloud Schematics to deploy, update, and manage the resources created by the IaC automation.
16-
Each project also includes tools to scan for potentially harmful resource changes, compliance, security, and cost, as well as tracking configuration versioning and governance.
15+
Beyond the core configuration grouping capability, IBM Cloud projects is designed with an IaC and a compliance-first approach. Projects also seemingly integrates with IBM Cloud Schematics to deploy, update, and manage the resources that are created by the IaC automation.
1716

18-
![IBM Cloud Projects](../about/40-projects.md)
17+
Each project also includes tools to scan for potentially harmful resource changes, compliance, security, and cost issues, and to track configuration versioning and governance.
18+
19+
![IBM Cloud projects](../images/about-projects.png)

‎docs/cover.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<img src="header.jpg">
22

3-
> Seamless App Deployment with<br/>
4-
> IBM Cloud's Secure Landing Zone
3+
> Seamless Deployment: From Provisioning to Runtime<br/>
4+
> with IBM Cloud VPC landing zone
55
66
_Session 2448_
77

0 commit comments

Comments
 (0)