oneofftech/k-link-registry repository overview

-

⁠K-Link-Registry

The K-Link-Registry is a Web Application that allows its Users, the "Registrants", to modify Applications served by K-Link.

⁠Installation

Precompiled binaries as well as docker images are provided for easy installation.

⁠Migrating from K-Link-registry 1

K-Link registry builds ontop of the API schema for the last iteration of the registry. It can be used with a preexisting Database, but this database needs to be migrated first. Refer to the documentation of the migrate subcommand.

⁠Usage

K-Link registry exposes two APIs: Version 1.0 is currently used as an endpoint for application validation, Version 2.0 is used by the frontend to get access to the managed resources, but can be used by other apps in the same way, once they are authenticated.

⁠Configuration

The software can be configured via a config file, environment variables or flags. To learn about the various options, run the binary using the help command, i.e. klinkregistry help.

⁠Base config

Used by every command

⁠server config

Used by the server subcommand

⁠migrate config

This command uses the base configuration

Supported arguments:

• up migrates to the latest database revision, this is probably what you have in mind
• down cleans the database
• 1 migrates to the specific revision number, '1' in this case

⁠Development

The K-Link Registry is written in GoLang⁠ with a VueJS⁠ frontend. We currently target Go 1.10.

⁠Build the binary

• Clone the repository in your Go path under github.com/k-box/k-link-registry
• Enter the cloned repository
• Pull in the dependencies via go get -tags="dev" -v github.com/k-box/k-link-registry/klinkregistry
• Run go get github.com/shurcooL/vfsgen/cmd/vfsgendev
• Build the frontend⁠
• Move to the ui directory
• Execute yarn (or npm install)
• Execute yarn development (or npm run development)

Now you are ready to build a development version.

Build for development

Building a development version will generate a binary that access the migrations and the frontend layer directly from the respective location on disk.

go build --tags="dev" github.com/k-box/k-link-registry/klinkregistry

Watch for changes

During development you might want to continuously re-build the binary and run it to try the changes. To this aim we selected Modd⁠, which is a tool that triggers commands and manages daemons in response to filesystem changes.

# Get Modd
go get -v github.com/cortesi/modd/cmd/modd

# Inser the configuration to be used by the K-Link Registry when started
mkdir ./dist
cp config.example.yaml ./dist/config.yaml

# Run Modd to watch for go files changes
modd --file="./modd.conf"

Build for production

# Build the frontend assets for production
cd ui
yarn production # or npm run production
cd ..

# Enable the assets to be included in the final binary
go generate github.com/k-box/k-link-registry/assets

# Generate the production binary
go build --tags="netgo" github.com/k-box/k-link-registry/klinkregistry

⁠Frontend

For the development documentation of the frontend please refer to the ./ui folder⁠

⁠Known Bugs

Users cannot change their name once registred, except if they are owner