provider/*: standardise boilerplate

provider/*: standardise boilerplate

We make the attribute descriptions full sentences to
aid comprehension, and separates them with newlines
to make the boundaries clear.

Since the entries are a little longer now, I've changed
it to use 4-space indentation to make the
transition between providers more obvious.

We also remove optional standard config entries
such as admin-secret. We should have a
place in help where these attributes are documented.

https://code.launchpad.net/~rogpeppe/juju-core/443-update-init-output/+merge/189850

(do not edit description out of merge proposal)

[rog, 2013-10-08 13:44:36]

Please take a look.

[natefinch, 2013-10-08 14:33:52]

LGTM with some small tweaks.  Definitely like the more readable configurations
with line breaks.

[natefinch, 2013-10-08 14:34:04]

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go
File provider/azure/config.go (right):

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:130: type: azure
Can we include a link to the azure setup help on juju.ubuntu.com?

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:138: management-subscription-id:
886413e1-3b8a-5382-9b90-0c9aee199e5d
These values always confuse me... are they real values or are they example
values?  If they're example, can we make them more obviously fake?  Like
baadf00d-000-000-000-000000000000?

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:141: # storage-accWindows Azure Storage info.
typo here?

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:142: storage-account-name: ghedlkjhw54e
as above... is this an example value or a real value?  I can't tell.

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:145: # name of a public container holding the juju
tools.
Can we have a blurb about why and when you'd override these?  A simple "the
default is usually ok, see the online help for more details" is fine

https://codereview.appspot.com/14426046/diff/3001/provider/maas/environprovid...
File provider/maas/environprovider.go (right):

https://codereview.appspot.com/14426046/diff/3001/provider/maas/environprovid...
provider/maas/environprovider.go:47: type: maas
url for docs on maas setup?

https://codereview.appspot.com/14426046/diff/3001/provider/null/provider.go
File provider/null/provider.go (right):

https://codereview.appspot.com/14426046/diff/3001/provider/null/provider.go#n...
provider/null/provider.go:109: # on. It defaults to ` +
fmt.Sprint(defaultStoragePort) + `
Can you make this whole boilerplate one big fmt.Sprintf? I think it would read
easier in the code.

https://codereview.appspot.com/14426046/diff/3001/provider/openstack/provider.go
File provider/openstack/provider.go (right):

https://codereview.appspot.com/14426046/diff/3001/provider/openstack/provider...
provider/openstack/provider.go:74: # tools-url specifies the location of the
Juju tools.
Does this default to something useful?

https://codereview.appspot.com/14426046/diff/3001/provider/openstack/provider...
provider/openstack/provider.go:99: # Use the following if you require keypair
autherntication
typo authentication

[dimitern, 2013-10-08 14:39:46]

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go
File provider/azure/config.go (right):

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:138: management-subscription-id:
886413e1-3b8a-5382-9b90-0c9aee199e5d
On 2013/10/08 14:34:04, nate.finch wrote:
> These values always confuse me... are they real values or are they example
> values?  If they're example, can we make them more obviously fake?  Like
> baadf00d-000-000-000-000000000000?

or my favorite: 0xDEADBEEF :)

[rog, 2013-10-11 14:07:06]

Please take a look.

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go
File provider/azure/config.go (right):

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:130: type: azure
On 2013/10/08 14:34:04, nate.finch wrote:
> Can we include a link to the azure setup help on juju.ubuntu.com?

Done.

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:138: management-subscription-id:
886413e1-3b8a-5382-9b90-0c9aee199e5d
On 2013/10/08 14:39:46, dimitern wrote:
> On 2013/10/08 14:34:04, nate.finch wrote:
> > These values always confuse me... are they real values or are they example
> > values?  If they're example, can we make them more obviously fake?  Like
> > baadf00d-000-000-000-000000000000?
> 
> or my favorite: 0xDEADBEEF :)

personally I prefer cafebabe, but i've gone with all zeros.

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:141: # storage-accWindows Azure Storage info.
On 2013/10/08 14:34:04, nate.finch wrote:
> typo here?

Done.

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:142: storage-account-name: ghedlkjhw54e
On 2013/10/08 14:34:04, nate.finch wrote:
> as above... is this an example value or a real value?  I can't tell.

Done.

https://codereview.appspot.com/14426046/diff/3001/provider/azure/config.go#ne...
provider/azure/config.go:145: # name of a public container holding the juju
tools.
On 2013/10/08 14:34:04, nate.finch wrote:
> Can we have a blurb about why and when you'd override these?  A simple "the
> default is usually ok, see the online help for more details" is fine

Done.

https://codereview.appspot.com/14426046/diff/3001/provider/null/provider.go
File provider/null/provider.go (right):

https://codereview.appspot.com/14426046/diff/3001/provider/null/provider.go#n...
provider/null/provider.go:109: # on. It defaults to ` +
fmt.Sprint(defaultStoragePort) + `
On 2013/10/08 14:34:04, nate.finch wrote:
> Can you make this whole boilerplate one big fmt.Sprintf? I think it would read
> easier in the code.

I actually prefer it this way, as you don't have to count %s's in
a very long string. When Go 1.2 is out, I'd consider %[1]s.

https://codereview.appspot.com/14426046/diff/3001/provider/openstack/provider.go
File provider/openstack/provider.go (right):

https://codereview.appspot.com/14426046/diff/3001/provider/openstack/provider...
provider/openstack/provider.go:74: # tools-url specifies the location of the
Juju tools.
On 2013/10/08 14:34:04, nate.finch wrote:
> Does this default to something useful?

I *think* so. Done.

https://codereview.appspot.com/14426046/diff/3001/provider/openstack/provider...
provider/openstack/provider.go:99: # Use the following if you require keypair
autherntication
On 2013/10/08 14:34:04, nate.finch wrote:
> typo authentication

Done. And a few other changes too.

[natefinch, 2013-10-11 14:30:37]

Great, LGTM.