Skip to content

Prereq #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Two labs are available. The two labs are independent. However, the first lab is
In [Lab 1](./part1/00-objectives), you take the perspective of a cloud infrastructure engineer:

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.
2. Manually customize the deployed infrastructure in the account in the following ways:
a. Provide operator access through a "jump box" VSI.
b. Install an Apache server in one of the workload VPCs that serves the web pages.
2. Manually customize the deployed infrastructure in the account in the following ways: \
a. Provide operator access through a "jump box" VSI. \
b. Install an Apache server in one of the workload VPCs that serves the web pages. \
c. Expose the web pages that are served by the Apache server through a public VPC load balancer.

In [Lab 2](./part2/00-objectives), you are a DevOps/automation engineer:
Expand Down
77 changes: 46 additions & 31 deletions docs/prereqs.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,51 @@
# Lab Prerequisites :white_check_mark:
# Lab Prerequisites

Make sure that you meet the following prerequisites before you begin the lab.

- IBM Cloud
- An IBM Cloud Pay-Go or Subscription account
- An IBMid

:information_source: **Note**: Participants in the TechXchange classroom will be provided with credentials to access an IBM Cloud account during the lab.
- [API key with the following permissions](https://cloud.ibm.com/docs/account?topic=account-userapikey&interface=ui#create_user_key)

| Service | Resources | Role |
| -------- | ------- | ------- |
| IBM Cloud Projects | Aldministrator |
| Activity Tracker event routing | All | Editor |
| Transit Gateway | All | Editor, Manager |
| Schematics | All | Editor, Manager |
| Key Protect | All | Editor, KeyPurge, Manager |
| Cloud Object Storage | All | Editor, Manager |
| VPC Infrastructure Services | All | Editor, Manager |
| Resource group only | All resource group in the account | Viewer, Editor, Administrator|

:exclamation: **Important**: Participants in the TechXchange classroom will need to create an API key for their provided credentials. Please save the generated API key for later use.

- A development computer with the following software.
- [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)
- Text editor of your choice
- Web browser
- Tools to generate SSH key
- Linux and Mac come with ssh-keygen.
- Windows users can use [PuTTYgen](https://www.ssh.com/academy/ssh/putty/windows/puttygen)

For more information, see [Generating an external SSH key](https://cloud.ibm.com/docs/vpc?topic=vpc-ssh-keys&interface=ui#generating-ssh-keys).
## IBM Cloud

1. An IBM Cloud Pay-Go or Subscription account (trial accounts are not sufficient)

:information_source: **Note**: Participants in the TechXchange lab will be provided with user credentials to access a paid IBM Cloud account for the duration of the lab.

:exclamation: **Important**: If you are an existing active user of IBM Cloud, and if you are provided with user credentials for this lab, ensure that you do not have an existing active session on [cloud.ibm.com](https://cloud.ibm.com) using your own credentials prior to accessing the provided login page. If needed, log out from your existing session (top right icon in the IBM Cloud Console -> Log out) first.

2. A personal API Key associated with a user with the following permissions.

:information_source: **Note**: The user account provided in the TechXchange lab already has got the necessary permissions. Participants in the TechXchange lab only need to create an API Key as described below.


| Service | Resources | Role |
| -------- | ------- | ------- |
| IBM Cloud Projects | All | Administrator |
| Activity Tracker event routing | All | Editor |
| Transit Gateway | All | Editor, Manager |
| Schematics | All | Editor, Manager |
| Key Protect | All | Editor, KeyPurge, Manager |
| Cloud Object Storage | All | Editor, Manager |
| VPC Infrastructure Services | All | Editor, Manager |
| Resource group only | All resource group in the account | Viewer, Editor, Administrator|
| Catalog Management | All | Editor, Publisher|


To create an API Key: \
1. In the IBM Cloud console, go to **Manage > Access (IAM) > API keys.** \
2. Click **Create an IBM Cloud API key**. \
3. Enter a name and description for your API key. \
4. Click **Create** \
5. Then, click **Show** to display the API key.

:exclamation: **Important**: Please save the generated API key for later use in the labs. The API key is only available to be copied or downloaded at the time of creation. If the API key is lost, you can re-create a new API key.

## Development environment

A development computer with the following software:
- [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)
- Text editor of your choice
- Web browser
- Tools to generate SSH key
- Linux and Mac come with ssh-keygen.
- Windows users can use [PuTTYgen](https://www.ssh.com/academy/ssh/putty/windows/puttygen)
- Optional: [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started)

:information_source: **Note**: Participants in the TechXchange classroom will be provided with a development VM with the prerequisite software installed.
:information_source: **Note**: Participants in the TechXchange classroom will be provided with a development VM with the prerequisite software installed. You may however decide to use your own machine for convenience.
2 changes: 1 addition & 1 deletion docs/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [🌍 VPC Landing Zone](./about/20-vpc-landing-zone.md)
- [🏗️ Deployable architectures](./about/30-deployable-arch)
- [📚 IBM Cloud projects](./about/40-projects.md)
- [📂 Lab Prerequisites](./prereqs.md)
- [ Lab Prerequisites](./prereqs.md)
- [📂 Lab 1 - End-to-end deployment](./part1/00-objectives.md)
- [🚀 Deploy the landing zone VSI pattern](./part1/10-project.md)
- [👤 Operator Access](./part1/20-operator-access.md)
Expand Down