Skip to content

Commit a3efab4

Browse files
authored
Botkube rebranding (#793)
* change BotKube -> Botkube * change logos and images related to old brand
1 parent 9f79ea3 commit a3efab4

File tree

81 files changed

+409
-409
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+409
-409
lines changed

.github/CODEOWNERS

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# BotKube maintainers (email: [email protected])
1+
# Botkube maintainers (email: [email protected])
22
# Maintainers are listed alphabetically
33

44
* @kubeshop/botkube-dev @PrasadG193

.github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ labels: bug
1313

1414
<!-- Provide a clear and concise description of the problem.
1515
Describe where it appears, when it occurred, and what it affects.
16-
Provide all relevant technical details such as the BotKube version. -->
16+
Provide all relevant technical details such as the Botkube version. -->
1717

1818
## Expected behavior
1919

.github/workflows/branch-build.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ jobs:
7878
- name: Create cluster
7979
run: "k3d cluster create botkube --wait --timeout=5m"
8080

81-
- name: Install BotKube
81+
- name: Install Botkube
8282
env:
8383
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
8484
DISCORD_BOT_TOKEN: ${{ secrets.DISCORD_BOT_TOKEN }}

.github/workflows/pr-build.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
- '.codespell-whitelist'
1212
- '.gitignore'
1313
- '.golangci.yml'
14-
- 'botkube-title.jpg'
14+
- 'botkube-title.png'
1515
- 'botkube_arch.jpg'
1616
- 'CODE_OF_CONDUCT.md'
1717
- 'comm_config.yaml.tpl'
@@ -34,7 +34,7 @@ env:
3434
jobs:
3535

3636
save-image:
37-
name: Build and save BotKube image
37+
name: Build and save Botkube image
3838
runs-on: ubuntu-latest
3939

4040
permissions:
@@ -71,7 +71,7 @@ jobs:
7171
retention-days: 1
7272

7373
push-image:
74-
name: Push BotKube image
74+
name: Push Botkube image
7575
runs-on: ubuntu-latest
7676
needs: [save-image]
7777

@@ -111,8 +111,8 @@ jobs:
111111
run: |
112112
cat > $GITHUB_STEP_SUMMARY << ENDOFFILE
113113
114-
### BotKube image published successfully! :rocket:
115-
To test BotKube with PR changes, run:
114+
### Botkube image published successfully! :rocket:
115+
To test Botkube with PR changes, run:
116116
117117
gh pr checkout ${PR_NUMBER}
118118
helm install botkube -n botkube --create-namespace \\
@@ -151,7 +151,7 @@ jobs:
151151
- name: Create cluster
152152
run: "k3d cluster create botkube --wait --timeout=5m"
153153

154-
- name: Install BotKube
154+
- name: Install Botkube
155155
env:
156156
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
157157
DISCORD_BOT_TOKEN: ${{ secrets.DISCORD_BOT_TOKEN }}

.github/workflows/process-chart.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ jobs:
9595
cd ${{ github.workspace }}/chart
9696
helm repo index --url "${{ env.CHART_REPOSITORY }}" --merge ./index.yaml .
9797
git add .
98-
git commit -m "${{ inputs.next-version }} BotKube Helm chart release"
98+
git commit -m "${{ inputs.next-version }} Botkube Helm chart release"
9999
git push
100100
env:
101101
GITHUB_TOKEN: ${{ secrets.gh-token }}

CONTRIBUTING.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# How to Contribute to BotKube
1+
# How to Contribute to Botkube
22

33
We'd love your help!
44

5-
BotKube is [MIT Licensed](LICENSE) and accepts contributions via GitHub pull requests. This document outlines conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contributions accepted.
5+
Botkube is [MIT Licensed](LICENSE) and accepts contributions via GitHub pull requests. This document outlines conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contributions accepted.
66

77
We gratefully welcome improvements to [documentation](https://botkube.io/ "Go to documentation site") as well as to code.
88

99
## Contributing to documentation
1010

1111
Follow the [botkube-docs/CONTRIBUTING.md](https://github.com/kubeshop/botkube-docs/blob/main/CONTRIBUTING.md) file to learn how to contribute to documentation.
1212

13-
## Build and run BotKube from source code
13+
## Build and run Botkube from source code
1414

15-
This section describes how to build and run the BotKube from the source code.
15+
This section describes how to build and run the Botkube from the source code.
1616

1717
### Prerequisite
1818

1919
- [Go](https://go.dev), at least 1.18
2020
- `make`
2121
- [Docker](https://docs.docker.com/install/)
2222
- Kubernetes cluster, at least 1.21
23-
- Cloned BotKube repository
23+
- Cloned Botkube repository
2424

2525
Use the following command to clone it:
2626
```sh
@@ -29,11 +29,11 @@ This section describes how to build and run the BotKube from the source code.
2929

3030
### Build and install on Kubernetes
3131

32-
1. Build BotKube and create a new container image tagged as `ghcr.io/kubeshop/botkube:v9.99.9-dev`. Choose one option:
32+
1. Build Botkube and create a new container image tagged as `ghcr.io/kubeshop/botkube:v9.99.9-dev`. Choose one option:
3333

3434
- **Single target build for your local K8s cluster**
3535

36-
This is ideal for running BotKube on a local cluster, e.g. using [kind](https://kind.sigs.k8s.io) or [`minikube`](https://minikube.sigs.k8s.io/docs/).
36+
This is ideal for running Botkube on a local cluster, e.g. using [kind](https://kind.sigs.k8s.io) or [`minikube`](https://minikube.sigs.k8s.io/docs/).
3737

3838
Remember to set the `IMAGE_PLATFORM` env var to your target architecture. For example, the command below builds the `linux/arm64` target. By default, the build targets `linux/amd64`.
3939

@@ -46,7 +46,7 @@ This section describes how to build and run the BotKube from the source code.
4646

4747
- **Multi-arch target builds for any K8s cluster**
4848

49-
This is ideal for running BotKube on remote clusters.
49+
This is ideal for running Botkube on remote clusters.
5050

5151
When tagging your dev image take care to add your target image architecture as a suffix. For example, in the command below we added `-amd64` as our target architecture.
5252

@@ -81,9 +81,9 @@ This section describes how to build and run the BotKube from the source code.
8181

8282
### Build and run locally
8383

84-
For faster development, you can also build and run BotKube outside K8s cluster.
84+
For faster development, you can also build and run Botkube outside K8s cluster.
8585

86-
1. Build BotKube local binary:
86+
1. Build Botkube local binary:
8787

8888
```sh
8989
# Fetch the dependencies
@@ -124,7 +124,7 @@ For faster development, you can also build and run BotKube outside K8s cluster.
124124
...
125125
```
126126

127-
6. Run BotKube binary:
127+
6. Run Botkube binary:
128128

129129
```sh
130130
./botkube
@@ -161,8 +161,8 @@ For faster development, you can also build and run BotKube outside K8s cluster.
161161

162162
## Support Channels
163163

164-
Join the BotKube-related discussion on Slack!
164+
Join the Botkube-related discussion on Slack!
165165

166-
Create your Slack account on [BotKube](https://join.botkube.io) workspace.
166+
Create your Slack account on [Botkube](https://join.botkube.io) workspace.
167167

168168
To report bug or feature, use [GitHub issues](https://github.com/kubeshop/botkube/issues/new/choose).

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<p align="center">
2-
<img src="./docs/assets/botkube-title.jpg" alt="BotKube Logo Light" width="90%" />
2+
<img src="./docs/assets/botkube-title.png" alt="Botkube Logo Light" />
33
</p>
44

55
<p align="center">
6-
BotKube is a messaging bot for monitoring and debugging Kubernetes clusters.
6+
Botkube is a messaging bot for monitoring and debugging Kubernetes clusters.
77
</p>
88

99

@@ -15,7 +15,7 @@
1515
<img src="https://img.shields.io/github/license/kubeshop/botkube" alt="License"/>
1616
</a>
1717
<a href="https://join.botkube.io/">
18-
<img src="https://badgen.net/badge/slack/BotKube?icon=slack" alt="Slack" />
18+
<img src="https://badgen.net/badge/slack/Botkube?icon=slack" alt="Slack" />
1919
</a>
2020
<a href="https://github.com/kubeshop/botkube/actions?query=workflow%3ACI+branch%3Amain">
2121
<img src="https://github.com/kubeshop/botkube/workflows/CI/badge.svg?branch=main" alt="CI Build" />
@@ -27,17 +27,17 @@
2727

2828
## Overview
2929

30-
BotKube helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources. It integrates with multiple communication platforms, such as [Slack](https://slack.com), [Discord](https://discord.com/), or [Mattermost](https://mattermost.com).
30+
Botkube helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources. It integrates with multiple communication platforms, such as [Slack](https://slack.com), [Discord](https://discord.com/), or [Mattermost](https://mattermost.com).
3131

32-
You can also execute `kubectl` commands on K8s cluster via BotKube which helps debugging an application or cluster.
32+
You can also execute `kubectl` commands on K8s cluster via Botkube which helps debugging an application or cluster.
3333

3434
<p align="center">
3535
<img src="./docs/assets/main-demo.gif" />
3636
</p>
3737

3838
## Getting started
3939

40-
Please follow [this](https://botkube.io/installation/) for a complete BotKube installation guide.
40+
Please follow [this](https://botkube.io/installation/) for a complete Botkube installation guide.
4141

4242
## Documentation
4343

@@ -49,39 +49,39 @@ For full documentation, visit [botkube.io](https://botkube.io). The documentatio
4949

5050
### Execute `kubectl` commands
5151

52-
The same `kubectl` capabilities inside your favorite communicator. You do not have to learn anything new! Plus, you can configure which `kubectl` commands BotKube can execute. See [configuration](https://botkube.io/configuration/resource/) for details.
52+
The same `kubectl` capabilities inside your favorite communicator. You do not have to learn anything new! Plus, you can configure which `kubectl` commands Botkube can execute. See [configuration](https://botkube.io/configuration/resource/) for details.
5353

5454
<br /><br />
5555

5656
<img src="./docs/assets/icons/question-answer-line.svg" width="10%" align="left"/>
5757

5858
### Use multiple communication platforms
5959

60-
BotKube integrates with Slack, Discord, Mattermost, Microsoft Teams, ElasticSearch and outgoing webhook. See [configuration](https://botkube.io/configuration/communication/) syntax for details.
60+
Botkube integrates with Slack, Discord, Mattermost, Microsoft Teams, ElasticSearch and outgoing webhook. See [configuration](https://botkube.io/configuration/communication/) syntax for details.
6161

6262
<br /><br />
6363

6464
<img src="./docs/assets/icons/stack-line.svg" width="13%" align="right"/>
6565

6666
### Monitor any Kubernetes resource
6767

68-
BotKube supports literally any Kubernetes resource, including Custom Resources. For example, if you use [`cert-manager`](https://cert-manager.io/), you can get alerted about certificate issue, or backup failure in case you use backup tools like [Velero](https://velero.io/) or [Kanister](https://kanister.io/).
68+
Botkube supports literally any Kubernetes resource, including Custom Resources. For example, if you use [`cert-manager`](https://cert-manager.io/), you can get alerted about certificate issue, or backup failure in case you use backup tools like [Velero](https://velero.io/) or [Kanister](https://kanister.io/).
6969

7070
<br /><br />
7171

7272
<img src="./docs/assets/icons/bug-line.svg" width="12%" align="left"/>
7373

7474
### Debug anywhere, anytime
7575

76-
Using BotKube you can debug your apps deployed on Kubernetes from anywhere. To extract crucial information from the cluster, you can even use mobile communicator apps, like Slack. The entire team can see what steps have already been taken and avoid duplicated work.
76+
Using Botkube you can debug your apps deployed on Kubernetes from anywhere. To extract crucial information from the cluster, you can even use mobile communicator apps, like Slack. The entire team can see what steps have already been taken and avoid duplicated work.
7777

7878
<br /><br />
7979

8080
<img src="./docs/assets/icons/cloud-line.svg" width="12%" align="right"/>
8181

8282
### Deploy on any Kubernetes cluster
8383

84-
You can deploy BotKube backend on any Kubernetes cluster. It doesn't matter whether it is [K3d](https://k3d.io), managed Kubernetes on a cloud provider, or bare-metal one.
84+
You can deploy Botkube backend on any Kubernetes cluster. It doesn't matter whether it is [K3d](https://k3d.io), managed Kubernetes on a cloud provider, or bare-metal one.
8585

8686
## Licence
8787

SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Please do not report security vulnerabilities through public GitHub issues.**
66

7-
To report security vulnerabilities in BotKube project, please email [**[email protected]**](mailto:[email protected]) with a detailed description of the issue. If the issue is confirmed, we will release a patch as soon as possible depending on complexity.
7+
To report security vulnerabilities in Botkube project, please email [**[email protected]**](mailto:[email protected]) with a detailed description of the issue. If the issue is confirmed, we will release a patch as soon as possible depending on complexity.
88

99
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
1010

33.6 KB
Loading
8.38 KB
Loading
5.28 KB
Loading
51.4 KB
Loading
16.2 KB
Loading
7.19 KB
Loading
44.6 KB
Loading
15.4 KB
Loading
5.58 KB
Loading

branding/logos/botkube_1000x1000.png

-114 KB
Binary file not shown.

branding/logos/botkube_192x192.png

-14.6 KB
Binary file not shown.

branding/logos/botkube_32x32.png

-2.12 KB
Binary file not shown.

build/Dockerfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
FROM alpine:3.15
22
ARG botkube_version="dev"
33
LABEL org.opencontainers.image.source="[email protected]:kubeshop/botkube.git" \
4-
org.opencontainers.image.title="BotKube" \
4+
org.opencontainers.image.title="Botkube" \
55
org.opencontainers.image.version="${botkube_version}" \
6-
org.opencontainers.image.description="BotKube is a messaging bot for monitoring and debugging Kubernetes clusters" \
6+
org.opencontainers.image.description="Botkube is a messaging bot for monitoring and debugging Kubernetes clusters" \
77
org.opencontainers.image.documentation="https://botkube.io" \
88
org.opencontainers.image.licenses="MIT"
99

build/test.Dockerfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ COPY $TEST_NAME /test
1212
LABEL name="botkube" \
1313
test=$TEST_NAME \
1414
org.opencontainers.image.source="[email protected]:kubeshop/botkube.git" \
15-
org.opencontainers.image.title="BotKube E2 tests" \
16-
org.opencontainers.image.description="BotKube E2E tests which are run against BotKube installed on Kubernetes cluster and Slack API." \
15+
org.opencontainers.image.title="Botkube E2 tests" \
16+
org.opencontainers.image.description="Botkube E2E tests which are run against Botkube installed on Kubernetes cluster and Slack API." \
1717
org.opencontainers.image.documentation="https://botkube.io" \
1818
org.opencontainers.image.licenses="MIT"
1919

cmd/botkube/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ func run() error {
273273
}
274274

275275
// non-blocking error, move forward
276-
logger.Warn("Config Watcher is still not synchronized. Read the logs of the sidecar container to see the cause. Continuing running BotKube...")
276+
logger.Warn("Config Watcher is still not synchronized. Read the logs of the sidecar container to see the cause. Continuing running Botkube...")
277277
}
278278
}
279279

comm_config.yaml.tpl

+11-11
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ communications:
1010
'alias':
1111
name: 'SLACK_CHANNEL'
1212
notification:
13-
# -- If true, the notifications are not sent to the channel. They can be enabled with `@BotKube` command anytime.
13+
# -- If true, the notifications are not sent to the channel. They can be enabled with `@Botkube` command anytime.
1414
disabled: false
1515
bindings:
1616
executors:
@@ -41,14 +41,14 @@ communications:
4141
mattermost:
4242
enabled: false
4343
url: 'MATTERMOST_SERVER_URL' # URL where Mattermost is running. e.g https://example.com:9243
44-
token: 'MATTERMOST_TOKEN' # Personal Access token generated by BotKube user
45-
team: 'MATTERMOST_TEAM' # Mattermost Team to configure with BotKube
46-
botName: 'BotKube' # Bot name
44+
token: 'MATTERMOST_TOKEN' # Personal Access token generated by Botkube user
45+
team: 'MATTERMOST_TEAM' # Mattermost Team to configure with Botkube
46+
botName: 'Botkube' # Bot name
4747
channels:
4848
'alias':
49-
name: 'MATTERMOST_CHANNEL' # Mattermost Channel for receiving BotKube alerts:
49+
name: 'MATTERMOST_CHANNEL' # Mattermost Channel for receiving Botkube alerts:
5050
notification:
51-
# -- If true, the notifications are not sent to the channel. They can be enabled with `@BotKube` command anytime.
51+
# -- If true, the notifications are not sent to the channel. They can be enabled with `@Botkube` command anytime.
5252
disabled: false
5353
bindings:
5454
executors:
@@ -63,21 +63,21 @@ communications:
6363
enabled: false
6464
appID: 'APPLICATION_ID'
6565
appPassword: 'APPLICATION_PASSWORD'
66-
botName: 'BotKube'
66+
botName: 'Botkube'
6767
notification:
6868
type: short
6969
port: 3978
7070

7171
# Settings for Discord
7272
discord:
7373
enabled: false
74-
token: 'DISCORD_TOKEN' # BotKube Bot Token
75-
botID: 'DISCORD_BOT_ID' # BotKube Application Client ID
74+
token: 'DISCORD_TOKEN' # Botkube Bot Token
75+
botID: 'DISCORD_BOT_ID' # Botkube Application Client ID
7676
channels:
7777
'alias':
78-
id: 'DISCORD_CHANNEL_ID' # Discord Channel id for receiving BotKube alerts:
78+
id: 'DISCORD_CHANNEL_ID' # Discord Channel id for receiving Botkube alerts:
7979
notification:
80-
# -- If true, the notifications are not sent to the channel. They can be enabled with `@BotKube` command anytime.
80+
# -- If true, the notifications are not sent to the channel. They can be enabled with `@Botkube` command anytime.
8181
disabled: false
8282
bindings:
8383
executors:

docs/assets/botkube-title.jpg

-57.1 KB
Binary file not shown.

docs/assets/botkube-title.png

6.88 KB
Loading

0 commit comments

Comments
 (0)