Merge lp:~natefinch/juju-core/win-getting-started into lp:juju-core/docs

[Nate Finch]

Add windows to the list of supported client OSes and modify the instructions to support Windows. Note that there is a link to the windows installer that currently is non-functional.

[Nate Finch (natefinch)]

Oh yeah, also modified the contribution instructions to use python's SimpleHTTPServer to test the docs, rather than trying to set up apache.

[lp:~natefinch/juju-core/win-getting-started]

74. By Nate Finch on 2013-08-30

suggest juju init instead of generate-config to save typing

75. By Nate Finch on 2013-08-30

merge from trunk

[John A Meinel (jameinel)]

You have a comment about using SimpleHTTPServer, but I don't see that string anywhere in the actual diff. Did you forget to push to update it?

[Nate Finch (natefinch)]

Oh, sorry, after I made my changes, I merged from trunk and someone else
had already made the SimpleHTTPServer change, so mine got "lost", since it
was identical to the other one.

On Tue, Sep 3, 2013 at 8:19 AM, John A Meinel <email address hidden>wrote:

> You have a comment about using SimpleHTTPServer, but I don't see that
> string anywhere in the actual diff. Did you forget to push to update it?
>
> --
>
> https://code.launchpad.net/~natefinch/juju-core/win-getting-started/+merge/183246
> You are the owner of lp:~natefinch/juju-core/win-getting-started.
>

[Dave Cheney (dave-cheney)]

=== modified file 'htmldocs/getting-started.html'
--- htmldocs/getting-started.html 2013-08-22 13:55:23 +0000
+++ htmldocs/getting-started.html 2013-08-30 20
+ <li> An Ubuntu, Windows, or OSX machine to install the client on.</li>

A Ubuntu, Windows or OS X machine ...

+ <li> An environment which can provide a new server with an Ubuntu cloud operating system image on-demand. This includes services such as Amazon EC2, HP Cloud, or an OpenStack installation.</li>

s/an/a

+ <li> An SSH key-pair. If you have not already set one up, you need to generate an appropriate keypair.</li>

s/An/A

+ On Linux and Mac OSX:<br/>
+ <pre>ssh-keygen -t rsa -b 2048</pre> <br/> On Windows: <br/>See the <a href="ssh-keygen-win.html">Windows instructions</a>
+ </ul>

+ <p>Open the Start Menu and type "cmd" (without quotes) in the search box at the bottom of the Start

Use <code>cmd</code> then you don't need to tell people to omit the quotes.

Menu. Click on cmd.exe when it comes up in the search results. This will open up a Windows command prompt. </p>
+ <p>type the following in the command prompt: <pre>mkdir .ssh</pre><br/><br/>
+ This will create a folder called .ssh in your home directory.</p>

<code>.ssh</code>

