Skip to content
This repository was archived by the owner on Aug 5, 2024. It is now read-only.

Commit e7ce79d

Browse files
authored
Update Getting_Started.md
I made some edits to a few items as they were out of date information
1 parent 81cf00f commit e7ce79d

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

automation/Getting_Started.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The following steps walk you through how to get a pre-built fhe-toolkit docker i
77
* You can use any Linux or Unix based (Mac will work) computer that the ibm cloud supports
88

99
* If the deploy script will be run on MacOS:
10-
* Requires a `python` installation
10+
* Requires a `python` installation, python 3.6+
1111
* Install `gpg`
1212
* MacOS with homebrew: `brew install gpg`
1313
* To install homebrew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
@@ -16,14 +16,15 @@ The following steps walk you through how to get a pre-built fhe-toolkit docker i
1616
* Install `pyenv`
1717
* MacOS with homebrew: `brew install pyenv`
1818
* MacOS without homebrew: `curl https://pyenv.run | bash`
19+
1920
* Otherwise, install these dependencies with your Linux distro's package manager
2021

2122
### Creating an IBM Cloud account
2223
* Create an IBM Cloud account if you have never done so. To do this, go to [https://cloud.ibm.com/login](https://cloud.ibm.com/login) in your web browser.
2324

2425
If you don't have an account, select the "Create an account" link. [https://cloud.ibm.com/registration](https://cloud.ibm.com/registration)
2526

26-
* Once you have made an account or logged into your existing account, you must then make an API Key in your ibm cloud account
27+
* Once you have made an account or logged into your existing account, you must then make an API Key in your IBM Cloud account
2728

2829
* At the top of the screen navigate the menus from Manage > Access (IAM). From the screen shown select the *My IBM Cloud API keys* tile. .
2930

@@ -40,6 +41,7 @@ The following steps walk you through how to get a pre-built fhe-toolkit docker i
4041

4142

4243
* Update or install `ibmcloud` CLI on the machine you will be using.
44+
4345
[https://cloud.ibm.com/docs/cli?topic=cli-getting-started](https://cloud.ibm.com/docs/cli?topic=cli-getting-started)
4446

4547
NOTE: If you have a mac, you can just open a terminal and issue the following command:
@@ -113,7 +115,7 @@ Space:
113115

114116
* Create a Resource Group in your account
115117

116-
my resource group is : `super_secret`
118+
my resource group is called : `super_secret`
117119

118120
Login to cloud.ibm.com -> `Manage -> Account -> Account Resources -> Resource Groups -> Create`
119121

@@ -134,7 +136,7 @@ Before you can run `DeployToHPVS.sh`, you must tell it:
134136
##### Automatic key generation
135137
If `DeployToHPVS.sh` called with the `-c` option, the interactive wizard will walk you through the process of key generation.
136138

137-
The root and repository keys are generated automatically by `docker trust`, which is invoked by `DeployToHPVS.sh`. The HPVS registration encryption key is hardcoded into `DeployToHPVS.sh`. The other keys (the vendor and delegation keys) must be generated ahead of time.
139+
The root and repository keys are generated automatically by `docker trust`, which is invoked by `DeployToHPVS.sh`. The HPVS registration encryption key is hardcoded into `DeployToHPVS.sh`. The other keys (the vendor and delegation keys) the interactive wizard will prompt if you want to generate them. If you want to do it manually, follow the next two steps. If you want the interactive wizard to do it for you, skip ahead to "Running the HPVS Deploy script" section.
138140

139141
##### Vendor key
140142

@@ -232,7 +234,7 @@ Find the reclamation id of the running resource and use that in the next command
232234

233235
docker image rmi -f [docker image id in this example it was 86c15e968f8b]
234236

235-
When a new image is signed there are a few keys that are created and become associated with that image. If you wish to push that image to the virtual server again, you will need those keys to sign and verify. This is the key pair in the config file called the delegation key. It is signed using a repo key that is stored in `~/.docker/trust/private`. The name of the key is a random string that is generated. You will need to hang onto this key to re-sign this image and any others associated with it. You can remove the delegation key if you no longer need it, but leave the repo key unless you are going to create a new one.
237+
When a new image is signed, there are a few keys that are created and become associated with that image. If you wish to push that image to the virtual server again, you will need those keys to sign and verify. This is the key pair in the config file called the delegation key. It is signed using a repo key that is stored in `~/.docker/trust/private`. The name of the key is a random string that is generated. You will need to hang onto this key to re-sign this image and any others associated with it. You can remove the delegation key if you no longer need it, but leave the repo key unless you are going to create a new one.
236238

237239
- delete the docker trust info
238240

0 commit comments

Comments
 (0)