README.md in ogre-0.1.4 vs README.md in ogre-0.1.5
- old
+ new
@@ -12,12 +12,14 @@
While this functionality already exists in [knife-opc](https://github.com/chef/knife-opc), we wanted to be able to create the chef policy repository as well and set the private key into vCenter Orchestrator all in one tool.
## Installation
-`gem install ogre`
+There's an open ended dependency on the ChefDK and is expected you have it already installed. The best way to install ogre the least amount of dependencies is to:
+`chef gem install ogre`
+
## Configuration
### ~/.ogre/config.json
All of the parameters here are optional and can be passed in and/or overriden at the CLI. As of today, the `pivotal` user is the only user able to execute certain methods via the [Chef API](https://docs.chef.io/api_chef_server.html). The key can be found in `/etc/opscode/pivotal.pem` on the Enterprise Chef box.
@@ -29,11 +31,12 @@
"server_url":"https://chef.url",
"vco_url":"https://vco.url:8281/",
"vco_user": "domain\\user",
"vco_password":"password",
"vco_wf_name":"vco_workflow_name",
- "vco_verify_ssl":"false"
+ "vco_verify_ssl":"false",
+ "repo_url":"https://path.to/skeleton_repo"
}
```
## Usage
@@ -42,22 +45,33 @@
- `-p`, `--create-repo` Create Chef policy repository
- `-P`, `--repo-path` Chef policy repo path
- `-I`, `--license=LICENSE` Chef policy repository license
- `-m`, `--email=EMAIL` Chef policy repository e-mail
- `-C`, `--authors=AUTHORS` Chef policy repository authors
+- `-r`, `--repo-url=REPO_URL` Chef Policy Repository skeleton url
When using `-p`, Ogre will save the Chef policy repository as ~/.ogre/ORG-chef, otherwise it will output the validator key for the new organization.
ogre org-delete ORG (options)
---
- `-f`, `--force` Delete without confirmation
+ogre org-list ORG (options)
+---
+
+ogre org-show ORG (options)
+---
+Users in the admin group are prefixed with `@`
+
ogre user-create USERNAME FIRST_NAME LAST_NAME EMAIL PASSWORD (options)
---
ogre user-delete USERNAME (options)
---
- `-f`, `--force` Delete without confirmation
+
+ogre user-list (options)
+---
ogre associate ORG USER (options)
---
- `-a`, `--admin` Add user to admin group within organization