Skip to content
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

v0.10.4 docfixes tlake (#490) #492

Merged
merged 6 commits into from
Jan 18, 2018
Merged
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
4 changes: 0 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,3 @@ before_install:

script:
- make unittest
- ./scripts/ci-smoketest.sh

after_script:
- make destroy-smoketest
19 changes: 3 additions & 16 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,10 @@ unittest:
smoketest:
$(MAKE) -C tests/smoke test

systemtest:
$(MAKE) -C tests/system test

stresstest:
$(MAKE) -C tests/stress test

install-smoketest:
$(MAKE) -C cli install-smoketest
$(MAKE) -C setup install-smoketest
$(MAKE) -C api deps
$(MAKE) -C api release
$(MAKE) -C runner release

apply-smoketest:
$(MAKE) -C setup apply-smoketest

destroy-smoketest:
$(MAKE) -C setup destroy-smoketest
systemtest:
$(MAKE) -C tests/system test

.PHONY: release unittest smoketest install-smoketest apply-smoketest destroy-smoketest systemtest benchmark
.PHONY: release unittest smoketest stresstest systemtest
4 changes: 1 addition & 3 deletions docs-src/docs/guides/walkthrough/deployment-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,12 +265,10 @@ Your data should still be there!

### Cleanup

If you're finished with the example and don't want to continue with this walkthrough, you can instruct Layer0 to delete the environment and terminate the application.
When you're finished with the example, you can instruct Layer0 to delete the environment and terminate the application.

`l0 environment delete demo-env`

However, if you intend to continue through [Deployment 3](deployment-3), you will want to keep the resources you made in this section.


---

Expand Down
3 changes: 1 addition & 2 deletions docs-src/docs/guides/walkthrough/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# An Iterative Walkthrough

This guide aims to take you through three increasingly-complex deployment examples using Layer0.
This guide aims to take you through two increasingly-complex deployment examples using Layer0.
Successive sections build upon the previous ones, and each deployment can be completed either through the Layer0 CLI directly, or through Terraform using our custom [Layer0 Terraform Provider](/reference/terraform-plugin).

We assume that you're using Layer0 v0.9.0 or later.
Expand All @@ -17,7 +17,6 @@ As you do so, we will assume that your working directory matches the part of the

- [Deployment 1](deployment-1): Deploying a web service (Guestbook)
- [Deployment 2](deployment-2): Deploying Guestbook and a data store service (Redis)
- [Deployment 3](deployment-3): Deploying Guestbook, Redis, and a service discovery service (Consul)


---
Expand Down
10 changes: 5 additions & 5 deletions docs-src/docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,11 +230,11 @@ Add-JobTrigger -Name $jobname -Trigger (New-JobTrigger -AtStartup -RandomDelay 0
```


!!! note "Windows Environments"
Windows containers are still in beta.
You can view the documented caveats with ECS [here](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_Windows.html#windows_caveats).
When creating Windows environments in Layer0, the root volume sizes for instances are 200GiB to accommodate the large size of the containers.
It can take as long as 45 minutes for a new windows container to come online.
!!! note "Note: Windows Environments"
Windows environments have a few quirks and idiosyncracies to be aware of:
- You can view the documented caveats with ECS [here](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_Windows.html#windows_caveats).
- When creating Windows environments in Layer0, the root volume sizes for instances are 200GiB to accommodate the large size of the containers.
- It can take as long as 45 minutes for a new windows container to come online.

### environment delete
Use the `delete` subcommand to delete an existing Layer0 environment.
Expand Down
2 changes: 1 addition & 1 deletion docs-src/docs/reference/consul.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Layer0 Services that use Consul will need to add the [Registrator](#registrator-
## Consul Agent Container Definition

!!!warning
You must replace `<url>` with your Layer0 Consul Load Balancer's
You must replace `<url>` with your Layer0 Consul Load Balancer's URL.

```
{
Expand Down
8 changes: 4 additions & 4 deletions docs-src/docs/reference/task_definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ The following snippet contains the task definition for the [Guestbook](../guides
* **Name** The name of the container

!!! warning
If you wish to update your task definition, the container names **must** remain the same.
If any container names are changed or removed in an updated task definition,
ECS will not know how the existing container(s) should be mapped over and you will not be able to deploy the updated task definition.
If you encounter a scenario where you must change or remove a container's name in a task definition, we recommend re-creating the Layer0 Deploy and Service.
If you wish to update your task definition, the container names **must** remain the same.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these spaces consistent with other parts of the docs? Do we need to update elsewhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For any of the !!!warning-and-similar blocks, any text that should be included in the admonition needs to be indented by four spaces, so this spacing should be consistent with any other not-broken admonition blocks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'll look back through and see if there are any other broken ones.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Awesome, thanks. I'm going through and doing the same, so it'll be good to have another set of eyes.

If any container names are changed or removed in an updated task definition,
ECS will not know how the existing container(s) should be mapped over and you will not be able to deploy the updated task definition.
If you encounter a scenario where you must change or remove a container's name in a task definition, we recommend re-creating the Layer0 Deploy and Service.


* **Image** The Docker image used to build the container. The image format is `url/image:tag`
Expand Down
2 changes: 1 addition & 1 deletion docs-src/docs/reference/terraform-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ provider "layer0" {
The following arguments are supported:

!!! note
The `endpoint` and `token` variables for your layer0 api can be found using the [l0-setup endpoint](setup-cli/#endpoint) command
The `endpoint` and `token` variables for your layer0 api can be found using the [l0-setup endpoint](setup-cli/#endpoint) command.

* `endpoint` - (Required) The endpoint of the layer0 api
* `token` - (Required) The authentication token for the layer0 api
Expand Down
3 changes: 1 addition & 2 deletions docs/guides/walkthrough/deployment-2/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1105,9 +1105,8 @@ <h3 id="part-7-prove-it">Part 7: Prove It<a class="headerlink" href="#part-7-pro
Your data should still be there!</p>
<hr />
<h3 id="cleanup">Cleanup<a class="headerlink" href="#cleanup" title="Permanent link">#</a></h3>
<p>If you're finished with the example and don't want to continue with this walkthrough, you can instruct Layer0 to delete the environment and terminate the application.</p>
<p>When you're finished with the example, you can instruct Layer0 to delete the environment and terminate the application.</p>
<p><code>l0 environment delete demo-env</code></p>
<p>However, if you intend to continue through <a href="../deployment-3">Deployment 3</a>, you will want to keep the resources you made in this section.</p>
<hr />
<h2 id="deploy-with-terraform">Deploy with Terraform<a class="headerlink" href="#deploy-with-terraform" title="Permanent link">#</a></h2>
<p>As before, we can complete this deployment using Terraform and the Layer0 provider instead of the Layer0 CLI. As before, we will assume that you've cloned the <a href="https://github.com/quintilesims/guides">guides</a> repo and are working in the <code>walkthrough/deployment-2/</code> directory.</p>
Expand Down
3 changes: 1 addition & 2 deletions docs/guides/walkthrough/intro/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@


<h1 id="an-iterative-walkthrough">An Iterative Walkthrough<a class="headerlink" href="#an-iterative-walkthrough" title="Permanent link">#</a></h1>
<p>This guide aims to take you through three increasingly-complex deployment examples using Layer0.
<p>This guide aims to take you through two increasingly-complex deployment examples using Layer0.
Successive sections build upon the previous ones, and each deployment can be completed either through the Layer0 CLI directly, or through Terraform using our custom <a href="../../../reference/terraform-plugin">Layer0 Terraform Provider</a>.</p>
<p>We assume that you're using Layer0 v0.9.0 or later.
If you have not already installed and configured Layer0, see the <a href="../../../setup/install">installation guide</a>.
Expand All @@ -614,7 +614,6 @@ <h1 id="an-iterative-walkthrough">An Iterative Walkthrough<a class="headerlink"
<ul>
<li><a href="../deployment-1">Deployment 1</a>: Deploying a web service (Guestbook)</li>
<li><a href="../deployment-2">Deployment 2</a>: Deploying Guestbook and a data store service (Redis)</li>
<li><a href="../deployment-3">Deployment 3</a>: Deploying Guestbook, Redis, and a service discovery service (Consul)</li>
</ul>
<hr />

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/cli/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3382,12 +3382,12 @@ <h4 id="optional-arguments">Optional arguments<a class="headerlink" href="#optio


<div class="admonition note">
<p class="admonition-title">Windows Environments<p>Windows containers are still in beta. </p>
</p>
<p class="admonition-title">Note: Windows Environments</p>
<p>Windows environments have a few quirks and idiosyncracies to be aware of:
- You can view the documented caveats with ECS <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_Windows.html#windows_caveats">here</a>.
- When creating Windows environments in Layer0, the root volume sizes for instances are 200GiB to accommodate the large size of the containers.
- It can take as long as 45 minutes for a new windows container to come online. </p>
</div>
<p>You can view the documented caveats with ECS <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_Windows.html#windows_caveats">here</a>.
When creating Windows environments in Layer0, the root volume sizes for instances are 200GiB to accommodate the large size of the containers.<br />
It can take as long as 45 minutes for a new windows container to come online. </p>
<h3 id="environment-delete">environment delete<a class="headerlink" href="#environment-delete" title="Permanent link">#</a></h3>
<p>Use the <code>delete</code> subcommand to delete an existing Layer0 environment.</p>
<h4 id="usage_9">Usage<a class="headerlink" href="#usage_9" title="Permanent link">#</a></h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/consul/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -780,8 +780,8 @@ <h2 id="registrator-container-definition">Registrator Container Definition<a cla
<h2 id="consul-agent-container-definition">Consul Agent Container Definition<a class="headerlink" href="#consul-agent-container-definition" title="Permanent link">#</a></h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>You must replace <code>&lt;url&gt;</code> with your Layer0 Consul Load Balancer's URL.</p>
</div>
<p>You must replace <code>&lt;url&gt;</code> with your Layer0 Consul Load Balancer's</p>
<div class="codehilite"><pre><span></span>{
&quot;name&quot;: &quot;consul-agent&quot;,
&quot;image&quot;: &quot;progrium/consul&quot;,
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/task_definition/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -675,11 +675,11 @@ <h2 id="sample">Sample<a class="headerlink" href="#sample" title="Permanent link
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
</div>
<p>If you wish to update your task definition, the container names <strong>must</strong> remain the same.
If any container names are changed or removed in an updated task definition,
ECS will not know how the existing container(s) should be mapped over and you will not be able to deploy the updated task definition.
If you encounter a scenario where you must change or remove a container's name in a task definition, we recommend re-creating the Layer0 Deploy and Service.</p>
</div>
<ul>
<li><strong>Image</strong> The Docker image used to build the container. The image format is <code>url/image:tag</code><ul>
<li>The <code>url</code> specifies which Docker Repo to pull the image from
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/terraform-plugin/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1377,7 +1377,7 @@ <h3 id="argument-reference">Argument Reference<a class="headerlink" href="#argum
<p>The following arguments are supported:</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code>endpoint</code> and <code>token</code> variables for your layer0 api can be found using the <a href="../setup-cli/#endpoint">l0-setup endpoint</a> command</p>
<p>The <code>endpoint</code> and <code>token</code> variables for your layer0 api can be found using the <a href="../setup-cli/#endpoint">l0-setup endpoint</a> command.</p>
</div>
<ul>
<li><code>endpoint</code> - (Required) The endpoint of the layer0 api</li>
Expand Down
Loading