-
Notifications
You must be signed in to change notification settings - Fork 2.1k
added instructions for AWS #817
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please squash your 2 commits and sign the resulting commit using git commit -s.
docs/dev-machine-setup.md
Outdated
| Firecracker development environment on AWS can be setup using bare metal instances. Follow these steps to create a bare metal instance. | ||
|
|
||
| 1. If you don't already have an AWS account, create one: https://portal.aws.amazon.com/billing/signup. | ||
| 1. Install AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This step is not mandatory because you can start the instance from the AWS console. Also, it seems like you are not using the AWS cli anyway.
docs/dev-machine-setup.md
Outdated
| 1. Login to the newly created instance: | ||
|
|
||
| ``` | ||
| ssh -i <ssh-key> ubunut@<public-ip> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ssh -i <ssh-key> ubunut@<public-ip> | |
| ssh -i <ssh-key> ubuntu@<public-ip> |
docs/dev-machine-setup.md
Outdated
| ``` | ||
|
|
||
| Now you can continue with the Firecracker [Getting Started](getting-started.md) | ||
| instructions to install and configure Firecracker in the new VM. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rephrase this sentence (i.e ...instructions to install and configure Firecracker in the new VM) since you are not installing Firecracker in a VM you are using Firecracker to spawn a microVM.
docs/dev-machine-setup.md
Outdated
| ### AWS | ||
|
|
||
| `[TODO]` | ||
| Firecracker development environment on AWS can be setup using bare metal instances. Follow these steps to create a bare metal instance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you make you all the lines maximum 80 characters long?
docs/dev-machine-setup.md
Outdated
| `[TODO]` | ||
| Firecracker development environment on AWS can be setup using bare metal instances. Follow these steps to create a bare metal instance. | ||
|
|
||
| 1. If you don't already have an AWS account, create one: https://portal.aws.amazon.com/billing/signup. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: do not use bare URL in markdown. One suggestion would be to re-write it as:
... create on using the [AWS portal](https://portal.aws.amazon.com/billing/signup).
or whatever else sounds better.
docs/dev-machine-setup.md
Outdated
| Firecracker development environment on AWS can be setup using bare metal instances. Follow these steps to create a bare metal instance. | ||
|
|
||
| 1. If you don't already have an AWS account, create one: https://portal.aws.amazon.com/billing/signup. | ||
| 1. Login to AWS console: https://console.aws.amazon.com/console/home?region=us-east-1. Bare metal instances are only supported in `US East (N. Virginia)` region at this time. This region is preselected for you in the Console. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bare URL, can you re-write it as:
Login to the [AWS Console](https://console.aws.amazon.com/console/home?region=us-east-1).
a641260 to
d64c587
Compare
Signed-off-by: Arun Gupta <[email protected]>
Signed-off-by: Arun Gupta <[email protected]>
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.