knife-opc 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3257cb3b536d35a41ec3fccb5c73162012fa9953
-  data.tar.gz: a439aff11ffa9bde8fe771cc4d39800875c26ae0
+SHA256:
+  metadata.gz: 21e309366d62a87b653421397ba19dbc9d2c794bf15e6afd523c22b012c465cb
+  data.tar.gz: 2e71da62849d8b082b194ada7ac061150ee79a0d9b07f9bf178fa72350e46718
 SHA512:
-  metadata.gz: 3195effbdcb420a5a81d75dcbdede8345174b733e0b6a8cfe0e71cded805592b5c941a09848d4cbbf09e0429128a42702949b9ef1b25901f5184c00ac698a1c2
-  data.tar.gz: df351c0d42dadc75f675121a6e39bb4da13a5e7abca00dd0392f2aae521300f5959549ad8d10ef69321777397050349ac164c6cf29f664d9993b4e76059dc91a
+  metadata.gz: 758d67e9f2dc3b87559729cddeb03a265a7803f1651fac7aacf6c63c62bb758f2aed2373861d5db2d87b52c9cfdfe389c7ee0a3b95a5e95869cba38896fc5c7e
+  data.tar.gz: 60553dd5d5ed676f9b94582654b832860e59956597b707d37b066ba1fda78582910a00002e4e3b1977acdad5d028f280dfb84dd6d5d395c824294a932cc39456

data/README.md

@@ -1,175 +1,138 @@
-# knife OPC #
+# knife OPC
 
