{"id":19230632,"url":"https://github.com/ctron/hawkbit-operator","last_synced_at":"2025-09-12T06:32:39.612Z","repository":{"id":140053005,"uuid":"288215368","full_name":"ctron/hawkbit-operator","owner":"ctron","description":"A Kubernetes operator for Eclipse Hawkbit","archived":false,"fork":false,"pushed_at":"2021-10-07T16:21:16.000Z","size":272,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-31T13:25:57.283Z","etag":null,"topics":["firmware-updater","iot","kubernetes-operator"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ctron.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2020-08-17T15:22:40.000Z","updated_at":"2023-09-08T09:42:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"4c7558c9-ffc5-431a-b63f-4d75d806c9df","html_url":"https://github.com/ctron/hawkbit-operator","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/ctron/hawkbit-operator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctron%2Fhawkbit-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctron%2Fhawkbit-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctron%2Fhawkbit-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctron%2Fhawkbit-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ctron","download_url":"https://codeload.github.com/ctron/hawkbit-operator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctron%2Fhawkbit-operator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274769583,"owners_count":25346209,"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-09-12T02:00:09.324Z","response_time":60,"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":["firmware-updater","iot","kubernetes-operator"],"created_at":"2024-11-09T15:39:57.446Z","updated_at":"2025-09-12T06:32:39.565Z","avatar_url":"https://github.com/ctron.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Install the operator\n\nYou need to install the operator. Once you have installed the operator, you can create a new hawkBit instance by\ncreate a new custom resource of type `Hawkbit`.\n\n### Using OperatorHub\n\nThe operator is available on [OperatorHub](https://operatorhub.io/operator/hawkbit-operator).\n\n### Using Helm\n\nYou can also install the operator using [Helm](https://helm.sh/):\n\n    helm install hawkbit-operator ./helm/hawkbit-operator\n\nOn OpenShift, you can also build a local instance using S2I:\n\n    helm install hawkbit-operator ./helm/hawkbit-operator --set s2i.enabled=true --set openshift.enabled=true\n\n## Create a hawkBit instance\n\nThe following sections describe briefly what is required to create a new instance.\n\n### Database instance\n\nhawkBit requires a database to run. You can provide an existing database instance, or\nyou can choose from the following options:\n\n#### Use an embedded database\n  \nThis can be achieved by using the following `database` configuration in the `Hawkbit` resource:\n\n~~~yaml\nspec:\n  database:\n    embedded: {}\n~~~\n\nNOTE: This uses an embedded instance of H2. This is only intended for testing.\n\n#### Create a new PostgreSQL instance:\n    \nNOTE: This currently requires a manually provide hawkBit image.\n    \n~~~\nhelm install hawkbit-db bitnami/postgresql --set securityContext.enabled=false --set postgresqlDatabase=hawkbit --set postgresqlUsername=hawkbit --set postgresqlPassword=hawkbit\n~~~\n\nAnd use the following `database` configuration in the `Hawkbit` resource:\n\n~~~yaml\nspec:\n  database:\n    postgres:\n      database: hawkbit\n      host: hawkbit-db-postgresql\n      username: hawkbit\n      passwordSecret:\n        name: hawkbit-db-postgresql\n        field: postgresql-password\n~~~\n\n#### Create a new MySQL instance:\n\n~~~\nhelm install hawkbit-db bitnami/mysql --set master.securityContext.enabled=false --set db.name=hawkbit --set db.user=hawkbit --set db.password=hawkbit --set replication.enabled=false\n~~~\n\nUse the following `database` configuration in the `Hawkbit` resource:\n\n~~~yaml\nspec:\n  database:\n    mysql:\n      database: hawkbit\n      host: hawkbit-db-mysql\n      username: hawkbit\n      passwordSecret:\n        name: hawkbit-db-mysql\n        field: mysql-password\n~~~\n\n### Broker instance\n\nEclipse hawkBit requires a RabbitMQ broker. You can use an existing instance or let the\noperator manage one for you.\n\n#### Managed by the operator\n\n~~~yaml\nspec:\nrabbit:\n  managed: {}\n~~~\n\n#### Create a new RabbitMQ instance\n  \n~~~\nhelm install hawkbit-rabbit bitnami/rabbitmq --set podSecurityContext= --set auth.username=hawkbit --set auth.password=hawkbit\n~~~\n\nUse the following configuration:\n\n~~~yaml\nspec:\nrabbit:\n  external:\n    host: hawkbit-rabbit-rabbitmq\n    username: hawkbit\n    passwordSecret:\n      name: hawkbit-rabbit-rabbitmq\n      field: rabbitmq-password\n~~~\n\n### Sign on solution\n\nThe console requires some kind of authentication/authorization backend:\n\n  * Basic username/password\n  \n    By default, the operator creates static username/password combination for login in to\n    the hawkBit instance.\n  \n    Once the instance is deployed, you can retrieve the information using the following\n    commands:\n    \n    ~~~sh\n    kubectl get secret default-admin -o jsonpath='{.data.adminUsername}' | base64 -d\n    kubectl get secret default-admin -o jsonpath='{.data.adminPassword}' | base64 -d | cut -c7-\n    ~~~\n      \n    You can update the secret with your own credentials, and the operator will reconcile\n    the deployment.\n    \n  * Using OAuth2 with Keycloak\n\n    It is also possible to use Keycloak as a sign-on solution. To enable Keycloak, you need to:\n\n    * Install the Keycloak operator\n    * Use the following configuration:\n    \n      ~~~yaml\n      spec:\n        signOn:\n          keycloak: {}\n      ~~~\n      \n      This will create a new Keycloak instance, realm, client, and initial admin user. You can\n      retrieve the access credentials using the following command once the instance is deployed:\n      \n      ~~~sh\n      kubectl describe keycloakuser default-admin\n      ~~~\n\n### The hawkBit instance\n\nAlso, see the snippets above or the other examples: [examples/](examples/).\n\n~~~yaml\nkind: Hawkbit\napiVersion: iot.eclipse.org/v1alpha1\nmetadata:\nname: default\nspec:\ndatabase:\n  embedded: {}\nrabbit:\n  managed: {}\n~~~\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctron%2Fhawkbit-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctron%2Fhawkbit-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctron%2Fhawkbit-operator/lists"}