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

Add Cloud link to Azure topics #2713

Merged
merged 16 commits into from
May 2, 2017
Merged

Add Cloud link to Azure topics #2713

merged 16 commits into from
May 2, 2017

Conversation

londoncalling
Copy link
Contributor

@londoncalling londoncalling commented Apr 10, 2017

What's changed

  • Adding topics on how to link Docker Cloud to Microsoft Azure Cloud Services, work-in-progress (WIP), still includes lots of TBD's

Topics to review

The relevant pages are on the Netlify preview are:

Reviewers

@KickingTheTV @MaximeHeckel @pkennedyr @jsouth

Signed-off-by: Victoria Bialas victoria.bialas@docker.com

@londoncalling
Copy link
Contributor Author

londoncalling commented Apr 12, 2017

Reviewers

@KickingTheTV @jsouth @MaximeHeckel @pkennedyr
Please take a look at the following updated docs pages on Netlify:

These are docs topics related to these Jira issues:

@mstanleyjones @johndmulhausen Please verify tabs implementation

Questions:

  1. Where and at what point does the user need to add their SSH key?
  2. I plan to add additional links, detail, and screen snaps to the first topic on Creating a Swarm. What else do you all think is needed to complete these topics for this week?

Copy link

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

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

The tabs look and work great! Bravo!

I left a couple suggestions, including adding markdown=1 to each of the <div> tags which contains Markdown, so you don't have to use the capture/markdownify trick at all.

### Check for existing SSH keys

You may not need to generate a new SSH key if you have an existing key that you
want to multi-purpose.

Choose a reason for hiding this comment

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

s/multi-purpose/reuse

Copy link
Contributor Author

Choose a reason for hiding this comment

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

DONE

<li><a data-toggle="tab" data-target="#linux-add-keys" data-group="linux">Linux</a></li>
</ul>
<div class="tab-content">
<div id="mac-add-keys" class="tab-pane fade in active">

Choose a reason for hiding this comment

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

I think you may need to add markdown=1 to this div and any div whose contents contain Markdown. Then you don't need to do the capture and then display.

Copy link
Contributor Author

@londoncalling londoncalling Apr 12, 2017

Choose a reason for hiding this comment

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

Tested this, but it didn't work as reliably as the current strategy:

{% capture some-label %}
 MARKDOWN CONTENT 
{% endcapture %}
{{ some-label | markdownify }}

So leaving as is for now. NOT DOING THIS.

```

2. On macOS Sierra 10.12.2 or newer, modify your
`~/.ssh/config` file to automatically load keys into the `ssh-agent` and store

Choose a reason for hiding this comment

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

Indent these lines to line up with On

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This looks lined up to me in source and on the rendered page. NOT DONE.


3. Add your SSH private key to the ssh-agent, using the default macOS `ssh-add` command.

```none

Choose a reason for hiding this comment

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

Why not use the bash hint here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Keeping same as GitHub instructions. Not sure what you mean. Feel free to update the file with a new PR later?

{% capture mac-content-add %}
1. Start the `ssh-agent` in the background.

```none

Choose a reason for hiding this comment

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

Which part of this does the user type and which is the response?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

DONE.

2. Paste the text below, substituting in your GitHub email address.

```none
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

Choose a reason for hiding this comment

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

You might want to show the option to control the file name of the keys, so they are not just the default. The flag is -f. So you might do like -f docker-key

It's a good idea to have a key per area of concern, rather than one key for your whole life. This way if you need to rotate or revoke a key later, it is minimally disruptive.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Leaving for now. Feel free to update these files later with a new PR.

@@ -0,0 +1,14 @@
SSH is a secure protocol for accessing remote machines and applications. It

Choose a reason for hiding this comment

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

Should we add SSH to the glossary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. Will do later.

instances. The instances are then joined to a swarm and the swarm is configured
using your input. When you access the swarm from Docker Cloud, the system
forwards your commands directly to the Docker instances running in the swarm.
When you create a swarm, Docker Cloud connects to the Cloud provider on your

Choose a reason for hiding this comment

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

does Cloud provider really need to be capitalized?

Copy link
Contributor Author

@londoncalling londoncalling Apr 13, 2017

Choose a reason for hiding this comment

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

It's changing to service provider anyway. DONE.


## Create a swarm
To create a swarm, you need to give Docker Cloud permission to deploy swarm
nodes on your behalf in your cloud services provider account. Follw the steps in these topics depending on which Cloud provider you want to link:

Choose a reason for hiding this comment

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

