Automate webtop environment deployment using Jinja2 templating

[ThomasCardin]

Executive summary

The goal of this project is to streamline the deployment process for Webtop environments, facilitating rapid setup for new team members and existing team members needing development environments. By utilizing templating and automation, we can ensure consistent, efficient rollouts of these instances.

Users will be able to choose from the following instances for their Webtop deployment (source):

TODO

• Support two Docker images (Fedora and Ubuntu) in order to support binaries pre-installed in both images devops#59
• Implement a workflow to capture user inputs and trigger template rendering. github-workflows#158
• Create a Jinja2 templates to dynamically insert user-specific data into webtop yaml files configuration. devops#61
• Establish an email system to automatically notify users with their temporary access credentials. #414
• Implement secure storage of secrets in Vault via a self-hosted runner. #415
  • This means that secrets from the webtop-secret.yaml will be pushed into Vault before the webtop-secret.yaml file is pushed to the Howard repository
• Ensure generated files are automatically committed and pushed to the Howard repository. devops#63
• Validate the workflow to ensure inputs are processed correctly and environments are deployed as intended. #417
• Documentation (explain how this workflow can be used and add it to integration documentation) #418
• As a DevOps, I want to create unit tests for the webtop template script  devops#64

Exemples

templates/webtop-deployment.yaml.j2

apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ name }}-webtop
spec:
  replicas: 1
  selector:
    matchLabels:
      app: {{ name }}-webtop
  template:
    metadata:
      labels:
        app: {{ name }}-webtop
    spec:
      containers:
      - name: webtop
        image: linuxserver/webtop:ubuntu-kde
        ports:
        - containerPort: 3000
        envFrom:
        - secretRef:
            name: webtop-secrets
        volumeMounts:
        - name: config
          mountPath: /config
      volumes:
      - name: config
        persistentVolumeClaim:
          claimName: webtop-config-pvc

---
apiVersion: v1
kind: Service
metadata:
  name: {{ name }}-webtop-service
spec:
  type: ClusterIP
  selector:
    app: webtop
  ports:
  - protocol: TCP
    port: 3000
    targetPort: 3000

---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: {{ name }}-webtop-config-pvc
spec:
  accessModes:
  - ReadWriteOnce
  resources:
    requests:
      storage: 10Gi

generete-template.py

import sys
from jinja2 import Environment, FileSystemLoader

def render_template(name):
    file_loader = FileSystemLoader('templates')
    env = Environment(loader=file_loader)
    
    template_name = 'webtop-deployment.yaml.j2'
    template = env.get_template(template_name)
    rendered_content = template.render(
        name=name,
    )
    
    output_filename = template_name.replace('.j2', '')
    with open(output_filename, 'w') as f:
        f.write(rendered_content)

if __name__ == '__main__':
    name = sys.argv[1]
    render_template(name)

webtop-deployment.yaml (template outcome):

apiVersion: apps/v1
kind: Deployment
metadata:
  name: thomas-webtop
spec:
  replicas: 1
  selector:
    matchLabels:
      app: thomas-webtop
  template:
    metadata:
      labels:
        app: thomas-webtop
    spec:
      containers:
      - name: webtop
        image: linuxserver/webtop:ubuntu-kde
        ports:
        - containerPort: 3000
        envFrom:
        - secretRef:
            name: webtop-secrets
        volumeMounts:
        - name: config
          mountPath: /config
      volumes:
      - name: config
        persistentVolumeClaim:
          claimName: webtop-config-pvc

---
apiVersion: v1
kind: Service
metadata:
  name: thomas-webtop-service
spec:
  type: ClusterIP
  selector:
    app: webtop
  ports:
  - protocol: TCP
    port: 3000
    targetPort: 3000

---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: thomas-webtop-config-pvc
spec:
  accessModes:
  - ReadWriteOnce
  resources:
    requests:
      storage: 10Gi