-* Documentation: http://docs.opscode.com/
-* Tickets/Issues: http://tickets.opscode.com
-* IRC: [#chef](irc://irc.freenode.net/chef) and [#chef-hacking](irc://irc.freenode.net/chef-hacking) on Freenode
-* Mailing list: http://lists.opscode.com
+[![Gem Version](https://badge.fury.io/rb/knife-opc.svg)](https://rubygems.org/gems/knife-opc) [![Build Status](https://travis-ci.org/chef/knife-opc.svg?branch=master)](https://travis-ci.org/chef/knife-opc)
 
-# Description
+This knife plugin supports basic organization and user operations in Enterprise Chef (formerly Opscode Private Chef) and Chef Server 12.
 
-This knife plugin supports basic organization and user operations in
-Enterprise Chef (formerly Opscode Private Chef) and Chef Server 12.
+- Documentation: <https://github.com/chef/knife-opc/blob/master/README.md>
+- Source: <http://github.com/chef/knife-opc/tree/master>
+- Issues: <https://github.com/chef/knife-opc/issues>
+- Slack: <http://community-slack.chef.io/>
+- Mailing list: <https://discourse.chef.io/>
 
-# Installation
+## Installation
 
-This knife plugin is packaged as a gem.  To install it, run:
+Using [ChefDK](https://downloads.chef.io/chef-dk/), simply install the Gem:
 
-    gem install knife-opc
+```bash
+chef gem install knife-opc
+```
 
-If you are using ChefDK, run:
+## Configuration
 
-    chef gem install knife-opc
+### knife.rb
 
-## Development version
+Unlike other knife subcommands the subcommands in the knife-opc plugin make API calls against the root of your OPC installations API endpoint.
 
-To install the latest development version:
+Typically the chef_server_url for your OPC installation may look like this:
 
-    git clone https://github.com/opscode/knife-opc.git
-    cd knife-opc
-    gem build knife-opc.gemspec
-    gem install knife-opc-0.3.2.gem
+```
+chef_server_url https://chef.yourdomain.com/organizations/ORGNAME
+```
 
-# Configuration
+To configure knife-opc, set the `chef_server_root` option to the root of your OPC installation:
 
-## knife.rb
-Unlike other knife subcommands the subcommands in the knife-opc
-plugin make API calls against the root of your OPC installations API
-endpoint.
+```
+chef_server_root https://chef.yourdomain.com/
+```
 
-Typically the chef_server_url for your OPC installation may look like
-this:
+Note that most users in an OPC installation lack the permissions to run most of the commands from this plugin. On Chef Server 12, the majority of the commands provided by this plugin can be accessed via `chef-server-ctl` wrapper commands that properly configure knife-opc for administrative action. We recommend you use the wrapper commands whenever possible
 
-    chef_server_url https://chef.yourdomain.com/organizations/ORGNAME
+When using knife-opc directly, many of the commands require special permissions. For instance, in order to use commands such as `knife opc org create`, you must authenticate as the 'pivotal' user.
 
-To configure knife-opc, set the `chef_server_root` option to the root
-of your OPC installation:
+Note that the key for the pivotal user is in /etc/opscode on any node in your Chef Server cluster. We recommend that you only use the pivotal user from a Chef Server itself and not copy this key off the machine. In that case, you should run knife opc on the **Frontend server** as root, with a `knife.rb` in root's home directory.
 
-    chef_server_root https://chef.yourdomain.com/
+```ruby
+current_dir = File.dirname(__FILE__)
+log_level                :info
+log_location             STDOUT
+node_name                "pivotal"
+client_key               "/etc/opscode/pivotal.pem"
+chef_server_root         "https://chef.yourdomain.com/"
+```
 
-Note that most users in an OPC installation lack the permissions to
-run most of the commands from this plugin.  On Chef Server 12, the
-majority of the commands provided by this plugin can be accessed via
-`chef-server-ctl` wrapper commands that properly configure knife-opc
-for administrative action.  We recommend you use the wrapper commands
-whenever possible
+## Knife Sub Commands
 
-When using knife-opc directly, many of the commands require special
-permissions. For instance, in order to use commands such as `knife opc
-org create`, you must authenticate as the 'pivotal' user.
+### knife opc user list (options)
 
-Note that the key for the pivotal user is in /etc/opscode on any node
-in your Chef Server cluster.  We recommend that you only use the
-pivotal user from a Chef Server itself and not copy this key off the
-machine. In that case, you should run knife opc on the **Frontend
-server** as root, with a `knife.rb` in root's home directory.
+_Options_
 
-    current_dir = File.dirname(__FILE__)
-    log_level                :info
-    log_location             STDOUT
-    node_name                "pivotal"
-    client_key               "/etc/opscode/pivotal.pem"
-    chef_server_root         "https://chef.yourdomain.com/"
-
-# Subcommands
-
-## knife opc user list (options)
-
-*Options*
-
-  * `-w`, `--with-uri`:
-     Show corresponding URIs
+- `-w`, `--with-uri`: Show corresponding URIs
 
 Show a list of all users in your OPC installation.
 
-## knife opc user show USERNAME (options)
+### knife opc user show USERNAME (options)
 
-  * `-l`, `--with-orgs`:
-    Show the organizations of which the user is a member.
+- `-l`, `--with-orgs`: Show the organizations of which the user is a member.
 
 Shows the details of a user in your OPC installation.
 
-## knife opc user create USERNAME FIRST_NAME [MIDDLE_NAME] LAST_NAME EMAIL PASSWORD (options)
+### knife opc user create USERNAME FIRST_NAME [MIDDLE_NAME] LAST_NAME EMAIL [PASSWORD] (options)
 
-  * `-f FILENAME`, `--filename FILENAME`:
-    Write private key to FILENAME rather than STDOUT.
+- `-f FILENAME`, `--filename FILENAME`: Write private key to FILENAME rather than STDOUT.
+- `-p`, `--prompt-for-password`: Prompt for password rather than providing it on the command line.
 
-Creates a new user in your OPC installation.  The user's private key
-will be returned in response.  Without this key, the user will need to
-log into the WebUI and regenerate their key before they can use knife.
+Creates a new user in your OPC installation. The user's private key will be returned in response. Without this key, the user will need to log into the WebUI and regenerate their key before they can use knife.
 
-## knife opc user delete USERNAME [-d]
+### knife opc user delete USERNAME [-d]
 
 Deletes the given OPC user.
 
-## knife opc user edit USERNAME
+### knife opc user edit USERNAME
 
 Will open $EDITOR. When finished, Knife will update the given OPC user.
 
-## knife opc user password USERNAME [PASSWORD | --enable_external_auth]
+### knife opc user password USERNAME [PASSWORD | --enable_external_auth]
 
 Command for managing password and authentication for a user.
 
 The last argument should either be a string you want the password to or you can pass --enable_external_auth instead of a password to enable external authentication for this user.
 
-## knife opc org list
+### knife opc org list
 
-  * `-w`, `--with-uri`:
-     Show corresponding URIs
-
-  * `-a`, `--all-orgs`:
-    Display hidden orgs
+- `-w`, `--with-uri`: Show corresponding URIs
+- `-a`, `--all-orgs`: Display hidden orgs
 
 Show a list of all organizations in your OPC installation.
 
-## knife opc org show ORG_NAME
+### knife opc org show ORG_NAME
 
 Shows description of given ORG_NAME.
 
-## knife opc org create ORG_NAME ORG_FULL_NAME
-
-  * `-f FILENAME`, `--filename FILENAME`:
-    Write private key to FILENAME rather than STDOUT.
+### knife opc org create ORG_NAME ORG_FULL_NAME
 
-  *  `-a USERNAME`, `--association_user USERNAME`,
-    Associate USERNAME with the organization after creation.
+- `-f FILENAME`, `--filename FILENAME`: Write private key to FILENAME rather than STDOUT.
+- `-a USERNAME`, `--association_user USERNAME`, Associate USERNAME with the organization after creation.
 
-Creates a new OPC Organization.  The private key for the organization's
-validator client is returned.
+Creates a new OPC Organization. The private key for the organization's validator client is returned.
 
-## knife opc org delete ORG_NAME
+### knife opc org delete ORG_NAME
 
 Deletes the given OPC organization.
 
-## knife opc org user add ORGNAME USERNAME
+### knife opc org user add ORGNAME USERNAME
+
+Adds a user to an organization. Requires that the named organization and user both exist.
 
-Adds a user to an organization.  Requires that the named organization
-and user both exist.
+### knife opc org user remove ORGNAME USERNAME
 
-## knife opc org user remove ORGNAME USERNAME
+Removes a user from an organization. Requires that the named organization and user both exist, and that the user is currently associated with the organization.
 
-Removes a user from an organization.  Requires that the named
-organization and user both exist, and that the user is currently
-associated with the organization.
+## KNOWN ISSUES
 
-# KNOWN ISSUES
+- Attempting to delete and immediately recreate an organization will result in an error (a 500 or a 409 Conflict depending on the server version). This is because of a server-side cache that must be cleared. Restarting the frontend services before recreating the org is necessary to avoid the error.
 
-* Attempting to delete and immediately recreate an organization will
-  result in an error (a 500 or a 409 Conflict depending on the server
-  version). This is because of a server-side cache that must be
-  cleared. Restarting the frontend services before recreating the org
-  is necessary to avoid the error.
+## Contributing
 
-# TODO
+For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
 
-* `--with-users` option for `org show` subcommand.
+## License
 
-## License ##
+Copyright:: Copyright (c) 2011-2016 Chef Software, Inc.
 
-|                      |                                          |
-|:---------------------|:-----------------------------------------|
-| **Copyright:**       | Copyright (c) 2011-2014 Opscode, Inc.
-| **License:**         | Apache License, Version 2.0
+License:: Apache License, Version 2.0
 
+```text
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
@@ -181,3 +144,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
+```

data/lib/chef/knife/opc_org_create.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Steven Danna (<steve@opscode.com>)
-# Copyright:: Copyright 2011 Opscode, Inc.
+# Author:: Steven Danna (<steve@chef.io>)
+# Copyright:: Copyright 2011-2016 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,20 +22,20 @@ module Opc
     banner "knife opc org create ORG_SHORT_NAME ORG_FULL_NAME (options)"
 
     option :filename,
-    :long => '--filename FILENAME',
-    :short => '-f FILENAME',
-    :description => 'Write validator private key to FILENAME rather than STDOUT'
+    :long => "--filename FILENAME",
+    :short => "-f FILENAME",
+    :description => "Write validator private key to FILENAME rather than STDOUT"
 
     option :association_user,
-    :long => '--association_user USERNAME',
-    :short => '-a USERNAME',
-    :description => 'Invite USERNAME to the new organization after creation'
+    :long => "--association_user USERNAME",
+    :short => "-a USERNAME",
+    :description => "Invite USERNAME to the new organization after creation"
 
     attr_accessor :org_name, :org_full_name
 
     deps do
-      require 'chef/org'
-      require 'chef/org/group_operations'
+      require "chef/org"
+      require "chef/org/group_operations"
     end
 
     def run
@@ -47,8 +47,8 @@ module Opc
         exit 1
       end
 
-      org = Chef::Org.from_hash({ 'name' => org_name,
-                                  'full_name' => org_full_name}).create
+      org = Chef::Org.from_hash({ "name" => org_name,
+                                  "full_name" => org_full_name }).create
       if config[:filename]
         File.open(config[:filename], "w") do |f|
           f.print(org.private_key)
@@ -59,8 +59,8 @@ module Opc
 
       if config[:association_user]
         org.associate_user(config[:association_user])
-        org.add_user_to_group('admins', config[:association_user])
-        org.add_user_to_group('billing-admins', config[:association_user])
+        org.add_user_to_group("admins", config[:association_user])
+        org.add_user_to_group("billing-admins", config[:association_user])
       end
     end
   end

data/lib/chef/knife/opc_org_delete.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Steven Danna (<steve@opscode.com>)
-# Copyright:: Copyright 2011 Opscode, Inc.
+# Author:: Steven Danna (<steve@chef.io>)
+# Copyright:: Copyright 2011-2016 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'chef/mixin/root_rest'
+require "chef/mixin/root_rest"
 
 module Opc
   class OpcOrgDelete < Chef::Knife

data/lib/chef/knife/opc_org_edit.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Steven Danna (<steve@opscode.com>)
-# Copyright:: Copyright 2011 Opscode, Inc.
+# Author:: Steven Danna (<steve@chef.io>)
+# Copyright:: Copyright 2011-2016 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'chef/mixin/root_rest'
+require "chef/mixin/root_rest"
 
 module Opc
   class OpcOrgEdit < Chef::Knife
@@ -33,7 +33,7 @@ module Opc
 
       include Chef::Mixin::RootRestv0
 
-      original_org =  root_rest.get("organizations/#{org_name}")
+      original_org = root_rest.get("organizations/#{org_name}")
       edited_org = edit_data(original_org)
 
       if original_org == edited_org

data/lib/chef/knife/opc_org_list.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Steven Danna (<steve@opscode.com>)
-# Copyright:: Copyright 2011 Opscode, Inc.
+# Author:: Steven Danna (<steve@chef.io>)
+# Copyright:: Copyright 2011-2016 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'chef/mixin/root_rest'
+require "chef/mixin/root_rest"
 
 module Opc
   class OpcOrgList < Chef::Knife
@@ -35,9 +35,9 @@ module Opc
     include Chef::Mixin::RootRestv0
 
     def run
-      results =  root_rest.get("organizations")
+      results = root_rest.get("organizations")
       unless config[:all_orgs]
-        results = results.select { |k,v| !(k.length == 20 && k =~ /^[a-z]+$/) }
+        results = results.select { |k, v| !(k.length == 20 && k =~ /^[a-z]+$/) }
       end
       ui.output(ui.format_list_for_display(results))
     end

data/lib/chef/knife/opc_org_show.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Steven Danna (<steve@opscode.com>)
-# Copyright:: Copyright 2011 Opscode, Inc.
+# Author:: Steven Danna (<steve@chef.io>)
+# Copyright:: Copyright 2011-2016 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'chef/mixin/root_rest'
+require "chef/mixin/root_rest"
 
 module Opc
   class OpcOrgShow < Chef::Knife

data/lib/chef/knife/opc_org_user_add.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Marc Paradise (<marc@getchef.com>)
-# Copyright:: Copyright 2014 Chef Software, Inc
+# Author:: Marc Paradise (<marc@chef.io>)
+# Copyright:: Copyright 2014-2016 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,13 +23,13 @@ module Opc
     attr_accessor :org_name, :username
 
     option :admin,
-    :long => '--admin',
-    :short => '-a',
-    :description => 'Add user to admin group'
+    :long => "--admin",
+    :short => "-a",
+    :description => "Add user to admin group"
 
     deps do
-      require 'chef/org'
-      require 'chef/org/group_operations'
+      require "chef/org"
+      require "chef/org/group_operations"
     end
 
     def run
@@ -52,8 +52,9 @@ module Opc
         end
       end
       if config[:admin]
-        org.add_user_to_group('admins', @username)
-        org.add_user_to_group('billing-admins', @username)
+        org.add_user_to_group("admins", @username)
+        org.add_user_to_group("billing-admins", @username)
+        ui.msg "User #{username} is added to admins and billing-admins group"
       end
     end
   end