Skip to content

Commit ba4e183

Browse files
docs: Update documentation for v0.3.0 release
1 parent 4aa33f7 commit ba4e183

File tree

10 files changed

+82
-3
lines changed

10 files changed

+82
-3
lines changed

deployment_assets/demo/evaluate_multi_tenant/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ You must create a Tenant and a specific Tenant Admin user to manage resources.
5050
- **Access Key**: `minioadmin`
5151
- **Secret Key**: `minioadmin`
5252
- **Vending Strategy**: `AWS Static` (Ensure "Use STS" is **UNCHECKED**)
53+
- **Path Style Access**: `true`
5354
- Click **Create**
5455
3. Go to **Catalogs****Create Catalog**
5556
- **Name**: `acme_cat`

deployment_assets/demo/evaluate_single_tenant/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Since the memory store starts empty, you must create a Warehouse and Catalog bef
3030
- **Access Key**: `minioadmin`
3131
- **Secret Key**: `minioadmin`
3232
- **Vending Strategy**: `AWS Static`
33+
- **Path Style Access**: `true` (Add as property or check box if available)
3334
- Click **Create**.
3435
3. Go to **Catalogs****Create Catalog**
3536
- **Name**: `demo`
@@ -58,7 +59,8 @@ curl -X POST http://localhost:8080/api/v1/warehouses \
5859
"region": "us-east-1",
5960
"endpoint": "http://minio:9000",
6061
"access_key_id": "minioadmin",
61-
"secret_access_key": "minioadmin"
62+
"secret_access_key": "minioadmin",
63+
"s3.path-style-access": "true"
6264
}
6365
}'
6466

deployment_assets/demo/evaluate_single_tenant/demo_client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ def main():
2121
# We rely on Pangolin's Vended Credentials for S3 access.
2222
# These point to 'http://minio:9000' which is accessible within the Docker network.
2323
# Do NOT override s3.endpoint here unless you are configuring /etc/hosts on your machine.
24+
# Ensure your Warehouse creation step included "s3.path-style-access": "true" for MinIO.
2425
}
2526
)
2627

docs/backend_storage/mongodb.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,10 @@ Pangolin uses the following collections:
120120
- `branches` - Branching information
121121
- `tags` - Snapshot tags
122122
- `commits` - Commit history
123+
- `service_users` - API identities
124+
- `system_settings` - Global configuration
125+
- `merge_operations` - Merge tracking
126+
- `merge_conflicts` - Conflict resolution data
123127
db.tenants.createIndex({ "name": 1 }, { unique: true })
124128

125129
// Warehouses

docs/backend_storage/postgresql.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,14 @@ The comprehensive schema includes:
132132

133133
**Governance & Security**:
134134
- `users` - Root and Tenant user accounts
135+
- `service_users` - Machine-to-machine API identities
135136
- `roles` - RBAC role definitions
136137
- `user_roles` - Role assignments to users
137138
- `permissions` - Direct (TBAC/RBAC) permission grants
138139
- `access_requests` - Data discovery access workflows
139140
- `audit_logs` - Comprehensive tamper-evident trail
141+
- `merge_operations` - Branch merge tracking
142+
- `merge_conflicts` - Conflict details for merges
140143
- `revoked_tokens` - Blacklisted JWT identifiers
141144
- `active_tokens` - (Internal) Session tracking for active tokens
142145

