{"id":51858578,"url":"https://github.com/stuttgart-things/provider-clusterbook","last_synced_at":"2026-07-24T03:31:07.224Z","repository":{"id":346992123,"uuid":"1192361848","full_name":"stuttgart-things/provider-clusterbook","owner":"stuttgart-things","description":"minimal Crossplane Provider that is meant to be used as a clusterbook for implementing new Providers","archived":false,"fork":false,"pushed_at":"2026-07-15T18:54:58.000Z","size":164,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-07-15T20:26:46.395Z","etag":null,"topics":["clusterbook","crossplane","crossplane-provider","ddwrt","golang","ipam","pdns"],"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/stuttgart-things.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"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":"DCO","cla":null}},"created_at":"2026-03-26T06:19:27.000Z","updated_at":"2026-06-14T07:01:41.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/stuttgart-things/provider-clusterbook","commit_stats":null,"previous_names":["stuttgart-things/xplane-provider-clusterbook","stuttgart-things/provider-clusterbook"],"tags_count":8,"template":false,"template_full_name":"crossplane/provider-template","purl":"pkg:github/stuttgart-things/provider-clusterbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fprovider-clusterbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fprovider-clusterbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fprovider-clusterbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fprovider-clusterbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stuttgart-things","download_url":"https://codeload.github.com/stuttgart-things/provider-clusterbook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fprovider-clusterbook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35826032,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-24T02:00:07.870Z","response_time":62,"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":["clusterbook","crossplane","crossplane-provider","ddwrt","golang","ipam","pdns"],"created_at":"2026-07-24T03:31:06.538Z","updated_at":"2026-07-24T03:31:07.190Z","avatar_url":"https://github.com/stuttgart-things.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# provider-clusterbook\n\n`provider-clusterbook` is a [Crossplane](https://crossplane.io/) Provider that\nmanages IP address reservations from a [clusterbook](https://github.com/stuttgart-things/clusterbook)\nREST API. It reserves IPs from network pools, optionally creates PowerDNS\nwildcard DNS records, and exposes the assigned addresses in status.\n\n## Features\n\n- **IP reservation** — reserve one or more IPs from a clusterbook network pool\n- **Explicit or auto-assign** — optionally specify an exact IP, or let clusterbook auto-assign from the pool\n- **PowerDNS integration** — optionally create wildcard DNS records for reserved IPs via `createDNS`\n- **Drift detection** — observes the clusterbook API and reconciles on changes\n- **TLS support** — custom CA certificates and insecure skip-verify for self-signed endpoints\n\n## Custom Resource Types\n\n| Kind | Scope | Description |\n|------|-------|-------------|\n| `ProviderConfig` | Namespaced | Clusterbook API connection settings (namespaced) |\n| `ClusterProviderConfig` | Cluster | Clusterbook API connection settings (cluster-scoped) |\n| `IPReservation` | Cluster | Managed resource — reserves IPs from a network pool |\n\n## Quick Start\n\n### 1. Install the Provider\n\n```yaml\napiVersion: pkg.crossplane.io/v1\nkind: Provider\nmetadata:\n  name: provider-clusterbook\nspec:\n  package: ghcr.io/stuttgart-things/provider-clusterbook-xpkg:v3.1\n```\n\n### 2. Create a ClusterProviderConfig\n\n```yaml\napiVersion: clusterbook.stuttgart-things.com/v1alpha1\nkind: ClusterProviderConfig\nmetadata:\n  name: default\nspec:\n  url: \"http://clusterbook.clusterbook.svc.cluster.local:8080\"\n```\n\nFor TLS endpoints with a custom CA:\n\n```yaml\napiVersion: clusterbook.stuttgart-things.com/v1alpha1\nkind: ClusterProviderConfig\nmetadata:\n  name: default\nspec:\n  url: \"https://clusterbook.example.com\"\n  customCA: |\n    -----BEGIN CERTIFICATE-----\n    ...\n    -----END CERTIFICATE-----\n```\n\nFor self-signed certificates (development only):\n\n```yaml\napiVersion: clusterbook.stuttgart-things.com/v1alpha1\nkind: ClusterProviderConfig\nmetadata:\n  name: default\nspec:\n  url: \"https://clusterbook.example.com\"\n  insecureSkipTLSVerify: true\n```\n\n### 3. Create an IPReservation\n\nAuto-assign an IP from a network pool:\n\n```yaml\napiVersion: ipreservation.clusterbook.stuttgart-things.com/v1alpha1\nkind: IPReservation\nmetadata:\n  name: my-cluster-ip\nspec:\n  forProvider:\n    networkKey: \"10.31.103\"\n    clusterName: my-cluster\n    count: 1\n  providerConfigRef:\n    name: default\n    kind: ClusterProviderConfig\n```\n\nReserve a specific IP with DNS record:\n\n```yaml\napiVersion: ipreservation.clusterbook.stuttgart-things.com/v1alpha1\nkind: IPReservation\nmetadata:\n  name: my-cluster-ip\nspec:\n  forProvider:\n    networkKey: \"10.31.103\"\n    clusterName: my-cluster\n    ip: \"10.31.103.42\"\n    createDNS: true\n  providerConfigRef:\n    name: default\n    kind: ClusterProviderConfig\n```\n\n## Verify\n\n```shell\n$ kubectl get ipreservation\nNAME             READY   SYNCED   NETWORK     CLUSTER      AGE\nmy-cluster-ip    True    True     10.31.103   my-cluster   5m\n\n$ kubectl get ipreservation my-cluster-ip -o jsonpath='{.status.atProvider}' | jq\n{\n  \"ipAddresses\": [\"10.31.103.42\"],\n  \"status\": \"ASSIGNED:DNS\"\n}\n```\n\n## IPReservation Fields\n\n### Spec (`forProvider`)\n\n| Field | Type | Required | Default | Description |\n|-------|------|----------|---------|-------------|\n| `networkKey` | string | Yes | — | Network pool key (e.g. `10.31.103`) |\n| `clusterName` | string | Yes | — | Cluster name to assign IPs to |\n| `count` | integer | No | 1 | Number of IPs to reserve |\n| `ip` | string | No | — | Explicit IP (skips auto-assignment) |\n| `createDNS` | boolean | No | false | Create a PDNS wildcard DNS record |\n\n### Status (`atProvider`)\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `ipAddresses` | []string | List of assigned IP addresses |\n| `status` | string | Assignment status (`ASSIGNED` or `ASSIGNED:DNS`) |\n\n## Building\n\n### Prerequisites\n\n- Go 1.23+\n- Docker\n- Make\n\n### Build the Provider\n\n```shell\n# Initialize the build submodule (first time only)\nmake submodules\n\n# Generate CRDs, deepcopy, and run linters\nmake reviewable\n\n# Build the provider binary and Docker image\nmake build\n```\n\n### Running Tests\n\n```shell\ngo test ./internal/... -v -count=1\n```\n\n## Project Structure\n\n```\napis/\n  v1alpha1/                    # ProviderConfig, ClusterProviderConfig types\n  ipreservation/\n    v1alpha1/                  # IPReservation managed resource type\ninternal/\n  client/                      # Clusterbook REST API client\n  controller/\n    config/                    # ProviderConfig controller\n    ipreservation/             # IPReservation reconciler\n    clusterbook.go             # Controller registration\npackage/\n  crds/                        # Generated CRDs\n  crossplane.yaml              # Crossplane package metadata\n```\n\n## Provider Flags\n\n| Flag | Default | Description |\n|------|---------|-------------|\n| `--debug` / `-d` | `false` | Enable debug logging |\n| `--leader-election` / `-l` | `false` | Enable leader election for HA |\n| `--poll` | `1m` | How often to check each resource for drift |\n| `--sync` / `-s` | `1h` | Controller manager sync period |\n| `--max-reconcile-rate` | `10` | Max reconciliations per second |\n\n## Links\n\n- [Crossplane Provider Development Guide](https://github.com/crossplane/crossplane/blob/master/contributing/guide-provider-development.md)\n- [clusterbook](https://github.com/stuttgart-things/clusterbook)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuttgart-things%2Fprovider-clusterbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstuttgart-things%2Fprovider-clusterbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuttgart-things%2Fprovider-clusterbook/lists"}