Bug 715100

Summary: need man page for aeolus-image
Product: [Retired] CloudForms Cloud Engine Reporter: wes hayutin <whayutin>
Component: rubygem-aeolus-imageAssignee: Jason Guiditta <jguiditt>
Status: CLOSED CURRENTRELEASE QA Contact: wes hayutin <whayutin>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 0.3.1CC: akarol, dajohnso, ssachdev
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description wes hayutin 2011-06-21 21:03:11 UTC
Description of problem:

[root@dell-pe1950-02 ~]# man aeolus-image
No manual entry for aeolus-image
[root@dell-pe1950-02 ~]# 



[root@dell-pe1950-02 ~]# aeolus-image --help
Usage: aeolus-image [list|build|push|import|delete] [general options] [command options]

General options:
    -u, --user USERNAME              Conductor username
    -w, --password PASSWORD          Conductor password
        --id ID                      id for a given object
        --description NAME           description (e.g. "<image><name>MyImage</name></image>" or "/home/user/myImage.xml")
    -r, --provider NAME1,NAME2       name of specific provider (ie ec2-us-east1)
    -I, --image ID                   ID of the base image, can be used in build and push commands, see examples
    -T, --target TARGET1,TARGET2     provider type (ec2, rackspace, rhevm, etc)
    -d, --daemon                     run as a background process
    -h, --help                       Get usage information for this tool

List options:
    -i, --images                     Retrieve a list of images
    -b, --builds ID                  Retrieve the builds of an image
    -t, --targetimages ID            Retrieve the target images from a build
    -P, --providerimages ID          Retrieve the provider images from a target image
    -g, --targets                    Retrieve the values available for the --target parameter
    -p, --providers                  Retrieve the values available for the --provider parameter
    -a, --accounts                   Retrieve the values available for the --account parameter

Build options:
    -e, --template FILE              path to file that contains template xml

Push options:
    -B, --build ID                   push all target images for a build, to same providers as previously
    -A, --account NAME               name of specific provider account to use for push

Delete options:
    -m, --targetimage ID             delete target image and its provider images
    -D, --providerimage ID           delete provider image

List Examples:
aeolus-image list --images                  # list available images
aeolus-image list --builds $image_id        # list the builds of an image
aeolus-image list --targetimages $build_id  # list the target images from a build
aeolus-image list --targets                 # list the values available for the --target parameter
aeolus-image list --providers               # list the values available for the --provider parameter
aeolus-image list --accounts                # list the values available for the --account parameter

Build examples:
aeolus-image build --target ec2 --template my.tmpl  # build a new image for ec2 from the template
aeolus-image build --image $image_id                # rebuild the image template and targets from latest build
aeolus-image build --target ec2,rackspace \         # rebuild the image with a new template and set of targets
                   --image $image_i \
                   --template my.tmpl

Push examples:
aeolus-image push --provider ec2-us-east-1,my-rhev-m --id $image_id         # push the image to the specified providers
aeolus-image push --build $build_id                               # push all target images for a build, to same providers as previously
aeolus-image push --account $provider_account --build $build_id   # ditto, using a specific provider account
aeolus-image push --image $image_id                               # push all the target images for the latest build

Import examples:
aeolus-image import --provider ec2-us-east-1 --target ec2 --id $ami_id # import an AMI from the specified provider
aeolus-image import --provider ec2-us-east-1 --target ec2 --id $ami_id --description '<image><name>My Image</name></image>' # import an AMI from the specified provider
aeolus-image import --provider ec2-us-east-1 --target ec2 --id $ami_id --description <path_to_xml_file> # import an AMI from the specified provider

Delete examples:
aeolus-image delete --build $build_id               # deletes a build, updating latest/parent references as appropriate
aeolus-image delete --targetimage $target_image     # deletes a target image and its provider images
aeolus-image delete --providerimage $provider_image # deletes a provider image

Comment 1 wes hayutin 2011-06-29 15:29:55 UTC
<jayg> hey, wanted to check on another BZ - https://bugzilla.redhat.com/show_bug.cgi?id=715100
<jayg> I did not think this feature was part of this iteration, do you strongly disagree?  it was never proposed as at feature before the bz at least afaik

<weshay> we should have one.. but dont need it..
<jayg> agree we shoudl add at some point
<weshay> k.. removing from the tracker

Comment 2 Jason Guiditta 2011-09-19 20:09:45 UTC
Martyn added this quite some time ago, we must have missed updating here:

rpm -qa rubygem-aeolus-image
rubygem-aeolus-image-0.1.0-3.20110914104314gitb6195f6.fc15.noarch

man aeolus-image 

aeolus-image(1)                                                                 USER COMMANDS                                                                aeolus-image(1)

NAME
       aeolus-image - command line tool for managing aeolus images

SYNOPSIS
       aeolus-image [-h]

DESCRIPTION
       aeolus-image is a tool that allows users to control their aeolus images through image builder and aeolus conductor.  aeolus-image offers four commands options; list,
       build, push, import.  For more information on each command please run man aeolus-image <command> or aeolus-image --help

OPTIONS
       -h, --help
              Get usage information for this tool and subcommands

AUTHOR
       Martyn Taylor (mtaylor), Jason Guiditta (jguiditta)

SEE ALSO
       aeolus-image-build(1), aeolus-image-push(1), aeolus-image-list(1), aeolus-image-import(1)

version 0.4                                                                     July 07, 2011                                                                aeolus-image(1)

Comment 3 Aziza Karol 2011-09-20 06:36:01 UTC
man page for aeolus-image is added.

#man aeolus-image
aeolus-image(1)                                                       USER COMMANDS                                                       aeolus-image(1)

NAME
       aeolus-image - command line tool for managing aeolus images

SYNOPSIS
       aeolus-image [-h]

DESCRIPTION
       aeolus-image is a tool that allows users to control their aeolus images through image builder and aeolus conductor.  aeolus-image offers four com‐
       mands options; list, build, push, import.  For more information on each command please run man aeolus-image <command> or aeolus-image --help

OPTIONS
       -h, --help
              Get usage information for this tool and subcommands

AUTHOR
       Martyn Taylor (mtaylor), Jason Guiditta (jguiditta)

SEE ALSO
       aeolus-image-build(1), aeolus-image-push(1), aeolus-image-list(1), aeolus-image-import(1)

version 0.4                                                           July 07, 2011                                                       aeolus-image(1)
~
~
[root@kvm-guest-06 nodes]# rpm -qa  | grep  aeolus
aeolus-conductor-0.4.0-0.20110919181505git369190d.fc15.noarch
aeolus-conductor-daemons-0.4.0-0.20110919181505git369190d.fc15.noarch
aeolus-conductor-doc-0.4.0-0.20110919181505git369190d.fc15.noarch
rubygem-aeolus-image-0.1.0-3.20110919115936gitd1d24b4.fc15.noarch
aeolus-configure-2.0.2-4.20110916125556git5a94390.fc15.noarch
aeolus-all-0.4.0-0.20110919181505git369190d.fc15.noarch

[root@kvm-guest-06 nodes]# rpm -qa | grep rubygem-aeolus
rubygem-aeolus-image-0.1.0-3.20110919115936gitd1d24b4.fc15.noarch

Comment 5 wes hayutin 2011-12-08 13:57:11 UTC
perm close

Comment 6 wes hayutin 2011-12-08 13:59:45 UTC
closing out old bugs