Skip to content

unb-libraries/maximilian.lib.unb.ca

Repository files navigation

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, our unified framework of Robo 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.

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, 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 UNB Libraries 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. 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.