api

module
v0.0.0-...-5a70278 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 17, 2026 License: MIT

README

Simple Container

OpenSSF Scorecard OpenSSF Best Practices OpenSSF Baseline CodeQL Semgrep SLSA Build L3 Sigstore signed Build govulncheck Go Reference

Simple Container (sc) is a cloud-agnostic deployment tool designed to simplify microservices deployment, infrastructure provisioning, and CI/CD automation.

It allows developers to deploy services effortlessly, while DevOps teams manage infrastructure centrally, ensuring scalability, security, and reliability across multi-cloud environments.


Features

  1. Infrastructure as Code (IaC) Simplified – Define infrastructure with lightweight YAML configurations, no need for Terraform or Pulumi.
  2. Effortless Microservice Deployment – Deploy services with one command, using familiar tools like Dockerfile and docker-compose.yaml.
  3. Built-in Secrets Management – Securely store and inject credentials using AWS Secrets Manager, GCP Secret Manager, or Kubernetes Secrets.
  4. Multi-Cloud & Kubernetes Support – Seamlessly deploy to AWS ECS, Google Cloud Run, Kubernetes clusters, and more.
  5. Built-in CI/CD & Automated Rollbacks – Deploy, monitor, and rollback services without external CI/CD pipelines.
  6. Comprehensive CloudWatch Monitoring – Built-in alerts for ECS services and Application Load Balancers with Email, Slack, Discord, and Telegram notifications.

Installation

To install sc, run:

curl -s "https://dist.simple-container.com/sc.sh" | bash

Verify installation:

sc --version

Getting Started

  1. Initialize a project

    sc init
    
  2. Configure infrastructure (for DevOps)

    • Define cloud resources in .sc/stacks/devops/server.yaml.
  3. Define a microservice (for developers)

    • Add a client.yaml file in .sc/stacks/<service-name>/client.yaml.
  4. Deploy a service

    sc deploy -s myservice -e staging
    

Documentation

Check out the full documentation for detailed guides, examples, and best practices.


Plugins

Cloud integrations ship as independently released plugin binaries that sc downloads and talks to over a local gRPC bus. Everything about an operator's client.yaml stays the same; server.yaml names which plugin release to use.

Plugin Repository Owns
aws simple-container-com/sc-plugin-aws aws provider, aws-lambda / ecs-fargate / aws-static-website templates, s3-bucket / ecr-repository / aws-rds-postgres / aws-rds-mysql / aws-cloudtrail-security-alerts resources, aws-kms secrets-provider, s3-bucket state-store, cloud-helpers Lambda
cloudflare simple-container-com/sc-plugin-cloudflare cloudflare DNS registrar, Workers overrides, Pages Direct Upload
cloudru simple-container-com/sc-plugin-cloudru cloudru provider, cloudru-container, cloudru-postgres, cloudru-evolution-vm
gcp simple-container-com/sc-plugin-gcp gcp provider, cloudrun / gcp-static-website / gcp-gke-autopilot templates, gcp-bucket / gcp-redis / gcp-pubsub / gcp-cloudsql-postgres / gcp-gke-autopilot-cluster / gcp-docker-image-push resources, gcp-kms + gcp-secrets-manager secrets-providers, gcp-bucket state-store, gcp-service-account auth
mongodb simple-container-com/sc-plugin-mongodb mongodb-atlas provider + ComputeProcessor for uses: env fan-out, PreDestroy database-drop hook
mws simple-container-com/sc-plugin-mws mws provider + mws-service-account auth
yandex simple-container-com/sc-plugin-yandex yandex provider, yc-dns, yc-serverless-container, yc-object-storage, yc-kms, yc-lockbox, yc-service-account, yandex-vm
echo (template) simple-container-com/sc-plugin-echo Template every new plugin starts from — gh repo create --template and swap in your cloud

Everything else — Kubernetes, k3s, vm — is still built into sc.


Contributing

We welcome contributions! Please see our CONTRIBUTING.md for guidelines on how to get involved, and our CODE_OF_CONDUCT.md for the community standards every participant is expected to uphold.


Roadmap

See ROADMAP.md for current themes, release cadence, and where planned work surfaces in the Issues tracker.


License

Simple Container is open-source and licensed under the MIT License.


Community & Support

  1. Feature Requests & Issues – GitHub Issues
  2. Discussions & Updates – Join our Discord
  3. Enterprise Support – Contact us at support@simple-container.com
  4. News and announcements - Follow us on X

Start deploying microservices effortlessly with Simple Container today!

Directories

