DEVELOPER_RESOURCES.md

KubeArchive Developer Resources

Scope

This page provides links to resources useful to a KubeArchive developer.

KubeArchive is a utility that stores Kubernetes resources off of the Kubernetes cluster. This enables users to delete those resources from the cluster without losing the information contained in those resources.

Communication

Chat rooms and email addresses for KubeArchive communication.

TBD

Dashboards

TBD

Code Repositories

Git repository for the KubeArchive source code.

• GitHub KubeArchive Repository

Development Resources

Kubernetes

Kubernetes is an open-source container orchestration engine for automating the deployment, scaling, and management of containerized applications.

• Kubernetes

Programming Languages

The Go programming language is an open-source programming language. Go is the preferred language for KubeArchive development.

• Go
• Exercism Learning Track for Go
• Golang By Example - Advanced Tutorial
• Ardan Labs Ultimate Go Tour
• Dave Cheney's Practical Go: Real World Advice Guide

Observability

OpenTelemetry is used to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) to help analyze software’s performance and behavior.

• OpenTelemetry
• OpenTelemetry Go Documentation
• OpenTelemetry Repository for Go Instrumentation

Tools

Additional software that KubeArchive uses.

• Helm - Package Managment for Kubernetes
• Kind - Local Kubernetes Cluster
• Podman Desktop - Includes Kind

To interact directly with the database:

• psql

  $ sudo dnf install postgresql
  $ psql --version
  psql (PostgreSQL) 15.6

A SQL client is recommended to interact easily with the database. For example DBeaver Community. To configure DBeaver, check these instructions.

If you use a Professional version of a Jetbrains IDE like Goland it already provides a built-in SQL client.