+ </section>
+ <section id="download">
+ <h1>Download puttygen.exe</h1>
+
+ <p>Download puttygen.exe from the <a href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">PuTTY download page</a></pre>
+
+ <p>The file you download is not an installer, but a simple executable you can run directly.</p>
+ <p>Once downloaded, run puttygen.exe, you should see a dialog that looks like this:</p>
+ <p><img src="media/puttygen.png"/></p>
+
+ </section>
+ <section id="generate">
+ <h1>Generating your keys</h1>
+ <p>The defaults for the parameters at the bottom of the window are correct (SSH-2 RSA and 2048 bits). Click generate, and move your mouse back and forth over the window to generate your key.</p>
+ <p>It is recommended that you specify a passphrase (password) for your key, so that if it is lost, it can't be used without the password. Choose a password you can remember, because it cannot be recovered if forgotten.</p>
+ </section>
+ <section id="saving">
+ <h1>Save your keys</h1>
+ <p>Click Conversions->Export OpenSSH Key on the main menu. Find the .ssh folder you created earlier and save the key in that folder with the name id_rsa (no extension). This is where Juju and some other programs will look for it by default.<p>
+
+ <p>Next, you need to save your public key. To do this, right click in the box under "Public key for pasting into OpenSSH authorized_keys file", and click "Select All". Copy the text using Ctrl-C or right-click Copy.</p>
+
+ <p>Open Notepad and paste the contents of the clipboard. Save the file with the name id_rsa.pub in the same directory where you saved the private key (note,...

review: Needs Fixing (small nits)

[Nate Finch (natefinch)]

> === modified file 'htmldocs/getting-started.html'
> + <li> An Ubuntu, Windows, or OSX machine to install the client
> on.</li>
>
> A Ubuntu, Windows or OS X machine ...

Wait, that can't be right. Ubuntu starts with a vowel sound (oo), and thus we should use "an", such as "an owl".

> + <li> An environment which can provide a new server with an
> Ubuntu cloud operating system image on-demand. This includes services such as
> Amazon EC2, HP Cloud, or an OpenStack installation.</li>
>
> s/an/a

as above

> + <li> An SSH key-pair. If you have not already set one up, you
> need to generate an appropriate keypair.</li>
>
> s/An/A

I pretty much always see people pronounce SSH as Ess Ess Aych, thus I used "an". I consider ssh to be such a universally known acronym at this point, that it's basically its own word. However, if others disagree, that's fine.

[Antonio Rosales (arosales)]

Note the current branch will need to re-factored to work with the current juju.ubuntu.com/docs layout. Other than that LGTM. The ssh section is a need add too.

-thanks,
Antonio

=== modified file 'htmldocs/getting-started.html'
--- htmldocs/getting-started.html	2013-08-22 13:55:23 +0000
+++ htmldocs/getting-started.html	2013-08-30 20:12:23 +0000
@@ -61,10 +61,12 @@
                 <p>This tutorial will show you how to get started with Juju, including installing, configuring and bootstrapping a new Juju environment.
                 Before you start you will need:</p>
                 <ul>
-                <li> An Ubuntu or OSX machine to install the client on.</li>
-                <li> An environment which can provide a new server with an Ubuntu cloud operating system image on-demand. This includes services such as Amazon EC2, HP Cloud, an OpenStack installation, or your local machine</li>
-                <li> An SSH key-pair. If you have not already set one up, you can generate an appropriate keypair with:</li>
-                <pre>ssh-keygen -t rsa -b 2048</pre>
+                <li> An Ubuntu, Windows, or OSX machine to install the client on.</li>
+                <li> An environment which can provide a new server with an Ubuntu cloud operating system image on-demand. This includes services such as Amazon EC2, HP Cloud, or an OpenStack installation.</li>
+                <li> An SSH key-pair. If you have not already set one up, you need to generate an appropriate keypair.</li>
+                  On Linux and Mac OSX:<br/>
+                  <pre>ssh-keygen -t rsa -b 2048</pre> <br/> On Windows: <br/>See the <a href="ssh-keygen-win.html">Windows instructions</a>
+                </ul>
               </ul>
             </section>
             <section id="install">
@@ -73,30 +75,22 @@
                 <nav class="control">
                   <a href="." class="selected" data-action="ubuntu">Ubuntu</a>
                   <a href="." class="" data-action="macosx">Mac OSX</a>
+                  <a href="." class="" data-action="windows">Windows</a>
                 </nav>
                 <div class="terminal-wrap">
                   <div data-section="ubuntu">
                     <p>To install Juju, you simply need to grab the latest juju-core package from the PPA:</p>
                     <pre>sudo add-apt-repository ppa:juju/stable
-                    sudo apt-get update && sudo apt-get install juju-core</pre>
+                    sudo apt-get update &amp;&amp; sudo apt-get install juju-core</pre>
                   </div>
                   <div data-section="macosx">
                     <p>Juju is in <a href="http://brew.sh/">Homebrew</a>, to install do:</p>
                     <pre>brew install juju</pre>
 
-                    <p>You can grab the latest pre-relase OSX client from our <a href="https://github.com/juju/juju-core/releases">Github Page</a>. Uncompress the tarball, then you can run the <code>juju</code> command from the terminal. We're in the process of testing these builds to be production ready, so if you have a problem please <a href="https://bugs.launchpad.net/juju-core/+filebug">file a bug</a>.</p>
-                    
-                    <p>If you have go installed you can install juju using go get. You can install go via homebrew you'll need bzr too:</p>
-                    <pre>brew install go bzr
-                    export PYTHONPATH=/usr/local/lib/python2.7/site-packages:$PYTHONPATH
-                    </pre>
-                    <p>Once you have go and bzr you can install juju:</p>
-                    <pre>mkdir $HOME/go
-                    export GOPATH=$HOME/go
-                    go get -v launchpad.net/juju-core/...
-                    export PATH=$PATH:$GOPATH/bin
-                    </pre>
-                    <p>be sure to add your go bin dir to your path permanently by adding it to your .bashrc</p>
+                    <p>We're in the process of testing the OSX client, so if you have a problem please <a href="https://bugs.launchpad.net/juju-core/+filebug">file a bug</a>.</p>
+                  </div>
+                  <div data-section="windows">
+                    <p>Download and run the <a href="PLACEHOLDER">Juju windows installer</a></p>
                   </div>
                 </div>
               </section>
@@ -104,12 +98,12 @@
             <section id="config">
             <h1>Configuring</h1>
             
-            <p>Now the Juju software is installed, it needs to be configured to use your particular cloud provider. This is done by generating and editing a file, "environments.yaml", which will live in your ~/.juju/ directory. You can generate the environments file manually, but Juju also includes a boilerplate configuration option that will flesh out most of the file for you and minimise the amount of work (and potential errors).</p>
+            <p>Now that the Juju software is installed, it needs to be configured to use your particular cloud provider. This is done by generating and editing a file, "environments.yaml", which will live in Juju's configuration directory (~/.juju/ on Linux and OSX, %LOCALAPPDATA%/Juju on Windows). You can generate the environments file manually, but Juju also includes a boilerplate configuration option that will flesh out most of the file for you and minimise the amount of work (and potential errors).</p>
             <p>To generate an initial config file, you simply need to run:</p>
-            <pre><code>juju generate-config -w</code></pre>
+            <pre><code>juju init</code></pre>
             
-            <p>The -w switch causes the file to be written to your ~/.juju directory if an environments.yaml file does not already exist. It will also create the ~./juju directory if that does not exist.</p>
-            <p>This file will contain sample profiles for different types of cloud services, but you will need to edit the files to provide specific information for your cloud provider. Sections are created for Amazon (AWS) services, HPCloud and a generic OpenStack instance. For more specifics on what needs to be changed, see the relevant sections below.</p>
+            <p>This will cause the file to be written to your Juju configuration directory if an environments.yaml file does not already exist. It will also create the directory if that does not exist.</p>
+            <p>This file will contain sample profiles for different types of cloud services, but you will need to edit the files to provide specific information for your cloud provider. Sections are created for Amazon (AWS) services, HPCloud, and a generic OpenStack instance, as well as a local option on Linux. For more specifics on what needs to be changed, see the relevant sections below.</p>
             <ul>
              <li><a href="config-aws.html">Configuring for Amazon AWS</a></li>
              <li><a href="config-hpcloud.html">Configuring for HP Cloud</a></li>

=== added file 'htmldocs/media/puttygen.png'
Binary files htmldocs/media/puttygen.png	1970-01-01 00:00:00 +0000 and htmldocs/media/puttygen.png	2013-08-30 20:12:23 +0000 differ
=== added file 'htmldocs/ssh-keygen-win.html'
--- htmldocs/ssh-keygen-win.html	1970-01-01 00:00:00 +0000
+++ htmldocs/ssh-keygen-win.html	2013-08-30 20:12:23 +0000
@@ -0,0 +1,159 @@
+<!DOCTYPE html>
+<html>
+  <head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>Juju Documentation - Creating an SSH keypair on Windows</title>
+  <link href='https://fonts.googleapis.com/css?family=Ubuntu:400,300,300italic,400italic,700,700italic|Ubuntu+Mono' rel='stylesheet' type='text/css' />
+  <link rel="stylesheet" type="text/css" media="screen" href="//juju.ubuntu.com/wp-content/themes/juju-website/css/reset.css" />
+  <link rel="stylesheet" type="text/css" media="screen" href="//juju.ubuntu.com/wp-content/themes/juju-website/css/960.css" />
+  <link rel="stylesheet" type="text/css" media="screen" href="//juju.ubuntu.com/wp-content/themes/juju-website/css/base.css" />
+  <link rel="stylesheet" type="text/css" media="screen" href="//juju.ubuntu.com/wp-content/themes/juju-website/css/home-new.css" />
+  <link rel='stylesheet' id='stacktack-css'  href='//juju.ubuntu.com/wp-content/plugins/stacktack/css/stacktack.min.css?ver=3.4.2' type='text/css' media='all' />
+  <link href="css/main.css?1375975745" rel="stylesheet" type="text/css"/>
+
+  <!--[if lt IE 9]>
+  <script type="text/javascript" src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+</head>
+  <body class="resources">
+    <header class="global clearfix" role="banner">
+  <div class="header-navigation">
+    <div>
+      <nav role="navigation">
+        <ul>
+          <li class="page_item page-item-6"><a href="https://juju.ubuntu.com/">Home</a></li>
+          <li class="page_item page-item-7"><a href="https://juju.ubuntu.com/get-started/">Get started</a></li>
+          <li class="page_item page-item-9 current_page_item"><a href="https://juju.ubuntu.com/resources/">Resources</a></li>
+          <li class="page_item page-item-13"><a href="https://juju.ubuntu.com/community/">Community</a></li>
+          <li class="page_item page-item-3688"><a href="https://juju.ubuntu.com/charm-store/">Charm Store</a></li>
+          <li class="page_item page-item-3691"><a href="https://juju.ubuntu.com/events/">Events</a></li>
+          <li class="page_item page-item-4474"><a href="https://juju.ubuntu.com/charm-championship/">Charm Championship</a></li>
+          <li class="page_item page-item-4249"><a href="https://juju.ubuntu.com/survey/">Survey</a></li>
+          <li>
+            <form id="form-search" method="get" action="https://juju.ubuntu.com/">
+              <fieldset>
+                <input id="input-search" type="text" name="s" value="Search" />
+              </fieldset>
+            </form>
+          </li>
+        </ul>
+      </nav>
+    </div>
+  </div>
+  <div class="header-content">
+    <div class="clearfix">
+      <img src="https://juju.ubuntu.com/wp-content/themes/juju-website/img/arrow-nav.png" width="9" height="5" style="left:455px; display: block;" class="arrow-nav">
+      <div class="header-navigation-secondary"></div>
+      <div class="header-image"></div>
+      <h1>Resources</h1>
+      <h2>A collection of some of the most important online references for Juju users and developers.</h2>
+    </div>
+  </div>
+</header>
+    <section id="content" class="container-12">
+      <div class="grid-12 doc-container">
+		    <div id="navlinks" class="grid-3 doc-navigation">LINKS</div>
+        <div class="grid-9 doc-content">
+          <article>
+            <section id="intro">
+              <h1>Creating SSH Keypairs on Windows</h1>
+                <p>This tutorial will show you how to create SSH keys for use with Juju on Windows.</p>
+            </section>
+            <section id="folder">
+            <h1>Create the .ssh folder</h1>
+
+            <p>First you need to create a folder called .ssh in your home directory, which will be where you save your ssh keys.<p>
+            <p>Open the Start Menu and type "cmd" (without quotes) in the search box at the bottom of the Start Menu. Click on cmd.exe when it comes up in the search results. This will open up a Windows command prompt. </p>
+            <p>type the following in the command prompt: <pre>mkdir .ssh</pre><br/><br/>
+            This will create a folder called .ssh in your home directory.</p>
+            </section>
+            <section id="download">
+            <h1>Download puttygen.exe</h1>
+            
+            <p>Download puttygen.exe from the <a href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">PuTTY download page</a></pre>
+            
+            <p>The file you download is not an installer, but a simple executable you can run directly.</p>
+            <p>Once downloaded, run puttygen.exe, you should see a dialog that looks like this:</p>
+            <p><img src="media/puttygen.png"/></p>
+
+            </section>
+            <section id="generate">
+            <h1>Generating your keys</h1>
+            <p>The defaults for the parameters at the bottom of the window are correct (SSH-2 RSA and 2048 bits). Click generate, and move your mouse back and forth over the window to generate your key.</p>
+            <p>It is recommended that you specify a passphrase (password) for your key, so that if it is lost, it can't be used without the password. Choose a password you can remember, because it cannot be recovered if forgotten.</p>
+            </section>
+            <section id="saving">
+            <h1>Save your keys</h1>
+            <p>Click Conversions->Export OpenSSH Key on the main menu. Find the .ssh folder you created earlier and save the key in that folder with the name id_rsa (no extension). This is where Juju and some other programs will look for it by default.<p>
+
+            <p>Next, you need to save your public key. To do this, right click in the box under "Public key for pasting into OpenSSH authorized_keys file", and click "Select All". Copy the text using Ctrl-C or right-click Copy.</p>
+
+            <p>Open Notepad and paste the contents of the clipboard. Save the file with the name id_rsa.pub in the same directory where you saved the private key (note, the extension should be .pub, not .txt).</p>
+
+            <p>That's it! You now have ssh keys that can be used with Juju and other applications that require ssh keys.
+            </section>
+          </article>
+        </div>
+    </section>
+    <div class="shadow"></div>
+    <footer class="global clearfix" role="contentinfo">
+  <div class="row">
+    <div class="inner-wrapper">
+      <nav role="navigation" class="clearfix">
+        <ul class="footer-a">
+          <li class="grid-3 first-col">
+            <h4><a href="/get-started">Get started</a></h4>
+            <ul>
+              <li class="page_item page-item-20"><a href="https://juju.ubuntu.com/get-started/local/">Local</a></li>
+              <li class="page_item page-item-22"><a href="https://juju.ubuntu.com/get-started/amazon/">Amazon Web Services</a></li>
+              <li class="page_item page-item-18"><a href="https://juju.ubuntu.com/get-started/hp-cloud/">HP Cloud</a></li>
+              <li class="page_item page-item-16"><a href="https://juju.ubuntu.com/get-started/rackspace/">Rackspace</a></li>
+              <li class="page_item page-item-3596"><a href="https://juju.ubuntu.com/get-started/openstack/">Openstack</a></li>
+              <li class="page_item page-item-3600"><a href="https://juju.ubuntu.com/get-started/maas/">MAAS</a></li>
+            </ul>
+          </li>
+          <li class="grid-3">
+            <h4><a href="/resources">Resources</a></h4>
+            <ul>
+              <li><a href="http://juju.ubuntu.com/docs">Documentation</a></li>
+              <li><a href="/resources/videos/">Videos</a></li>
+              <li><a href="http://uistage.jujucharms.com:8080/">Juju GUI demo site</a></li>
+            </ul>
+          </li>
+          <li class="grid-3">
+            <h4><a href="/community">Community</a></h4>
+            <ul>
+              <li class="page_item page-item-28"><a href="https://juju.ubuntu.com/community/juju-blog/">Juju Blog</a></li>
+              <li class="page_item page-item-4262"><a href="https://juju.ubuntu.com/community/weekly-charm-meeting/">Weekly Charm Meeting</a></li>
+              <li class="page_item page-item-4036"><a href="https://juju.ubuntu.com/community/charmers/">Charmers</a></li>
+              <li><a href="https://lists.ubuntu.com/mailman/listinfo/juju">Mailing List</a></li>
+              <li><a href="http://webchat.freenode.net/?channels=juju">Chat</a></li>
+              <li><a href="http://askubuntu.com/questions/tagged/juju?sort=faq&pagesize=50">FAQ</a></li>
+            </ul>
+          </li>
+          <li class="grid-3 last-col">
+            <h4><a href="https://launchpad.net/juju">Code</a></h4>
+            <ul>
+              <li><a href="https://launchpad.net/juju-core">Juju Core</a></li>
+              <li><a href="https://launchpad.net/charms">Charms</a></li>
+            </ul>
+          </li>
+        </ul>
+      </nav>
+    </div>
+  </div>
+  <div class="row no-border">
+    <div class="legal inner-wrapper">
+      <p>&copy; 2013 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd.</p>
+      <p><a href="https://bugs.launchpad.net/juju-website/+filebug">Report a bug on this site</a></p>
+    </div>
+  </div>
+</footer>
+
+    <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
+    <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jqueryui/1.8.14/jquery-ui.min.js"></script>
+    <script src="//d38yea5fb4e2oh.cloudfront.net/jquery.stacktack.min.js"></script>
+    <script type="text/javascript" src="js/main.js"></script>
+    <script type="text/javascript" src="http://code.jquery.com/jquery-1.9.1.js"></script>
+  </body>
+</html>