nit: typo "follw"


### Create a new SSH key

{% include content/ssh-gen-keys.md %}

Choose a reason for hiding this comment

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

It occurs to me that having _includes/content/ doesn't really provide much organizational benefit. Maybe make a folder called _includes/ssh and use that for these topics? We probably need to come up with a sensible way to organize this stuff as we try to leverage reuse more.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, I thought about that. For the short term, I started all these filenames with ssh- but a content specific subfolder would be better.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

DONE.

@londoncalling
Copy link
Contributor Author

londoncalling commented Apr 12, 2017

@KickingTheTV @pkennedyr FYI, here are notes from our quick chat this morning:

  1. Re-work Swarm docs organization as follows, with separate topics:
  • Linking to Amazon Web Services
  • Linking to Azure Microsoft Azure
  • Create a Swarm in AWS
  • Create a Swarm in Azure
  • Setting up SSH keys
  1. Add second-to-last step in "Linking to Azure" to grant Docker Cloud access permissions to Azure. azure-permissions

  2. Change Cloud Providers to Service Providers

  3. Add more screen snaps (AWS, Azure, Docker Cloud)

  4. Vicky will test both procedures and all docs topics (Link to AWS, Create a swarm in AWS, Link to Azure, Create a swarm in Azure).

  5. Docs to be published on Monday 4/17 (first day of DockerCon) along with feature release.

@pkennedyr
Copy link
Contributor

Thanks, @londoncalling - the plan SGTM.

@londoncalling
Copy link
Contributor Author

londoncalling commented Apr 13, 2017

@KickingTheTV @pkennedyr

  1. The topic reorganization is largely done: https://deploy-preview-2713--docker-docs.netlify.com/docker-cloud/cloud-swarm/.
  • There are separate topics for Linking Docker Cloud to AWS and Linking Docker Cloud to Azure
  • The SSH key information is in a stand-alone topic, and linked to from the "Linking Azure" topic
  1. I still need to add screen snaps and flesh out the "create swarms" topics with specifics of each provider. Getting these topics completed is somewhat dependent on getting the linking working;
    e.g., we hit an intermittent bug with linking to Azure

  2. TBD notes are in red to make them stand out.

  3. Links to videos per Ryan are on these pages, please check them out and let me know if they are what you want. We can do more of these as needed:

Also added ssh to glossary per @mstanleyjones comments, and noted limitations of autoredeploy to latest tagged images per user feedback.

when using Docker for AWS. (To learn more, see
[Why Docker for AWS](/docker-for-aws/why.md).)

> **Note**: At this time, you cannot add or remove nodes from a swarm from within Docker Cloud. To add new nodes or remove nodes from an existing swarm,
Copy link
Contributor

Choose a reason for hiding this comment

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

Since users will be able to remove nodes from a swarm via the Terminate option, let's remove the "remove nodes" references in this section.

* Enable or disable Cloudwatch for container logging. (It is enabled by default.)

<font style="color:red;">
RYAN, ALBERTO:<br>
Copy link
Contributor

Choose a reason for hiding this comment

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

Believe the primary advantage of leaving "daily resource cleanup" enabled is to avoid incurring charges for resources that you are no longer using. (cc: @alberto for confirmation)

Btw, here's the AWS doc on the topic: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_CleaningUp.html


![](images/aws-create-swarm-6-manager-worker.png)

<font style="color:red;">RYAN, ALBERTO: Should we add more detail on machine sizes?</font>
Copy link
Contributor

Choose a reason for hiding this comment

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

Here is a link to the instance options and pricing on Azure: https://azure.microsoft.com/en-us/pricing/details/virtual-machines/linux/

Perhaps we could include a link.

Victoria Bialas added 16 commits May 1, 2017 22:52
WIP: 1st draft includes, tabs re: SSH key topics

adding more Azure Cloud content and SSH includes

copyedits

cloud azure, aws topics organization, videos

incorporated review comments

copyedits, colour-coded TBD's

copyedits to make create a swarm w/AWS and Azure consistent

updated links to use new titles

added SSH key setup to the Swarm overview list of links

updated link services titles

add ssh to glossary, note autoredeploy limitations

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
@londoncalling
Copy link
Contributor Author

LGTM!

@londoncalling londoncalling merged commit e552c02 into docker:master May 2, 2017
@londoncalling londoncalling deleted the cloud-docs branch May 3, 2017 20:51
@londoncalling londoncalling changed the title WIP: add Cloud link to Azure topics Add Cloud link to Azure topics May 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants