Project status: Not completed | On hold

kube-bot

A Kubernetes Slack bot. Addressed by the named @kube.

Table Of Contents

• Commands
• Permissions
• Contributing

Commands

You communicate with Kube in a command line-ish way. The first word of every message must be a valid command. These commands can have sub commands and arguments.

There is one exception to this, augmentations. Augmentations are arguments you can pass Kube, before the command. To change the behavior of Kube in a way that is independent of any command.

Avaliable augmentations are:

• ⭕ thread
  • Forces Kube to reply in a thread
• ⭕ channel
  • Forces Kube to reply in the channel
• ⭕ pm
  • Forces Kube to reply in a private message

Example: Making Kube describe a resource in the channel: @kube channel describe ingress/application-name.

Most commands have a <query> argument. Which specifies which Kubernetes resource you are trying to perform an action on. This query format follows the exact same syntax as the kubectl tool: <type>/<name>[/<revision>].

Kube responds to the following commands:

✅ = Available, ⭕ = In Progress

• ⭕ get <query>
  • Retrieves a list of resources based on the given query
• ⭕ describe <query>
  • Shows detailed information about a particular item specified by the query
• ⭕ rollout <sub command> <query>
  • Performs actions related to application rollouts (updating versions, deployments)
  • The application to perform rollout related actions on is specified by the query option
  • Available sub commands are:
    • status
      • Shows the status of the specified rollout
    • pause
      • Pauses the specified rollout
    • resume
      • Resumes the specified rollout
    • history
      • Shows the rollout history for the specified resource
    • undo
      • Revert to the specified rollout
• ⭕ scale <query> <number>
  • Scales the resource specify by the provided query to the provided number of replicas
• ⭕ logs <query> [top | bottom] [<lines>]
  • Displays the logs from the resource specified by the query
  • By default 25 lines from the logs are shown. This can be changed by providing your own number of lines as an argument
  • By default this command will display the # of lines specified from the bottom of the logs. This can be changed by providing the top or bottom keywords (Not both)
• ⭕ version
  • Displays version information about kube-bot

All of which are existing kubectl commands. The following original commands are also provided:

• ⭕ track <repo name> [#<channels...>] [anyones | mine | none] [all | failure | success] [<branches...>]
  • Signs you up to receive messages about application deployments
  • The repo name argument should be the name of a GitHub repo. In the form username/repository.
  • An optional list of channels to update about deployments can be provided. Channels names must have a # before their name, and be separated by spaces
  • One of, and no more, of the following keywords can be provided after the repo name argument: anyones, mine, or none
    • If none of these keywords is provided mine is assumed
    • anyones signs you up for updates about all commits
    • mine signs you up for updates only about your commits
    • none unsubscribes you from any updates
  • One of the following keywords can be provided after the repo name argument:
    • If none of these keywords is provided all is assumed
    • all signs you up for updates about all deployments
    • failure signs you up to be updated only when a deployment fails
    • success signs you up to be updated only when a deployment succeeds
  • The branches argument can be used to customize which branches you receive updates about
    • If none are provided, you are signed up for updates about all branches
    • Multiple branch names can be provided, separated by spaces
• ⭕ group <sub command> <user> <group>
  • Performs group related actions on the specified user and group
  • Valid sub commands are:
    • add
      • Adds the user to the group
      • If the specified group does not exist yet, creates it
    • remove
      • Removes the user from the group
• ⭕ access [<action> <entity> <resource>]
  • Controls access to the specified resource
  • If no arguments are provided, a in Slack UI message is sent back with controls for access. This will be sent to the user in a personal message.
  • The action argument can be either: allow or deny. And either grants or blocks access to the specified resource
  • The entity argument can be either a user name or a group name
• ⭕ config [<key>] [<value>]
  • Manages kube-bot configuration
  • If no key is provided, a general settings message will be sent in response. Where users can edit settings via a in Slack UI of sorts. This will be sent in a personal message
  • One can view a key's value by providing only the key argument
  • If only the key argument is provided, but no parameter matches exactly, a search will be performed, and similar settings keys will be listed
  • If the key and value arguments are provided, the specified option will be set to the specified value
  • Valid keys are:
    • reply
      • Specifies the method of response Kube bot should use by default
      • Default value is thread
      • Values are:
        • channel: Respond in the channel message was sent in
        • thread: Respond in a thread, in the channel the message was sent in
• ⭕ shutup [sorry]
  • Emergency kill switch if Kube is misbehaving. Will disallow all communication until the command is called again with the sorry keyword
  • If the sorry keyword is present any existing blocks on Kube's communication will be removed. And Kube will return to normal. However messages scheduled to send during communication blocks time will be dropped (and logged). As they might be incorrect or buggy.
• ⭕ your <key>
  • Used to retrieve internal Kube bot related information. The information retrieved is based on the key argument
  • Valid key values are:
    • health
      • Retrieves Kube bot's current health
• ⭕ help
  • Prints this command list

Permissions

Kube bot has permission model built in. Which controls who is allowed to do what. Permissions are controlled on a per action basis. Actions are scoped around the effect of a command and the resource it acts on.

Actions are represented by strings in the format <resource>.<action>.

Contributing

Kube Bot is an Open Source Software project. And welcomes contributions from anyone and everyone.

Check out the issue tracker to find work. Or open an issue if you found a bug or had an idea for a new feature. Or, even better, open a Pull Request with the code for that new feature!