lukechilds
/
docs
mirror of https://github.com/lukechilds/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Fixing some problems spotted in formattting 

Updating with a couple of tweaks
Placing sub in card

Signed-off-by: Mary Anthony <mary@blockstack.com>
feat/clarity-updates
Mary Anthony 6 years ago
parent
db44245742
commit
c3fd95f7f7
1 changed files with 95 additions and 88 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 183
      _storage/amazon-s3-deploy.md

183
_storage/amazon-s3-deploy.md
View File

@ -55,7 +55,7 @@ If `watch` is not located, install it on your workstation.
The system opens the EC2 dashboard. The system opens the EC2 dashboard.
4. Enter `blockstack-gaia_hub-[a-z]*-[.0-9]*-hvm` in the search bar. 4. Enter `blockstack-gaia` in the search bar.
The system finds AMIs in the Marketplace and the Community. The system finds AMIs in the Marketplace and the Community.
@ -67,109 +67,116 @@ If `watch` is not located, install it on your workstation.
6. Select the most recent version of the image. 6. Select the most recent version of the image.
* Current Release: `2.5.3`
Each image name has this format: Each image name has this format:
`blockstack-gaia_hub-STORAGETYPE-VERSION-hvm - ami-BUILDTAG` `blockstack-gaia_hub-STORAGETYPE-VERSION-hvm - ami-BUILDTAG`
So, the `blockstack-gaia_hub-ephemeral-2.5.3-hvm - ami-0c8fc48c10a42737e` image uses ephemeral storage, is at version `2.5.3` and has the `0c8fc48c10a42737e` tag.
You can choose an image that uses ephemeral or EBS storage. The ephemeral You can choose an image that uses **ephemeral** or **EBS** storage. The ephemeral
storage is very small but free. Only choose this if you plan to test or use storage is very small but free. Only choose this if you plan to test or use
a personal hub. Otherwise, choose the AMI for elastic block storage (EBS) which provides a persistent data store on a separate disk backed by [EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html). a personal hub. Otherwise, choose the AMI for elastic block storage (EBS) which provides a persistent data store on a separate disk backed by [EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html).
So, the `blockstack-gaia_hub-ephemeral-2.5.3-hvm - ami-0c8fc48c10a42737e` image uses ephemeral storage, is at version `2.5.3` and has the `0c8fc48c10a42737e` tag.
After you select an image, the system displays **Step 2: Choose an Instance Type** page. After you select an image, the system displays **Step 2: Choose an Instance Type** page.
![](/storage/images/tier-2-image.png) ![](/storage/images/tier-2-image.png)
7. Select **t2.micro** and choose **Next: Configure Instance Details**. 7. Select **t2.micro** and choose **Next: Configure Instance Details**.
<hr>
To configure instance details, do the following: To configure instance details, do the following:
1. Select a VPC. <div class="uk-card uk-card-body">
<ol>
A default VPC is created with a free tier account. You can use this <li>
default VPC. Or you can choose another VPC. If you choose another VPC, <p>Select a VPC.</p>
ensure the `Subnet` value is set to a subnet reachable by a public IP. <p>A default VPC is created with a free tier account. You can use this
default VPC. Or you can choose another VPC. If you choose another VPC,
{% include important.html content="If you're using a private subnet, you ensure the <code class="highlighter-rouge">Subnet</code> value is set to a subnet reachable by a public IP.
should attach an elastic IP (EIP) to the VM. This EIP allows you to </p>
reboot the instance without worrying whether the address will reset. To <div class="uk-alert-warning uk-alert" uk-alert=""><b>Important:</b> If you're using a private subnet, you
attach an IP, <strong>press allocate new address</strong> and follow the should attach an elastic IP (EIP) to the VM. This EIP allows you to
instructions to [attach the EIP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-associating) to your new EC2 instance." %} reboot the instance without worrying whether the address will reset. To
attach an IP, <strong>press allocate new address</strong> and follow the
2. Set **Protect against accidental termination**. instructions to <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#using-instance-addressing-eips-associating" target="_blank">attach the EIP</a> to your new EC2 instance.
</div>
If you terminate a Gaia instance, you lose all the data associated with it. Protection adds an extra step to terminating your Gaia instance. </li>
<li>
3. Open the **Advanced Details**. <p>Set <strong>Protect against accidental termination</strong>.</p>
<p>If you terminate a Gaia instance, you lose all the data associated with it. Protection adds an extra step to terminating your Gaia instance.</p>
At this point, you are going to configure environment variables for your instance. </li>
<li>
4. Paste the following into the **Advanced Details**. <p>Open the <strong>Advanced Details</strong>.</p>
<p>At this point, you are going to configure environment variables for your instance.</p>
```json </li>
{ <li>
"ignition": { "version": "2.2.0" }, <p>Paste the following into the <strong>Advanced Details</strong>.</p>
"storage": {
"files": [{ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
"filesystem": "root", {
"path": "/etc/environment", "ignition": { "version": "2.2.0" },
"mode": 420, "storage": {
"contents": { "files": [{
"source": "data:application/octet-stream,API_KEY%3D<KEYPHRASE>%0ADOMAIN%3D<DOMAIN_NAME_VALUE>%0ASTAGING%3D<STAGING_VALUE>" "filesystem": "root",
"path": "/etc/environment",
"mode": 420,
"contents": {
"source": "data:application/octet-stream,API_KEY%3DKEYPHRASE%0ADOMAIN%3DNAME_OF_DOMAIN%0ASTAGING%3DSTAGING_VALUE"
}
}]
} }
}] }
} </code></pre></div> </div>
} </li>
``` <li>
<p>Replace the following values in the JSON.</p>
5. Replace the following values in the JSON. <table class="uk-table uk-table-small uk-table-divider">
<tbody>
<table class="uk-table uk-table-small uk-table-divider"> <tr>
<tr> <th>Value</th>
<th>Value</th> <th>Description</th>
<th>Description</th> </tr>
</tr> <tr>
<tr> <td><code>&lt;KEYPHRASE&gt;</code></td>
<td><code>&lt;KEYPHRASE&gt;</code></td> <td>A phrase to pass when using the hub admin. For example, <code>hubba</code> is a fun key phrase.</td>
<td>A phrase to pass when using the hub admin. For example, <code>hubba</code> is a fun key phrase.</td> </tr>
</tr> <tr>
<tr> <td><code>&lt;NAME_OF_DOMAIN&gt;</code></td>
<td><code>&lt;DOMAIN_NAME_VALUE&gt;</code></td> <td>Your hub's domain name. For example, <code>maryhub.ml</code> is the domain name in this example.</td>
<td>Your hub's domain name. For example, <code>maryhub.ml</code> is the domain name in this example.</td> </tr>
</tr> <tr>
<tr> <td><code>&lt;STAGING_VALUE&gt;</code></td>
<td><code>&lt;STAGING_VALUE&gt;</code></td> <td>
<td><p>Indicates what type of SSL to create, testing (`1`) or production (`0`). Set testing if you want to test without worrying about rate limiting. A testing cerificate is not secure.</p> <p>Indicates what type of SSL to create, testing (`1`) or production (`0`). Set testing if you want to test without worrying about rate limiting. A testing cerificate is not secure.</p>
<p>For this tutorial, use production (`0`).</p>
<p>For this tutorial, use production (`0`).</p> </td>
</td> </tr>
</tr> </tbody>
</table> </table>
</li>
6. Check your **Advanced Details** they should look similar to the following: <li>
<p>Check your <strong>Advanced Details</strong> they should look similar to the following:</p>
```
{ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> {
"ignition": { "version": "2.2.0" }, "ignition": { "version": "2.2.0" },
"storage": { "storage": {
"files": [{ "files": [{
"filesystem": "root", "filesystem": "root",
"path": "/etc/environment", "path": "/etc/environment",
"mode": 420, "mode": 420,
"contents": { "contents": {
"source": "data:application/octet-stream,API_KEY%3Dhubba%0ADOMAIN%3Dmaryhub.ml%0ASTAGING%3D0" "source": "data:application/octet-stream,API_KEY%3Dhubba%0ADOMAIN%3Dmaryhub.ml%0ASTAGING%3D0"
} }
}] }]
} }
} }
``` </code></pre></div> </div>
</li>
</ol>
</div>
At this point, you have configured your instance details. At this point, you have configured your instance details.
<hr>
8. Choose **Next: Add Storage**. 8. Choose **Next: Add Storage**.
@ -368,11 +375,11 @@ Each service plays a particular role in running your Gaia hub.
<tbody> <tbody>
<tr> <tr>
<td><code>certbot</code></td> <td><code>certbot</code></td>
<td>Service running Let's Encrypt `certbot` client to support SSL. Certbot renews your certificates and reloads Nginx to pick up the changes. This service will run 2x per day checking if the certificate needs to be renewed. </td> <td>Service running Let's Encrypt <code>certbot</code> client to support SSL. Certbot renews your certificates and reloads Nginx to pick up the changes. This service will run 2x per day checking if the certificate needs to be renewed. </td>
</tr> </tr>
<tr> <tr>
<td><code>nginx</code></td> <td><code>nginx</code></td>
<td>Runs an Nginx proxy in front of the Gaia Hub. This service does things like rate-limiting, SSL termination, and redirects to HTTPS. Your nginx service relies on your hub's <code>readURL</code> to make requests. Changes to a hub's <code>readURL</code> must be reflected in the <code>nginx</code> service configuration in </code>/gaia/nginx/conf.d/default.conf</code></td> <td>Runs an Nginx proxy in front of the Gaia Hub. This service does things like rate-limiting, SSL termination, and redirects to HTTPS. Your nginx service relies on your hub's <code>readURL</code> to make requests. Changes to a hub's <code>readURL</code> must be reflected in the <code>nginx</code> service configuration in <code>/gaia/nginx/conf.d/default.conf</code></td>
</tr> </tr>
<tr> <tr>
<td><code>gaia-admin</code></td> <td><code>gaia-admin</code></td>
@ -396,7 +403,7 @@ Each service plays a particular role in running your Gaia hub.
### Locations of key files ### Locations of key files
<table> <table class="uk-table uk-table-small uk-table-divider">
<thead> <thead>
<tr> <tr>
<th>File or Directory</th> <th>File or Directory</th>
@ -415,12 +422,12 @@ Each service plays a particular role in running your Gaia hub.
</tr> </tr>
<tr> <tr>
<td><code>/gaia/gaia.env</code></td> <td><code>/gaia/gaia.env</code></td>
<td>Contains the environment variables used by the Gaia systemd unit-files <td>Contains the environment variables used by the Gaia <code>systemd</code> unit-files.
</td> </td>
</tr> </tr>
<tr> <tr>
<td><code>reset-ssl-certs.service</code></td> <td><code>reset-ssl-certs.service</code></td>
<td>Removes all existing certificates and restarts all the Gaia hub services. <br>* Use this sparingly, since the Letsencrypt service will throttle too many requests for certificates </td> <td>Removes all existing certificates and restarts all the Gaia hub services. Use this sparingly, since the Lets Encrypt service will throttle too many requests for certificates.</td>
</tr> </tr>
<tr> <tr>
<td><code>/gaia/hub-config</code></td> <td><code>/gaia/hub-config</code></td>
@ -440,11 +447,11 @@ Each service plays a particular role in running your Gaia hub.
</tr> </tr>
<tr> <tr>
<td><code>/gaia/nginx/certbot/conf</code></td> <td><code>/gaia/nginx/certbot/conf</code></td>
<td>Letsencrypt SSL certificates/configs</td> <td>Lets Encrypt SSL certificates/configs.</td>
</tr> </tr>
<tr> <tr>
<td><code>/gaia/scripts</code></td> <td><code>/gaia/scripts</code></td>
<td>Scripts run by the systemd services on startup</td> <td>Scripts run by the systemd services on startup.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

Write Preview
Loading…
Cancel
Save