Skip to content
This repository has been archived by the owner on Jul 21, 2019. It is now read-only.

Add setup guide for deploying through CloudFormation #143

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
13 changes: 11 additions & 2 deletions content/latest/deploy/public-clouds/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@ menu:

<ul class="nav nav-tabs nav-tabs-yb">
<li>
<a href="#terraform" class="nav-link active" id="terraform-tab" data-toggle="tab" role="tab" aria-controls="terraform" aria-selected="true">
<a href="#cloudformation" class="nav-link active" id="cloudformation-tab" data-toggle="tab" role="tab" aria-controls="cloudformation" aria-selected="true">
<i class="icon-shell"></i>
CloudFormation
</a>
</li>
<li>
<a href="#terraform" class="nav-link" id="terraform-tab" data-toggle="tab" role="tab" aria-controls="terraform" aria-selected="true">
<i class="icon-shell"></i>
Terraform
</a>
Expand All @@ -27,7 +33,10 @@ menu:
</ul>

<div class="tab-content">
<div id="terraform" class="tab-pane fade show active" role="tabpanel" aria-labelledby="terraform-tab">
<div id="cloudformation" class="tab-pane fade show active" role="tabpanel" aria-labelledby="cloudformation-tab">
{{% includeMarkdown "aws/cloudformation.md" /%}}
</div>
<div id="terraform" class="tab-pane fade" role="tabpanel" aria-labelledby="terraform-tab">
{{% includeMarkdown "aws/terraform.md" /%}}
</div>
<div id="manual-deployment" class="tab-pane fade" role="tabpanel" aria-labelledby="manual-deployment-tab">
Expand Down
43 changes: 43 additions & 0 deletions content/latest/deploy/public-clouds/aws/cloudformation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## Prerequisites

Download the template file
```sh
$ wget https://raw.githubusercontent.com/yugabyte/aws-cloudformation/master/yugabyte_cloudformation.yaml
```

## AWS Command Line

Create CloudFormation template:

```sh
$ aws cloudformation create-stack --stack-name <stack-name> --template-body yugabyte_cloudformation.yaml --parameters DBVersion=1.2.8.0, KeyName=<ssh-key-name>
```
Once resource creation completes, check that stack was created:

```sh
$ aws cloudformation describe-stacks --stack-name <stack-name>
```
From this output, you will be able to get the VPC id and YugaByte DB admin URL.

## AWS Console

1. Navigate to your AWS console and open the CloudFormation dashboard. Click `Create Stack`
<img title="Cloud Formation dashboard" class="expandable-image" src="/images/deploy/aws/aws-cf-initial-dashboard.png" />
<br>
2. Prepare template using the downloaded template
<img title="Prepare template" class="expandable-image" src="/images/deploy/aws/aws-cf-prepare-template.png" />
<br>
3. Specify the template file downloaded in Prerequisites: `yugabyte_cloudformation.yaml`
<img title="Upload template" class="expandable-image" src="/images/deploy/aws/aws-cf-upload-template.png" />
<br>
4. Provide the required parameters. Each of these fields are prefilled with information from the configuration yaml file that was uploaded. `LatestAmiId` refers to the id of the machine image to use, see [more](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html).
<img title="Provide Parameters" class="expandable-image" src="/images/deploy/aws/aws-cf-provide-parameters.png" />
<br>
5. Configure Stack options. For more information about these options click [here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html).
<img title="Configure options" class="expandable-image" src="/images/deploy/aws/aws-cf-configure-options.png" />
<br>
6. Finalize changes before creation
<img title="Review stack" class="expandable-image" src="/images/deploy/aws/aws-cf-review-stack.png" />
<br>
7. Check stack output in dashboard
<img title="Check output" class="expandable-image" src="/images/deploy/aws/aws-cf-check-output.png" />
9 changes: 8 additions & 1 deletion layouts/_default/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,14 @@ <h1>{{ .Description }} {{ if .IsDraft }} (Draft){{ end }}{{ if .Page.Params.beta
{{ partial "footer_links" . }}
<!--{{ partial "feedback" . }}-->
</article>

<div class="modal fade" id="imageModal" tabindex="-1" role="dialog" aria-labelledby="imageModal" aria-hidden="true">
<div class="modal-dialog" role="document">
<div class="modal-content">
<div class="modal-body">
</div>
</div>
</div>
</div>
<div class="results" role="status" aria-live="polite">
<div class="scrollable">
<div class="wrapper">
Expand Down
10 changes: 10 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,16 @@ $(document).ready(() => {
},
}).show();

$('.expandable-image').click(function () {
$('#imageModal').modal('show');
$('#imageModal .modal-body').html($(this).clone());
});

$('#imageModal').on('hide.bs.modal', () => {
$('#imageModal .modal-body').html('');
$('#imageModal').hide();
});

((document, Clipboard) => {
const $codes = document.querySelectorAll('pre');
// Check if there's a language class (mark of to-be-copied content)
Expand Down
Binary file added static/images/deploy/aws/aws-cf-check-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/deploy/aws/aws-cf-review-stack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion styles/_navbar.scss
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body {
left: 0;
width: 100%;
height: 75px;
z-index: 10000;
z-index: 5000;
}

@media (min-width: 992px) {
Expand Down
5 changes: 3 additions & 2 deletions styles/_toc.scss
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,9 @@ pre code.copy + textarea + button.copy, .copy pre code + textarea + button.copy,
position: absolute;
top: 0;
left: 0;
font: normal normal normal 18px/1 FontAwesome;
content: '\F00C';
font: normal normal normal 18px/1 'Font Awesome 5 Free';
font-weight: 900;
content: '\f00c';
color: #fff;
text-align: center;
border-radius: 2px;
Expand Down
8 changes: 7 additions & 1 deletion styles/_yuga_content.scss
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
list-style-type: none;
&:before {
content: '\f067';
font-family: 'FontAwesome';
font-family: 'Font Awesome 5 Free';
font-weight: 900;
font-size: 13px;
background-color: transparent;
border: none;
Expand Down Expand Up @@ -75,3 +76,8 @@
}
}
}

.article .expandable-image {
display: block;
width: 350px;
}
20 changes: 19 additions & 1 deletion styles/_yuga_overrides.scss
Original file line number Diff line number Diff line change
Expand Up @@ -991,7 +991,7 @@ h1, h2, h3, h4, h5, h6 {
font-size: 14px;
background-color: #f75821;
cursor: pointer;
z-index: 9999;
z-index: 4999;

-moz-transition: bottom 300ms ease;
-webkit-transition: bottom 300ms ease;
Expand Down Expand Up @@ -1169,6 +1169,24 @@ h1, h2, h3, h4, h5, h6 {
}
}

/** Bootstrap Overrides **/
.modal {
z-index: 6000;
}
.modal.show .modal-dialog {
-webkit-transform: translate(0, 0);
transform: translate(0, 0);
min-width: 1280px;

img {
width: 100%;
}
}
.modal-backdrop {
z-index: 5500;
}
/***********************/

@media screen and (max-width: 959px) {
.breadcrumbs {
margin-top: 0;
Expand Down