docs/cli/admin-system-settings.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# System Settings Management
2+
3+
The `pangolin-admin` tool provides commands to view and update global system configuration. These settings are stored in the backend database and override default environment variables where applicable.
4+
5+
## Commands
6+
7+
### `get-system-settings`
8+
9+
Retrieve the current global system configuration.
10+
11+
**Usage:**
12+
```bash
13+
pangolin-admin get-system-settings
14+
```
15+
16+
**Output:**
17+
```json
18+
{
19+
"allow_public_signup": false,
20+
"default_warehouse_bucket": "warehouse",
21+
"default_retention_days": 30,
22+
"smtp_host": "smtp.example.com",
23+
"smtp_user": "admin"
24+
}
25+
```
26+
27+
### `update-system-settings`
28+
29+
Update one or more global configuration parameters.
30+
31+
**Usage:**
32+
```bash
33+
pangolin-admin update-system-settings \
34+
--allow-public-signup true \
35+
--default-retention-days 90
36+
```
37+
38+
**Options:**
39+
- `--allow-public-signup <bool>`: Enable or disable public user registration.
40+
- `--default-warehouse-bucket <string>`: Default bucket name for new warehouses.
41+
- `--default-retention-days <int>`: Default data retention period.
42+
- `--smtp-host <string>`: SMTP server hostname.
43+
- `--smtp-port <int>`: SMTP server port.
44+
- `--smtp-user <string>`: SMTP username.
45+
- `--smtp-password <string>`: SMTP password (write-only).
46+
47+
**Example:**
48+
```bash
49+
# Enable public signup and set default retention to 60 days
50+
pangolin-admin update-system-settings --allow-public-signup true --default-retention-days 60
51+
```

docs/cli/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Targeted at Root and Tenant Admins for infrastructure and identity management.
1818
| `create-catalog` | Provision Iceberg or Federated catalogs. | Admin |
1919
| `grant-permission`| Assign RBAC/TBAC roles and access levels. | Admin |
2020
| `list-audit-events`| Comprehensive forensic and security tracking. | Admin |
21+
| `create-service-user`| Manage machine-to-machine API identities. | Admin |
22+
| `update-system-settings`| Configure global platform defaults. | Root |
2123

2224
### 2. `pangolin-user` (The Data Tool)
2325
Targeted at Data Engineers and Analysts for discovery and versioning.

docs/features/audit_logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Every log entry follows a standardized structure:
6363
| `user_id` | UUID of the actor. |
6464
| `username` | Readable name of the actor. |
6565
| `action` | The operation (e.g., `create_table`, `merge_branch`). |
66-
| `resource` | Path to the affected object (e.g., `catalog/ns/table`). |
66+
| `resource_name` | Path to the affected object (e.g., `catalog/ns/table`). |
6767
| `result` | `success` or `failure`. |
6868
| `timestamp` | UTC ISO8601 string. |
6969
| `metadata` | Action-specific JSON (e.g., old/new schema ID). |

docs/getting-started/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Pangolin follow a "Configuration-over-Code" philosophy, allowing for flexible de
66

77
Most settings are managed via **Environment Variables** at startup. This includes everything from the port number to the metadata persistence backend.
88

9-
- For a complete list of variables, see **[Environment Variables](./env_vars.md)**.
9+
- For a complete list of variables, see **[Environment Variables](../environment-variables.md)**.
1010
- For deployment-specific patterns, see **[Deployment Guide](./deployment.md)**.
1111

1212
## Client Configuration Discovery

scripts/build_docker_sequential.sh

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/bin/bash
2+
set -e
3+
4+
echo "Starting Sequential Docker Build..."
5+
6+
echo "--- Building API (1/3) ---"
7+
docker buildx build --platform linux/amd64,linux/arm64 -t alexmerced/pangolin-api:latest -t alexmerced/pangolin-api:0.3.0 --push -f pangolin/Dockerfile pangolin
8+
9+
echo "--- Building CLI (2/3) ---"
10+
docker buildx build --platform linux/amd64,linux/arm64 -t alexmerced/pangolin-cli:latest -t alexmerced/pangolin-cli:0.3.0 --push -f pangolin/Dockerfile.tools pangolin
11+
12+
echo "--- Building UI (3/3) ---"
13+
docker buildx build --platform linux/amd64,linux/arm64 -t alexmerced/pangolin-ui:latest -t alexmerced/pangolin-ui:0.3.0 --push -f pangolin_ui/Dockerfile pangolin_ui
14+
15+
echo "All builds completed successfully."

0 commit comments

Comments
 (0)