Update documentation
This commit updates documentation to complete the move to go
This commit is contained in:
parent
4bffc9e92a
commit
89bbbb7371
2 changed files with 91 additions and 118 deletions
37
TODO.md
37
TODO.md
|
|
@ -1,31 +1,18 @@
|
|||
# WissKI-Distillery in Go
|
||||
# WissKI Distillery TODO
|
||||
|
||||
This document describes the process of moving the distillery to using golang for the control plane (outside of docker containers).
|
||||
- User-level documentation
|
||||
- What is a factory?
|
||||
- Why a factory?
|
||||
- First steps after provisioning
|
||||
|
||||
## Bootstrapping
|
||||
|
||||
This documents the bootstraping process.
|
||||
Work in progress.
|
||||
|
||||
- `wdcli bootstrap $DIRECTORY`
|
||||
0. Create the deployment directory
|
||||
1. Copy over the executable (unless it already exists)
|
||||
2. Create a default configuration file (unless it already exists)
|
||||
3. Store the directory in a file called .wdcli in the $HOME directory
|
||||
|
||||
- `wdcli system_update`
|
||||
- to be documented
|
||||
## Future Work
|
||||
|
||||
- Move `provision_entrypoint.sh` into go
|
||||
- Rename backups to 'snapshots' and make them restorable
|
||||
- Enhance Snapshots
|
||||
- Export the Docker Images
|
||||
- Export the XML from the Pathbuilder
|
||||
- Snapshot the docker images being used also!
|
||||
- Avoid running `docker compose` executable and shift it to a library
|
||||
- Automatically bootstrap the docker container sql connection (use proper environment variables)
|
||||
- Make error handling consistent
|
||||
- Add a server that serves information
|
||||
- Migrate the individual commands below
|
||||
- restructure resource files
|
||||
- Documentation
|
||||
- single malt
|
||||
- snapshots: export xml from pathbuilder
|
||||
- Cleanup code: Have consistent error handling
|
||||
- Add a metadata / statistics server
|
||||
- Restructure code files
|
||||
- Single Malt Mode: Support having a single instance only!
|
||||
Loading…
Add table
Add a link
Reference in a new issue