├── .gitignore ├── .circleci └── config.yml ├── Makefile ├── variables.tf ├── outputs.tf ├── main.tf ├── README.md ├── LICENSE └── diagram.svg /.gitignore: -------------------------------------------------------------------------------- 1 | /.terraform/ 2 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | jobs: 3 | build: 4 | docker: 5 | - image: hashicorp/terraform:0.12.24 6 | steps: 7 | - checkout 8 | - run: apk add make 9 | - run: terraform init 10 | - run: make check 11 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all: check README.md 2 | 3 | .PHONY: check 4 | check: 5 | terraform fmt -check=true -diff=true 6 | AWS_REGION=us-east-1 terraform validate 7 | 8 | README.md: variables.tf outputs.tf 9 | sed -e '/^/q' $@ > $@.tmp 10 | terraform-docs md . >> $@.tmp 11 | mv $@.tmp $@ 12 | -------------------------------------------------------------------------------- /variables.tf: -------------------------------------------------------------------------------- 1 | variable "oidc_s3_bucket_name" { 2 | description = "Name of a S3 bucket for the OIDC endpoint" 3 | } 4 | 5 | variable "oidc_jwks_filename" { 6 | description = "Filename of OIDC JWKS" 7 | } 8 | 9 | variable "oidc_ca_sha1" { 10 | description = "SHA1 thumbprint of the root CA certificate (default to *.s3.amazonaws.com)" 11 | default = "3fe05b486e3f0987130ba1d4ea0f299539a58243" 12 | } 13 | 14 | variable "signer_public_key_filename" { 15 | description = "Filename of the private key (for kops_cluster.yaml)" 16 | default = "/dev/null" 17 | } 18 | 19 | variable "signer_private_key_filename" { 20 | description = "Filename of the private key (for kops_cluster.yaml)" 21 | default = "/dev/null" 22 | } 23 | -------------------------------------------------------------------------------- /outputs.tf: -------------------------------------------------------------------------------- 1 | output "oidc_provider_arn" { 2 | description = "ARN of the OIDC provider for IRSA" 3 | value = aws_iam_openid_connect_provider.irsa.arn 4 | } 5 | 6 | output "oidc_issuer" { 7 | description = "Domain name of the S3 bucket (*.s3.amazonaws.com)" 8 | value = aws_s3_bucket.oidc.bucket_domain_name 9 | } 10 | 11 | output "pod_identity_webhook_ecr_repository_url" { 12 | description = "URL to the ECR repository for eks/pod-identity-webhook" 13 | value = aws_ecr_repository.pod_identity_webhook.repository_url 14 | } 15 | 16 | output "kops_cluster_yaml" { 17 | description = "Content of kops cluster.yaml" 18 | value = < sa-signer-pkcs8.pub 21 | 22 | go run /amazon-eks-pod-identity-webhook/hack/self-hosted/main.go -key sa-signer-pkcs8.pub | jq '.keys += [.keys[0]] | .keys[1].kid = ""' > jwks.json 23 | ``` 24 | 25 | It will create the following files: 26 | 27 | - `./irsa/sa-signer.key` 28 | - `./irsa/sa-signer-pkcs8.pub` 29 | - `./irsa/jwks.json` 30 | 31 | ### 2. Provision the AWS resources 32 | 33 | Run Terraform with the following file. 34 | 35 | ```tf 36 | resource "random_uuid" "irsa_s3_bucket_name" { 37 | } 38 | 39 | module "irsa" { 40 | source = "int128/kubernetes-irsa/aws" 41 | oidc_s3_bucket_name = "oidc-${random_uuid.irsa_s3_bucket_name.result}" 42 | oidc_jwks_filename = "./irsa/keys.json" 43 | } 44 | 45 | output "irsa_oidc_issuer" { 46 | description = "Issuer of OIDC provider for IRSA" 47 | value = module.irsa.oidc_issuer 48 | } 49 | 50 | output "irsa_pod_identity_webhook_ecr_repository_url" { 51 | description = "URL to the ECR repository for eks/pod-identity-webhook" 52 | value = module.irsa.pod_identity_webhook_ecr_repository_url 53 | } 54 | ``` 55 | 56 | It will create the following resources: 57 | 58 | - S3 bucket for OpenID Connect discovery endpoint 59 | - OpenID Connect provider (IAM) 60 | - ECR repository to store the image of pod-identity-webhook 61 | - CodeBuild project to build the image of pod-identity-webhook 62 | 63 | See also the diagram. 64 | 65 | ![diagram](diagram.svg) 66 | 67 | You will get the following outputs. 68 | 69 | ```console 70 | % terraform output 71 | irsa_oidc_issuer = https://oidc-RANDOM.s3.amazonaws.com 72 | irsa_pod_identity_webhook_ecr_repository_url = REGISTRY_ID.dkr.ecr.REGION.amazonaws.com/eks/pod-identity-webhook 73 | ``` 74 | 75 | ### 3. Configure the Kubernetes cluster 76 | 77 | Set the following API server flags. 78 | 79 | ``` 80 | --service-account-key-file=sa-signer-pkcs8.pub 81 | --service-account-signing-key-file=sa-signer.key 82 | --api-audiences=sts.amazonaws.com 83 | --service-account-issuer=https://oidc-RANDOM.s3.amazonaws.com 84 | ``` 85 | 86 | #### For kops users 87 | 88 | If you are using kops, you can generate a template of the cluster config. 89 | 90 | ```tf 91 | module "irsa" { 92 | signer_public_key_filename = "./irsa/sa-signer-pkcs8.pub" 93 | signer_private_key_filename = "./irsa/sa-signer.key" 94 | } 95 | 96 | resource "local_file" "irsa_kops_cluster_yaml" { 97 | filename = "./irsa/kops.yaml" 98 | content = module.irsa.kops_cluster_yaml 99 | } 100 | ``` 101 | 102 | You will get `irsa/kops.yaml` after applying. 103 | 104 | ```sh 105 | # get the template 106 | terraform apply 107 | less irsa/kops.yaml 108 | 109 | # apply the cluster config 110 | kops edit cluster 111 | kops update cluster 112 | kops rolling-update cluster 113 | ``` 114 | 115 | ### 4. Deploy pod-identity-webhook 116 | 117 | You can build and push the Docker image of [pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook) to the ECR repository using the CodeBuild project. 118 | 119 | 1. Open the CodeBuild project. 120 | 1. Start a build. 121 | 1. Make sure the image exists on the ECR repository. 122 | 123 | To deploy the manifest of pod-identity-webhook to the Kubernetes cluster: 124 | 125 | ```console 126 | cd /amazon-eks-pod-identity-webhook 127 | make cluster-up IMAGE=REGISTRY_ID.dkr.ecr.REGION.amazonaws.com/eks/pod-identity-webhook 128 | ``` 129 | 130 | ### 5. Verify a service account 131 | 132 | Create an IAM role. 133 | 134 | ```tf 135 | resource "aws_iam_role" "s3-echoer" { 136 | name = "s3-echoer" 137 | assume_role_policy = < 184 | ## Requirements 185 | 186 | No requirements. 187 | 188 | ## Providers 189 | 190 | | Name | Version | 191 | |------|---------| 192 | | aws | n/a | 193 | 194 | ## Inputs 195 | 196 | | Name | Description | Type | Default | Required | 197 | |------|-------------|------|---------|:--------:| 198 | | oidc\_ca\_sha1 | SHA1 thumbprint of the root CA certificate (default to \*.s3.amazonaws.com) | `string` | `"3fe05b486e3f0987130ba1d4ea0f299539a58243"` | no | 199 | | oidc\_jwks\_filename | Filename of OIDC JWKS | `any` | n/a | yes | 200 | | oidc\_s3\_bucket\_name | Name of a S3 bucket for the OIDC endpoint | `any` | n/a | yes | 201 | | signer\_private\_key\_filename | Filename of the private key (for kops\_cluster.yaml) | `string` | `"/dev/null"` | no | 202 | | signer\_public\_key\_filename | Filename of the private key (for kops\_cluster.yaml) | `string` | `"/dev/null"` | no | 203 | 204 | ## Outputs 205 | 206 | | Name | Description | 207 | |------|-------------| 208 | | kops\_cluster\_yaml | Content of kops cluster.yaml | 209 | | oidc\_issuer | Domain name of the S3 bucket (\*.s3.amazonaws.com) | 210 | | oidc\_provider\_arn | ARN of the OIDC provider for IRSA | 211 | | pod\_identity\_webhook\_ecr\_repository\_url | URL to the ECR repository for eks/pod-identity-webhook | 212 | 213 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /diagram.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | AWS resources (this module provisions)
S3 Bucket
(discovery endpoint)
S3 Buc...
OpenID Connect
Provider
OpenID...
ECR
Repository
ECR...
CodeBuild
Project
CodeBu...
amazon-eks-
pod-identity-webhook
amazon...
push
pushKubernetes cluster
pull
pullpod-identity-webhook
call
calls3-echoer
inject
inject
IAM Role
(s3-echoer)
IAM Ro...kube-apiserver
pull
pull
assume
assumeViewer does not support full SVG 1.1 --------------------------------------------------------------------------------