Skip to content

Latest commit

 

History

History
135 lines (116 loc) · 5.61 KB

README.md

File metadata and controls

135 lines (116 loc) · 5.61 KB
Raw

Build Status Coverage Status Dependency Status npm

hubot-ibmcloud-auth

Script package that provides simple whitelist access to commands in hubot scripts for IBM Cloud. Two levels of access, reader and power, are offered.

Getting Started

Usage

Steps for adding this to your hubot:

  1. cd into your hubot directory
  2. Install this package via npm install hubot-ibmcloud-auth --save
  3. Add hubot-ibmcloud-auth to your external-scripts.json
  4. Add the necessary environment variables:
HUBOT_IBMCLOUD_POWERUSERS=<comma-separated list of power-user emails -- no spaces!>
HUBOT_IBMCLOUD_READERUSERS=<comma-separated list of reader-user emails -- no spaces!>
HUBOT_IBMCLOUD_LDAP_PROTOCOL=<ldap or ldaps>
HUBOT_IBMCLOUD_LDAP_SERVER=<LDAP server name>
HUBOT_IBMCLOUD_LDAP_PORT=<LDAP port -- 1389>
HUBOT_IBMCLOUD_LDAP_BIND_USER=<LDAP login user>
HUBOT_IBMCLOUD_LDAP_BIND_PASSWORD=<LDAP login user password>
HUBOT_IBMCLOUD_LDAP_ORG_ROOT=<LDAP organization root -- "dc=example,dc=com">
HUBOT_IBMCLOUD_LDAP_EMAIL_FIELD=<LDAP user email field name -- mail>
HUBOT_IBMCLOUD_LDAP_GROUP_MEMBERSHIP_FIELD=<LDAP group member field -- uniqueMember or memberuid>
HUBOT_IBMCLOUD_LDAP_POWERUSERS_GROUP_DN_LIST=<semi-colon separated list of LDAP group distinguished names -- no spaces!>
HUBOT_IBMCLOUD_LDAP_READERUSERS_GROUP_DN_LIST=<semi-colon separated list of LDAP group distinguished names -- no spaces!>
HUBOT_IBMCLOUD_AUTHENTICATION_DISABLED=<only if desired, disables authentication and authorization if true)>
  1. Start up your bot & off to the races!

Access

Reader-level users have access to the following operations:

  • list apps
  • show app logs
  • show app status
  • list containers
  • show container logs
  • show container status
  • list container groups
  • list services
  • get the current space the user is looking at
  • list spaces
  • list services within a space
  • set the current space the user is looking at
  • list openwhisk actions
  • list openwhisk namespaces
  • get the current openwhisk namespace the user is looking at
  • set the current openwhisk namespace the user is looking at
  • list virtual servers
  • list Cloudant databases
  • list Cloudant database info
  • list Cloudant database views
  • run Cloudant database view
  • get natural language classifier status
  • list natural language classifiers
  • list object storage containers
  • get object storage container details

Power-level users have access to the following operations:

  • remove an app
  • restage an app
  • scale an app
  • start an app
  • stop an app
  • remove a container
  • start a container
  • stop a container
  • remove a container group
  • scale a container group
  • bind a service instance
  • create a service instance
  • remove a service instance
  • unbind a service instance
  • deploy to github
  • destroy a virtual server
  • reboot a virtual servers
  • start a virtual server
  • stop a virtual server
  • invoke an openwhisk action
  • enable twitter monitoring
  • disable twitter monitoring
  • edit monitoring tweets
  • create Cloudant databases
  • set Cloudant database permissions
  • start natural language classifier training
  • enable auto approve for natural language classifier
  • retrieve object storage object
  • search for an object in object storage

If a command is not listed, all users have access.

Development

Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:

Configuration Setup

  1. Create config folder in root of this project.
  2. Create env in the config folder, with the following contents:
HUBOT_IBMCLOUD_POWERUSERS=<comma-separated list of power-user emails -- no spaces!>
HUBOT_IBMCLOUD_READERUSERS=<comma-separated list of reader-user emails -- no spaces!>
HUBOT_IBMCLOUD_LDAP_PROTOCOL=<ldap or ldaps>
HUBOT_IBMCLOUD_LDAP_SERVER=<LDAP server name>
HUBOT_IBMCLOUD_LDAP_PORT=<LDAP port -- 1389>
HUBOT_IBMCLOUD_LDAP_BIND_USER=<LDAP login user>
HUBOT_IBMCLOUD_LDAP_BIND_PASSWORD=<LDAP login user password>
HUBOT_IBMCLOUD_LDAP_ORG_ROOT=<LDAP organization root -- "dc=example,dc=com">
HUBOT_IBMCLOUD_LDAP_EMAIL_FIELD=<LDAP user email field name -- mail>
HUBOT_IBMCLOUD_LDAP_GROUP_MEMBERSHIP_FIELD=<LDAP group member field -- uniqueMember or memberuid>
HUBOT_IBMCLOUD_LDAP_POWERUSERS_GROUP_DN_LIST=<semi-colon separated list of LDAP group distinguished names -- no spaces!>
HUBOT_IBMCLOUD_LDAP_READERUSERS_GROUP_DN_LIST=<semi-colon separated list of LDAP group distinguished names -- no spaces!>
HUBOT_IBMCLOUD_AUTHENTICATION_DISABLED=<only if desired, disables authentication and authorization if true)>

License

See LICENSE.txt for license information.

Contribute

Please check out our Contribution Guidelines for detailed information on how you can lend a hand.