Skip to content

Commit c25947c

Browse files
committed
docs: further pass on prereq section
1 parent 05b84b8 commit c25947c

File tree

2 files changed

+34
-19
lines changed

2 files changed

+34
-19
lines changed

Diff for: docs/prereqs.md

+33-18
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,41 @@
1-
# Lab Prerequisites :white_check_mark:
1+
# Lab Prerequisites
22

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

5-
- IBM Cloud
6-
- An IBM Cloud Pay-Go or Subscription account
7-
- An IBMid
5+
## IBM Cloud
86

9-
:information_source: **Note**: Participants in the TechXchange classroom will be provided with credentials to access an IBM Cloud account during the lab.
10-
- [API key with the following permissions](https://cloud.ibm.com/docs/account?topic=account-userapikey&interface=ui#create_user_key)
7+
1. An IBM Cloud Pay-Go or Subscription account (trial accounts are not sufficient)
118

12-
| Service | Resources | Role |
13-
| -------- | ------- | ------- |
14-
| IBM Cloud Projects | Aldministrator |
15-
| Activity Tracker event routing | All | Editor |
16-
| Transit Gateway | All | Editor, Manager |
17-
| Schematics | All | Editor, Manager |
18-
| Key Protect | All | Editor, KeyPurge, Manager |
19-
| Cloud Object Storage | All | Editor, Manager |
20-
| VPC Infrastructure Services | All | Editor, Manager |
21-
| Resource group only | All resource group in the account | Viewer, Editor, Administrator|
9+
: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.
2210

23-
: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.
11+
2. A personal API Key associated with a user with the following permissions.
12+
13+
: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.
14+
15+
16+
| Service | Resources | Role |
17+
| -------- | ------- | ------- |
18+
| IBM Cloud Projects | All | Administrator |
19+
| Activity Tracker event routing | All | Editor |
20+
| Transit Gateway | All | Editor, Manager |
21+
| Schematics | All | Editor, Manager |
22+
| Key Protect | All | Editor, KeyPurge, Manager |
23+
| Cloud Object Storage | All | Editor, Manager |
24+
| VPC Infrastructure Services | All | Editor, Manager |
25+
| Resource group only | All resource group in the account | Viewer, Editor, Administrator|
26+
| Catalog Management | All | Editor, Publisher|
27+
28+
29+
To create an API Key: \
30+
1. In the IBM Cloud console, go to **Manage > Access (IAM) > API keys.** \
31+
2. Click **Create an IBM Cloud API key**. \
32+
3. Enter a name and description for your API key. \
33+
4. Click **Create** \
34+
5. Then, click **Show** to display the API key.
35+
36+
: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.
37+
38+
## Development environment
2439

2540
- A development computer with the following software.
2641
- [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)
@@ -33,4 +48,4 @@ Make sure that you meet the following prerequisites before you begin the lab.
3348
For more information, see [Generating an external SSH key](https://cloud.ibm.com/docs/vpc?topic=vpc-ssh-keys&interface=ui#generating-ssh-keys).
3449
- Optional: [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started)
3550

36-
:information_source: **Note**: Participants in the TechXchange classroom will be provided with a development VM with the prerequisite software installed.
51+
: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.

Diff for: docs/sidebar.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- [🌍 VPC Landing Zone](./about/20-vpc-landing-zone.md)
44
- [🏗️ Deployable architectures](./about/30-deployable-arch)
55
- [📚 IBM Cloud projects](./about/40-projects.md)
6-
- [📂 Lab Prerequisites](./prereqs.md)
6+
- [ Lab Prerequisites](./prereqs.md)
77
- [📂 Lab 1 - End-to-end deployment](./part1/00-objectives.md)
88
- [🚀 Deploy the landing zone VSI pattern](./part1/10-project.md)
99
- [👤 Operator Access](./part1/20-operator-access.md)

0 commit comments

Comments
 (0)