feat: new interactive configuration tool #10

.gitignore

@@ -23,6 +23,9 @@ _*
 TODO.txt
 **/.env
 **/id_rsa*
+.agent
+.claude
+CLAUDE.md
 .task/
 attic.txt
 **/venv/

AGENTS.md

@@ -0,0 +1,147 @@
+# Apache OpenServerless Task Agent Guidelines
+
+This file provides instructions for agentic coding agents working in this repository.
+
+
+## Setup commands
+
+- Install Dependencies: `bun install`
+- Start development server: ``
+- Build the configurator utility: `cd util/config/configurator && bun run build`
+
+## Testing instructions
+- Run tests: `bun test`
+
+- Run a single test: `bun test util/config/configurator/tests/index.test.ts`
+- Run tests with verbose output `bun test --reporter=verbose`
+
+## Running the application
+- Run the configurator utility: `cd util/config/configurator && bun run start`
+- Run the configurator utility with a specified configuration file: `bun run start -- <config-file>`
+- Run the configurator utility with a specified configuration file overriding existing values: `bun run start -- <config-file> [--override]`
+
+
+## Code style
+
+- TypeScript strict mode
+
+### Language & Version
+- Primary language: TypeScript
+- Runtime: Bun (Node.js compatible)
+- Target ES version: ES2022+
+- Module system: ES Modules (`"type": "module"` in package.json)
+
+### File Organization
+- TypeScript files: `.ts` extension
+- Test files: `*.test.ts` located in `__tests__` or `tests` directories
+- Configuration: TOML (`.toml`) or JSON (`.json`)
+- Operations definitions: YAML (`.yml`)
+
+### Imports
+1. **Order**:
+ - Built-in Node.js/Bun modules (e.g., `import { $ } from "bun";`)
+ - Third-party libraries (e.g., `import { select } from "@clack/prompts";`)
+ - Local application files (relative paths)
+
+2. **Syntax**:
+ - Use ES module syntax: `import { foo } from "bar";`
+ - Default imports: `import foo from "bar";`
+ - Avoid `require()` syntax
+
+3. **Specific Rules**:
+ - Import types separately when needed: `import type { TypeName } from "./types";`
+ - Group related imports together
+ - No unused imports allowed
+
+### Formatting
+- **Indentation**: 2 spaces (not tabs)
+- **Line length**: Maximum 100 characters (prefer 80-100)
+- **Semicolons**: Required (use semicolons to terminate statements)
+- **Quotes**: 
+ - Single quotes (`'`) for strings
+ - Template literals (`` ` ``) for multi-line or interpolated strings
+ - Double quotes (`"`) only when required by JSON or external specifications
+- **Commas**: Trailing commas in multi-line objects/arrays
+- **Braces**: 
+ - Opening brace on the same line as the statement
+ - Closing brace on its own line
+ - No braces for single-line conditionals when it improves readability
+
+### Types
+- **Type Annotations**:
+ - Always annotate function parameters
+ - Annotate return values for public functions
+ - Use type inference for local variables when obvious
+- **Interfaces vs Types**:
+ - Use `interface` for object shapes that may be extended
+ - Use `type` for unions, primitives, complex mapped types
+- **Strictness**: Enable strict TypeScript options (null checks, no implicit any, etc.)
+
+### Naming Conventions
+- **Files & Directories**: kebab-case (e.g., `configurator.ts`, `all-config-parameters.toml`)
+- **Variables & Functions**: camelCase (e.g., `readPositionalFile`, `isInputConfigValid`)
+- **Constants**: UPPER_SNAKE_CASE (e.g., `HelpMsg`, `AdditionalArgsMsg`)
+- **Types & Interfaces**: PascalCase (e.g., `OpsConfig`, `PromptData`)
+- **Classes**: PascalCase (though minimal class usage in this codebase)
+- **Boolean Variables**: Prefix with `is`, `has`, `should`, `can` (e.g., `isValid`, `hasError`)
+
+### Error Handling
+- **Early Returns**: Handle error conditions first with early returns
+- **Async Functions**: Use try/catch for async operations that can fail
+- **Bun Specific**: 
+ - Use `process.exit(1)` for error exits
+ - Use `process.exit(0)` for successful exits
+ - Check `success` property on result objects from utils
+- **Messages**: 
+ - Export constant error messages (as seen with `HelpMsg`, `NotValidJsonMsg`, etc.)
+ - Use descriptive, user-friendly error messages
+ - Log warnings with `console.warn()`, errors with `console.error()`
+
+### Specific Patterns from Codebase
+- **Configuration Validation**: Separate validation functions (e.g., `isInputConfigValid`)
+- **File Operations**: 
+ - Read → Parse → Validate pattern
+ - Return objects with `{ success: boolean, message?: string, ...data }` shape
+- **CLI Argument Parsing**: Use `util.parseArgs` with strict mode and positionals
+- **Interactive Prompts**: Use `@clack/prompts` with proper cancellation handling
+- **Shell Commands**: Use Bun's `$` helper for shell commands with `.quiet()` to suppress output
+
+### Testing
+- **Framework**: Bun's built-in test framework (`bun:test`)
+- **File Naming**: `*.test.ts`
+- **Structure**:
+ - Use `describe()` for test suites
+ - Use `test()` for individual tests
+ - Use `expect()` for assertions
+- **Mocking**: Minimal mocking; prefer testing actual behavior
+- **Async Tests**: Return promises or use `async`/`await`
+
+### Comments
+- Use JSDoc-style comments for public APIs
+- Use `//` for inline comments explaining why (not what)
+- Keep comments up-to-date; delete outdated comments
+- TODO comments should include GitHub issue references when possible
+- When adding bash scripts in the documentation, always keep commands separate (one command per ```bash section)
+
+### Security
+- Never log secrets or credentials
+- Use `password` prompt type for sensitive inputs
+- Validate and sanitize all external inputs
+- Follow the principle of least privilege
+
+## Task Tracking
+
+For any task that involves more than one non-trivial step (multi-file changes, investigations with uncertain outcomes, features spanning multiple components), maintain a TODO list using the `TaskCreate` / `TaskUpdate` / `TaskList` tools:
+
+1. **Start**: call `TaskCreate` to create one task entry per step before writing any code.
+2. **Progress**: call `TaskUpdate` (status `in_progress`) when starting a step, `completed` when it is done.
+3. **Visibility**: after completing a task, call `TaskList` to confirm no steps are left open.
+
+Keep task titles short and action-oriented ("Add `type` field to ConfigParameter", "Update parseParameter", etc.). 
+Do **not** create tasks for trivial single-file edits or quick answers.
+
+## Additional Notes
+- This repository uses Bun as its primary runtime/package manager
+- Configuration is driven by TOML files and environment variables
+- The `opsfile.yml` defines operational tasks but is not part of the main TypeScript codebase
+- When modifying the configurator utility, remember to rebuild after changes

admin/docopts.md

@@ -27,7 +27,7 @@ You can create namespaces and choose which services to enable.
 
 ```text
 Usage:
- admin adduser <username> <email> <password> [--all] [--redis] [--mongodb] [--minio] [--postgres] [--milvus] [--storagequota=<quota>|auto]
+ admin adduser <username> <email> <password> [--all] [--redis] [--mongodb] [--minio|--seaweedfs] [--postgres] [--milvus] [--storagequota=<quota>|auto]
  admin deleteuser <username>
  admin listuser [<username>]
  admin compact [--ttl=<ttl>|10]
@@ -49,6 +49,7 @@ Usage:
  --redis enable redis
  --mongodb enable mongodb
  --minio enable minio
+ --seaweedfs enable seaweedfs
  --postgres enable postgres
  --milvus enable milvus vector db
  --storagequota=<quota>

admin/opsfile.yml

@@ -119,17 +119,18 @@ tasks:
  fi
  fi
 
- if {{.__minio}} || {{.__all}}
+ if {{.__minio}} || {{.__seaweedfs}} || {{.__all}}
  then 
- if $OPERATOR_COMPONENT_MINIO
+ if $OPERATOR_COMPONENT_MINIO || $OPERATOR_COMPONENT_SEAWEEDFS
  then 
  MINIO_DATA_ENABLED=true
  MINIO_STATIC_ENABLED=true
  else 
- die "Error! Minio is not enabled in OpenServerless"
+ die "Error! Minio or Seaweedfs are not enabled in OpenServerless"
  fi
  fi
 
+
  if test -n "{{.__storagequota}}"
  then MINIO_STORAGE_QUOTA={{.__storagequota}}
  fi 

config/docopts.md

@@ -24,13 +24,14 @@ Configure OpenServerless
 
 ```text
 Usage:
- config (enable|disable) [--all] [--redis] [--mongodb] [--minio] [--cron] [--static] [--postgres] [--prometheus] [--slack] [--mail] [--affinity] [--tolerations] [--quota] [--milvus] [--registry]
+ config (enable|disable) [--all] [--redis] [--mongodb] [--minio] [--cron] [--static] [--postgres] [--prometheus] [--slack] [--mail] [--affinity] [--tolerations] [--quota] [--milvus] [--registry] [--seaweedfs]
  config apihost (<apihost>|auto) [--tls=<email>] [--protocol=<http/https>|auto]
  config runtimes [<runtimesjson>] 
  config slack [--apiurl=<slackapiurl>] [--channel=<slackchannel>]
  config mail [--mailuser=<mailuser>] [--mailpwd=<mailpwd>] [--mailfrom=<mailfrom>] [--mailto=<mailto>]
- config volumes [--couchdb=<couchdb>] [--kafka=<kafka>] [--pgvol=<postgres>] [--storage=<storage>] [--alerting=<alerting>] [--zookeeper=<zookeeper>] [--redisvol=<redis>] [--mongodbvol=<mongodb>] [--etcdvol=<etcd>] [--mvvol=<milvus>] [--mvzookvol=<milvuszook>] [--pulsarjournalvol=<pulsarjournal>] [--pulsarledgelvol=<pulsarledge>] 
+ config volumes [--couchdb=<couchdb>] [--kafka=<kafka>] [--pgvol=<postgres>] [--storage=<storage>] [--alerting=<alerting>] [--zookeeper=<zookeeper>] [--redisvol=<redis>] [--mongodbvol=<mongodb>] [--etcdvol=<etcd>] [--mvvol=<milvus>] [--mvzookvol=<milvuszook>] [--pulsarjournalvol=<pulsarjournal>] [--pulsarledgelvol=<pulsarledge>] [--seaweedfsvol=<seaweedfsvol>] 
  config controller [--javaopts=<javaopts>] [--loglevel=<loglevel>] [--replicas=<replicas>]
+ config ingress [--class=<auto|nginx|traefik|public>]
  config invoker [--javaopts=<javaopts>] [--poolmemory=<poolmemory>] [--timeoutsrun=<timeoutsrun>] [--timeoutslogs=<timeoutslogs>] [--loglevel=<loglevel>] [--replicas=<replicas>]
  config limits [--time=<time>] [--memory=<memory>] [--sequencelength=<sequencelength>] [--perminute=<perminute>] [--concurrent=<concurrent>] [--triggerperminute=<triggerperminute>] [--activation_max_payload=<activation_max_payload>] [--blackbox_fraction=<blackbox_fraction>]
  config storage [--class=<storage_class>] [--provisioner=<storage_provisioner>]
@@ -45,7 +46,8 @@ Usage:
  config azcloud [--project=<project>] [--region=<region>] [--vm=<vm>] [--disk=<disk>] [--key=<key>] [--image=<image>]
  config aks [--project=<project>] [--name=<name>] [--region=<region>] [--count=<count>] [--vm=<vm>] [--disk=<disk>] [--key=<key>]
  config externalregistry [--regurl=<regurl>] [--reguser=<reguser>] [--regpassword=<regpassword>]
- config registry [--disk=<disk>] [--ingress] 
+ config registry [--disk=<disk>] [--ingress]
+ config seaweedfs [--s3] [--console]
  config (status|export|reset)
  config use [<n>] [--delete] [--rename=<rename>]
  config minimal
@@ -63,6 +65,7 @@ Usage:
  config mail configure Alert Manager over a gmail account
  config volumes configure the volume size distinguished in 3 categories (openwhisk couchdb & kafka, database, minio storage, alerting, milvus)
  config controller configure Openwhisk enterprise controller java options
+ config ingress configure OpenServerless ingress class
  config invoker configure Openwhisk enterprise invoker options
  config limits configure Openwhisk actions limits
  config storage allows to customize storage persistence class and provider
@@ -120,4 +123,6 @@ Usage:
  --quota select quota checker module
  --milvus select MILVUS vector database
  --registry activate the support for a private image registry for custom actions (by default it will install one)
+ --class specify the ingress class. It can be auto, traefik, nginx. On microk8s it should be public.
+ --seaweedfs activate the support of SEAWEEDFS as S3 api and buckets provider
 ```