https://github.com/jnsgruk/hello-kubecon
A Charmed Operator demonstration for Operator Day 2021, hosted by Canonical
https://github.com/jnsgruk/hello-kubecon
canonical charm charmed-operator demo juju kubecon kubernetes operator-day training
Last synced: about 1 year ago
JSON representation
A Charmed Operator demonstration for Operator Day 2021, hosted by Canonical
- Host: GitHub
- URL: https://github.com/jnsgruk/hello-kubecon
- Owner: jnsgruk
- License: apache-2.0
- Created: 2021-04-22T09:00:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T17:24:18.000Z (about 1 year ago)
- Last Synced: 2025-03-24T18:33:59.321Z (about 1 year ago)
- Topics: canonical, charm, charmed-operator, demo, juju, kubecon, kubernetes, operator-day, training
- Language: Python
- Homepage:
- Size: 73.2 KB
- Stars: 15
- Watchers: 4
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Operator Day 2021 Demo Charm
Contents
> [!WARNING]
> This charm is now quite out of date. Feel free to follow the example from the YouTube video, but
> note that charming practices have evolved. For more information, see https://juju.is/docs/sdk,
> or get in touch with us on the [Ubuntu Matrix](https://ubuntu.com/community/communications/matrix)!
Overview
Quickstart
Development Setup
Build and Deploy Locally
Testing
Get Help & Community
More Information/Related
Overview
This [charm](https://charmhub.io/hello-kubecon) is a demonstration of a charm
implemeting the sidecar pattern used during
[Operator Day 2021](https://www.linkedin.com/events/6788422954821656577/). You
can grab the slides from the demo [here](https://jnsgr.uk/demo-slides).
The charm is written using the
[Charmed Operator Framework](https://github.com/canonical/operator).
It deploys [gosherve](https://github.com/jnsgruk/gosherve), relying upon the
charm container to populate a shared volume with a simple
[landing-page](https://github.com/canonical-web-and-design/kubecon-2021/) style
website and configure the app before it is started.
Slides for the demo [are available](https://jnsgr.uk/demo-slides) and there
is a supporting [Github Gist](https://jnsgr.uk/demo-gist) that contains copy-and-
pastable content from the slide deck.
The finished charm is published [on Charmhub](https://charmhub.io/hello-kubecon).
The charm will:
- Deploy a container running [gosherve](https://github.com/jnsgruk/gosherve)
- Fetch a website [from Github](https://jnsgr.uk/demo-site-repo)
- Place the downloaded file in a storage volume
- Expose a `redirect-map` config item to configure
[gosherve](https://github.com/jnsgruk/gosherve) redirects
- Expose a `pull-site` action to pull the latest version of the test site
- Utilise an ingress relation using the
[`nginx-ingress-integrator`](https://charmhub.io/nginx-ingress-integrator) library
Each branch of this repository represents a different stage from the demonstration:
- [`1-specify-workload`](https://github.com/jnsgruk/hello-kubecon/tree/1-specify-workload)
- [`2-handle-configuration`](https://github.com/jnsgruk/hello-kubecon/tree/2-handle-configuration)
- [`3-storage`](https://github.com/jnsgruk/hello-kubecon/tree/3-storage)
- [`4-action`](https://github.com/jnsgruk/hello-kubecon/tree/4-action)
- [`5-ingress`](https://github.com/jnsgruk/hello-kubecon/tree/5-ingress)
- [`master`](https://github.com/jnsgruk/hello-kubecon/)
Quickstart
Assuming you already have Juju installed and bootstrapped on a cluster (if you
do not, see the next section):
```bash
# Create a juju model
$ juju add-model dev
# Deploy the charm
$ juju deploy hello-kubecon
# Deploy the ingress charm
$ juju deploy traefik-k8s --trust
$ juju config traefik-k8s external_hostname=juju.local
$ juju config traefik-k8s routing_mode=subdomain
# Relate our app to the ingress
$ juju relate hello-kubecon traefik-k8s
# Wait for the deployment to complete
$ watch -n1 --color juju status --color
# Add an entry to /etc/hosts
$ echo " dev-hello-kubecon.juju.local" | sudo tee -a /etc/hosts
```
You should be able to visit [http://dev-hello-kubecon.juju.local](http://dev-hello-kubecon.juju.local)
in your browser.
Development Setup
To set up a local test environment with [MicroK8s](https://microk8s.io):
```bash
# Install MicroK8s
$ sudo snap install --classic microk8s
# Wait for MicroK8s to be ready
$ sudo microk8s status --wait-ready
# Enable features required by Juju controller & charm
$ sudo microk8s enable storage dns metallb
# (Optional) Alias kubectl bundled with MicroK8s package
$ sudo snap alias microk8s.kubectl kubectl
# (Optional) Add current user to 'microk8s' group
# This avoid needing to use 'sudo' with the 'microk8s' command
$ sudo usermod -aG microk8s $(whoami)
# Activate the new group (in the current shell only)
# Log out and log back in to make the change system-wide
$ newgrp microk8s
# Install Charmcraft
$ sudo snap install charmcraft
# Install juju
$ sudo snap install --classic juju
# Bootstrap the Juju controller on MicroK8s
$ juju bootstrap microk8s micro
# Add a new model to Juju
$ juju add-model dev
```
Build and Deploy Locally
```bash
# Clone the charm code
$ git clone https://github.com/jnsgruk/hello-kubecon && cd hello-kubecon
# Build the charm package
$ charmcraft pack
# Create a juju model
$ juju add-model dev
# Deploy!
$ juju deploy ./hello-kubecon_ubuntu-20.04-amd64.charm --resource gosherve-image=jnsgruk/gosherve:latest
# Deploy the ingress charm
$ juju deploy traefik-k8s --trust
$ juju config traefik-k8s external_hostname=juju.local
$ juju config traefik-k8s routing_mode=subdomain
# Relate our app to the ingress
$ juju relate hello-kubecon traefik-k8s
# Wait for the deployment to complete
$ watch -n1 --color juju status --color
# Add an entry to /etc/hosts
$ echo " dev-hello-kubecon.juju.local" | sudo tee -a /etc/hosts
```
You should be able to visit [http://dev-hello-kubecon.juju.local](http://dev-hello-kubecon.juju.local)
in your browser.
Testing
```bash
# Clone the charm code
$ git clone https://github.com/jnsgruk/hello-kubecon && cd hello-kubecon
# Install python3-virtualenv
$ sudo apt update && sudo apt install -y python3-virtualenv
# Create a virtualenv for the charm code
$ virtualenv venv
# Activate the venv
$ source ./venv/bin/activate
# Install dependencies
$ pip install -r requirements-dev.txt
# Run the tests
$ ./run_tests
```
Get Help & Community
If you get stuck deploying this charm, or would like help with charming
generally, come and join the charming community!
- [Community Discourse](https://discourse.charmhub.io)
- [Community Chat](https://chat.charmhub.io/charmhub/channels/creating-charmed-operators)
More Information/Related
Below are some links related to this demonstration:
- [Charmed Operator Framework Documentation](https://juju.is/docs/sdk)
- [Charmed Operator Framework Source](https://github.com/canonical/operator)
- [Juju Documentation](https://juju.is/docs/olm)
- [Charmhub](https://charmhub.io)
- [Pebble](https://github.com/canonical/github)
- [The Future of Charmed Operators on Kubernetes](https://discourse.charmhub.io/t/4361)