| Name | arkitekt-server JSON |
| Version |
1.5.0
JSON |
| download |
| home_page | None |
| Summary | Add your description here |
| upload_time | 2025-07-24 20:19:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
arkitekt
server
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Arkitekt Server
A command-line tool for deploying and managing an Arkitekt server deployments. Arkitekt Server provides a comprehensive platform for scientific computing and data management, with built-in support for authentication, task orchestration, data storage, and containerized application deployment.
## Overview
Arkitekt Server is a deployment configuration management tool that simplifies the setup and management of the Arkitekt ecosystem. It generates Docker Compose configurations and handles the complex orchestration of multiple services including databases, message queues, object storage, and various scientific computing services.
## Requirements
- Python 3.12+
- Docker and Docker Compose
- Git (for development mode with repository mounting)
## Running
```bash
uvx arkitekt-server init default
```
This command initializes a new Arkitekt Server deployment configuration and will guide your with a wizard for some basic configuration options.
You can also specify different configurations such as `dev` for development mode or `minimal` for a lightweight setup.
```bash
uvx arkitekt-server build docker
```
This command generates the necessary Docker Compose files and directory based on your configuration.
Run this command after modifying your configuration or when you want to deploy the services.
```bash
uvx arkitekt-server update
```
Especially useful whe you are on the development branch, this command updates the Docker images and configurations to the latest versions.
```bash
uvx arkitekt-server start
```
And lets go! This command starts all the services defined in the generated Docker Compose files.
What a while wait for the services to be up and running, and then you can access the deployment through the Arkitekt Orkestrator interface.
Thats it! You now have a fully functional Arkitekt Server deployment.
## Oh my god, I forgot all of my passwords!
If you forget your preconfiugred user passwords, you can reset them by running:
```bash
uvx arkitekt-server inspect users
```
This command will list all users and their roles, that you have configured previously.
Of course you would never use this in production, but it is a useful command for development and testing purposes.
### Non-UVX Usage
If you prefer not to use UVX, you can run the tool directly with:
```bash
pip install arkitekt-server
arkitekt-server init default
```
## Key Features
- **One-Command Deployment**: Generate complete Docker Compose configurations with sensible defaults
- **Service Deployment**: Deploy and manage multiple interconnected services
- **Authentication & Authorization**: Built-in user management with JWT-based authentication
- **Development Mode**: Hot-reload support for development with GitHub repository mounting (when available)
## Core Services
The Arkitekt ecosystem includes several specialized services:
- **Lok**: Authentication and authorization service with JWT token management
- **Rekuest**: Task orchestration and workflow management
- **Mikro**: Image and microscopy data management
- **Kabinet**: Container and application registry
- **Fluss**: Workflow execution engine
- **Kraph**: Knowledge graph and metadata management
- **Elektro**: Event streaming and notifications
- **Alpaka**: AI/ML model management with Ollama integration
## Quick Start
### Initialize a new deployment
```bash
# Create a default configuration
arkitekt-server init default
# Create a development configuration with GitHub mounting
arkitekt-server init dev
# Create a minimal configuration
arkitekt-server init minimal
```
### Configure services
```bash
# Enable/disable specific services
arkitekt-server service rekuest --enable
arkitekt-server service mikro --enable
arkitekt-server service kabinet --enable
```
### Manage users
```bash
# Add a new user
arkitekt-server auth user add
```
Allows you to add a new user with options for username, email, and password.
### Deploy
When ready to deploy, run:
```bash
# Generate Docker Compose files and deploy
arkitekt-server build docker
```
This command generates the necessary Docker Compose files based on your configuration and starts the services.
### Start the services
```bash
docker compose up
```
This command starts all the services defined in the generated Docker Compose files, wait for the services to be up and running, and then you can access the
deployment though the orkestrator interface.
## Configuration
The tool generates and manages a `arkitekt_server_config.yaml` file that contains all deployment settings. This file includes:
- Service configurations and Docker images
- Database and Redis settings
- Object storage (MinIO) configuration
- Authentication keys and secrets
- User and group management
- Network and routing configuration
This file can be customized to suit your deployment needs, allowing you to specify local or remote databases, shared or dedicated storage buckets, and development or production deployment modes. This config-file is the central point for managing your Arkitekt Server deployment. And it is automatically generated based on the services you enable and the options you choose during initialization.
## Architecture
Arkitekt Server uses a self-container-service architecture with:
- **PostgreSQL**: Primary database for all services
- **Redis**: Message queuing and caching
- **MinIO**: S3-compatible object storage
- **Caddy**: Reverse proxy and gateway
- **Docker**: Container orchestration
Each service can be configured independently with options for:
- Local or remote databases
- Shared or dedicated storage buckets
- Development or production deployment modes
- Custom authentication configurations
## Development
For development workflows, the tool supports:
- GitHub repository mounting for live code reloading
- Debug mode with detailed logging
- Separate development configurations
- Hot-swappable service configurations
## License
MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "arkitekt-server",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "arkitekt, server",
"author": null,
"author_email": "Your Name <your.email@example.com>",
"download_url": "https://files.pythonhosted.org/packages/7c/6e/2f2e7a2f7443d8d297b340c0e02c7eedc733f0b4c5e5621cba77f77fe9f5/arkitekt_server-1.5.0.tar.gz",
"platform": null,
"description": "# Arkitekt Server\n\nA command-line tool for deploying and managing an Arkitekt server deployments. Arkitekt Server provides a comprehensive platform for scientific computing and data management, with built-in support for authentication, task orchestration, data storage, and containerized application deployment.\n\n## Overview\n\nArkitekt Server is a deployment configuration management tool that simplifies the setup and management of the Arkitekt ecosystem. It generates Docker Compose configurations and handles the complex orchestration of multiple services including databases, message queues, object storage, and various scientific computing services.\n\n## Requirements\n\n- Python 3.12+\n- Docker and Docker Compose\n- Git (for development mode with repository mounting)\n\n## Running\n\n```bash\nuvx arkitekt-server init default\n```\n\nThis command initializes a new Arkitekt Server deployment configuration and will guide your with a wizard for some basic configuration options.\nYou can also specify different configurations such as `dev` for development mode or `minimal` for a lightweight setup.\n\n```bash\nuvx arkitekt-server build docker\n```\n\nThis command generates the necessary Docker Compose files and directory based on your configuration.\nRun this command after modifying your configuration or when you want to deploy the services.\n\n```bash\nuvx arkitekt-server update\n```\n\nEspecially useful whe you are on the development branch, this command updates the Docker images and configurations to the latest versions.\n\n```bash\nuvx arkitekt-server start\n```\n\nAnd lets go! This command starts all the services defined in the generated Docker Compose files. \n\n\nWhat a while wait for the services to be up and running, and then you can access the deployment through the Arkitekt Orkestrator interface.\nThats it! You now have a fully functional Arkitekt Server deployment.\n\n## Oh my god, I forgot all of my passwords!\n\nIf you forget your preconfiugred user passwords, you can reset them by running:\n\n```bash\nuvx arkitekt-server inspect users\n```\n\nThis command will list all users and their roles, that you have configured previously.\nOf course you would never use this in production, but it is a useful command for development and testing purposes.\n\n\n### Non-UVX Usage\n\nIf you prefer not to use UVX, you can run the tool directly with:\n\n```bash\npip install arkitekt-server\narkitekt-server init default\n```\n\n## Key Features\n\n- **One-Command Deployment**: Generate complete Docker Compose configurations with sensible defaults\n- **Service Deployment**: Deploy and manage multiple interconnected services\n- **Authentication & Authorization**: Built-in user management with JWT-based authentication\n- **Development Mode**: Hot-reload support for development with GitHub repository mounting (when available)\n\n## Core Services\n\nThe Arkitekt ecosystem includes several specialized services:\n\n- **Lok**: Authentication and authorization service with JWT token management\n- **Rekuest**: Task orchestration and workflow management\n- **Mikro**: Image and microscopy data management\n- **Kabinet**: Container and application registry\n- **Fluss**: Workflow execution engine\n- **Kraph**: Knowledge graph and metadata management\n- **Elektro**: Event streaming and notifications\n- **Alpaka**: AI/ML model management with Ollama integration\n\n## Quick Start\n\n### Initialize a new deployment\n\n```bash\n# Create a default configuration\narkitekt-server init default\n\n# Create a development configuration with GitHub mounting\narkitekt-server init dev\n\n# Create a minimal configuration\narkitekt-server init minimal\n```\n\n### Configure services\n\n```bash\n# Enable/disable specific services\narkitekt-server service rekuest --enable\narkitekt-server service mikro --enable\narkitekt-server service kabinet --enable\n```\n\n### Manage users\n\n```bash\n# Add a new user\narkitekt-server auth user add\n```\n\nAllows you to add a new user with options for username, email, and password.\n\n\n### Deploy\n\nWhen ready to deploy, run:\n\n```bash\n# Generate Docker Compose files and deploy\narkitekt-server build docker\n```\n\nThis command generates the necessary Docker Compose files based on your configuration and starts the services.\n\n### Start the services\n\n```bash\ndocker compose up\n```\n\nThis command starts all the services defined in the generated Docker Compose files, wait for the services to be up and running, and then you can access the \ndeployment though the orkestrator interface.\n\n\n## Configuration\n\nThe tool generates and manages a `arkitekt_server_config.yaml` file that contains all deployment settings. This file includes:\n\n- Service configurations and Docker images\n- Database and Redis settings\n- Object storage (MinIO) configuration\n- Authentication keys and secrets\n- User and group management\n- Network and routing configuration\n\nThis file can be customized to suit your deployment needs, allowing you to specify local or remote databases, shared or dedicated storage buckets, and development or production deployment modes. This config-file is the central point for managing your Arkitekt Server deployment. And it is automatically generated based on the services you enable and the options you choose during initialization.\n\n## Architecture\n\nArkitekt Server uses a self-container-service architecture with:\n\n- **PostgreSQL**: Primary database for all services\n- **Redis**: Message queuing and caching\n- **MinIO**: S3-compatible object storage\n- **Caddy**: Reverse proxy and gateway\n- **Docker**: Container orchestration\n\nEach service can be configured independently with options for:\n- Local or remote databases\n- Shared or dedicated storage buckets\n- Development or production deployment modes\n- Custom authentication configurations\n\n## Development\n\nFor development workflows, the tool supports:\n\n- GitHub repository mounting for live code reloading\n- Debug mode with detailed logging\n- Separate development configurations\n- Hot-swappable service configurations\n\n\n\n## License\n\nMIT License\n",
"bugtrack_url": null,
"license": null,
"summary": "Add your description here",
"version": "1.5.0",
"project_urls": null,
"split_keywords": [
"arkitekt",
" server"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b9540d50ed5f1e6eba7e945f31d7c5a733db183375183e4a9dc89447472d40ff",
"md5": "86b55fb4bf9ccc568ecd20caf67fcdc3",
"sha256": "f3b9e74751291bd1bb5df12911a14b3275df355c89b97c82a40490b7b178aecf"
},
"downloads": -1,
"filename": "arkitekt_server-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86b55fb4bf9ccc568ecd20caf67fcdc3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 24864,
"upload_time": "2025-07-24T20:19:56",
"upload_time_iso_8601": "2025-07-24T20:19:56.534987Z",
"url": "https://files.pythonhosted.org/packages/b9/54/0d50ed5f1e6eba7e945f31d7c5a733db183375183e4a9dc89447472d40ff/arkitekt_server-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7c6e2f2e7a2f7443d8d297b340c0e02c7eedc733f0b4c5e5621cba77f77fe9f5",
"md5": "8c1ee919fa78b8c7fb5c047025b1b254",
"sha256": "fa188e0753233fd26cea65804e58bd6dc98a0536ac2a6fe9775135336a36843f"
},
"downloads": -1,
"filename": "arkitekt_server-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "8c1ee919fa78b8c7fb5c047025b1b254",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 22645,
"upload_time": "2025-07-24T20:19:57",
"upload_time_iso_8601": "2025-07-24T20:19:57.428664Z",
"url": "https://files.pythonhosted.org/packages/7c/6e/2f2e7a2f7443d8d297b340c0e02c7eedc733f0b4c5e5621cba77f77fe9f5/arkitekt_server-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-24 20:19:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "arkitekt-server"
}
