Skip to content
This repository has been archived by the owner on Feb 1, 2021. It is now read-only.

High-level docs for Swarm #1694

Merged
merged 2 commits into from
Feb 3, 2016
Merged

Conversation

moxiegirl
Copy link

  • TLS docs from Nigel
  • Planning documentation
  • Swarm at scale sample

Signed-off-by: Mary Anthony mary@docker.com

@moxiegirl
Copy link
Author

@nigelpoulton Here are the WIP docs; I've split them and just making the language conform for clarity.

Typical to our docs, we often say Docker to mean "Docker Engine" but our readers can't see the difference and it just sounds like are repeating "Docker, Docker, Docker" with several products that start with this name, we should use the specific product when we mean one. That's where most of my changes are...

@moxiegirl
Copy link
Author

@nigelpoulton @mgoelzer @amitshukla Gents, this is ready for review. @nigelpoulton I incorporated Mike's comments and made some sentence structural changes to make the read an easier ride. I don't think I foobared the technical.

One thing to note, in some places you had readers elevating to sudo and in others not. In those cases, the prompt changed from $ to # which might confuse folks. I added sudo and used $ --- in this case it might be easier to use sudo and just assume folks can't sudo su. WDYT?

@moxiegirl moxiegirl changed the title WIP: TLS Docs for Swarm TLS Docs for Swarm Jan 28, 2016
@nigelpoulton
Copy link

@moxiegirl Good idea re sudo. I just ran through the procedure and checked it worked with sudo (occasionally long commands made of more than one binary - this isn't - don't work with sudo). All good though!!

@moxiegirl
Copy link
Author

@nigelpoulton OK, cool. I'll remove the elevate steps and just use sudo throughout. as openssl requires it and also the edit to set the DOCKER_OPTS.

>`Note`:If you already have access to a CA and certificates, and are comfortable working with them, you should skip this step and go to the next.

In this step, you configure a Linux server as a CA. You use this CA to create
and sign keys. This step included so that readers without access to an existing
Copy link
Contributor

Choose a reason for hiding this comment

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

Add is to become This step *is* included

@MHBauer
Copy link
Contributor

MHBauer commented Jan 28, 2016

I like the step7 process of creating a customized version of the swarm image. Creative and avoids using volumes.

Nice pictures throughout.

I like the Passport analogy.

Looking good so far.

@moxiegirl moxiegirl changed the title TLS Docs for Swarm High-level docs for Swarm Jan 29, 2016


# Planning for Swarm in production

Choose a reason for hiding this comment

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

If I have time I will make the examples more generic and not AWS.

Copy link
Author

Choose a reason for hiding this comment

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

Which examples? I didn't see any mention of AWS in this piece. Oh wait, you mention Azure and AWS at the same time...that can be enough.

Choose a reason for hiding this comment

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

@moxiegirl All of the HA examples refer to AWS availability zones as do the diagrams. I'm happy to leave it that way (it's easier). But there was a convo on slack yesterday about referencing AWS too much might look like we're taking sides. Any thoughts?

@moxiegirl
Copy link
Author

@nigelpoulton @mgoelzer @amitshukla @rolfedh This PR contains the latest content from Nigel that incorporates everyone's comments. Moving forward, please comment against this rather than the email thread. It simply is easier to track and check off comments here rather than juggling emails. As we get closer to the release, efficiency is crticial.

@ghost
Copy link

ghost commented Jan 29, 2016

Understood. Thanks, @moxiegirl

On Fri, Jan 29, 2016 at 10:31 AM, moxiegirl notifications@github.com
wrote:

@mgoelzer https://github.com/mgoelzer @amitshukla
https://github.com/amitshukla @rolfedh https://github.com/rolfedh
This PR contains the latest content from Nigel that incorporates everyone's
comments. Moving forward, please comment against this rather than the email
thread. It simply is easier to track and check off comments here rather
than juggling emails. As we get closer to the release, efficiency is
crticial.


Reply to this email directly or view it on GitHub
#1694 (comment).

Mike Goelzer
Product Manager
Docker, Inc.
650-329-8500

@moxiegirl
Copy link
Author

@mgoelzer @amitshukla @vieux @abronan @aluzzardi Can I get a review of this. Nigel is pretty much out the door because he has family obligations. I want to get comments and enter them by EOD Monday. Lots of moving parts on 1.10.

For more information on configuring Swarm for TLS, see the **need link to
securing swarm article**

### Network access control
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also mention the ports for libnetwork if used with swarm?

So:

  • tcp 7946 (serf gossip)
  • udp 7946 (serf gossip)
  • tcp <store-port> (depends on the distributed kv store used)
  • udp 4789 (vxlan)

Choose a reason for hiding this comment

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

Agreed. I think we should whack a sentence before it though explaining that if you are using container networking then these re the ports....

Copy link
Contributor

Choose a reason for hiding this comment

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

@nigelpoulton Yes sounds good to me to first mention it and explain the specifics with ports if libnetwork is used 👍

Struct edit pass thru conceptual material
Updating with comments from Mike
Tweaking menu layout
Updating for Nigel
Updating with local images, formatting fixes
Updating with the comments from review

Signed-off-by: Mary Anthony <mary@docker.com>
@moxiegirl
Copy link
Author

@abronan @mgoelzer Hi gents, can I get the final review and hopefully, LGTMs.


## Related information

The application in this example could be deployed on Docker Universal Control Plane (UPC) which is currently in Beta release. To try the application on UPC in your environment, [request access to the UPC Beta release](https://www.docker.com/products/docker-universal-control-plane). Other useful documentation:
Copy link
Contributor

Choose a reason for hiding this comment

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

UPC -> UCP?

Signed-off-by: Mary Anthony <mary@docker.com>
@abronan
Copy link
Contributor

abronan commented Feb 3, 2016

LGTM

1 similar comment
@vieux
Copy link
Contributor

vieux commented Feb 3, 2016

LGTM

vieux added a commit that referenced this pull request Feb 3, 2016
@vieux vieux merged commit 658280c into docker-archive:master Feb 3, 2016
ChristianKniep pushed a commit to ChristianKniep/swarm that referenced this pull request Jul 27, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants