buzz 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +95 -0
- data/VERSION +1 -1
- data/buzz.gemspec +3 -3
- data/lib/buzz.rb +1 -1
- metadata +4 -4
- data/README.rdoc +0 -19
    
        data/README.md
    ADDED
    
    | @@ -0,0 +1,95 @@ | |
| 1 | 
            +
            # buzz
         | 
| 2 | 
            +
             | 
| 3 | 
            +
            Buzz is a command-line interface into Spacewalk/RHN Satellite, written in Ruby. It will work with Ruby 1.8, which is the default Ruby on a lot of systems.
         | 
| 4 | 
            +
             | 
| 5 | 
            +
            ## Introduction
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            The buzz command itself has several sub-commands for manipulating different aspects of your Spacewalk.
         | 
| 8 | 
            +
             | 
| 9 | 
            +
            * channel - for manipulating channels
         | 
| 10 | 
            +
            * system  - for manipulating systems
         | 
| 11 | 
            +
             | 
| 12 | 
            +
            ## Configuration
         | 
| 13 | 
            +
             | 
| 14 | 
            +
            By default, Buzz will look at $HOME/.buzz for it's (YAML) config, which looks a bit like this
         | 
| 15 | 
            +
             | 
| 16 | 
            +
                spacewalk_server:  spacewalk.mycompany.com
         | 
| 17 | 
            +
                username        :  my.user.name
         | 
| 18 | 
            +
                password        :  my_spacewalk_password
         | 
| 19 | 
            +
             | 
| 20 | 
            +
            You can point Buzz at other config files using the -c flag
         | 
| 21 | 
            +
             | 
| 22 | 
            +
                $ buzz system list -c=./other.conf
         | 
| 23 | 
            +
             | 
| 24 | 
            +
            ## The channel commands
         | 
| 25 | 
            +
             | 
| 26 | 
            +
            ### Create
         | 
| 27 | 
            +
             | 
| 28 | 
            +
            You can create a new channel in Spacewalk using
         | 
| 29 | 
            +
             | 
| 30 | 
            +
            option :name, :aliases => ['-n']
         | 
| 31 | 
            +
              option :summary, :aliases => ['-s']
         | 
| 32 | 
            +
              option :arch, :aliases => ['-a']
         | 
| 33 | 
            +
              option :parent, :default => '', :aliases => ['-p']
         | 
| 34 | 
            +
              option :checksum, :default => 'sha256'
         | 
| 35 | 
            +
             | 
| 36 | 
            +
                $ buzz channel create <LABEL> -n <name> -s <summary> -a <architecture> -p <parent-label> --checksum <checksumType>
         | 
| 37 | 
            +
             | 
| 38 | 
            +
            Checksum type will default to sha256
         | 
| 39 | 
            +
             | 
| 40 | 
            +
            ## The system commands
         | 
| 41 | 
            +
             | 
| 42 | 
            +
            ### list 
         | 
| 43 | 
            +
             | 
| 44 | 
            +
            List all registered systems
         | 
| 45 | 
            +
             | 
| 46 | 
            +
                $ buzz system list
         | 
| 47 | 
            +
             | 
| 48 | 
            +
            ### list_by_regex
         | 
| 49 | 
            +
             | 
| 50 | 
            +
            List all registered systems whose name (hostname) matches the provided regex
         | 
| 51 | 
            +
             | 
| 52 | 
            +
                $ buzz system list_by_regex "^testbox.*"
         | 
| 53 | 
            +
             | 
| 54 | 
            +
            Will list all the systems whose hostname begins with testbox
         | 
| 55 | 
            +
             | 
| 56 | 
            +
            ### deleteself
         | 
| 57 | 
            +
             | 
| 58 | 
            +
                $ buzz system deleteself
         | 
| 59 | 
            +
             | 
| 60 | 
            +
            This will de-register the box it is run on from Spacewalk. Handy if you spin up and tear down VMs all the time. Use this command in your tear down scripts.
         | 
| 61 | 
            +
             | 
| 62 | 
            +
            ### delete
         | 
| 63 | 
            +
             | 
| 64 | 
            +
            Delete a specific system by ID
         | 
| 65 | 
            +
             | 
| 66 | 
            +
                $ buzz system delete <SYSTEMID>
         | 
| 67 | 
            +
             | 
| 68 | 
            +
            ### delete_by_regex
         | 
| 69 | 
            +
             | 
| 70 | 
            +
            Delete all registered systems whose name (hostname) matches the provided regex
         | 
| 71 | 
            +
             | 
| 72 | 
            +
                $ buzz system delete_by_regex "^testbox.*"
         | 
| 73 | 
            +
             | 
| 74 | 
            +
            Will delete all the systems whose hostname begins with testbox. Be careful!
         | 
| 75 | 
            +
             | 
| 76 | 
            +
            ## Completeness
         | 
| 77 | 
            +
             | 
| 78 | 
            +
            Buzz is far from a complete implementation. I tend to build a tool to do exactly what I need at that time, and extend it as I need to, or find time, or am asked to. 
         | 
| 79 | 
            +
             | 
| 80 | 
            +
             | 
| 81 | 
            +
            ## Contributing to buzz
         | 
| 82 | 
            +
             
         | 
| 83 | 
            +
            * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
         | 
| 84 | 
            +
            * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
         | 
| 85 | 
            +
            * Fork the project.
         | 
| 86 | 
            +
            * Start a feature/bugfix branch.
         | 
| 87 | 
            +
            * Commit and push until you are happy with your contribution.
         | 
| 88 | 
            +
            * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
         | 
| 89 | 
            +
            * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
         | 
| 90 | 
            +
             | 
| 91 | 
            +
            ## Copyright
         | 
| 92 | 
            +
             | 
| 93 | 
            +
            Copyright (c) 2013 George McIntosh. See LICENSE.txt for
         | 
| 94 | 
            +
            further details.
         | 
| 95 | 
            +
             | 
    
        data/VERSION
    CHANGED
    
    | @@ -1 +1 @@ | |
| 1 | 
            -
            0.0. | 
| 1 | 
            +
            0.0.2
         | 
    
        data/buzz.gemspec
    CHANGED
    
    | @@ -5,7 +5,7 @@ | |
| 5 5 |  | 
| 6 6 | 
             
            Gem::Specification.new do |s|
         | 
| 7 7 | 
             
              s.name = "buzz"
         | 
| 8 | 
            -
              s.version = "0.0. | 
| 8 | 
            +
              s.version = "0.0.2"
         | 
| 9 9 |  | 
| 10 10 | 
             
              s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
         | 
| 11 11 | 
             
              s.authors = ["George McIntosh"]
         | 
| @@ -14,14 +14,14 @@ Gem::Specification.new do |s| | |
| 14 14 | 
             
              s.email = "george@georgemcintosh.com"
         | 
| 15 15 | 
             
              s.extra_rdoc_files = [
         | 
| 16 16 | 
             
                "LICENSE.txt",
         | 
| 17 | 
            -
                "README. | 
| 17 | 
            +
                "README.md"
         | 
| 18 18 | 
             
              ]
         | 
| 19 19 | 
             
              s.files = [
         | 
| 20 20 | 
             
                ".document",
         | 
| 21 21 | 
             
                "Gemfile",
         | 
| 22 22 | 
             
                "Gemfile.lock",
         | 
| 23 23 | 
             
                "LICENSE.txt",
         | 
| 24 | 
            -
                "README. | 
| 24 | 
            +
                "README.md",
         | 
| 25 25 | 
             
                "Rakefile",
         | 
| 26 26 | 
             
                "VERSION",
         | 
| 27 27 | 
             
                "buzz",
         | 
    
        data/lib/buzz.rb
    CHANGED
    
    
    
        metadata
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: buzz
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 0.0. | 
| 4 | 
            +
              version: 0.0.2
         | 
| 5 5 | 
             
              prerelease: 
         | 
| 6 6 | 
             
            platform: ruby
         | 
| 7 7 | 
             
            authors:
         | 
| @@ -145,13 +145,13 @@ executables: [] | |
| 145 145 | 
             
            extensions: []
         | 
| 146 146 | 
             
            extra_rdoc_files:
         | 
| 147 147 | 
             
            - LICENSE.txt
         | 
| 148 | 
            -
            - README. | 
| 148 | 
            +
            - README.md
         | 
| 149 149 | 
             
            files:
         | 
| 150 150 | 
             
            - .document
         | 
| 151 151 | 
             
            - Gemfile
         | 
| 152 152 | 
             
            - Gemfile.lock
         | 
| 153 153 | 
             
            - LICENSE.txt
         | 
| 154 | 
            -
            - README. | 
| 154 | 
            +
            - README.md
         | 
| 155 155 | 
             
            - Rakefile
         | 
| 156 156 | 
             
            - VERSION
         | 
| 157 157 | 
             
            - buzz
         | 
| @@ -177,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement | |
| 177 177 | 
             
                  version: '0'
         | 
| 178 178 | 
             
                  segments:
         | 
| 179 179 | 
             
                  - 0
         | 
| 180 | 
            -
                  hash:  | 
| 180 | 
            +
                  hash: 4071003276715920899
         | 
| 181 181 | 
             
            required_rubygems_version: !ruby/object:Gem::Requirement
         | 
| 182 182 | 
             
              none: false
         | 
| 183 183 | 
             
              requirements:
         | 
    
        data/README.rdoc
    DELETED
    
    | @@ -1,19 +0,0 @@ | |
| 1 | 
            -
            = buzz
         | 
| 2 | 
            -
             | 
| 3 | 
            -
            Description goes here.
         | 
| 4 | 
            -
             | 
| 5 | 
            -
            == Contributing to buzz
         | 
| 6 | 
            -
             
         | 
| 7 | 
            -
            * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
         | 
| 8 | 
            -
            * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
         | 
| 9 | 
            -
            * Fork the project.
         | 
| 10 | 
            -
            * Start a feature/bugfix branch.
         | 
| 11 | 
            -
            * Commit and push until you are happy with your contribution.
         | 
| 12 | 
            -
            * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
         | 
| 13 | 
            -
            * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
         | 
| 14 | 
            -
             | 
| 15 | 
            -
            == Copyright
         | 
| 16 | 
            -
             | 
| 17 | 
            -
            Copyright (c) 2013 George McIntosh. See LICENSE.txt for
         | 
| 18 | 
            -
            further details.
         | 
| 19 | 
            -
             |