minivault

module
v2.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 31, 2024 License: Apache-2.0

README

Mini Vault

This application serves as a proxy to generate and serve TLS certificates for microservices in the UB-IT architecture.

Development

To run the mini vault locally execute the following commands:

go mod tidy
go run ./cmd/minivault

Add a folder certs with the following files:

  • certs/ca.crt
  • certs/ub-log.ub.unibas.ch.cert.pem
  • certs/ub-log.ub.unibas.ch.key.pem

Docker

The docker image is built in the GitLab CI pipeline. For testing local:

docker build -t test:latest .

docker run -v ./certs:/certs:ro -v ./config:/config:ro test:latest

Swagger Documentation

The documentation is generated by swaggo. First install the dependencies:

go get github.com/swaggo/swag/gen@v1.16.3
go get github.com/swaggo/swag/cmd/swag@v1.16.3
cd pkg/rest
go run github.com/swaggo/swag/cmd/swag init --instanceName MiniVault --parseDependency  --parseInternal -g ./api.go

Documentation

Directories

Path Synopsis
cmd
pkg
k8s
rest/docs
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL