{"id":28364109,"url":"https://github.com/olric-data/olric-cloud-plugin","last_synced_at":"2025-10-30T04:12:09.027Z","repository":{"id":45722105,"uuid":"247490994","full_name":"olric-data/olric-cloud-plugin","owner":"olric-data","description":"Discover Olric nodes in cloud environments","archived":false,"fork":false,"pushed_at":"2023-02-25T06:44:38.000Z","size":205,"stargazers_count":10,"open_issues_count":4,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-19T09:57:30.459Z","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/olric-data.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-03-15T15:12:23.000Z","updated_at":"2025-04-25T15:31:30.000Z","dependencies_parsed_at":"2024-06-19T22:49:43.370Z","dependency_job_id":"ecc0cc08-1598-4cf7-a84d-dd1d0d0f754f","html_url":"https://github.com/olric-data/olric-cloud-plugin","commit_stats":null,"previous_names":["olric-data/olric-cloud-plugin","buraksezer/olric-cloud-plugin"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/olric-data/olric-cloud-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olric-data%2Folric-cloud-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olric-data%2Folric-cloud-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olric-data%2Folric-cloud-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olric-data%2Folric-cloud-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/olric-data","download_url":"https://codeload.github.com/olric-data/olric-cloud-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olric-data%2Folric-cloud-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267802741,"owners_count":24146509,"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-07-30T02:00:09.044Z","response_time":70,"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":[],"created_at":"2025-05-28T20:15:57.038Z","updated_at":"2025-10-30T04:12:08.962Z","avatar_url":"https://github.com/olric-data.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# olric-cloud-plugin\n\nDiscover nodes in cloud environments. Uses [hashicorp/go-discover](https://github.com/hashicorp/go-discover) under the hood.\n\n## Install\n\nGet the code:\n\n```\ngo get -u github.com/buraksezer/olric-cloud-plugin\n```\n\n## Usage\n\n### Load as compiled plugin\n\n#### Build\n\nWith a properly configured Go environment:\n\n```\ngo build -buildmode=plugin -o olric-cloud-plugin.so \n```\n\nIf you want to strip debug symbols from the produced binary add `-ldflags=\"-s -w\"` to `build` command.\n\n#### Configuration\n\nThis plugin is only tested against Kubernetes.\n\n##### Kubernetes\n\nFor the uses of `olricd`, the following block is going to loads and configures the plugin.\n\n```\nserviceDiscovery:\n  provider: \"k8s\"\n  path: \"/path/to/olric-cloud-plugin.so\"\n  args: 'label_selector=\"run = olricd\"'\n```\n\nAvailable configuration parameters for Kubernetes integration:\n\n| Key | Description |\n|-----|-------------|\n| kubeconfig | Path to the kubeconfig file. |\n| namespace | Namespace to search for pods (defaults to \"default\"). |\n| label_selector | Label selector value to filter pods. |\n| field_selector | Field selector value to filter pods. |\n| host_network | \"true\" if pod host IP and ports should be used. |\n\nSample usage:\n\n```\n...\nargs: 'label_selector=\"run = olricd\"'\n...\n```\nFrom go-discover's documentation:\n\nThe **kubeconfig** file value will be searched in the following locations:\n1. Use path from \"kubeconfig\" option if provided.\n2. Use path from KUBECONFIG environment variable.\n3. Use default path of $HOME/.kube/config\n\nBy default, the Pod IP is used to join. The \"host_network\" option may be set to use the Host IP. No port is used by default. \nPods may set an annotation 'hashicorp/consul-auto-join-port' to a named port or an integer value. If the value matches a \nnamed port, that port will be used to join. Note that if \"host_network\" is set to true, then only pods that have a HostIP \navailable will be selected. If a port annotation exists, then the port must be exposed via a HostPort as well, otherwise \nthe pod will be ignored.\n\nIf you prefer to use Olric in embedded-member mode, the following code snipped will guide you:\n\n```go\nc := olric.New(\"lan\")\n...\ncd := \u0026discovery.CloudDiscovery{}\nlabelSelector := fmt.Sprintf(\"app.kubernetes.io/name=%s,app.kubernetes.io/instance=%s\", name, instance)\nc.ServiceDiscovery = map[string]interface{}{\n  \"plugin\":   cd,\n  \"provider\": \"k8s\",\n  \"args\":     fmt.Sprintf(\"namespace=%s label_selector=\\\"%s\\\"\", namespace, labelSelector),\n}\n```\n\nSee details about how you deploy your Olric-based application on Kubernetes:\n\n* [olric-kubernetes repository](https://github.com/buraksezer/olric-kubernetes)\n* [Olric documentation](https://github.com/buraksezer/olric#kubernetes)\n\n## Docker Build \u0026 Push\n\nBuild a Docker image, in the root folder:\n\n```bash\n$ docker build -t $USERNAME/olric-cloud-plugin:$TAG .\n```\n\nPush the image to a registry:\n\n```bash\n$ docker push $USERNAME/olric-cloud-plugin:$TAG\n```\n\nSee [Dockerfile](Dockerfile) for details.\n\n## TODO\n\nTest this plugin on the following cloud providers:\n\n* Google Cloud\n* DigitalOcean\n* Amazon AWS\n* Microsoft Azure\n\n## Contributions\n\nPlease don't hesitate to fork the project and send a pull request or just e-mail me to ask questions and share ideas.\n\n## License\n\nThe Apache License, Version 2.0 - see LICENSE for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folric-data%2Folric-cloud-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Folric-data%2Folric-cloud-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folric-data%2Folric-cloud-plugin/lists"}