Skip to content

Commit 0f6a58e

Browse files
authored
docs: update markdown documents (#751)
1 parent a7eb5c5 commit 0f6a58e

File tree

9 files changed

+58
-90
lines changed

9 files changed

+58
-90
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- BEGIN MODULE HOOK -->
22

3-
# IBM Power Virtual Server with VPC landing zone
3+
# IBM Power Virtual Server with VPC Landing Zone
44

55
[![Graduated (Supported)](https://img.shields.io/badge/status-Graduated%20(Supported)-brightgreen?style=plastic)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
66
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
@@ -9,28 +9,28 @@
99
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
1010

1111
## Summary
12-
This repository contains deployable architecture solutions which helps in provisioning VPC landing zone, PowerVS workspace and interconnecting them. The solutions are available in IBM Cloud Catalog and also can be deployed without catalog as well except the second solution below.
12+
This repository contains deployable architecture solutions that help provision VPC landing zones, PowerVS workspaces, and interconnect them. The solutions are available in the IBM Cloud Catalog and can also be deployed without the catalog, except for the second solution below.
1313

1414
Three solutions are offered:
1515
1. [PowerVS full-stack variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/solutions/full-stack)
16-
- Creates three VPCs with RHEL or SLES instances, Power Virtual Server workspace, interconnects them and configures os network management services(SQUID proxy, NTP, NFS, and DNS services) using ansible galaxy collection roles [ibm.power_linux_sap collection](https://galaxy.ansible.com/ui/repo/published/ibm/power_linux_sap/).
16+
- Creates three VPCs with RHEL or SLES instances, Power Virtual Server workspace, interconnects them, and configures OS network management services (SQUID proxy, NTP, NFS, and DNS services) using Ansible Galaxy collection roles [ibm.power_linux_sap collection](https://galaxy.ansible.com/ui/repo/published/ibm/power_linux_sap/).
1717
2. [PowerVS extension variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/solutions/extension)
18-
- Extends the full-stack solution by creating a new Power Virtual Server workspace in different zone and interconnects with the previous solution.
19-
- This solution is typically used for **High Availability scenarios** where a single management VPCs can be used to reach both PowerVS workspaces.
18+
- Extends the full-stack solution by creating a new Power Virtual Server workspace in a different zone and interconnects with the previous solution.
19+
- This solution is typically used for **High Availability scenarios** where a single management VPC can be used to reach both PowerVS workspaces.
2020
3. [PowerVS quickstart variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/solutions/quickstart)
21-
- Creates 1VPC and a Power Virtual Server workspace, interconnects them and configures os network management services(SQUID proxy, NTP, NFS, and DNS services) using ansible galaxy collection roles [ibm.power_linux_sap collection](https://galaxy.ansible.com/ui/repo/published/ibm/power_linux_sap/).
22-
- Additionally creates a Power Virtual Server Instance of selected t-shirt size.
23-
- This solution is typically used for **PoCs, demos and quick onboarding** to PowerVS Infrastructure.
21+
- Creates a VPC and a Power Virtual Server workspace, interconnects them, and configures operating network management services (SQUID proxy, NTP, NFS, and DNS services) using Ansible Galaxy collection roles [ibm.power_linux_sap collection](https://galaxy.ansible.com/ui/repo/published/ibm/power_linux_sap/).
22+
- Additionally creates a Power Virtual Server Instance of a selected t-shirt size.
23+
- This solution is typically utilized for **PoCs, demos, and quick onboarding** to PowerVS Infrastructure.
2424
4. [PowerVS import-workspace variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/solutions/import-workspace)
25-
- Takes information of an existing infrastructure and creates a schematics workspace.
26-
- The schematics workspace's id and the outputs from it can be used to install the terraform solution 'Power Virtual Server for SAP HANA' on top of a pre-existing PowerVS infrastructure.
27-
- It creates the ACL and security group rules necessary for management services(NTP. NFS, DNS and proxy server) and schematics engine access.
28-
- This solution is typically used for converting an existing Power Virtual Server landscape to Schematics workspace.
25+
- Takes information about an existing infrastructure and creates a schematics workspace.
26+
- The schematics workspace's ID and the outputs from it can be used to install the terraform solution 'Power Virtual Server for SAP HANA' on top of a pre-existing PowerVS infrastructure.
27+
- It creates the ACL and security group rules necessary for management services (NTP, NFS, DNS, and proxy server) and schematics engine access.
28+
- This solution is typically used for converting an existing Power Virtual Server landscape to a Schematics workspace.
2929

3030
## Reference architectures
31-
- [PowerVS full-stack variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/reference-architectures/full-stack/deploy-arch-ibm-pvs-inf-full-stack.md)
32-
- [PowerVS extension variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/reference-architectures/extension/deploy-arch-ibm-pvs-inf-extension.md)
33-
- [PowerVS quickstart variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/reference-architectures/quickstart/deploy-arch-ibm-pvs-inf-quickstart.md)
31+
- [PowerVS Full-Stack Variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/reference-architectures/full-stack/deploy-arch-ibm-pvs-inf-full-stack.md)
32+
- [PowerVS Extension Variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/reference-architectures/extension/deploy-arch-ibm-pvs-inf-extension.md)
33+
- [PowerVS Quickstart Variation](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/tree/main/reference-architectures/quickstart/deploy-arch-ibm-pvs-inf-quickstart.md)
3434

3535
## Solutions
3636
| Variation | Available on IBM Catalog | Requires IBM Schematics Workspace ID | Creates VPC Landing Zone | Performs VPC VSI OS Config | Creates PowerVS Infrastructure | Creates PowerVS Instance | Performs PowerVS OS Config |
@@ -72,7 +72,7 @@ You need the following permissions to run this module.
7272
<!-- BEGIN CONTRIBUTING HOOK -->
7373
## Contributing
7474

75-
You can report issues and request features for this module in GitHub issues in the module repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md).
75+
You can report issues and request features for this module in GitHub issues in the module repository. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md).
7676

7777
To set up your local development environment, see [Local development setup](https://terraform-ibm-modules.github.io/documentation/#/local-dev-setup) in the project documentation.
7878
<!-- END CONTRIBUTING HOOK -->

modules/powervs-vpc-landing-zone/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# Module powervs-vpc-landing-zone
22

3-
## IBM Power Virtual Server with VPC landing zone
3+
## IBM Power Virtual Server with VPC Landing Zone
44

55
This module provisions the following resources in IBM Cloud:
6-
- A **VPC Infrastructure** based on value passed to 'var.landing_zone_configuration' with the following components:
6+
- A **VPC Infrastructure** based on the value passed to 'var.landing_zone_configuration' with the following components:
77
- **landing_zone_configuration = 3VPC_RHEL or 3VPC_SLES**
88

9-
- Provisions three VPCs with one VSI in each VPC one management(jump/bastion) VSI, one inet-svs VSI configured as squid proxy server, one private-svs VSI (configured as NFS, NTP, DNS server) using [this preset](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/modules/powervs-vpc-landing-zone/presets/3vpc.preset.json.tftpl).
10-
- Installs and configures the Squid Proxy, DNS Forwarder, NTP forwarder and NFS on hosts, and sets the host as the server for the NTP, NFS, and DNS services by using ansible galaxy collection roles [ibm.power_linux_sap collection](https://galaxy.ansible.com/ui/repo/published/ibm/power_linux_sap/).
9+
- Provisions three VPCs with one VSI in each VPC - one management (jump/bastion) VSI, one inet-svs VSI configured as a squid proxy server, and one private-svs VSI (configured as NFS, NTP, DNS server) using [this preset](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/modules/powervs-vpc-landing-zone/presets/3vpc.preset.json.tftpl).
10+
- Installs and configures the Squid Proxy, DNS Forwarder, NTP forwarder, and NFS on hosts, and sets the host as the server for the NTP, NFS, and DNS services by using Ansible Galaxy collection roles [ibm.power_linux_sap collection](https://galaxy.ansible.com/ui/repo/published/ibm/power_linux_sap/).
1111

1212
- **landing_zone_configuration = 1VPC_RHEL**
1313

14-
- One VPC with one VSI for management(jump/bastion) using [this preset](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/modules/powervs-vpc-landing-zone/presets/1vpc.preset.json.tftpl).
15-
- Installation and configuration of Squid Proxy, DNS Forwarder, NTP forwarder and NFS on the bastion host, and sets the host as the server for the NTP, NFS, and DNS services using ansible galaxy collection roles [ibm.power_linux_sap collection](https://galaxy.ansible.com/ui/repo/published/ibm/power_linux_sap/)
14+
- One VPC with one VSI for management (jump/bastion) using [this preset](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/modules/powervs-vpc-landing-zone/presets/1vpc.preset.json.tftpl).
15+
- Installation and configuration of Squid Proxy, DNS Forwarder, NTP forwarder, and NFS on the bastion host, and sets the host as the server for the NTP, NFS, and DNS services using Ansible Galaxy collection roles [ibm.power_linux_sap collection](https://galaxy.ansible.com/ui/repo/published/ibm/power_linux_sap/)
1616

1717
- **A Power Virtual Server workspace** with the following network topology:
1818
- Creates two private networks: a management network and a backup network.
19-
- Creates one or two IBM Cloud connections in Non PER environment.
20-
- Attaches the private networks to the IBM Cloud connections in Non PER environment.
21-
- Attaches the IBM Cloud connections to a transit gateway in Non PER environment.
22-
- Attaches the PowerVS workspace to Transit gateway in PER enabled DC
19+
- Creates one or two IBM Cloud connections in a non-PER environment.
20+
- Attaches the private networks to the IBM Cloud connections in a non-PER environment.
21+
- Attaches the IBM Cloud connections to a transit gateway in a non-PER environment.
22+
- Attaches the PowerVS workspace to Transit gateway in PER-enabled DC.
2323
- Creates an SSH key.
2424

25-
- Finally Interconnects both VPC and PowerVS infrastructure.
25+
- Finally, interconnects both VPC and PowerVS infrastructure.
2626

2727
## Usage
2828
```hcl

reference-architectures/extension/deploy-arch-ibm-pvs-inf-extension.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,6 @@ docs: https://cloud.ibm.com/docs/powervs-vpc
2121

2222
image_source: https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/reference-architectures/extension/deploy-arch-ibm-pvs-inf-extension.svg
2323

24-
related_links:
25-
- title: 'SAP in IBM Cloud documentation'
26-
url: 'https://cloud.ibm.com/docs/sap'
27-
description: 'SAP in IBM Cloud documentation.'
28-
- title: 'Reference architecture for "Secure infrastructure on VPC for regulated industries" as standard variation'
29-
url: 'https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-vsi-ra'
30-
description: 'Reference architecture for "Secure infrastructure on VPC for regulated industries" as standard variation'
31-
3224
use-case: ITServiceManagement
3325

3426
industry: Technology
@@ -49,17 +41,15 @@ content-type: reference-architecture
4941
{: toc-compliance="SAPCertified"}
5042
{: toc-version="4.3.0"}
5143

52-
The Power Virtual Server with VPC landing zone as variation 'Extend Power Virtual Server with VPC landing zone' creates an additional Power Virtual Server workspace and connects it with already created Power Virtual Server with VPC landing zone. It builds on existing Power Virtual Server with VPC landing zone deployed as a variation 'Create a new architecture'.
44+
The Power Virtual Server with VPC landing zone as variation 'Extend Power Virtual Server with VPC landing zone' creates an additional Power Virtual Server workspace and connects it with the already created Power Virtual Server with VPC landing zone. It builds on the existing Power Virtual Server with VPC landing zone deployed as a variation 'Create a new architecture'.
5345

5446
## Architecture diagram
5547
{: #ext-architecture-diagram}
5648

57-
![Architecture diagram for 'Power Virtual Server with VPC landing zone' - variation 'PowerVS workspace'.](deploy-arch-ibm-pvs-inf-extension.svg "Architecture diagram"){: caption="Figure 1. Single-zone PowerVS workspace accessible over secure landing zone" caption-side="bottom"}{: external download="deploy-arch-ibm-pvs-inf-extension.svg"}
58-
5949
## Design requirements
6050
{: #ext-design-requirements}
6151

62-
![Design requirements for 'Power Virtual Server with VPC landing zone' - variation 'PowerVS workspace'.](heat-map-deploy-arch-ibm-pvs-inf-extension.svg "Design requirements"){: caption="Figure 2. Scope of the solution requirements" caption-side="bottom"}
52+
![Design requirements for 'Power Virtual Server with VPC landing zone' - variation 'PowerVS Workspace'](heat-map-deploy-arch-ibm-pvs-inf-extension.svg "Design requirements"){: caption="Figure 2. Scope of the solution requirements" caption-side="bottom"}
6353

6454
IBM Cloud® Power Virtual Servers (PowerVS) is a public cloud offering that an enterprise can use to establish its own private IBM Power computing environment on shared public cloud infrastructure. PowerVS is logically isolated from all other public cloud tenants and infrastructure components, creating a private, secure place on the public cloud. This deployable architecture provides a framework to build a PowerVS offering according to the best practices and requirements from the IBM Cloud.
6555

reference-architectures/full-stack/deploy-arch-ibm-pvs-inf-full-stack.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,6 @@ docs: https://cloud.ibm.com/docs/powervs-vpc
2323

2424
image_source: https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/reference-architectures/full-stack/deploy-arch-ibm-pvs-inf-full-stack.svg
2525

26-
related_links:
27-
- title: 'SAP in IBM Cloud documentation'
28-
url: 'https://cloud.ibm.com/docs/sap'
29-
description: 'SAP in IBM Cloud documentation.'
30-
- title: 'Reference architecture for "Secure infrastructure on VPC for regulated industries" as standard variation'
31-
url: 'https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-vsi-ra'
32-
description: 'Reference architecture for "Secure infrastructure on VPC for regulated industries" as standard variation'
33-
3426
use-case: ITServiceManagement
3527

3628
industry: Technology
@@ -51,18 +43,17 @@ content-type: reference-architecture
5143
{: toc-compliance="SAPCertified"}
5244
{: toc-version="4.3.0"}
5345

54-
PowerVS workspace deployment of the Power Virtual Server with VPC landing zone creates VPC services and a Power Virtual Server workspace and interconnects them.
46+
The PowerVS workspace deployment of the Power Virtual Server with VPC landing zone creates VPC services and a Power Virtual Server workspace and interconnects them.
5547

5648
A proxy service for public internet access from the PowerVS workspace is configured. You can optionally configure some management components on VPC (such as an NFS server, NTP forwarder, and DNS forwarder).
5749

5850
## Architecture diagram
5951
{: #full-architecture-diagram}
6052

61-
![Architecture diagram for 'Power Virtual Server with VPC landing zone' - variation 'PowerVS workspace'.](deploy-arch-ibm-pvs-inf-full-stack.svg "Architecture diagram"){: caption="Figure 1. Single-zone PowerVS workspace accessible over secure landing zone" caption-side="bottom"}{: external download="deploy-arch-ibm-pvs-inf-full-stack.svg"}
53+
![Architecture diagram for 'Power Virtual Server with VPC landing zone' - variation 'PowerVS workspace'](deploy-arch-ibm-pvs-inf-full-stack.svg "Architecture diagram"){: caption="Figure 1. Single-zone PowerVS workspace accessible over secure landing zone" caption-side="bottom"}{: external download="deploy-arch-ibm-pvs-inf-full-stack.svg"}
6254

6355
## Design requirements
6456
{: #full-design-requirements}
65-
6657
![Design requirements for 'Power Virtual Server with VPC landing zone' - variation 'PowerVS workspace'.](heat-map-deploy-arch-ibm-pvs-inf-full-stack.svg "Design requirements"){: caption="Figure 2. Scope of the solution requirements" caption-side="bottom"}
6758

6859
IBM Cloud® Power Virtual Servers (PowerVS) is a public cloud offering that an enterprise can use to establish its own private IBM Power computing environment on shared public cloud infrastructure. PowerVS is logically isolated from all other public cloud tenants and infrastructure components, creating a private, secure place on the public cloud. This deployable architecture provides a framework to build a PowerVS offering according to the best practices and requirements from the IBM Cloud.

reference-architectures/import-workspace/deploy-arch-ibm-pvs-inf-import-workspace.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,6 @@ docs: https://cloud.ibm.com/docs/powervs-vpc
2121

2222
image_source: https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/reference-architectures/reference-architectures/import-workspace/deploy-arch-ibm-pvs-inf-import-workspace.svg
2323

24-
related_links:
25-
- title: 'SAP in IBM Cloud documentation'
26-
url: 'https://cloud.ibm.com/docs/sap'
27-
description: 'SAP in IBM Cloud documentation.'
28-
- title: 'Reference architecture for "Secure infrastructure on VPC for regulated industries" as standard variation'
29-
url: 'https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-vsi-ra'
30-
description: 'Reference architecture for "Secure infrastructure on VPC for regulated industries" as standard variation'
31-
3224
use-case: ITServiceManagement
3325

3426
industry: Technology

0 commit comments

Comments
 (0)