https://github.com/unb-libraries/maximilian.lib.unb.ca
A ChatOps app to interact with Kubernetes via Slack
https://github.com/unb-libraries/maximilian.lib.unb.ca
dockworker ghcr github-actions go slack-bot
Last synced: 6 months ago
JSON representation
A ChatOps app to interact with Kubernetes via Slack
- Host: GitHub
- URL: https://github.com/unb-libraries/maximilian.lib.unb.ca
- Owner: unb-libraries
- License: mit
- Created: 2022-10-04T10:07:00.000Z (about 3 years ago)
- Default Branch: utility
- Last Pushed: 2024-09-06T12:02:21.000Z (about 1 year ago)
- Last Synced: 2025-02-15T18:53:25.703Z (8 months ago)
- Topics: dockworker, ghcr, github-actions, go, slack-bot
- Language: Go
- Homepage:
- Size: 83 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# maximilian.lib.unb.ca
## Introduction
Maximilian is a ChatOps app allowing users to interact with Kubernetes resources via Slack.
## Slack Commands
* ```/drupal-uli``` : Provides a ULI link for Drupal instances
## Deploy this Application Yourself!
Local deployment, development and testing of maximilian is easy, as we leverage [dockworker](https://github.com/unb-libraries/dockworker), our unified framework of [Robo](https://robo.li/) commands that streamline local development of our applications on Linux or OSX.
### Step 1: Install Dockworker's Dependencies
In your local development environment, a minimal number of 'one time' dependencies are required to deploy applications with dockworker. Some or all of these may already be installed in your environment; see the list of dependencies and installation instructions [here](https://github.com/unb-libraries/dockworker/blob/4.x/docs/prerequisites.md).
### Step 2: Deploy
With all dependencies installed, you are ready to deploy any of our applications locally and and begin development:
```
composer install
vendor/bin/dockworker run
```
And that's it! The application will build and deploy in your local environment.
If you work with unb-libraries applications often, you may also consider [installing a dockworker alias](https://gist.github.com/JacobSanford/1448fece856be371060d0f16ccb1b194), which avoids referencing vendor/bin for each dockworker command.
## Notes: k8s API Authentication
The application authenticates to the k8s API via two methods:
* It first attempts authentication using the configuration found at ```$HOME/.kube/config``` - this is useful for local development.
* If the above file does not exist, in-cluster API authentication (via a standard service account token mounted within deployed k8s pods) is attempted.
* If neither file exists, authentication will fail.
## Author / Contributors
This application was created at [](https://lib.unb.ca) by the following humans:
## License
- As part of our 'open' ethos, UNB Libraries licenses its applications and workflows to be freely available to all whenever possible.
- Consequently, the contents of this repository [unb-libraries/maximilian.lib.unb.ca] are licensed under the [MIT License](http://opensource.org/licenses/mit-license.html). This license explicitly excludes:
- Any website content, which remains the exclusive property of its author(s).
- The UNB logo and any of the associated suite of visual identity assets, which remains the exclusive property of the University of New Brunswick.