https://github.com/hochfrequenz/malo-id-generator
A simple go backend (encapsulated into an Azure Function) with HTML frontend that generates random Markt-, Mess- and Netzlokation- and SR/TR-IDs for testing purposes with an "exotic" tech stack
https://github.com/hochfrequenz/malo-id-generator
azure-functions maloid marktlokation neloid netzlokation tool
Last synced: 7 months ago
JSON representation
A simple go backend (encapsulated into an Azure Function) with HTML frontend that generates random Markt-, Mess- and Netzlokation- and SR/TR-IDs for testing purposes with an "exotic" tech stack
- Host: GitHub
- URL: https://github.com/hochfrequenz/malo-id-generator
- Owner: Hochfrequenz
- License: mit
- Created: 2022-04-20T11:50:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T10:07:44.000Z (8 months ago)
- Last Synced: 2025-03-06T11:23:20.773Z (8 months ago)
- Topics: azure-functions, maloid, marktlokation, neloid, netzlokation, tool
- Language: HTML
- Homepage: https://netz.lokations.id
- Size: 240 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# malo-id-generator / nelo-id-generator
🇩🇪 Dieses Repository enthält den Source Code hinter den Websites:
* [markt.lokations.id](https://markt.lokations.id), einem Generator für Marktlokations-IDs ("MaLo-ID") zu Testzwecken
* [netz.lokations.id](https://netz.lokations.id), einem Generator für Netzlokations-IDs ("NeLo-ID") zu Testzwecken
* [mess.lokations.id](https://mess.lokations.id), einem Generator für Messlokations-IDs ("MeLo-ID") zu Testzwecken
* [technische.ressource.id](https://technische.ressource.id), einem Generator für Technische Ressourcen-IDs ("TR-ID") zu Testzwecken
* [steuerbare.ressource.id](https://steuerbare.ressource.id), einem Generator für Steuerbare Ressourcen-IDs ("SR-ID") zu Testzwecken
🇬🇧 This repository contains
an [Azure Function with a Go Handler](https://docs.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-other?tabs=go%2Cwindows) which is deployed to [netz.lokations.id](https://netz.lokations.id) and [markt.lokations.id](https://markt.lokations.id).
The tech stack is historically grown and not a good choice - but it works 😉
Its purpose is to
- generate:
1. Marktlokations-IDs (MaLo-IDs)
2. Netzlokations-IDs (NeLo-IDs)
3. Messlokations-IDs (MeLo-IDs)
4. Technische Ressourcen-IDs (TR-IDs)
5. Steuerbare Ressourcen-IDs (SR-IDs)
- with a valid checksum
- on the fly
The business logic is written in Go using [Gin Gonic](https://gin-gonic.com/) and can be found in [cmd/api.go](cmd/api.go).
It's a super basic website with three "pseudo files":
1. [`/` (root)](https://malo-id-generator.azurewebsites.net/) that returns a basic HTML site which refers to (this is the main entry point for users)
2. `/api/favicon` (returns a favicon) and refers to
3. `/api/style` (returns a stylesheet)
The files are not really served as plain files as you would expect it from a usual web app setup, but they are all separate Azure Functions and hence have their own respective `function.json`.
The files are embedded into the go binary using `go:embed`.
This means you need to rebuild in order to change e.g. the stylesheet.
## Running it Locally
The setup is generally described quite well in [this article by Thorsten Hans](https://www.thorsten-hans.com/azure-functions-with-go/).
First install the [Azure Function Core Tools](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local?tabs=v4%2Cwindows%2Ccsharp%2Cportal%2Cbash#v2).
Then, in the root directory of this repo, execute:
```bash
go build -o api ./cmd/
```
followed by (also in the repo root)
```bash
func start
```
## CI/CD
This function app is managed in two separate Azure Function Apps.
Both Function apps are assigned to the [malo-id-generator resource group on Azure](https://portal.azure.com/#@hochfrequenz.net/resource/subscriptions/1cdc65f0-62d2-4770-be11-9ec1da950c81/resourceGroups/malo-id-generator/overview).
There is one function app instance per supported ID type.
This is because to use the function app directly behind top level domain registered in Azure, its respective entry point must be a top level domain itself without any further, relative path (e.g. `foobarsomerandomstring.azurewebsites.net` and _not_ `foobarsomerandomstring.azurewebsites.net/malo`).
| Purpose | `ID_TYPE_TO_GENERATE` env var value | Deployed to (URL) | Settings |
|-------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Generate MaLo-IDs | `"MALO"` | [`malo-id-generator.azurewebsites.net/`](https://malo-id-generator.azurewebsites.net/) and [markt.lokations.id](https://markt.lokations.id) | [malo-id-generator](https://portal.azure.com/#@hochfrequenz.net/resource/subscriptions/1cdc65f0-62d2-4770-be11-9ec1da950c81/resourceGroups/malo-id-generator/providers/Microsoft.Web/sites/malo-id-generator/appServices) | |.
| Generate NeLo-IDs | `"NELO"` | [`nelo-id-generator.azurewebsites.net/`](https://nelo-id-generator.azurewebsites.net/) and [netz.lokations.id](https://netz.lokations.id) | [nelo-id-generator](https://portal.azure.com/#@hochfrequenz.net/resource/subscriptions/1cdc65f0-62d2-4770-be11-9ec1da950c81/resourcegroups/malo-id-generator/providers/Microsoft.Web/sites/nelo-id-generator/appServices) |
| Generate MeLo-IDs | `"MELO"` | [`melo-id-generator.azurewebsites.net/`](https://melo-id-generator.azurewebsites.net/) and [mess.lokations.id](https://mess.lokations.id) | [melo-id-generator](https://portal.azure.com/#@hochfrequenz.net/resource/subscriptions/1cdc65f0-62d2-4770-be11-9ec1da950c81/resourceGroups/malo-id-generator/providers/Microsoft.Web/sites/melo-id-generator/appServices) |
| Generate TR-IDs | `"TRID"` | [`tr-id-generator.azurewebsites.net/`](https://tr-id-generator.azurewebsites.net/) and [technische.ressource.id](https://technische.ressource.id) | [tr-id-generator](https://portal.azure.com/#@hochfrequenz.net/resource/subscriptions/1cdc65f0-62d2-4770-be11-9ec1da950c81/resourcegroups/malo-id-generator/providers/Microsoft.Web/sites/tr-id-generator/appServices) |
| Generate SR-IDs | `"SRID"` | [`sr-id-generator.azurewebsites.net/`](https://sr-id-generator.azurewebsites.net/) and [steuerbare.ressource.id](https://steuerbare.ressource.id) | [sr-id-generator](https://portal.azure.com/#@hochfrequenz.net/resource/subscriptions/1cdc65f0-62d2-4770-be11-9ec1da950c81/resourcegroups/malo-id-generator/providers/Microsoft.Web/sites/sr-id-generator/appServices) |
The function apps are all
- code based (instead of dockerized (todo @kevin))
- linux based (instead of windows)
There is an environment variable named `ID_TYPE_TO_GENERATE` which you can modify in the [function app settings](https://portal.azure.com/#@hochfrequenz.net/resource/subscriptions/1cdc65f0-62d2-4770-be11-9ec1da950c81/resourcegroups/malo-id-generator/providers/Microsoft.Web/sites/malo-id-generator/configuration).
Its value can be `"MALO"` or `"NELO"` or `"MELO"` or `"TRID"` or `"SRID"`at the moment.
If its value is not set or set to an invalid value, the function app will return a HTTP 501 error.
For your local tests you can modify the value in the `local.settings.json` file.
### How To Deploy
There is _no_ automatic deployment yet (fixable with docker).
To deploy:
First **build** locally for linux (note that the build is the same for all ID types, only the env var is different)
```bash
set GOOS=linux
go build -o api ./cmd
```
or
```ps
$env:GOOS = "linux"; go build -o api ./cmd
```
The GOOS env var can be set in the build configuration in Goland.
The build should create an `api` (no file ending) file on root level.
Then **upload**
```bash
func azure functionapp publish malo-id-generator
```
or
```bash
func azure functionapp publish nelo-id-generator
```
respectively (and similar for `melo-id-generator`, `sr-id-generator` and `tr-id-generator`).
You have to be logged in (`az login`) using the [Azure CLI Tools](https://docs.microsoft.com/de-de/cli/azure/install-azure-cli-windows?tabs=azure-cli).
#### Deploy them all
```bash
func azure functionapp publish malo-id-generator
func azure functionapp publish melo-id-generator
func azure functionapp publish nelo-id-generator
func azure functionapp publish sr-id-generator
func azure functionapp publish tr-id-generator
```