{"id":39349289,"url":"https://github.com/pixelsdb/pixels-spike","last_synced_at":"2026-01-18T02:27:31.138Z","repository":{"id":276784258,"uuid":"915974335","full_name":"pixelsdb/pixels-spike","owner":"pixelsdb","description":"A cloud-native computing framework for serverless query processing.","archived":false,"fork":false,"pushed_at":"2025-06-29T16:33:16.000Z","size":366,"stargazers_count":30,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-29T17:33:43.989Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pixelsdb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-01-13T08:05:27.000Z","updated_at":"2025-06-29T16:33:20.000Z","dependencies_parsed_at":"2025-02-10T12:36:40.524Z","dependency_job_id":"898efb1b-1dbf-4159-9641-99a3f7aba237","html_url":"https://github.com/pixelsdb/pixels-spike","commit_stats":null,"previous_names":["pixelsdb/pixels-spike"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pixelsdb/pixels-spike","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelsdb%2Fpixels-spike","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelsdb%2Fpixels-spike/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelsdb%2Fpixels-spike/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelsdb%2Fpixels-spike/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pixelsdb","download_url":"https://codeload.github.com/pixelsdb/pixels-spike/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelsdb%2Fpixels-spike/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28526569,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-18T02:27:30.716Z","updated_at":"2026-01-18T02:27:31.108Z","avatar_url":"https://github.com/pixelsdb.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pixels-spike\nA cloud-native computing framework for serverless query processing.\n\n[English](README.md) | [中文](README_CN.md)\n\n## 1. How to get started\n\n### step1: Install Go\nRequires Go version 1.22.7 or higher.\n\nSome go plugins for protobuf and grpc are required to generate the go source files for the proto files:\n```bash\n# install protoc-gen-go to generate the go source code for protobuf messages\ngo install google.golang.org/protobuf/cmd/protoc-gen-go@latest\n# install protoc-gen-go-grpc to generate the go source code for grpc services\ngo install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest\n# install protoc-gen-grpc-gateway to transport HTTP to grpc\ngo install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest\n# install protoc-gen-swagger to parse the swagger annotations in the proto files and generate OpenAPI docs\ngo install github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger@latest\n```\n\n### step2: Start MySQL\nFor example, start MySQL with Docker, and then create the `spike` database:\n\n```shell\n# Download the mysql:8.0.31 image\ndocker pull mysql:8.0.31\n\n# Start the MySQL instance\ndocker run --name spike-mysql -e MYSQL_ROOT_PASSWORD=spikepassword -p 3306:3306 -d mysql:8.0.31\n\n# After the MySQL instance starts, enter the MySQL container\ndocker exec -it spike-mysql mysql -uroot -pspikepassword -e \"CREATE DATABASE spike;\"\n```\n\n### step3: Initialize submodules\nThis project uses Git submodules. You need to initialize and update them:\n\n```shell\n# Initialize submodules\ngit submodule init\n\n# Update submodules to their latest commits\ngit submodule update\n```\n\n### step4: Build spike\n```shell\nsh build.sh\n```\n\n### step5: Setup AWS credentials\nTo use AWS computing resources, you need to configure AWS credentials. You can use either [environment variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html#envvars-set) or [credential files](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).\n\n### step6: Modify spike config file\nEdit `spike.yaml`, mainly modify the `aws_config` section to match your AWS cluster configuration.\n\nParameter description:\n* `aws_cluster`: AWS ECS cluster name\n* `aws_subnets`: List of AWS VPC subnet IDs for deploying function instances\n* `aws_security_groups`: List of AWS security group IDs for controlling network access permissions\n* `task_role`: AWS IAM role name for granting function instances access to AWS resources\n* `ec2_provider`: AWS EC2 capacity provider name for providing EC2 instance resources\n\n```yaml\naws_config:\n  aws_cluster: spike_cluster_mini\n  aws_subnets:\n    - subnet-01930cb57dbc12f7e\n    - subnet-0c77aae8c226d039c\n    - subnet-02bd39d1f8b337c22\n  aws_security_groups:\n    - sg-02221dbcd555d5277\n  task_role: PixelsFaaSRole\n  ec2_provider: Infra-ECS-Cluster-spikeclustermini-d985e674-EC2CapacityProvider-FufGynLGFE0q\n```\n\n### step7: Run spike\n```shell\ncd build\n./spike-server -f spike.yaml\n```\n\n## 2. How to call function\n\n### step1: Create a function\n\nParameter description:\n* `function_name`: Function name, used to uniquely identify a function\n* `image_url`: Container image URL for the function\n* `resources`: List of function resource configurations, multiple specifications can be configured\n  * `cpu`: CPU resource size in millicores (1 core = 1000 millicores)\n  * `memory`: Memory resource size in MB\n  * `min_replica`: Minimum number of replicas, i.e., minimum number of function instances\n  * `max_replica`: Maximum number of replicas, i.e., maximum number of function instances\n\n```bash\ncurl --location 'http://127.0.0.1:8080/v1/create_function' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"function_name\": \"test\",\n    \"image_url\": \"013072238852.dkr.ecr.cn-north-1.amazonaws.com.cn/agentguo/test:1.1\",\n    \"resources\": [\n        {\n            \"cpu\": 8192,\n            \"memory\": 32768,\n            \"min_replica\": 1,\n            \"max_replica\": 5\n        },\n        {\n            \"cpu\": 4096,\n            \"memory\": 16384,\n            \"min_replica\": 1,\n            \"max_replica\": 5\n        }\n    ]\n}'\n```\n\n### step2: Call function (test function will sleep for payload seconds)\n\nParameter description:\n* `function_name`: Name of the function to call\n* `payload`: Function input parameters, here representing sleep seconds\n* `cpu`: Required CPU resource size in millicores (1 core = 1000 millicores)\n* `memory`: Required memory resource size in MB, set to 0 for default value\n\n```bash\ncurl --location 'http://127.0.0.1:8080/v1/call_function' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"function_name\": \"test\",\n    \"payload\": \"3\",\n    \"cpu\": 8192,\n    \"memory\": 0\n}'\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelsdb%2Fpixels-spike","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpixelsdb%2Fpixels-spike","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelsdb%2Fpixels-spike/lists"}