{"id":27870902,"url":"https://github.com/sapcc/disco","last_synced_at":"2026-05-18T19:02:57.506Z","repository":{"id":267650435,"uuid":"901876812","full_name":"sapcc/disco","owner":"sapcc","description":"Designate IngresS CNAME Operator (DISCO)","archived":false,"fork":false,"pushed_at":"2025-10-02T16:26:36.000Z","size":152,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":36,"default_branch":"main","last_synced_at":"2025-10-02T18:27:23.398Z","etag":null,"topics":["designate","kubernetes","openstack"],"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/sapcc.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-12-11T13:35:18.000Z","updated_at":"2025-09-18T19:05:19.000Z","dependencies_parsed_at":"2024-12-30T19:31:35.305Z","dependency_job_id":"698c965e-142b-4dad-985b-1e2319d3a0d6","html_url":"https://github.com/sapcc/disco","commit_stats":null,"previous_names":["sapcc/disco"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sapcc/disco","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fdisco","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fdisco/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fdisco/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fdisco/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sapcc","download_url":"https://codeload.github.com/sapcc/disco/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fdisco/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279011053,"owners_count":26084863,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["designate","kubernetes","openstack"],"created_at":"2025-05-04T23:28:19.820Z","updated_at":"2025-10-12T10:13:37.252Z","avatar_url":"https://github.com/sapcc.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Designate IngresS Cname Operator (DISCO)\n\n[![REUSE status](https://api.reuse.software/badge/github.com/sapcc/disco)](https://api.reuse.software/info/github.com/sapcc/disco)\n[![GitHub Container Registry](https://img.shields.io/badge/GitHub%20Container%20Registry-disco-blue?logo=github\u0026logoColor=white\u0026style=flat)](https://github.com/sapcc/disco/pkgs/container/disco)\n\n\nThe DISCO operator automatically discovers Ingresses in the Kubernetes cluster and creates corresponding CNAMEs in OpenStack Desginate.\n\n## Features\n\n- Discovers required CNAMEs via Kubernetes API\n- Automatically creates CNAMEs via OpenStack Designate API\n- Periodically verifies CNAMEs\n- Automatically deletes CNAMEs when the Ingress is deleted\n- Exposes Prometheus metrics\n\n## Requirements\n\n- go 1.23\n\n## Installation\n\nThe [helm chart](https://github.com/sapcc/helm-charts/tree/master/system/kube-system/charts/disco/) can be used to bring the DISCO to your cluster.  \nNote that the DISCO will only start for Ingresses that are annotated with\n```\nmetadata:\n  annotations:\n    disco: \"true\"\n```\n\n## Configuration\n\nThe DISCO is configured via environment variables:\n```\n# Openstack configurations.\nOS_AUTH_URL:\nOS_REGION_NAME:\nOS_USERNAME:\nOS_PASSWORD:\nOS_USER_DOMAIN_NAME:\nOS_PROJECT_NAME:\nOS_PROJECT_DOMAIN_NAME:\n\n# Operator specifics.\nDEFAULT_DNS_ZONE_NAME:\nDEFAULT_DNS_RECORD:\n```\n\n## Usage\n\nGiven the following Ingress\n```\napiVersion: extensions/v1beta1\nkind: Ingress\nmetadata:\n  annotations:\n    disco: \"true\"\n  \n... \n \nspec:\n  rules:\n  - host: myhost.zone.tld\n    ...\n```\nthe operator would create the following CNAME in the configured zone in OpenStack Designate\n```\n+-----------------------+-------+----------------+\n| name                  | type  | records        |\n+------------------------------------------------+\n| myhost.zone.tld.      | CNAME | \u003crecord\u003e       |\n+-----------------------+-------+----------------+\n```\n\nGiven the following service:\n\n```\napiVersion: v1\nkind: Service\nmetadata\n  annotations:\n    disco: \"true\"\n    disco/record: myhost.zone.tld.\nspec:\n  externalIPs:\n  - 1.2.3.4\n  loadBalancerIP: 1.2.3.4\n  ...\nstatus:\n  loadBalancer:\n    ingress:\n    - ip: 1.2.3.4\n```\n\nthe operator would create the following A record in the configured zone in OpenStack Designate\n```\n+-----------------------+-------+----------------+\n| name                  | type  | records        |\n+------------------------------------------------+\n| myhost.zone.tld.      | A     | 1.2.3.4        |\n+-----------------------+-------+----------------+\n```\n\n**Fine-tuning:**\n\nThe operator has to be configured with a default record.\nHowever, this can also be set on the ingress using the following annotation:\n```\ndisco/record: \u003c record \u003e\n```\n\nPer default type of all records will be `CNAME`.\nThis can be set to one of `A`, `SOA`, `NS`, `CNAME` using the following annotation:\n```\ndisco/record-type: \u003crecord type\u003e\n```\n\nMoreover, a description can be provided via the annotation:\n```\ndisco/record-description: \u003c description \u003e\n``` \n\nCreation of records in a different zone is supported via the annotation:\n```\ndisco/zone-name: \u003cname of the zone\u003e\n```\n\nAll parameters and their defaults:\n```\nUsage of disco:\n      --config string               Path to operator config file (default \"/etc/disco/disco.conf\")\n      --debug                       Enable debug logging\n      --ingress-annotation string   Handle ingress with this annotation (default \"disco\")\n      --service-annotation string   Handle service with this annotation (default \"disco\")\n      --kubeconfig string           Path to kubeconfig file with authorization and master location information\n      --metric-port int             Metrics are exposed on this port (default 9091)\n      --recheck-period int          RecheckPeriod[min] defines the base period after which configmaps are checked again (default 5)\n      --record string               Default record data used for the CNAME\n      --recordset-ttl int           The Recordset TTL in seconds (default 1800)\n      --resync-period int           ResyncPeriod[min] defines the base period after which the cache is resynced (default 2)\n      --threadiness int             The operator threadiness (default 1)\n      --zone-name string            Name of the openstack zone in which the recordset will be created\n```\n\n**Note**:\nThe DISCO operator uses [finalizers](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#finalizers)\nto ensure the deletion of Designate CNAMEs when the deletion of the corresponding ingress is triggered.\nRemoving the finalizer manually will cause a left-over CNAME in Designate.\n\n## Limitations\n\nIf an Ingress defines multiple hosts, as shown below, deleting one rule will currently not trigger the deletion of the record in Designate.\n```\nspec:\n  rules:\n  - host: party.subdomain.tld\n    http:\n      paths:\n      - backend:\n          serviceName: party-service\n          servicePort: 80\n        path: /\n  - host: disco.subdomain.tld\n    http:\n      paths:\n      - backend:\n          serviceName: disco-service\n          servicePort: 80\n        path: /\n```\n\n## Getting Started\n\nYou’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.\n**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).\n\n### Running on the cluster\n1. Install Instances of Custom Resources:\n\n```sh\nkubectl apply -f config/samples/\n```\n\n2. Build and push your image to the location specified by `IMG`:\n\t\n```sh\nmake docker-build docker-push IMG=\u003csome-registry\u003e/disco:tag\n```\n\t\n3. Deploy the controller to the cluster with the image specified by `IMG`:\n\n```sh\nmake deploy IMG=\u003csome-registry\u003e/disco:tag\n```\n\n### Uninstall CRDs\nTo delete the CRDs from the cluster:\n\n```sh\nmake uninstall\n```\n\n### Undeploy controller\nUnDeploy the controller to the cluster:\n\n```sh\nmake undeploy\n```\n\n## Contributing\n// TODO(user): Add detailed information on how you would like others to contribute to this project\n\n### How it works\nThis project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)\n\nIt uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) \nwhich provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster \n\n### Test It Out\n1. Install the CRDs into the cluster:\n\n```sh\nmake install\n```\n\n2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):\n\n```sh\nmake run\n```\n\n**NOTE:** You can also run this in one step by running: `make install run`\n\n## License\n\nCopyright 2022 SAP SE.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsapcc%2Fdisco","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsapcc%2Fdisco","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsapcc%2Fdisco/lists"}