Skip to content

Commit c750416

Browse files
committed
Initial commit for docs
1 parent 6de992b commit c750416

9 files changed

+78
-3
lines changed

docs/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,3 @@ The objective of this lab is split into two distinct parts. The first part is bu
1616
- An Apache server will be deployed in a secure VSI workload VPC
1717
- The web application will be exposed for outside access.
1818
- 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
19-
20-
Before we go onto practical steps, the following sections introduces some of the necessary background and context to understand the general principles of this lab.

docs/about/10-fs-cloud.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# VPC Landing Zone
2+
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:
4+
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
13+
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.
24+
25+
![VPC reference architecture](../images/about-fs-cloud.png)

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

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# IBM Cloud for Financial Cloud Services Framework
2+
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.
4+
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.
6+
7+
[Getting started with IBM Cloud for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-about)
8+
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.

docs/about/30-deployable-arch.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Deployable Architecture
2+
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.”
4+
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:
6+
7+
- Discoverable and available through the IBM Cloud Catalog (and through IBM Cloud search)
8+
- Fully integrated in IBM Cloud Projects and Schematics.
9+
- 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)
10+
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.
12+
13+
![Deployable Architecture console](../images/about-deployable-arch.png)
14+
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.
16+
17+
IBM-maintained Deployable Architectures, like the Landing Zone Deployable Architecture:
18+
19+
- 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

docs/about/40-projects.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# IBM Cloud Projects
2+
3+
IBM Cloud Projects make it easy to manage Infrastructure-As-Code deployments across accounts, collaborate with team members, and maintain compliance.
4+
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.
6+
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):
8+
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.
12+
13+
That SRE team can group configurations, and thus centralize the governance, for the 4 different environments in one single Project.
14+
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.
17+
18+
![IBM Cloud Projects](../about/40-projects.md)

docs/images/about-deployable-arch.png

58.6 KB
Loading

docs/images/about-fs-cloud.png

223 KB
Loading

docs/images/about-projects.png

28.3 KB
Loading

docs/sidebar.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
- [🛫 Overview](README.md)
1+
- [📘 Overview](README.md)
2+
- [IBM Cloud for Financial Service](./about/10-fs-cloud.md)
3+
- [VPC Landing Zone](./about/20-vpc-landing-zone.md)
4+
- [Deployable Architectures](./about/30-deployable-arch)
5+
- [IBM Cloud Projects](./about/40-projects.md)

0 commit comments

Comments
 (0)