Skip to content

quiltdata/quiltx

Repository files navigation

quiltx

PyPI

Quilt extension toolkit for working with Quilt catalogs.

Quick start

# See available tools
uvx quiltx

# Configure a Quilt catalog
uvx quiltx stack catalog https://open.quiltdata.com

# Get help for any tool
uvx quiltx <tool> --help

Tools

  • bucket — Register cross-account S3 buckets with Quilt (policy, SNS, notifications)
  • ecs — ECS task tools:
    • ecs shell — Interactive shell access to running ECS tasks via Session Manager
    • ecs run-migration — Re-run the registry migration task for a stack
  • logs — Display and tail CloudWatch logs for the configured catalog
  • stack — Manage Quilt stack:
    • stack acl — Declarative access-control-list (ACL) reconciliation from YAML
    • stack catalog — Configure and display Quilt catalog settings
    • stack cfn — Discover the Quilt CloudFormation stack and cache metadata

Python API

See README_DEV.md for programmatic usage of ECS, ACL, config, and stack APIs.

Persistent install (optional)

uv tool install -U quiltx
# Now use without the uvx prefix:
quiltx --list

Stack ACL

quiltx stack acl declaratively manages a Quilt stack's access control lists (ACLs) from a single YAML file with exactly two top-level blocks: policies: and roles:. Policy audiences synthesize cumulative managed roles, while static roles compose named policies and optional inline bucket grants. Instead of clicking through the catalog admin UI, you define the desired state in version-controlled YAML and let the tool reconcile it against the server.

YAML example

# Access control lists for a Quilt stack
policies:
  public:
    sso.groups: [Everyone]
    buckets.read: [quilt-example]
    config.default_role: true
  internal:
    sso.groups: [Employees]
    buckets.read_write: [quilt-bake, quilt-dev]
    buckets.read: [quilt-leadership]

roles:
  exec:
    sso.groups: [Executives]
    config.policies: [public, internal]
    buckets.read_write: [quilt-leadership]
    config.is_admin: true

Policy order matters. In this example public synthesizes the public role, and internal synthesizes internal_public, which cumulatively includes both public and internal. Reordering the policies changes those synthesized role names and who receives which cumulative grants.

Usage

# Show current server ACL state
uvx quiltx stack acl

# Preview changes (dry run)
uvx quiltx stack acl config.yml --dry-run

# Preview with full detail
uvx quiltx stack acl config.yml --dry-run --verbose

# Apply changes (with confirmation prompt)
uvx quiltx stack acl config.yml

# Apply without prompting
uvx quiltx stack acl config.yml --yes

Catalogs behind corporate TLS proxies

If quiltx stack catalog <url> fails with CERTIFICATE_VERIFY_FAILED (common on networks with TLS-inspection proxies or self-signed catalog certs), point Python at your organization's CA bundle:

# Preferred: trust your corporate root CA
uvx quiltx stack catalog https://quilt.example.com --ca-bundle /path/to/corp-root.pem

# Escape hatch: skip TLS verification (trusted networks only)
uvx quiltx stack catalog https://quilt.example.com --insecure

--ca-bundle also exports SSL_CERT_FILE / REQUESTS_CA_BUNDLE for the current process. To make the override stick across other quiltx subcommands, export SSL_CERT_FILE=/path/to/corp-root.pem in your shell profile.

ECS

# Open an interactive shell inside the registry service task
uvx quiltx ecs shell

# Dry-run the registry migration relaunch using cached stack metadata
uvx quiltx ecs run-migration --dry-run

# Start the migration task and wait for completion
uvx quiltx ecs run-migration

License

MIT

About

Quilt Extension Library and Tools

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages