{"id":28722325,"url":"https://github.com/docling-project/docling-operator","last_synced_at":"2025-06-15T08:08:58.808Z","repository":{"id":283154191,"uuid":"948741154","full_name":"docling-project/docling-operator","owner":"docling-project","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-16T08:31:20.000Z","size":557,"stargazers_count":2,"open_issues_count":3,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-16T08:42:14.906Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/docling-project.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,"zenodo":null}},"created_at":"2025-03-14T21:56:00.000Z","updated_at":"2025-05-16T07:54:18.000Z","dependencies_parsed_at":"2025-05-06T23:19:42.826Z","dependency_job_id":"4c8a5803-6073-4cc0-82e3-81a072e53dda","html_url":"https://github.com/docling-project/docling-operator","commit_stats":null,"previous_names":["opdev/docling-operator","docling-project/docling-operator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/docling-project/docling-operator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docling-project%2Fdocling-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docling-project%2Fdocling-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docling-project%2Fdocling-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docling-project%2Fdocling-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docling-project","download_url":"https://codeload.github.com/docling-project/docling-operator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docling-project%2Fdocling-operator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259942797,"owners_count":22935330,"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":[],"created_at":"2025-06-15T08:08:57.902Z","updated_at":"2025-06-15T08:08:58.798Z","avatar_url":"https://github.com/docling-project.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docling Operator\nThe Docling Operator distributes [docling-serve](https://github.com/docling-project/docling-serve) together with the [docling-jobkit](https://github.com/docling-project/docling-jobkit) Kubeflow jobs.\n\n## Description\nThe Docling Operator configures the docling-serve API Deployment and related Secret, ConfigMap, Service. It also configures the docling-kfp-job Data Science Pipeline for running the distributed Docling conversion. This is launched and inspected from docling-serve using the k8s api. With docling-serve you can deploy with different compute engines.\nWith the docling operator you can configure which compute engine to use for the deployment.\n\n![Docling Operator Diagram](docs/assests/docling-diagram.png)\n\n## Getting Started\n\n### Prerequisites\n- go version v1.24.1+\n- docker version 17.03+.\n- kubectl version v1.11.3+.\n- Access to a Kubernetes v1.11.3+ cluster.\n\n### Kubeflow Pipeline Engine\n\nThe engine is set to local by default. To deploy a Kubeflow Pipeline engine, adjust the custom resource at `config/samples/docling_v1alpha1_doclingserve.yaml` and add a Kubeflow endpoint.\n\n```\nengine:\n    kfp:\n      enpoint: \u003ckubeflow-endpoint\u003e\n```\n\n### To Deploy on the cluster\n\n```sh\ngit clone https://github.com/docling-project/docling-operator.git\n```\n```sh\ncd \u003cproject\u003e\n```\n```sh\nmake generate\n```\n```sh\nmake manifests\n```\n\n**Build and push your image to the location specified by `IMG`:**\n\n```sh\nmake docker-build docker-push IMG=\u003csome-registry\u003e/docling-operator:tag\n```\n\n**NOTE:** This image ought to be published in the personal registry you specified.\nAnd it is required to have access to pull the image from the working environment.\nMake sure you have the proper permission to the registry if the above commands don’t work.\n\n**Install the CRDs into the cluster:**\n\n```sh\nmake install\n```\n\n**Deploy the Manager to the cluster with the image specified by `IMG`:**\n\n```sh\nmake deploy IMG=\u003csome-registry\u003e/docling-operator:tag\n```\n\n\u003e **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin\nprivileges or be logged in as admin.\n\n**Create instances of your solution**\nYou can apply the samples (examples) from the config/sample:\n\n```sh\nkubectl apply -k config/samples/docling_v1alpha1_doclingserve.yaml\n```\n\n\u003e**NOTE**: Ensure that the samples has default values to test it out.\n\n### To Uninstall\n**Delete the instances (CRs) from the cluster:**\n\n```sh\nkubectl delete -k config/samples/docling_v1alpha1_doclingserve.yaml\n```\n\n**Delete the APIs(CRDs) from the cluster:**\n\n```sh\nmake uninstall\n```\n\n**UnDeploy the controller from the cluster:**\n\n```sh\nmake undeploy\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocling-project%2Fdocling-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocling-project%2Fdocling-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocling-project%2Fdocling-operator/lists"}