REPOSITORY OVERVIEW

Live repository statistics

★ 1Stars

⑂ 0Forks

◯ 0Open issues

◉ 1Watchers

27/100

OPENREPOHUB HEALTH SIGNAL

Limited signals

A transparent discovery signal based on current public GitHub metadata.

Recent activity35% weight

Community adoption25% weight

Maintenance state20% weight

100

License clarity10% weight

Project information10% weight

This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.

README preview

Description

pulumi program written in python to create a namespace in a K8s cluster and deploy a bot in it for ChatOps communication (Slack, Mattermost)

What is ChatOps

ChatOps is a way to execute DevOps tasks, such as deployments, monitoring and system management using chat messages. For example sending a logs message to a chatbot retrieves the latest log messages. Or a deployment could be triggered from a chat message.

This offers a few important advantages:

A very human way to manage your infrastructure, by chatting with a bot.
It can be part of a shared chat, so that people can collaborate and share information. This also offers a record of executed commands and actions.
It can help safely overcome network and firewall restrictions to make working from home or on the go possible.
A unified interface over DevOps tools, manage Kubernetes and OpenShift with the same interfaceIt can simplify and secure infrastructure tasks, so they can be done by the developers themselves.

BotKube Backend Architecture

source: BotKube

Informer Controller: Registers informers to kube-apiserver to watch events on the configured Kubernetes resources. It forwards the incoming Kubernetes event to the Event Manage
Event Manager: Extracts required fields from Kubernetes event object and creates a new BotKube event struct. It passes BotKube event struct to the Filter Engine
Filter Engine: Takes the Kubernetes object and BotKube event struct and runs Filters on them. Each filter runs some validations on the Kubernetes object and modifies the messages in the BotKube event struct if required.
Event Notifier: Finally, notifier sends BotKube event over the configured communication channel.
Bot Interface: Bot interface takes care of authenticating and managing connections with communication mediums like Slack, Mattermost. It reads/sends messages from/to commucation mediums.
Executor: Executes BotKube or kubectl command and sends back the result to the Bot interface.

BotKube ChatOps interaction in multi-environment

Prerequisites

Install BotKube App in your Slack/Mattermost and remember to keep the associated token when creating the app.
Create a dedicated channel in Slack/Mattermost.
Have access to a kubernete cluster with privileges access.
Have a valid pulumi account

Installation

Clone this Git Repository

$git clone https://github.com/chrisley75/pulumi_deploy_k8s_botkube_ChatOps

Manual installation

Create a folder

$mkdir <folder> && cd <folder>

Init a new pulumi stack and configure as a new kubernetes-python

$pulumi stack init
$pulumi new kubernetes-python

Replace main.py with the one in this Github repository

Configuration

Set pulumi environment variables with your environment information.

$pulumi config set SLACK_CHANNEL_NAME <SLACK_CHANNEL>
$pulumi config set CLUSTER_NAME <Cluster_Name>
$pulumi config set ALLOW_KUBECTL True
$pulumi config set --secret SLACK_API_TOKEN <TOKEN>

Check the configured variables

$ pulumi config
KEY                 VALUE
ALLOW_KUBECTL       True
CLUSTER_NAME        <Cluster_Name>
SLACK_API_TOKEN     <TOKEN>
SLACK_CHANNEL_NAME  <SLACK_CHANNEL>

or to visualize encrypt vars

$pulumi config --show-secrets

Deploy the ChatOps BotKube with Pulumi

$ pulumi up
Previewing update (dev)

View Live: https://app.pulumi.com/chrisley75/k8s-apps-chatops-botkube/dev/previews/397a3c49-d785-4ca2-aed7-e082b7565dcd

     Type                                                           Name                                  Plan       Info
 +   pulumi:pulumi:Stack                                            k8s-apps-chatops-botkube-dev          create     6 messages
 +   ├─ kubernetes:helm.sh:Chart                                    botkube                               create     
 +   │  ├─ kubernetes:rbac.authorization.k8s.io:ClusterRole         botkube-clusterrole                   create     
 +   │  ├─ kubernetes:rbac.authorization.k8s.io:ClusterRoleBinding  botkube-clusterrolebinding            create     
 +   │  ├─ kubernetes:core:ServiceAccount                           botkube/botkube-sa                    create     
 +   │  ├─ kubernetes:core:Secret                                   botkube/botkube-communication-secret  create     
 +   │  ├─ kubernetes:core:ConfigMap                                botkube/botkube-configmap             create     
 +   │  └─ kubernetes:apps:Deployment                               botkube/botkube                       create     
 +   └─ kubernetes:core:Namespace                                   botkube                               create     
 
Diagnostics:
  pulumi:pulumi:Stack (k8s-apps-chatops-botkube-dev):
    True
    True
    <pulumi.output.Output object at 0x109c7f160>
    <pulumi.output.Output object at 0x10b2104f0>
    k8schrisley
    k8schrisley
 

Do you want to perform this update? yes
Updating (dev)