Path Synopsis
cmd
cloud-helpers command
github-actions command
sc command
schema-gen command
internal
pkg
api
api/inlinetag
Package inlinetag detects struct fields that are tagged `json:",inline"` while being NAMED rather than embedded — a shape that means two different things to the two codecs this repo's config travels through, and the single root cause behind seven production failures across the fleet on 2026-11-09.
Package inlinetag detects struct fields that are tagged `json:",inline"` while being NAMED rather than embedded — a shape that means two different things to the two codecs this repo's config travels through, and the single root cause behind seven production failures across the fleet on 2026-11-09.
api/secrets/scoped
Package scoped implements the additive per-scope secret store (secrets.<scope>.yaml): committed-encrypted files whose values are sealed to a per-scope recipient set, so a pull_request-triggered CI job can be given a key that opens only the "pr" scope rather than the whole-file store.
Package scoped implements the additive per-scope secret store (secrets.<scope>.yaml): committed-encrypted files whose values are sealed to a per-scope recipient set, so a pull_request-triggered CI job can be given a key that opens only the "pr" scope rather than the whole-file store.
assistant/embeddings
Package embeddings provides semantic search capabilities for Simple Container documentation.
Package embeddings provides semantic search capabilities for Simple Container documentation.
clouds/caddy
Package caddy holds the parts of SC's Caddy configuration that both edges render.
Package caddy holds the parts of SC's Caddy configuration that both edges render.
clouds/k3s
Package k3s is the config tier of a Kubernetes cluster SC stands up itself, on machines described by a `vm` resource (pkg/clouds/vm).
Package k3s is the config tier of a Kubernetes cluster SC stands up itself, on machines described by a `vm` resource (pkg/clouds/vm).
clouds/pulumi/k3s
Package k3s provisions a Kubernetes cluster SC installs itself, over SSH, onto the machines of a `vm` resource.
Package k3s provisions a Kubernetes cluster SC installs itself, over SSH, onto the machines of a `vm` resource.
clouds/pulumi/vm
Package vm provisions the machines behind SC's VM-based delivery paths: compose on one VM (P5) and, next, k3s that SC stands up itself (P3).
Package vm provisions the machines behind SC's VM-based delivery paths: compose on one VM (P5) and, next, k3s that SC stands up itself (P3).
clouds/vm
Package vm is the cloud-independent description of a virtual machine, or of a pool of them.
Package vm is the cloud-independent description of a virtual machine, or of a pool of them.
clouds/vm/imageship
Package imageship moves locally-held docker images onto a remote docker host over SSH, without a registry and without the docker CLI on the machine doing the shipping.
Package imageship moves locally-held docker images onto a remote docker host over SSH, without a registry and without the docker CLI on the machine doing the shipping.
cmd
Package cmd provides the SC CLI command tree for embedding in other binaries.
Package cmd provides the SC CLI command tree for embedding in other binaries.
cmd/cmd_sbom
Package cmd_sbom provides CLI commands for SBOM operations
Package cmd_sbom provides CLI commands for SBOM operations
plugin
Package plugin wires hashicorp/go-plugin's lifecycle to the sc_plugin.proto service, providing both the SC-core-side client wrapper and the plugin-side server registration helper.
Package plugin wires hashicorp/go-plugin's lifecycle to the sc_plugin.proto service, providing both the SC-core-side client wrapper and the plugin-side server registration helper.
plugin/runtime
Package runtime is the shared RPC-handler scaffolding every SC plugin uses: context construction with a local-engine fallback, deferred drain-then-settle of the Pulumi SDK context, harvest of pctx exports into ProvisionResponse.Outputs, and the compute-process parent-env swap.
Package runtime is the shared RPC-handler scaffolding every SC plugin uses: context construction with a local-engine fallback, deferred drain-then-settle of the Pulumi SDK context, harvest of pctx exports into ProvisionResponse.Outputs, and the compute-process parent-env swap.
security/sbom
Package sbom provides Software Bill of Materials (SBOM) generation and attestation functionality
Package sbom provides Software Bill of Materials (SBOM) generation and attestation functionality
security/tools/cosigntest
Package cosigntest installs a scripted stand-in for the cosign binary so tests can drive the signing, SBOM and provenance code paths without a real cosign install, registry, or signing key.
Package cosigntest installs a scripted stand-in for the cosign binary so tests can drive the signing, SBOM and provenance code paths without a real cosign install, registry, or signing key.
stackread
Package stackread is the two-pass reader that discovers plugin-owned types BEFORE server.yaml's full parse runs.
Package stackread is the two-pass reader that discovers plugin-owned types BEFORE server.yaml's full parse runs.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL