From 2afeaf180e94d4cf88c91189d557a1d2e041f331 Mon Sep 17 00:00:00 2001 From: Oskar Skoglund Date: Wed, 19 Nov 2025 09:49:49 +0000 Subject: [PATCH 1/2] add some content to the README file --- README.md | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 103 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 09f6019..26abee8 100644 --- a/README.md +++ b/README.md @@ -1 +1,103 @@ -# Dev container templates for ColonyOS Executors \ No newline at end of file +# Dev Container Templates for ColonyOS Executors + +Dev container templates that streamline local development of ColonyOS executors. Each template provisions a full multi-container environment (database + ColonyOS server + your dev container) with credentials auto-generated and injected as environment variables. + +## Published Templates + +Use the registry identifiers directly when creating a dev container configuration: + +* `ghcr.io/ossko/colonyos-executor-devcontainers/go` – Go executor development +* `ghcr.io/ossko/colonyos-executor-devcontainers/python` – Python executor development + +## What You Get + +When a template is applied it automatically launches: + +* A TimescaleDB instance seeded for ColonyOS use +* A ColonyOS server reachable from the dev container +* Your language-specific development container with the ColonyOS CLI installed +* Unique credentials / IDs exported as environment variables (e.g. `COLONIES_COLONY_ID`, `COLONIES_USER_ID`, `COLONIES_EXECUTOR_ID`) + +## Prerequisites + +* VS Code (or Codespaces) with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) +* Docker daemon running locally (for VS Code on your machine) + +## Quick Start (VS Code) + +1. Create a new directory for your project and open it in VS Code. +2. Open the Command Palette: “Dev Containers: Open Folder in Container…”. +3. Choose where to store devcontainer configuration files (in project or separate). +4. In the template input box, paste one of: + * `ghcr.io/ossko/colonyos-executor-devcontainers/go` + * `ghcr.io/ossko/colonyos-executor-devcontainers/python` +5. (Optional) Add additional Dev Container features. +6. Confirm and let VS Code build & start the environment. + +After the build completes you will be attached to the dev container with a ready ColonyOS environment. + +## Verifying the Environment + +Inside the dev container terminal run: + +```bash +colonies server status +``` + +Example output: + +```bash +╭──────────────────┬──────────────────────╮ +│ Server version │ dev │ +│ Server buildtime │ 2025-11-19 09:29:52Z │ +│ CLI version │ 1.9.0 │ +│ CLI buildtime │ 2025-10-26 10:08:29Z │ +│ HTTP TLS │ false │ +│ HTTP Port │ 50080 │ +│ HTTP Insecure │ false │ +│ HTTP Host │ 0.0.0.0 │ +│ HTTP Host │ localhost │ +│ Server Backends │ http │ +│ Client Backends │ http │ +╰──────────────────┴──────────────────────╯ +``` + +## Provisioning a Development Colony + +To begin executor development, create a colony, user, and executor using the generated IDs. Run these inside the dev container shell: + +```bash +# Create a development colony (IDs are already exported as env vars) +colonies colony add \ + --name="$COLONIES_COLONY_NAME" \ + --colonyid="$COLONIES_COLONY_ID" + +# Add a user (change the name if desired) +colonies user add \ + --name=devuser \ + --userid="$COLONIES_USER_ID" + +# Register and approve an executor (rename/type to match your project) +colonies executor add \ + --name=devexecutor \ + --type=dev \ + --executorid="$COLONIES_EXECUTOR_ID" \ + --approve +``` + +You can now scaffold your executor (e.g. initialize a Go module or create a Python package) and begin implementing task handling logic. + +## Common Environment Variables +See .env files within the /configuration -directory mounted in the devcontainer. + +## Updating +To pick up template updates: reopen in container and choose “Rebuild Container” or delete the `.devcontainer` folder and re-select the template. + +## Contributing +Issues and PRs are welcome. Please keep changes minimal and focused; propose larger adjustments first via an issue for discussion. + +## License +See `LICENSE` in the repository root. + +--- +Happy hacking with ColonyOS executors! \ No newline at end of file From a462d4e61c509ef97da728435e10a211eab44c6a Mon Sep 17 00:00:00 2001 From: Oskar Skoglund Date: Wed, 19 Nov 2025 10:54:31 +0100 Subject: [PATCH 2/2] bump template versions --- src/go/devcontainer-template.json | 2 +- src/python/devcontainer-template.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/go/devcontainer-template.json b/src/go/devcontainer-template.json index e21ad69..cda996f 100644 --- a/src/go/devcontainer-template.json +++ b/src/go/devcontainer-template.json @@ -1,6 +1,6 @@ { "id": "go", - "version": "1.0.5", + "version": "1.0.6", "name": "ColonyOS Go Executor", "description": "A devcontainer template for developing ColonyOS Executor projects using Go.", "documentationURL": "https://github.com/ossko/colonyos-executor-devcontainers", diff --git a/src/python/devcontainer-template.json b/src/python/devcontainer-template.json index 15ccbfe..960a94d 100644 --- a/src/python/devcontainer-template.json +++ b/src/python/devcontainer-template.json @@ -1,6 +1,6 @@ { "id": "python", - "version": "1.0.5", + "version": "1.0.6", "name": "ColonyOS Python Executor", "description": "A devcontainer template for developing ColonyOS Executor projects using Python.", "documentationURL": "https://github.com/ossko/colonyos-executor-devcontainers",