{"id":13569481,"url":"https://github.com/ing-bank/apache-ranger-s3-plugin","last_synced_at":"2025-04-14T14:31:14.478Z","repository":{"id":63997521,"uuid":"149246824","full_name":"ing-bank/apache-ranger-s3-plugin","owner":"ing-bank","description":"Apache Ranger Plugin for S3","archived":false,"fork":false,"pushed_at":"2022-11-30T07:52:48.000Z","size":69,"stargazers_count":19,"open_issues_count":2,"forks_count":13,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-28T03:32:27.514Z","etag":null,"topics":["apache-ranger","aws-s3","ranger-plugin","rokku"],"latest_commit_sha":null,"homepage":"","language":"Java","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/ing-bank.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}},"created_at":"2018-09-18T07:31:35.000Z","updated_at":"2024-05-20T03:07:37.000Z","dependencies_parsed_at":"2023-01-14T18:00:53.025Z","dependency_job_id":null,"html_url":"https://github.com/ing-bank/apache-ranger-s3-plugin","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ing-bank%2Fapache-ranger-s3-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ing-bank%2Fapache-ranger-s3-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ing-bank%2Fapache-ranger-s3-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ing-bank%2Fapache-ranger-s3-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ing-bank","download_url":"https://codeload.github.com/ing-bank/apache-ranger-s3-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248897096,"owners_count":21179536,"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":["apache-ranger","aws-s3","ranger-plugin","rokku"],"created_at":"2024-08-01T14:00:40.578Z","updated_at":"2025-04-14T14:31:14.225Z","avatar_url":"https://github.com/ing-bank.png","language":"Java","funding_links":[],"categories":["Java"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/ing-bank/apache-ranger-s3-plugin.svg?branch=master)](https://travis-ci.org/ing-bank/apache-ranger-s3-plugin)\n[![codecov.io](http://codecov.io/github/ing-bank/apache-ranger-s3-plugin/coverage.svg?branch=master)](https://codecov.io/gh/ing-bank/apache-ranger-s3-plugin?branch=master)\n\n# Apache Ranger S3 Plugin\n\nRanger S3 Plugin enables creation of policies in Apache Ranger for S3 buckets hosted on Ceph/RadosGW (S3 coming later). \nIt merely allows for the creation of policies and does not set ACLs by itself. It can be used together with its sister \n`scala` project [Airlock](https://github.com/ing-bank/airlock).\n\n# Installation\n\n1. Run ceph demo container using docker-compose\n```\ndocker-compose up\n```\nIt will start Ceph demo image on port 8010. \n\n2. Build the plugin jar using maven \n```\nmvn package\n``` \nIf you do not have a local Ceph installation to test against use `mvn package -DskipTests`.\n\n3. Copy the jar to `${RANGER_HOME}/ews/webapp/WEB-INF/classes/ranger-plugins/s3`. Please note that the location\nis important (`s3`). \n\n4. Load the service definition into Apache Ranger. \n```\ncurl -u \u003cadmin\u003e:\u003cadmin\u003e -d \"@s3-ranger.json\" -X POST -H \"Accept: application/json\" -H \"Content-Type: application/json\" \nhttp://{RANGER_HOST}:{RANGER_PORT}/service/public/v2/api/servicedef\n```\n5. Configure the service in Apache Ranger by logging in to the Web UI.\n\n# Roadmap\n\n* Proper lookups\n* No ceph-user name required\n* AWS S3 support\n\n# Ranger admin site configuration\n\nRanger S3 plugin uses aws sdk to connect to backend to list buckets and folders. In case of \ntimeouts, check ranger setting and adjust accordingly. Default 1000 may be to low in some cases.\nConfiguration file is in `ranger-1.1.0-admin/ews/webapp/WEB-INF/classes/conf/ranger-admin-default-site.xml.`\n\n```\n\u003cproperty\u003e\n    \u003cname\u003eranger.resource.lookup.timeout.value.in.ms\u003c/name\u003e\n    \u003cvalue\u003e10000\u003c/value\u003e\n    \u003cdescription /\u003e\n\u003c/property\u003e\n```\n\nAdditionally plugin can be configured with different aws region. In order to change region, add\nfollowing section to `ranger-1.1.0-admin/ews/webapp/WEB-INF/classes/conf/ranger-admin-default-site.xml.`\n\n```\n \u003cproperty\u003e\n     \u003cname\u003eairlock.s3.aws.region\u003c/name\u003e\n     \u003cvalue\u003eregion_name\u003c/value\u003e\n \u003c/property\u003e\n```\n\n\n# Plugin usage with [Airlock](https://github.com/ing-bank/airlock)\n\nIf you run plugin via Airlock, make sure that:\n\n- user used in S3 service setup is NPA user in [Airlock STS](https://github.com/ing-bank/airlock-sts).\nSee \"NPA S3 users\" section of STS readme\n- user is added to \"all - path\" Ranger policy - in oder words ceph user used for connection, must be \nallowed to read all bucket paths   ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fing-bank%2Fapache-ranger-s3-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fing-bank%2Fapache-ranger-s3-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fing-bank%2Fapache-ranger-s3-plugin/lists"}