exbotanical / goldmund-sh-i

Retired personal website. Distributed, multi-service system automated with Kubernetes, custom headless CMS, and bespoke CDN pipeline.

My name is Matthew Zito. I'm a software engineer at Amazon Web Services. Lately, I'm interested in schedulers, daemons, and processes. Here you'll find all of my open source personal projects written in js, ts, c, go, java, python, kotlin, rust, ocaml, x86 assembly (prefer AT&T syntax).

For more stuff, you can check out my software bucket list and finally, my personal blog where I predominantly write source code reviews. `

goldmund-sh-i's Issues

[feature] Upgrade to HTTP/2

This is a low-priority feature. I'll probably wait until the various Node deps I'm relying upon offer better support for HTTP/2.

configure CI/CD pipeline

Given we've already built out two containerized services (the next server and the DPS micro-service), preemptively establishing a CI/CD pipeline for development is a denomination long passed. Blocks TBD; needs to be done before analytics micro-service dev begins.

[cli] Add ephemeral template reset to deauth

• Template resets after deauth has been called with a returned status of 204.
• Template fields do NOT contain the ID field once reset.

[next-server] populate meta headers with data `tags`

Closed by #31

[goldmund-cli] bugfix - web utilities

fix boolean expression

[goldmund-api] add GNU custom header

const msg = "GNU Terry Pratchett"

module.exports = function(req, res, next){
    setHeader(res,msg);
    next()
}

module.exports.msg = function(headerText){
    msg = headerText.replace(/[^\x20-\x7E]+/g, '')
    return this;
}

function setHeader(res, msg){
    res.setHeader('X-Clacks-Overhead', msg );
}

[dev] test deployment configurations list

• nextjs telemetry disabled
• docker-compose restart policies established
• docker-compose wait-for-it set to use --strict flag tested

est admin routing, HOC

Closed by #19 - migrate to CLI for localized sessions management.

est production error boundary

[CI/CD] Add Makefile for repository

• 'Single source of truth' root environment allocation
• build CLI binary and persist in PATH (prompt user, macos + linux only)
• automate docker deployment pipeline

[CI/CD] est Skaffold for local k8s dev

• Skaffold has been configured for local Kubernetes development.

est. email endpoint w/ sanitization validator

[CI/CD] disable THP support in container host to fix caching latency issues

Depends on #8

[CI/CD] Config Lerna for monorepo handling

• All packages should be managed from the root directory
• All dependency locks should be sym-linked
• Dockerfile should build shared dependencies volume

refactor controllers

• est controller classes
• export and test all handlers

[CI/CD] set polling for database index to trigger SSG re-build

Whenever a new resource is pushed to the database via the CLI, the client application [next-server] needs to be notified so it can include said resource in its static site generation build profile. In order to do this, a shell script can live inside the host container and poll for db index changes, and trigger SSG builds as needed.

Add pagination, at vestibule component

[goldmund-client] upgrade to `getStaticProps`

I can save a ton of overhead by utilizing getStaticProps and getStaticPaths on the entries pages. This will enable SSG.

[SEO] Assign static indexer preview image

Figure out how this works and make the site's preview image static.

[goldmund-client] add helmet for headers

• est architectural obfuscation
• enforce content policies at all endpoints

SEO optimize via meta wrapper

wrap services in docker-compose

Way over-due for dev/prod pipeline configuration.

• bind dev src directory to DPS' tmp volume
• write bash script to seed DB inside container using constants lib (bypasses known environment issues in Docker)

[CI/CD] Est. A/B Deployment Pipeline

Implement A/B testing across cloned micro-service instances once Nginx incorporated for load balancing

A lot of research will be needed on this one...let's do it!

[goldmund-client] update outbound links, reallocate masonry in component lifecycle

• add link to Medium, social
• fix masonry initialization (as it stands, the masonry script is being executed, naturally, after component hydration. Given the script execution's predecessors are blocking, a simple fix would be to cache the masonry script and bind its initialization context to the initial render)

[CI/CD] Est K8s Deployment

• Kubernetes deployment configuration should mirror Compose build requirements
• All networks should be bound to loopback interface/internal pod namespace
• Web NodePort should be configured (dev only)
• The following prod endpoints should be configured: web, SSL tunnel
• An Ingress controller should be configured
• RBAC should be enforced.
• TLS should be configured across all planes.

[goldmund-client] Add transparent overlay to search for enhanced UX and accessibility

[dps-api] enable asymmetric alg for token encryption

[feature] migrate client to serverless via AWS Lambda

low priority
Migrate Nextjs frontend from Kubernetes to serverless w/ AWS Lambda

[goldmund-client] WCAG Compliance Checklist

• fulfill WCAG AAA checklist

[feature] Add steganographer

low priority

• Runs as a separate Node worker process
• Pub/Sub w/Redis to coordinate image conversions.
• Sharp entropy to auto-crop and deflate assets prior to persisting in-memory

[dps-api] Add JSDocs

sessions auth handling

[goldmund-cli] consolidate field operations to markdown template

• All fields are set in the markdown template.
• All validation logic is applicable to markdown template's field allocations.
• The JSON template file has been deprecated.

[dps-api] Est. persistent logging

• Logger should be verbose
• Logs should be persisted to local storage at regular intervals

add backup hydration component

implement batch processing in DPS

data processing service requires a dedicated handler for dynamically processing batches contingent on queries from the client service (Next v9 server)

• it should accept as input the ObjectID of the last document in the preceding batch (ObjectID should have a default parameter of null)
  • if ObjectID evaluates to null, begin cursor at batch 0
• it should return the ObjectID of the last document in the current batch being processed
  • if the returned value last processed ObjectID evaluates to null, signify EOF
• it should return the current batch of documents
  • if the returned documents object evaluates to null, signify EOF

[goldmund-client] configure multi-zonal sub-ingress

In order to scale up goldmund-client, I need to establish a sub-ingress service which is charged with handling the routing of instances' respective BUILD_IDs. At a glance, I suspect the path to accomplishing this lies in Nextjs' advanced 'multi-zone' feature, as described here

[goldmund-client] TypeScript Migration

• Wire Nextjs built-in TS support via next.config
• Migrate client service src to TypeScript

This will afford for better scaling in the future as the codebase will be exponentially more aligned with self-documentation if type-specification is provided. This will tangentially improve security as well.

[goldmund-client] Route backend to nginx reverse proxy

Now that the reverse proxy is working properly, it's time to add the second service:

• test API endpoint as configured via reverse proxy
• run nmap scan on daemon host
  • All Docker host ports are locked down
  • Services are only accessible via reverse proxy

[goldmund-client] grid styles need to be dynamic

• dynamic sizing for grid containers
• mosaic rendering
• fix flex-box rendering @ viewport < 900px