mirror of
https://github.com/go-sigma/sigma.git
synced 2026-10-28 15:05:06 +08:00
Tosone
187f5c4d97
Sigma shipped three overlapping ways to operate a remote server: the embedded MCP server, sigma-cli, and the sigma-api-operator skill. All three wrapped the same HTTP API, yet each covered a different subset: user CRUD existed only in the CLI, system-* only in MCP, and builders, daemons, webhooks, validators, code repositories and tokens were reachable only through raw HTTP. MCP was disabled by default and still carried 1246 lines of production code plus 606 lines of tests to maintain that partially overlapping surface. Keep two surfaces instead: sigma-cli for execution and the skill for API discovery. - delete pkg/server/mcp and its mcp-go dependency, which also drops the jsonschema-go, jsonschema/v6 and uritemplate/v3 transitives - drop ConfigurationMCP, its defaults and the authz/audit skipper bypasses that existed only to let the MCP endpoint bypass both - remove the mcp section from conf/config*.yaml, docs/configuration.md, and the Helm chart values and configmap - replace docs/mcp.md with docs/cli.md covering sigma-cli login, global flags, per-resource commands, jq composition and agent usage - make sigma-cli the preferred path in the sigma-api-operator skill and rebuild its examples around the resources the CLI does not wrap yet, using the paths and request schemas from swagger.yaml Lint was already red on dev for an unrelated reason: golangci-lint v2.13.0 vendors golang.org/x/tools v0.49.0, which only decodes export data version 4, so every import of a Go 1.27.2 standard library package failed typecheck with "export data version 5 is greater than maximum supported version 4". Bump to v2.15.0 (x/tools v0.52.0) and fix the two modernize findings it reports for Go 1.27's strings.CutLast. - .github/workflows/lint.yml: golangci-lint v2.13.0 -> v2.15.0, and document the export data constraint next to the pin - pkg/authz/resolver.go, pkg/logger/logger.go: replace LastIndex slicing with strings.CutLast - bump github.com/docker/cli v29.9.0 -> v29.9.1 BREAKING CHANGE: the `mcp` configuration section and the /api/v1/mcp endpoint are gone. Use sigma-cli or the REST API for automation. Verification: - go build -tags "netgo,timetzdata,exclude_graphdriver_btrfs,containers_image_openpgp" ./... - go vet -tags "netgo,timetzdata,exclude_graphdriver_btrfs,containers_image_openpgp" ./... - golangci-lint v2.15.0 run --build-tags "netgo,timetzdata,exclude_graphdriver_btrfs,containers_image_openpgp" ./... (0 issues) - golangci-lint config verify - go test -tags "netgo,timetzdata,exclude_graphdriver_btrfs,containers_image_openpgp" ./pkg/authz/... ./pkg/logger/... ./cmd/cli/... ./pkg/app/... ./pkg/background/build/... - go test -run TestConfiguration -tags "netgo,timetzdata,exclude_graphdriver_btrfs,containers_image_openpgp" ./pkg/config/... - go mod tidy - make swagen - helm template sigma ./deploy/sigma - bun run docs:build - make build - make build-cli
65 lines
3.1 KiB
Markdown
65 lines
3.1 KiB
Markdown
<p align="center">
|
|
<a href="https://github.com/go-sigma/sigma">
|
|
<img alt="sigma" src="https://raw.githubusercontent.com/go-sigma/sigma/dev/assets/sigma.svg" width="220"/>
|
|
</a>
|
|
</p>
|
|
<h1 align="center">sigma</h1>
|
|
|
|
  
|
|
|
|
Sigma is an image registry that is extremely easy to deploy and maintain, and it adheres to the interface standards defined by the [OCI Distribution Specification 1.1](https://github.com/opencontainers/distribution-spec/tree/v1.1.0), it can also support any other client programs that follow the interface definition of the OCI Distribution Specification, such as [oras](https://github.com/oras-project/oras), [apptainer](https://github.com/apptainer/apptainer), [helm](https://github.com/helm/helm), and [nerdctl](https://github.com/containerd/nerdctl).
|
|
|
|
## Quick Start
|
|
|
|
Now you can use this command to run a simple server:
|
|
|
|
```bash
|
|
docker run --name sigma -p 3000:3000 --rm tosone/sigma:nightly-alpine
|
|
```
|
|
|
|
The default username and password is: sigma/Admin@123. If you want to modify the default password, please refer to the [configuration instructions](https://docs.sigma.tosone.cn/docs/configuration).
|
|
|
|
## Demo Server
|
|
|
|
It is deployed on an AWS EC2 instance (2C4G, 40G disk) running Debian 12.1 as the Linux distribution. The Docker version used is 25.0.3. The demo server was set up following these [instructions](tools/demo-server).
|
|
|
|
Visit: <https://sigma.tosone.cn>, username/password: sigma/Admin@123
|
|
|
|
## Architecture
|
|
|
|
The diagram below maps Sigma's main runtime layers, from client entry points to request handling, background workers, and the infrastructure services they depend on.
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- [x] Support docker registry v2 protocol.
|
|
- [x] Support OCI Image v1 Format and OCI Image Index v1 Format.
|
|
- [x] Support OCI artifacts such as helm and so on.
|
|
- [x] Support OCI sbom.
|
|
- [x] Support Image security scan.
|
|
- [x] Support registry proxy.
|
|
- [x] Support Namespace quota.
|
|
- [x] Support Image automatic garbage collection.
|
|
- [x] Support Image sign.
|
|
- [x] Support Image build in docker, podman and kubernetes.
|
|
- [ ] Support Image replication.
|
|
|
|
## AI Clients and Automation
|
|
|
|
Sigma provides two integration paths for AI clients and external automation:
|
|
|
|
- `sigma-cli`: a single binary that operates a remote Sigma server over the REST
|
|
API. It covers namespaces, repositories, tags, artifacts, members, and users.
|
|
See [CLI & AI Agents](docs/cli.md).
|
|
- External REST API skill: `tools/skill/sigma-api-operator` packages a reusable
|
|
skill and `swagger.yaml` so CLI agents such as Claude Code or Copilot CLI can
|
|
discover Sigma APIs and operate resources through HTTP requests, including the
|
|
areas the CLI does not wrap yet.
|
|
|
|
## Alternatives
|
|
|
|
- [Distribution](https://distribution.github.io/distribution/)
|
|
- [Harbor](https://goharbor.io/)
|
|
- [zot](https://zotregistry.io/)
|