View Live: https://app.pulumi.com/chrisley75/k8s-apps-chatops-botkube/dev/updates/41

     Type                                                           Name                                  Status      Info
 +   pulumi:pulumi:Stack                                            k8s-apps-chatops-botkube-dev          created     6 messages
 +   ├─ kubernetes:helm.sh:Chart                                    botkube                               created     
 +   │  ├─ kubernetes:rbac.authorization.k8s.io:ClusterRole         botkube-clusterrole                   created     
 +   │  ├─ kubernetes:rbac.authorization.k8s.io:ClusterRoleBinding  botkube-clusterrolebinding            created     
 +   │  ├─ kubernetes:core:ServiceAccount                           botkube/botkube-sa                    created     
 +   │  ├─ kubernetes:core:Secret                                   botkube/botkube-communication-secret  created     
 +   │  ├─ kubernetes:core:ConfigMap                                botkube/botkube-configmap             created     
 +   │  └─ kubernetes:apps:Deployment                               botkube/botkube                       created     
 +   └─ kubernetes:core:Namespace                                   botkube                               created     
 
Diagnostics:
  pulumi:pulumi:Stack (k8s-apps-chatops-botkube-dev):
    True
    True
    <pulumi.output.Output object at 0x10cddcf10>
    <pulumi.output.Output object at 0x10e374430>
    k8schrisley
    k8schrisley
 
Resources:
    + 9 created

Duration: 12s

If everything went well, the deployment appears directly in your ChatOps and it is now possible to view and manage the cluster (or several clusters) from the channel.

Manage Kubernetes cluster with Chat

Check cluster is ready:

Kubectl command to get namespace on the cluster:

Get state of the creation on resource in the cluster:

be automatically alerted in case of a problem on the cluster:

and so many other possibilities.....

Delete and remove app

This action will delete the app and the namespace in the K8s cluster (Only resources created by this program), but not the stack in pulumi

$ pulumi destroy
Previewing destroy (dev)

View Live: https://app.pulumi.com/chrisley75/k8s-apps-chatops-botkube/dev/previews/834376a4-587b-46e8-9838-5b5666f18b03

     Type                                                           Name                                  Plan       
 -   pulumi:pulumi:Stack                                            k8s-apps-chatops-botkube-dev          delete     
 -   ├─ kubernetes:helm.sh:Chart                                    botkube                               delete     
 -   │  ├─ kubernetes:rbac.authorization.k8s.io:ClusterRole         botkube-clusterrole                   delete     
 -   │  ├─ kubernetes:rbac.authorization.k8s.io:ClusterRoleBinding  botkube-clusterrolebinding            delete     
 -   │  ├─ kubernetes:core:ServiceAccount                           botkube/botkube-sa                    delete     
 -   │  ├─ kubernetes:core:ConfigMap                                botkube/botkube-configmap             delete     
 -   │  ├─ kubernetes:core:Secret                                   botkube/botkube-communication-secret  delete     
 -   │  └─ kubernetes:apps:Deployment                               botkube/botkube                       delete     
 -   └─ kubernetes:core:Namespace                                   botkube                               delete     
 
Resources:
    - 9 to delete

Do you want to perform this destroy? yes
Destroying (dev)

View Live: https://app.pulumi.com/chrisley75/k8s-apps-chatops-botkube/dev/updates/40

     Type                                                           Name                                  Status      
 -   pulumi:pulumi:Stack                                            k8s-apps-chatops-botkube-dev          deleted     
 -   ├─ kubernetes:helm.sh:Chart                                    botkube                               deleted     
 -   │  ├─ kubernetes:core:ConfigMap                                botkube/botkube-configmap             deleted     
 -   │  ├─ kubernetes:core:Secret                                   botkube/botkube-communication-secret  deleted     
 -   │  ├─ kubernetes:core:ServiceAccount                           botkube/botkube-sa                    deleted     
 -   │  ├─ kubernetes:rbac.authorization.k8s.io:ClusterRole         botkube-clusterrole                   deleted     
 -   │  ├─ kubernetes:rbac.authorization.k8s.io:ClusterRoleBinding  botkube-clusterrolebinding            deleted     
 -   │  └─ kubernetes:apps:Deployment                               botkube/botkube                       deleted     
 -   └─ kubernetes:core:Namespace                                   botkube                               deleted     
 
Resources:
    - 9 deleted

Duration: 18s

The resources in the stack have been deleted, but the history and configuration associated with the stack are still maintained. 
If you want to remove the stack completely, run 'pulumi stack rm dev'.

Author

Christopher LEY SRE and MultiCloud Architect at IBM - IBM Services - christopher.ley@ibm.com

ALGORITHMICALLY RELATED

Similar Open-Source Projects

Selected from shared topics, language and repository description—not editorial ratings.

mohdizzy /

pulumi-python-lambda

★ 0

A sample pulumi program written in python that deploys a Lambda function, S3 bucket & DynamoDB table

27/100 health

Active repository

PythonNo license

⑂ 0 forks◯ 0 issuesUpdated Jun 25, 2020

View details View on GitHub ↗