Skip to content
getgitopsPublic

About

GitOps Platform Open Source to manage Vault, Code Report and State IaC as Devops

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

273 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitOps

GitOps is an open source internal developer platform for managing identity, project operations, security reports, and infrastructure state in one place.

Built with SvelteKit, TypeScript, and GitDB, it keeps operational data versioned and auditable in Git.

GitOps is under active development. We welcome contributions that improve reliability, documentation, testing, accessibility, and the product experience.

Features

  • Identity and access management for users, organizations, projects, roles, permissions, invitations, sessions, and API keys.
  • Cluster-wide Google sign-in (OpenID Connect) alongside local email and password login.
  • Security reporting for vulnerabilities, SBOMs, secrets, licenses, and services.
  • Pulumi state, history, and lock visibility for S3 and Google Cloud Storage backends.
  • Git-backed, auditable application data through GitDB.

Get started

Requirements: Bun 1.3+, Git 2.20+, and a GitDB repository accessible to your local environment.

git clone https://github.com/getgitops/gitops.git
cd gitops
bun install
cp .env.example .env
bun run dev

Set GITDB_REPOSITORY_URL and a long, random GITDB_ENCRYPTION_KEY in .env. The development server is available at http://localhost:5173.

Private runtime variables are declared in src/env.ts and imported from $app/env/private. When adding one, keep its existing consumer defaults and validation. Logging defaults to pino-pretty in development and structured GCP JSON in production. Use LOG_MODE=standard|gcp and LOG_FORMAT=pretty|json to override these defaults.

GitDB read cache

GitOps preloads every current entity table into RAM after GitDB clones or opens the local repository. Startup readiness includes this preload. Queries, nested relations, and aggregates read the cache first; cache misses fall back to GitDB and repopulate it. Cache hits do not stat or read files, reconstruct chunks, or clone entire tables before filtering and pagination. Only the returned rows are cloned to isolate callers.

GitDB remains the source of truth for writes, schema validation, commits, and audit history. GitOps serializes writes per entity and refreshes that entity's cache after each write, including actor-scoped writes. Failed cache operations are logged and fall back to GitDB without hiding persistence errors.

The cache lives entirely in src/lib/server/gitdb/ in this application, not in the GitDB library. EntityCache defines an async get/set/delete contract; MemoryEntityCache is the default backend. CachedGitDb accepts another backend through its constructor, so a future Redis adapter can use the same repository-scoped keys without changing repositories or query callers.

This caches the current tables, not .git history or unrelated files. Allow enough Node.js heap for decoded JSON and temporary write buffers (potentially several times the repository's on-disk size); adjust NODE_OPTIONS=--max-old-space-size=<MiB> for large deployments. There is no eviction or TTL by default. The current deployment assumes a single writer: changes made outside GitOps require restarting it to rebuild the cache. Redis alone would not add cross-process invalidation.

The Code Report service-detail page uses a single cache projection: it returns full results only for the latest analysis of each tool and compact counters for every completed historical analysis. Historical chart points are not truncated; full older reports remain available from the history page. Derived counters are memoized against immutable cache snapshots and refreshed when those snapshots change. Debug logs named code report service detail loaded include loader and analysis-loading durations; the HTTP duration also includes ancestor loaders, SSR, and response serialization.

Docker

cp .env.example .env
docker compose up --build

The container is available at http://localhost:3000 and stores persistent data in ./data. The image ships git without an SSH client, so point GITDB_REPOSITORY_URL at an HTTPS remote and authenticate with GITDB_TOKEN (or GITDB_USERNAME/GITDB_PASSWORD); with an SSH (git@...) remote the container can commit locally but cannot push.

Google sign-in

Google sign-in is configured once for the whole cluster, through environment variables:

  1. In Google Cloud Console, open APIs & Services → Credentials and create an OAuth client ID of type Web application (configure the consent screen as Internal for Workspace-only access).

  2. Under Authorized redirect URIs (not JavaScript origins), add https://<your-host>/auth/sso/google/callback. For local use add the URI of the port you run on, which must match exactly: http://localhost:5173/auth/sso/google/callback for bun run dev, http://localhost:3000/auth/sso/google/callback for Docker.

  3. Set the variables and restart GitOps:

    GOOGLE_SSO_CLIENT_ID=123456789-abc.apps.googleusercontent.com
    GOOGLE_SSO_CLIENT_SECRET=...
    # optional: comma-separated Google Workspace domains allowed to sign in
    GOOGLE_SSO_ALLOWED_DOMAINS=example.com
    # optional: sign up unknown Workspace accounts of the allowed domains automatically
    GOOGLE_SSO_AUTO_PROVISION=false

The login page then shows Continue with Google, and every organization's Settings → Global shows Google SSO as enabled for the cluster. Leave GOOGLE_SSO_ALLOWED_DOMAINS empty to accept personal @gmail.com accounts, which carry no Workspace domain. With an External consent screen in testing mode, only the accounts listed as test users can sign in.

By default only existing or invited users can sign in with Google. With GOOGLE_SSO_AUTO_PROVISION=true (requires at least one allowed domain), the first Google sign-in of an unknown @example.com Workspace account creates a plain GitOps User (cluster-user) with no organization membership; organizations still have to invite it. Personal Google accounts are never signed up automatically, because the domain is checked against the Workspace hd claim, not the email address. If the variables are inconsistent (only one credential set, an invalid domain, or automatic sign-up without domains), the Google button is hidden and the reason is logged.

Development

bun run check
bun run lint
bun run test
bun run format:check

Use bun run test for the Vitest suite. For end-to-end tests, install Playwright's Chromium browser once with bunx playwright install chromium, then run bun run test:e2e.

Contributing

Contributions of code, tests, documentation, accessibility improvements, bug reports, and product feedback are welcome. Please read CONTRIBUTING.md before opening a pull request.

License

GitOps is released under the Elastic License 2.0.

About

GitOps Platform Open Source to manage Vault, Code Report and State IaC as Devops

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages