├── bin ├── create-bundle ├── build ├── create-service-account ├── download-bundle-from-gcs ├── grant-current-user-run-invoker ├── deploy ├── test └── deploy-with-ext ├── bundle.tar.gz ├── input.json ├── Dockerfile ├── policies └── http │ └── example │ └── authz │ └── authz.rego ├── config.yaml ├── README.md └── LICENSE /bin/create-bundle: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | opa build -t rego -r 1 policies/ 4 | -------------------------------------------------------------------------------- /bundle.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kelseyhightower/opa-on-cloud-run/HEAD/bundle.tar.gz -------------------------------------------------------------------------------- /input.json: -------------------------------------------------------------------------------- 1 | { 2 | "input": { 3 | "path": "/health", 4 | "method": "GET" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM gcr.io/hightowerlabs/opa:0.24.0-dev 2 | 3 | ADD config.yaml /config.yaml 4 | 5 | ENTRYPOINT ["/opa"] 6 | CMD ["run"] 7 | -------------------------------------------------------------------------------- /bin/build: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | PROJECT_ID=$(gcloud config get-value project) 4 | 5 | gcloud builds submit -t gcr.io/${PROJECT_ID}/opa:0.24.0-ext . 6 | -------------------------------------------------------------------------------- /bin/create-service-account: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | PROJECT_ID=$(gcloud config get-value project) 4 | 5 | gcloud iam service-accounts create open-policy-agent 6 | -------------------------------------------------------------------------------- /policies/http/example/authz/authz.rego: -------------------------------------------------------------------------------- 1 | package http.example.authz 2 | 3 | default allow = false 4 | 5 | allow { 6 | input.method == "GET" 7 | input.path == "/health" 8 | } 9 | -------------------------------------------------------------------------------- /bin/download-bundle-from-gcs: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | curl -v -i -X GET \ 4 | -H "Authorization: Bearer $(gcloud auth print-identity-token)" \ 5 | -o bundle.tar.gz \ 6 | "https://storage.googleapis.com/storage/v1/b/openpolicyagent/o/bundles%2Fbundle.tar.gz?alt=media" 7 | -------------------------------------------------------------------------------- /bin/grant-current-user-run-invoker: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | CURRENT_USER_EMAIL=$(gcloud config list account --format "value(core.account)") 4 | 5 | gcloud run services add-iam-policy-binding open-policy-agent \ 6 | --member="user:${CURRENT_USER_EMAIL}" \ 7 | --role='roles/run.invoker' \ 8 | --platform managed \ 9 | --region us-west1 10 | -------------------------------------------------------------------------------- /bin/deploy: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | PROJECT_ID=$(gcloud config get-value project) 4 | 5 | gcloud beta run deploy open-policy-agent \ 6 | --args='--server,--log-format,text,--addr,0.0.0.0:8181' \ 7 | --concurrency 80 \ 8 | --cpu 2 \ 9 | --image gcr.io/${PROJECT_ID}/opa:0.24.0-dev \ 10 | --memory '4G' \ 11 | --min-instances 1 \ 12 | --no-allow-unauthenticated \ 13 | --platform managed \ 14 | --port 8181 \ 15 | --region us-west1 \ 16 | --service-account "open-policy-agent@${PROJECT_ID}.iam.gserviceaccount.com" \ 17 | --timeout 300 18 | -------------------------------------------------------------------------------- /config.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | gcs: 3 | url: https://storage.googleapis.com/storage/v1/b/${BUCKET_NAME}/o 4 | response_header_timeout_seconds: 5 5 | credentials: 6 | gcp_metadata: 7 | scopes: 8 | - "https://www.googleapis.com/auth/devstorage.read_only" 9 | cloudrun: 10 | url: ${BQ_CONNECTOR_URL} 11 | credentials: 12 | gcp_metadata: 13 | audience: ${BQ_CONNECTOR_URL} 14 | 15 | decision_logs: 16 | service: cloudrun 17 | reporting: 18 | min_delay_seconds: 5 19 | max_delay_seconds: 10 20 | 21 | bundles: 22 | authz: 23 | service: gcs 24 | resource: 'bundle.tar.gz?alt=media' 25 | persist: true 26 | polling: 27 | min_delay_seconds: 60 28 | max_delay_seconds: 120 29 | -------------------------------------------------------------------------------- /bin/test: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ID_TOKEN=$(gcloud auth print-identity-token) 4 | 5 | URL=$(gcloud run services describe open-policy-agent \ 6 | --platform managed \ 7 | --region us-west1 \ 8 | --format json | \ 9 | jq -r '.status.url') 10 | 11 | echo "List policies ..." 12 | curl "${URL}/v1/policies" \ 13 | -H "Authorization: Bearer ${ID_TOKEN}" 14 | 15 | echo "Get Health ..." 16 | curl -i "${URL/health}" \ 17 | -H "Authorization: Bearer ${ID_TOKEN}" 18 | 19 | echo "Get bundle health ..." 20 | curl -i "${URL}/health?bundles" \ 21 | -H "Authorization: Bearer ${ID_TOKEN}" 22 | 23 | echo "Test policy and decision logs ..." 24 | curl -i "${URL}/v1/data/http/example/authz" \ 25 | -H "Authorization: Bearer ${ID_TOKEN}" \ 26 | -d @input.json 27 | -------------------------------------------------------------------------------- /bin/deploy-with-ext: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | BUCKET_NAME="openpolicyagent" 4 | PROJECT_ID=$(gcloud config get-value project) 5 | BQ_CONNECTOR_URL=$(gcloud run services describe opa-bq-connector \ 6 | --platform managed \ 7 | --region us-west1 \ 8 | --format json | \ 9 | jq -r '.status.url') 10 | 11 | gcloud beta run deploy open-policy-agent \ 12 | --args='--server,--log-format,text,--addr,0.0.0.0:8181,-c,/config.yaml' \ 13 | --concurrency 80 \ 14 | --cpu 2 \ 15 | --image gcr.io/${PROJECT_ID}/opa:0.24.0-ext \ 16 | --memory '2G' \ 17 | --min-instances 1 \ 18 | --no-allow-unauthenticated \ 19 | --platform managed \ 20 | --port 8181 \ 21 | --region us-west1 \ 22 | --service-account "open-policy-agent@${PROJECT_ID}.iam.gserviceaccount.com" \ 23 | --set-env-vars="BUCKET_NAME=${BUCKET_NAME},BQ_CONNECTOR_URL=${BQ_CONNECTOR_URL}" \ 24 | --timeout 300 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OPA on Cloud Run 2 | 3 | This tutorial walks you through deploying [Open Policy Agent](https://www.openpolicyagent.org) on [Cloud Run](https://cloud.google.com/run). 4 | 5 | ## Tutorial 6 | 7 | ``` 8 | PROJECT_ID=$(gcloud config get-value project) 9 | ``` 10 | 11 | ``` 12 | gcloud iam service-accounts create open-policy-agent 13 | ``` 14 | 15 | ``` 16 | SERVICE_ACCOUNT="open-policy-agent@${PROJECT_ID}.iam.gserviceaccount.com" 17 | ``` 18 | 19 | ``` 20 | export BUCKET_NAME=oocr 21 | ``` 22 | 23 | ``` 24 | gsutil mb gs://${BUCKET_NAME} 25 | ``` 26 | 27 | ``` 28 | gsutil cp bundle.tar.gz gs://${BUCKET_NAME}/ 29 | ``` 30 | 31 | ``` 32 | gsutil iam ch "serviceAccount:${SERVICE_ACCOUNT}:roles/storage.objectViewer" gs://${BUCKET_NAME} 33 | ``` 34 | 35 | ``` 36 | BQ_CONNECTOR_URL=$(gcloud run services describe opa-bq-connector \ 37 | --platform managed \ 38 | --region us-west1 \ 39 | --format json | \ 40 | jq -r '.status.url') 41 | ``` 42 | 43 | ``` 44 | gcloud run services add-iam-policy-binding opa-bq-connector \ 45 | --member="serviceAccount:${SERVICE_ACCOUNT}" \ 46 | --role='roles/run.invoker' \ 47 | --platform managed \ 48 | --region us-west1 49 | ``` 50 | 51 | ``` 52 | gcloud beta run deploy open-policy-agent \ 53 | --args='--server,--log-format,text,--addr,0.0.0.0:8181,-c,/config.yaml' \ 54 | --concurrency 80 \ 55 | --cpu 2 \ 56 | --image gcr.io/${PROJECT_ID}/opa:0.24.0-ext \ 57 | --memory '2G' \ 58 | --min-instances 1 \ 59 | --no-allow-unauthenticated \ 60 | --platform managed \ 61 | --port 8181 \ 62 | --region us-west1 \ 63 | --service-account ${SERVICE_ACCOUNT} \ 64 | --set-env-vars="BUCKET_NAME=${BUCKET_NAME},BQ_CONNECTOR_URL=${BQ_CONNECTOR_URL}" \ 65 | --timeout 300 66 | ``` 67 | 68 | ``` 69 | OPA_URL=$(gcloud run services describe open-policy-agent \ 70 | --platform managed \ 71 | --region us-west1 \ 72 | --format json | \ 73 | jq -r '.status.url') 74 | 75 | ``` 76 | 77 | ``` 78 | curl -i "${OPA_URL}/v1/data/http/example/authz" \ 79 | -H "Authorization: Bearer $(gcloud auth print-identity-token)" \ 80 | -d '{"input": {"path": "/health","method": "GET"}}' 81 | ``` 82 | 83 | ``` 84 | bq query "select * from ${PROJECT_ID}:opa.decision_logs" 85 | ``` 86 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------