help text for juju add-credential needs improving

Bug #1566362 reported by Peter Matulis
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Canonical Juju
Fix Released
Medium
Reed O'Brien

Bug Description

e.g.:

Usage: juju add-credential [options] <cloud name>

Summary:
Adds or replaces credentials for a cloud.

Options:

-f (= "")
    Path to YAML credentials file
--replace (= false)
    Overwrite existing credential information

Details:
The user is prompted to add credentials interactively if a YAML-formatted credentials file is not specified. Here is a sample credentials file:

credentials:
   aws:
        <credential name>:
            auth-type: access-key
            access-key: <key>
            secret-key: <key>
   azure:
        <credential name>:
            auth-type: userpass
            application-id: <uuid1>
            application-password: <password>
            subscription-id: <uuid2>
            tenant-id: <uuid3>

A "credential name" is arbitrary and is used solely to represent a set of credentials, of which there may be multiple per cloud.
The `--replace` option is required if credential information for the named cloud already exists. All such information will be overwritten.
This command does not set default regions nor default credentials. Note that if only one credential name exists, it will become the effective default credential.
For credentials which are already in use by tools other than Juju, `juju autoload-credentials` may be used.
When Juju needs credentials for a cloud, i) if there are multiple available; ii) there's no set default; iii) and one is not specified ('--credential'), an error will be emitted.

Examples:

    juju add-credential google
    juju add-credential aws -f ~/credentials.yaml

See also: list-credentials
          remove-credential
          set-default-credential
          autoload-credentials

Tags: helpdocs
description: updated
description: updated
Changed in juju-core:
status: New → Triaged
importance: Undecided → Medium
milestone: none → 2.0-beta4
Changed in juju-core:
milestone: 2.0-beta4 → 2.0-rc1
Changed in juju-core:
assignee: nobody → Reed O'Brien (reedobrien)
status: Triaged → In Progress
Revision history for this message
Reed O'Brien (reedobrien) wrote :

Output:

Usage: juju add-credential [options] <cloud name>

Summary:
Adds or replaces credentials for a cloud.

Options:
-f (= "")
    The YAML file containing credentials to add
--replace (= false)
    Overwrite existing credential information

Details:
The user is prompted to add credentials interactively if a YAML-formatted
credentials file is not specified. Here is a sample credentials file:

credentials:
  aws:
    <credential name>:
      auth-type: access-key
      access-key: <key>
      secret-key: <key>
  azure:
    <credential name>:
      auth-type: userpass
      application-id: <uuid1>
      application-password: <password>
      subscription-id: <uuid2>
      tenant-id: <uuid3>

A "credential name" is arbitrary and is used solely to represent a set of
credentials, of which there may be multiple per cloud.
The `--replace` option is required if credential information for the named
cloud already exists. All such information will be overwritten.
This command does not set default regions nor default credentials. Note
that if only one credential name exists, it will become the effective
default credential.
For credentials which are already in use by tools other than Juju, `juju
autoload-credentials` may be used.
When Juju needs credentials for a cloud, i) if there are multiple
available; ii) there's no set default; iii) and one is not specified ('--
credential'), an error will be emitted.

Examples:
    juju add-credential google
    juju add-credential aws -f ~/credentials.yaml

See also:
    list-credentials
    remove-credential
    set-default-credential
    autoload-credentials

Changed in juju-core:
status: In Progress → Fix Committed
Curtis Hovey (sinzui)
Changed in juju-core:
status: Fix Committed → Fix Released
affects: juju-core → juju
Changed in juju:
milestone: 2.0-beta5 → none
milestone: none → 2.0-beta5
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.