{"id":19076123,"url":"https://github.com/acalephstorage/kontinuous","last_synced_at":"2025-04-30T01:13:09.460Z","repository":{"id":57556417,"uuid":"55745559","full_name":"AcalephStorage/kontinuous","owner":"AcalephStorage","description":"The Kubernetes Continuous Integration \u0026 Delivery Platform (CI/CD) :arrows_counterclockwise:","archived":false,"fork":false,"pushed_at":"2016-07-08T10:06:43.000Z","size":1046,"stargazers_count":115,"open_issues_count":21,"forks_count":9,"subscribers_count":12,"default_branch":"develop","last_synced_at":"2025-04-30T01:13:03.984Z","etag":null,"topics":["ci","ci-cd","continuous-delivery","continuous-integration","kubernetes"],"latest_commit_sha":null,"homepage":"","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/AcalephStorage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-08T03:00:42.000Z","updated_at":"2025-02-11T21:32:33.000Z","dependencies_parsed_at":"2022-09-14T12:21:57.830Z","dependency_job_id":null,"html_url":"https://github.com/AcalephStorage/kontinuous","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcalephStorage%2Fkontinuous","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcalephStorage%2Fkontinuous/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcalephStorage%2Fkontinuous/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcalephStorage%2Fkontinuous/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AcalephStorage","download_url":"https://codeload.github.com/AcalephStorage/kontinuous/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251608465,"owners_count":21616859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ci","ci-cd","continuous-delivery","continuous-integration","kubernetes"],"created_at":"2024-11-09T01:57:17.111Z","updated_at":"2025-04-30T01:13:09.421Z","avatar_url":"https://github.com/AcalephStorage.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Kontinuous](docs/logo/logo-small.png)\n\nKontinuous - The Kubernetes Continuous Integration \u0026 Delivery Platform\n==========\n\nAre you sick of having to deal with Jenkins and its plugins? Getting a headache from trying to get your builds working in Kubernetes? *Kontinuous is here to save the day!*\n\nKontinuous is a Continuous Integration \u0026 Delivery pipeline tool built specifically for Kubernetes. It aims to provide a platform for building and deploying applications using native Kubernetes Jobs and Pods.\n\n\u003e This is a **Work In Progress** designed to gather feedback from the community so has fairly basic functionality. Please file Issues (or better yet PRs!) so we can build the :ok_hand: CI/CD platform for K8s\n\n\n## Features\n\nKontinuous currently offers the following features:\n\n - A simple Kubernetes-like spec for declaring delivery pipelines\n - Flexible stages - Command execution, Docker builds and publishing to local or remote registries\n - Integration with Github for builds and status\n - Slack notifications\n - A CLI tool for querying pipelines, build status and logs\n\nWe've got lots more planned, see the [Roadmap](#roadmap) or Github issues to get in on the action!\n\n## Running Kontinuous\n\n### Getting Started\n\nBefore running Kontinuous, it needs to be added as a github OAuth Application [here](https://github.com/settings/applications/new). The `Client ID` and `Client Secret` will be used in running Kontinuous.\n\nThe `kubernetes-cli` can bootstrap a kontinuous setup on a running Kubernetes cluster. This requires `kubectl` to be in the `PATH` and configured to access the cluster. \n\n```\n$ kontinuous-cli --namespace {namespace} \\\n    --auth-secret {base64 encoded secret} \\\n    --github-client-id {github client id} \\\n    --github-client-secret {github client secret}\n```\n\nParameters:\n\n| parameter              | description                                                                                                                  |\n|------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| --namespace            | The namespace to deploy Kontinuous to. This defaults to `kontinuous`                                                         |\n| --auth-secret          | A base64 encoded secret. This is used by kontinuous to provide JWT for authentication. This can be any base64 encoded string |\n| --github-client-id     | The Github client ID provided when registering kontinuous as a Github OAuth application                                      |\n| --github-client-secret | The Github client secret provided when registering kontinuous as a Github OAuth application                                  |\n\n\nThis will launch `kontinuous` via the locally configured `kubectl` in the given namespace together with `etcd`, `minio`, a docker `registry`, and `kontinuous-ui`. This expects that the kubernetes cluster supports the LoadBalancer service.\n\nOnce a public IP for `kontinuous-ui` is available, the Github OAuth Application settings needs to be modified to reflect the actual IP address of `kontinuous-ui` for the Homepage and Callback URL.\n\nAlternatively, for more customization, a sample yaml file for running kontinuous and its dependencies in Kubernetes can be found [here](./k8s-spec.yml.example). More details can be found [here](docs/setup.md).\n\nOnce running, add a [.pipeline.yml](#pipeline-spec) to the root of your Github repo and configure the webhooks. \n\nExample pipelines can be found in [/examples](./examples)\n\nThe [CLI client](#clients) or [API](#api) can be used to view build status or logs.\n\n## Pipeline Specification\n\nPipeline specification should be at the root directory of the repository. This defines the stages of the builds. More details about pipeline spec creation can be found [here](docs/pipeline.md).\n\n```yaml\n---\nkind: Pipeline\napiVersion: v1alpha1\nmetadata:\n  name: kontinuous\n  namespace: acaleph\nspec:\n  selector:\n    matchLabels:\n      app: kontinuous\n      type: ci-cd\n  template:\n    metadata:\n      name: kontinuous\n      labels:\n        app: kontinuous\n        type: ci-cd\n    notif:\n      - type: slack\n    secrets:\n      - notifcreds\n      - docker-credentials\n    stages:\n      - name: Build Docker Image\n        type: docker_build\n```\n\nThis example only has one stage, build a docker image.\n\n## Clients\n\nThere are two clients currently available:\n\n### Kontinuous CLI\n\nThe CLI tool is the one that is used in the gettings started section. It can bootstrap Kontinuous to a running Kubernetes Cluster and can access details on Kontinuous pipelines and builds.\n\nMore info about the CLI can be found [here](https://github.com/AcalephStorage/kontinuous/tree/develop/cli) and the binary can be downloaded [here](https://github.com/AcalephStorage/kontinuous/releases).\n\n### Kontinuous UI\n\nKontinuous UI is a web based client for Kontinuous. Bootstrapping Kontinuous using the CLI will install the UI on the Kubernetes Cluster too. More info about the UI can be found [here](https://github.com/AcalephStorage/kontinuous-ui).\n\n## API\n\nKontinuous is accessible from it's API and docs can be viewed via Swagger. More details about using the API and Authentication can be found [here](docs/api.md).\n\n## Development\n\nBuilding `kontinuous` from source is done by:\n\n```console\n$ make deps build\n```\n\nBuild the docker image:\n\n```console\n$ docker build -t {tag} .\n```\n\n## Roadmap\n\n- [ ] More stage types - wait/approvals, vulnerability/security testing, container slimming, load testing, deploy tools (Helm, DM, KPM, etc)\n- [ ] Full stack tests - Spin up full environments for testing\n- [ ] Advanced branch testing - Review/Sandbox environments\n- [ ] Metrics - Compare build performance\n- [ ] Notification service integration - Email, hipchat, etc\n- [ ] Web based management Dashboard\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facalephstorage%2Fkontinuous","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facalephstorage%2Fkontinuous","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facalephstorage%2Fkontinuous/lists"}