metal-toolbox / fleet-rest-skeleton

An example service for EM's Fleet Services group

What is this?

This is a small service that exposes a toy RESTful API. It is intended to be a template or example for how we write this sort of code in FleetServices. It also contains example configuration for other useful things such as:

1. Creating a Docker image
2. Launching the service image into our sandbox environment. See the helm directory.
3. Typical pull-request workflow (linting, building, code-analysis)
4. Creating a release image of the software for deployment to Kubernetes.

How do I use it?

That depends on what you want to do.

• You can clone this repo as a template service, make your modifications, and push it to a new repo on Github.com.
• You can get a sense of how we handle common tasks (like using gin or zap) without being overwhelmed by details of a non-trivial service.
• You can propose new conventions (such as adding a client for NATS or FleetDB)
• You can launch this service into our kind sandbox by doing helm install skeleton-test helm from the root of this repo. Port-forward to your local environment to test the API by hand, or configure service-to-service tests with other services in kind.

Much of the functionality is encapsulated into Makefile targets. On the one hand this is a pretty clear abuse of make, but on the other we do it in many other repositories. make will tab-prompt the user with potential targets (e.g. build, image, push-sandbox-image et al.)

I hope it serves to reduce the friction of getting a service into production for you.

fleet-rest-skeleton's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update module github.com/spf13/viper to v1.19.0
• Update goreleaser/goreleaser-action action to v6
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update module golang.org/x/net to v0.23.0 [SECURITY]
• Update module google.golang.org/protobuf to v1.33.0 [SECURITY]
• Update module go.hollow.sh/toolbox to v0.6.3
• Update alpine Docker tag to v3.20.0
• Update anchore/sbom-action action to v0.16.0
• Update golang Docker tag to v1.22.3
• Update module github.com/gin-gonic/gin to v1.10.0
• Update module github.com/prometheus/client_golang to v1.19.1
• Update module go.uber.org/zap to v1.27.0
• Update golangci/golangci-lint-action action to v6
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

dockerfile

Dockerfile

• golang 1.21.3-alpine3.18
• alpine 3.19.1

github-actions

.github/workflows/codeql-analysis.yml

• actions/checkout v4
• github/codeql-action v3
• github/codeql-action v3
• github/codeql-action v3

.github/workflows/push-pr-lint.yml

• actions/setup-go v5
• actions/checkout v4
• golangci/golangci-lint-action v4
• actions/setup-go v5
• actions/checkout v4
• docker/setup-buildx-action v3
• docker/build-push-action v5
• anchore/scan-action v3

.github/workflows/release.yml

• docker/login-action v3
• actions/checkout v4
• actions/setup-go v5
• anchore/sbom-action v0.15.8
• goreleaser/goreleaser-action v5

gomod

go.mod

• go 1.21
• github.com/equinix-labs/otel-init-go v0.0.9
• github.com/gin-gonic/gin v1.9.1
• github.com/pkg/errors v0.9.1
• github.com/prometheus/client_golang v1.18.0
• github.com/spf13/cobra v1.8.0
• github.com/spf13/viper v1.18.2
• go.hollow.sh/toolbox v0.6.2
• go.uber.org/zap v1.26.0
• golang.org/x/net v0.20.0
• google.golang.org/protobuf v1.32.0

---

• Check this box to trigger a request for Renovate to run again on this repository