Skip to content

Commit

Permalink
docs: Added details found needed while onboarding (awslabs#593)
Browse files Browse the repository at this point in the history
  • Loading branch information
maghirardelli authored Jul 22, 2021
1 parent feca167 commit 86426d7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/docs/deployment/deployment/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,13 @@ _**Note**: You can create your own machine image if you do not wish to use the o
To deploy the machine images SDC, follow the steps outlined in the readme file located in `main/solution/machine-images/README.md`. Additionally, perform the following actions:

1. Install Packer 1.6.0 by using [pkenv](https://github.com/iamhsa/pkenv). Packer 1.6.0 creates a custom AMI that is uploaded to the Service Workbench deployment.
2. Fetch the package with `curl` or `wget`, unzip the package, and copy it to the `directory /usr/local/bin`.
3. Change directory to `/main/solution/machine-images`.
4. Run the command below. The command takes approximately 15 minutes to complete:
2. Change directory to `/main/solution/machine-images`.
3. Run the command below. The command takes approximately 15 minutes to complete:
```
`pnpx sls build-image -s <mystage>`
pnpx sls build-image -s <mystage>
```
- ** If the above command does not work, you might have to fetch the custom AMI package created in step 1 with `curl` or `wget`, unzip the package, and copy it to the `directory /usr/local/bin`. Resume from step 2.**

For examples of how to build a custom AMI, refer to the following scripts:

`config/infra/packer-ec2-<platform>-workspace.json`
Expand Down
2 changes: 2 additions & 0 deletions main/end-to-end-tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ To run the E2E tests, you will need the following items:
- Username and password of an admin for the Service Workbench environment
- Username and password of a researcher for the Service Workbench environment
- A project set up for that researcher that can launch EC2 workspaces and Sagemaker workspaces
- Within that project, a study where the researcher is admin
- Within that project, a study where the researcher is not an admin
- A configured EC2 workspace
- A configured Sagemaker workspace

Expand Down

0 comments on commit 86426d7

Please sign in to comment.