{"id":18498778,"url":"https://github.com/smallcase/cdk8s-botkube","last_synced_at":"2025-05-14T05:34:15.490Z","repository":{"id":57683779,"uuid":"478081029","full_name":"smallcase/cdk8s-botkube","owner":"smallcase","description":null,"archived":false,"fork":false,"pushed_at":"2022-04-05T10:41:02.000Z","size":502,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-11T12:06:10.248Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smallcase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2022-04-05T10:35:49.000Z","updated_at":"2022-04-05T10:48:24.000Z","dependencies_parsed_at":"2022-09-17T00:11:34.819Z","dependency_job_id":null,"html_url":"https://github.com/smallcase/cdk8s-botkube","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallcase%2Fcdk8s-botkube","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallcase%2Fcdk8s-botkube/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallcase%2Fcdk8s-botkube/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallcase%2Fcdk8s-botkube/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smallcase","download_url":"https://codeload.github.com/smallcase/cdk8s-botkube/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254076977,"owners_count":22010630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T13:42:34.049Z","updated_at":"2025-05-14T05:34:15.467Z","avatar_url":"https://github.com/smallcase.png","language":"TypeScript","readme":"# CDK8S BotKube\n\n`cdk8s-botkube` is an open-source construct library for cdk8s to deploy a configurable instance of BotKube to your Kubernetes cluster. BotKube is a messaging bot for monitoring and debugging Kubernetes clusters.\nYou provide the configuration for BotKube, our construct library does the rest of the magic.\n\n[Official website](https://www.botkube.io/)\n\n## Installation\n\nInstall using NPM:\n\n```\nnpm install @smallcase/cdk8s-botkube\n```\n\nUsing yarn\n\n```\nyarn add @smallcase/cdk8s-botkube\n```\n\n### Configuration Helper\n\n| Property      | Type                      | Default                              | Description                                                                                                 |\n| ------------- | ------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------- |\n| secretName    | string                    | botkube-communication-secret         | Your BotKube communication secret name (Read below to see how to define your secret)                        |\n| configMapData | string                    | [./configmap.yaml](./configmap.yaml) | YAML formatted string defining your BotKube monitoring config (Read below to see how to define your config) |\n| replicas      | number                    | 1                                    | Number of pod replicas for deployment                                                                       |\n| nodeSelector  | { [key: string]: string } | {}                                   | Node selectors for the BotKube deployment                                                                   |\n| tolerations   | k8s.Toleration[]          | []                                   | Tolerations for the BotKube deployment                                                                      |\n\n## Setting Up Secrets:\n\nSince the communication configuration contains sensitive information like webhook and application tokens we recommend you deploy the configuration as a secret.\n\nTemplate:\n\n```\napiVersion: v1\nkind: Secret\nmetadata:\n  name: botkube-communication-secret\n  labels:\n    app: botkube\ntype: Opaque\nstringData:\n  comm_config.yaml: |\n    ...\n```\n\nFill in the communication secret as per your requirements, have a look at BotKube's official documentation [here](https://www.botkube.io/configuration/#comm_configyaml-syntax) to get an idea of the syntax.\n\n## Setting Up the Resource Config\n\nYou can customize alerts from BotKube as per your needs by tweaking its config. You can leave this field empty and a [default config](./configmap.yaml) will be added, or you can specify a custom YAML config. See resource config syntax [here](https://www.botkube.io/configuration/#resource_configyaml-syntax).\n\n## Using the construct\n\nImport the library in your CDK8s project and pass the necessary parameters to the construct.\n\nExample:\n\n```\nnew BotKube(this, 'botkube-default', {\n  secretName: 'my-secret-name',\n  configMapData: 'Foo',\n  replicas: 2\n});\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmallcase%2Fcdk8s-botkube","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmallcase%2Fcdk8s-botkube","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmallcase%2Fcdk8s-botkube/lists"}