Compare commits
15 Commits
47cdf16b54
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f7a0bd23eb | ||
|
|
01551b47e2 | ||
|
|
1a30dbff83 | ||
|
|
4ff0c532c4 | ||
|
|
3219265dff | ||
|
|
a998f8a5a3 | ||
|
|
089e96ef00 | ||
|
|
5824927b77 | ||
|
|
53be18dd24 | ||
|
|
7fa2c4493a | ||
|
|
046af77d82 | ||
|
|
55a020a7ce | ||
|
|
2e2717e2c7 | ||
|
|
65852c9f38 | ||
|
|
d586e10776 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -21,6 +21,7 @@ uv.lock
|
||||
|
||||
# Wild Cloud
|
||||
.envrc
|
||||
wild-cloud-redmond-data
|
||||
|
||||
# Development working dir
|
||||
.working/
|
||||
|
||||
18
.gitmodules
vendored
18
.gitmodules
vendored
@@ -1,18 +1,6 @@
|
||||
[submodule "wild-directory"]
|
||||
path = wild-directory
|
||||
url = https://git.civilsociety.dev/wild-cloud/wild-directory.git
|
||||
[submodule "wild-cli"]
|
||||
path = wild-cli
|
||||
url = https://git.civilsociety.dev/wild-cloud/wild-cli.git
|
||||
[submodule "wild-cloud-poc"]
|
||||
path = wild-cloud-poc
|
||||
url = https://git.civilsociety.dev/wild-cloud/wild-cloud-poc.git
|
||||
[submodule "wild-central-api"]
|
||||
path = wild-central-api
|
||||
url = https://git.civilsociety.dev/wild-cloud/wild-central-api.git
|
||||
[submodule "wild-web-app"]
|
||||
path = wild-web-app
|
||||
url = https://git.civilsociety.dev/wild-cloud/wild-web-app.git
|
||||
[submodule "wild-central"]
|
||||
path = wild-central
|
||||
url = https://git.civilsociety.dev/wild-cloud/wild-central.git
|
||||
[submodule "wild-cloud"]
|
||||
path = wild-cloud
|
||||
url = https://git.civilsociety.dev/wild-cloud/wild-cloud.git
|
||||
|
||||
17
CLAUDE.md
17
CLAUDE.md
@@ -6,17 +6,22 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
||||
|
||||
This project is called "Wild Cloud". Wild Cloud is a platform for managing and orchestrating cloud-native applications on local networks using a network appliance called "Wild Central".
|
||||
|
||||
Wild Central is a lightweight server that runs on a local machine (e.g., a Raspberry Pi) and provides an API for users to manage their Wild Cloud instances. The Wild Cloud API is implemented in the wild-central-api project. @wild-central-api/README.md . Wild Central devices can be set up using our apt package implemented in the wild-central project. @wild-central/README.md
|
||||
Wild Central is a lightweight server that runs on a local machine (e.g., a Raspberry Pi) and provides an API for users to manage their Wild Cloud instances. The core Wild Cloud components are in the `wild-cloud` mono-repo:
|
||||
|
||||
- **API** (`wild-cloud/api`): The Wild Cloud API that runs on Wild Central. @wild-cloud/api/CLAUDE.md
|
||||
- **CLI** (`wild-cloud/cli`): Command-line interface for managing Wild Cloud instances. @wild-cloud/cli/README.md
|
||||
- **Web App** (`wild-cloud/web`): Web-based interface for managing Wild Cloud instances. @wild-cloud/web/CLAUDE.md
|
||||
- **Dist** (`wild-cloud/dist`): Distribution package for setting up Wild Central devices via apt. @wild-cloud/dist/README.md
|
||||
|
||||
All data and config for an instance of Wild Central is defined in Central's environment in the WILD_API_DATA_DIR variable. For ease of access, a symlink to our Wild API data dir is made at ./wild-cloud-redmond-data.
|
||||
|
||||
A Wild Cloud instance is a kubernetes (k8s) environment that runs Wild Cloud services and applications. Wild Cloud instances can be created, managed, and monitored using the Wild Cloud API running on a Wild Central device.
|
||||
|
||||
Wild Cloud applications are custom packages designed to be deployed to Wild Cloud instances. They consist of kustomize templates and a Wild Cloud app manifest file that describes the application and how it should be deployed configured and deployed in a Wild Cloud instance. Wild Cloud applications are stored in a "Wild Directory". The directory contained in the wild-directory folder is the official Wild Directory. @wild-directory/README.md
|
||||
Wild Cloud applications are custom packages designed to be deployed to Wild Cloud instances. They consist of kustomize templates and a Wild Cloud app manifest file that describes the application and how it should be deployed configured and deployed in a Wild Cloud instance. Wild Cloud applications are stored in a "Wild Directory". The directory contained in the wild-directory folder is the official Wild Directory. @wild-directory/CLAUDE.md
|
||||
|
||||
The Wild Cloud API maintains data for each Wild Cloud instance in its configured WILD_API_DATA_DIR. A data directory is intended to be checked into version control (e.g., git) to track changes to the configuration of Wild Cloud instances and their deployed applications over time. These are designed to follow infrastructure-as-code principles, allowing experienced devops users to manage their Wild Cloud instances using familiar tools and workflows.
|
||||
The Wild Cloud API maintains data for each Wild Cloud instance in its configured WILD_API_DATA_DIR. A data directory is intended to be checked into version control (e.g., git) to track changes to the configuration of Wild Cloud instances and their deployed applications over time. These are designed to follow infrastructure-as-code principles, allowing experienced devops users to manage their Wild Cloud instances using familiar tools and workflows.
|
||||
|
||||
We provide a command-line interface (CLI) tool called Wild CLI, implemented in the wild-cli project, that allows users to interact with the Wild Cloud API and manage their Wild Cloud instances from the terminal. This allows users to automate tasks and integrate Wild Cloud management into their existing workflows. @wild-cli/README.md
|
||||
|
||||
To make Wild Cloud more accessible to less-experienced users, the Wild Central device hosts a web-based interface for managing Wild Cloud instances, which is implemented in the wild-web-app project. @wild-web-app/README.md
|
||||
We have a public website for Wild Cloud (https://mywildcloud.org) with source in `wild-cloud/docs`.
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
|
||||
20
README.md
20
README.md
@@ -2,17 +2,21 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This project includes a Claude Code assisted environment for working on all Wild Cloud components at once. Each component of the Wild Cloud project is included as submodules in this repo. This includes:
|
||||
This project includes a Claude Code assisted environment for working on all Wild Cloud components at once. The Wild Cloud project is organized as follows:
|
||||
|
||||
- [Wild Central](wild-central/README.md): The network appliance.
|
||||
- [Wild Centrail API](wild-central-api/README.md): The daemon running on the network appliance.
|
||||
- [Wild CLI](wild-cli/README.md): A command line interface to the API.
|
||||
- [Wild Web App](wild-web-app/README.md): A web interface to the API.
|
||||
- [Wild Directory](wild-directory/README.md): Managed apps to be deployed on wild clouds.
|
||||
### Wild Cloud Mono-repo
|
||||
|
||||
... and, until this milestone is complete:
|
||||
The core components are in the [wild-cloud](wild-cloud/README.md) mono-repo:
|
||||
|
||||
- [Wild CLoud PoC](wild-cloud-poc/README.md): The proof-of-concept project that includes functional scripts for running a wild cloud within a development environment. This will be retired as soon as the CLI and web-app are at feature-parity.
|
||||
- [API](wild-cloud/api/README.md): The Wild Cloud API that runs on Wild Central.
|
||||
- [CLI](wild-cloud/cli/README.md): Command-line interface for managing Wild Cloud instances.
|
||||
- [Web App](wild-cloud/web/README.md): Web-based interface for managing Wild Cloud instances.
|
||||
- [Dist](wild-cloud/dist/README.md): Distribution package for setting up Wild Central devices via apt.
|
||||
- [Docs](wild-cloud/docs/): Public website source (https://mywildcloud.org).
|
||||
|
||||
### Other Submodules
|
||||
|
||||
- [Wild Directory](wild-directory/README.md): Managed apps to be deployed on Wild Cloud instances.
|
||||
|
||||
## Dev environment setup
|
||||
|
||||
|
||||
20
TODO.md
20
TODO.md
@@ -1,20 +0,0 @@
|
||||
# Development TO DO
|
||||
|
||||
## Wild Central
|
||||
|
||||
- dnsmasq setup and config for DNS resolution
|
||||
- (future) PXE boot setup and config
|
||||
- (future) DHCP setup and config
|
||||
|
||||
## Wild Daemon (Central Service, wildd)
|
||||
|
||||
- Add methods for config get and set and use them consistently instead of yq.
|
||||
- Put all directory/setup files inside the daemon itself. These can be versioned with the daemon.
|
||||
|
||||
## Wild CLI
|
||||
|
||||
- Use common.sh in install.sh scripts.
|
||||
|
||||
## Wild App
|
||||
|
||||
- Need to build the whole thing.
|
||||
@@ -43,7 +43,7 @@ defaultConfig:
|
||||
storage: 10Gi
|
||||
dbHostname: postgres.postgres.svc.cluster.local
|
||||
dbUsername: myapp
|
||||
requiredSecrets:
|
||||
defaultSecrets:
|
||||
- apps.myapp.dbPassword
|
||||
- apps.postgres.password
|
||||
```
|
||||
@@ -55,7 +55,7 @@ requiredSecrets:
|
||||
- `icon` - A URL to an icon representing the app
|
||||
- `requires` - A list of other apps that this app depends on (each entry should be the name of another app)
|
||||
- `defaultConfig` - A set of default configuration values for the app (when an app is added using `wild-app-add`, these values will be added to the Wild Cloud `config.yaml` file)
|
||||
- `requiredSecrets` - A list of secrets that must be set in the Wild Cloud `secrets.yaml` file for the app to function properly (these secrets are typically sensitive information like database passwords or API keys; keys with random values will be generated automatically when the app is added)
|
||||
- `defaultSecrets` - A list of secrets that must be set in the Wild Cloud `secrets.yaml` file for the app to function properly (these secrets are typically sensitive information like database passwords or API keys; keys with random values will be generated automatically when the app is added)
|
||||
|
||||
### Kustomization Configuration
|
||||
|
||||
@@ -354,7 +354,7 @@ spec:
|
||||
|
||||
```yaml
|
||||
# In manifest.yaml
|
||||
requiredSecrets:
|
||||
defaultSecrets:
|
||||
- apps.myapp.dbUrl
|
||||
|
||||
# Generated secret (by wild-app-add)
|
||||
@@ -509,7 +509,7 @@ Wild Cloud includes apps for common self-hosted services:
|
||||
|
||||
**Manifest Design**:
|
||||
- Include comprehensive `defaultConfig` for all configurable values
|
||||
- List all `requiredSecrets` the app needs
|
||||
- List all `defaultSecrets` the app needs
|
||||
- Specify dependencies in `requires` field
|
||||
- Use semantic versioning
|
||||
|
||||
|
||||
@@ -247,7 +247,7 @@ wild-secret-set apps.database '{"user":"admin","password":"secret"}'
|
||||
|
||||
When you run `wild-app-add`, Wild Cloud automatically generates required secrets:
|
||||
|
||||
1. **Reads App Manifest**: Identifies `requiredSecrets` list
|
||||
1. **Reads App Manifest**: Identifies `defaultSecrets` list
|
||||
2. **Checks Existing Secrets**: Never overwrites existing values
|
||||
3. **Generates Missing Secrets**: Creates secure random values
|
||||
4. **Updates secrets.yaml**: Adds new secrets with proper structure
|
||||
@@ -255,7 +255,7 @@ When you run `wild-app-add`, Wild Cloud automatically generates required secrets
|
||||
**Example App Manifest**:
|
||||
```yaml
|
||||
name: ghost
|
||||
requiredSecrets:
|
||||
defaultSecrets:
|
||||
- apps.ghost.dbPassword # Auto-generated if missing
|
||||
- apps.ghost.jwtSecret # Auto-generated if missing
|
||||
- apps.postgresql.password # Auto-generated if missing (dependency)
|
||||
|
||||
Submodule wild-central deleted from 44ebbbd42c
Submodule wild-central-api deleted from c8fd702d1b
1
wild-cli
1
wild-cli
Submodule wild-cli deleted from 77571e8062
1
wild-cloud
Submodule
1
wild-cloud
Submodule
Submodule wild-cloud added at b0362dc1ca
Submodule wild-cloud-poc deleted from 2684c46de4
Submodule wild-directory updated: 351f58b80d...e2aa16e679
Submodule wild-web-app deleted from b324540ce0
Reference in New Issue
Block a user