{"id":15156747,"url":"https://github.com/puppetlabs/relay-core","last_synced_at":"2025-09-30T06:31:20.710Z","repository":{"id":39580489,"uuid":"192807993","full_name":"puppetlabs/relay-core","owner":"puppetlabs","description":"Kubernetes-based execution engine","archived":true,"fork":false,"pushed_at":"2023-02-09T21:10:43.000Z","size":23340,"stargazers_count":16,"open_issues_count":0,"forks_count":8,"subscribers_count":40,"default_branch":"main","last_synced_at":"2024-09-23T05:31:37.169Z","etag":null,"topics":["relay"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"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/puppetlabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-19T21:40:20.000Z","updated_at":"2023-10-05T00:09:34.000Z","dependencies_parsed_at":"2024-06-18T21:53:13.620Z","dependency_job_id":null,"html_url":"https://github.com/puppetlabs/relay-core","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/puppetlabs%2Frelay-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/puppetlabs%2Frelay-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/puppetlabs%2Frelay-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/puppetlabs%2Frelay-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/puppetlabs","download_url":"https://codeload.github.com/puppetlabs/relay-core/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219874799,"owners_count":16554617,"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":["relay"],"created_at":"2024-09-26T19:41:14.099Z","updated_at":"2025-09-30T06:31:20.225Z","avatar_url":"https://github.com/puppetlabs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Relay Core\n\nThis repository contains a Kubernetes-based execution engine for running workflows or processing webhook triggers.\n\n## Installation\n\n```bash\nkustomize build manifests | kubectl apply -f -\nkustomize build examples/install | kubectl apply -f -\n```\n\n### Requirements\n\n* Kubernetes v1.20+\n* [Tekton](https://tekton.dev/) (v0.32.1+)\n* [Knative Serving](https://knative.dev/) (v1.1.2+)\n* [Kourier](https://github.com/knative-sandbox/net-kourier/) (v1.1.0+)\n\n## Components\n\n### Operator\n\nThe Relay operator is responsible for reconciling the Relay [custom resource\ndefinitions\n(CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).\nIt is built using\n[controller-runtime](https://github.com/kubernetes-sigs/controller-runtime/),\nalthough it does not use a higher-level framework like Kubebuilder or Operator\nSDK.\n\nThe entry point for the operator is in\n[`cmd/relay-operator`](cmd/relay-operator).\n\n#### Resources\n\n| API Version | Kind | Description |\n|-------------|------|-------------|\n| `relay.sh/v1beta1` | `Run` | Runs the defined workflow using a Tekton pipeline |\n| `relay.sh/v1beta1` | `Tenant` | Defines event emission and namespace configuration for objects attached to it |\n| `relay.sh/v1beta1` | `WebhookTrigger` | Creates Knative services with a given container configuration and tenant to handle webhook requests and emit events |\n| `relay.sh/v1beta1` | `Workflow` | Defines a workflow using the given container configurations and dependencies |\n\n### Metadata API\n\nThe metadata API provides runtime information to a pod running under the\nsupervision of the Relay operator.\n\nThe entry point for the metadata API is in\n[`cmd/relay-metadata-api`](cmd/relay-metadata-api).\n\n#### Endpoints\n\nRequests to the metadata API are always authenticated. In production mode, we\nuse the source IP of the request to look up an annotation containing an\nencrypted token that grants access to the resources for that pod. Once\nauthenticated, the following endpoints are available:\n\n| Method | Path | Scope | Description |\n|--------|------|-------|-------------|\n| `GET` | `/conditions` | Any | Resolves any conditions specified in the `when` clause of a container specification |\n| `POST` | `/events` | Triggers | Emits a new event using the configure trigger event sink of the pod's tenant |\n| `PUT` | `/outputs/:name` | Steps | Sets the output with the given name |\n| `GET` | `/outputs/:step_name/:name` | Steps | Retrieves the value of the output with the given step name and output name |\n| `GET` | `/secrets/:name` | Any | Retrieves the value of the secret with the given name |\n| `GET` | `/spec` | Any | Retrieves the entire specification associated with this container or a subset of the specification described by the given language (`lang`) and expression (`q`) query string parameters |\n| `GET` | `/state/:name` | Any | Retrieves the value of the internal state variable with the given name |\n\n#### Testing\n\nTo test the metadata API without deploying it in a live environment, you can run\nit using a sample configuration. A selection of sample configurations are\nprovided in the [`examples/sample-configs`](examples/sample-configs) directory.\n\nYou can specify a JWT signing key for authenticating requests explicitly using\nthe `RELAY_METADATA_API_SAMPLE_HS256_SIGNING_KEY` environment variable. If not\nspecified, the metadata API process will generate and print one when it starts\nup.\n\nFor example:\n\n```console\n$ go build -o relay-metadata-api ./cmd/relay-metadata-api\n$ export RELAY_METADATA_API_SAMPLE_CONFIG_FILES=examples/sample-configs/simple.yaml\n$ ./relay-metadata-api \u0026\n[...] created new HMAC-SHA256 signing key     key=[...]\n[...] generated JWT for step                  run-id=1234 step-name=foo token=eyJhbGciOiJIUzI1NiJ9.[...]\n[...] listening for metadata connections      addr=0.0.0.0:7000\n$ curl -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.[...]' http://localhost:7000/spec | jq .\n{\n  \"value\": {\n    \"aws\": {\n      \"accessKeyID\": \"AKIASAMPLEKEY\",\n      \"secretAccessKey\": \"6bkpuV9fF3LX1Yo79OpfTwsw8wt5wsVLGTPJjDTu\"\n    },\n    \"foo\": \"bar\"\n  },\n  \"unresolvable\": {},\n  \"complete\": true\n}\n```\n\n## Contributing\n\nSee [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information on how to\ncontribute to this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpuppetlabs%2Frelay-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpuppetlabs%2Frelay-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpuppetlabs%2Frelay-core/lists"}