├── Dockerfile ├── deployment.yaml ├── README.md ├── ebs-params.sh └── LICENSE /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM flant/shell-operator:v1.6.1 2 | ENV SHELL_OPERATOR_PROMETHEUS_METRICS_PREFIX=ebs_params_controller_ 3 | RUN apk --no-cache add aws-cli 4 | ADD ebs-params.sh /hooks 5 | -------------------------------------------------------------------------------- /deployment.yaml: -------------------------------------------------------------------------------- 1 | # Parameters: 2 | # - role-arn -- IAM role with permissions to modify EBS volumes. Can be the same as for EBS CSI driver 3 | # see https://docs.aws.amazon.com/eks/latest/userguide/csi-iam-role.html 4 | # - namespace 5 | --- 6 | apiVersion: v1 7 | kind: ServiceAccount 8 | metadata: 9 | name: ebs-params-controller 10 | annotations: 11 | eks.amazonaws.com/role-arn: ${role_arn} 12 | --- 13 | apiVersion: rbac.authorization.k8s.io/v1 14 | kind: ClusterRole 15 | metadata: 16 | name: ebs-params-controller-role 17 | rules: 18 | - apiGroups: [""] 19 | resources: ["persistentvolumeclaims"] 20 | verbs: ["get", "list", "watch", "update", "patch"] 21 | - apiGroups: [""] 22 | resources: ["persistentvolumes"] 23 | verbs: ["get", "list", "watch"] 24 | --- 25 | apiVersion: rbac.authorization.k8s.io/v1 26 | kind: ClusterRoleBinding 27 | metadata: 28 | name: ebs-params-controller-binding 29 | roleRef: 30 | apiGroup: rbac.authorization.k8s.io 31 | kind: ClusterRole 32 | name: ebs-params-controller-role 33 | subjects: 34 | - kind: ServiceAccount 35 | name: ebs-params-controller 36 | namespace: ${namespace} 37 | --- 38 | apiVersion: apps/v1 39 | kind: Deployment 40 | metadata: 41 | name: ebs-params-controller 42 | spec: 43 | replicas: 1 44 | selector: 45 | matchLabels: 46 | app: ebs-params-controller 47 | template: 48 | metadata: 49 | name: ebs-params-controller 50 | labels: 51 | app: ebs-params-controller 52 | annotations: 53 | prometheus.io/scrape: "true" 54 | prometheus.io/port: "9115" 55 | spec: 56 | serviceAccountName: ebs-params-controller 57 | containers: 58 | - name: controller 59 | image: altinity/ebs-params-controller:v0.4.0 60 | env: 61 | - name: LOG_TYPE 62 | value: text 63 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # EBS Params Controller 2 | 3 | This controller provides a way to control iops and throughput parameters for EBS volumes 4 | provisioned by EBS CSI Driver with annotations on corresponding PersistentVolumeClaim objects in Kubernetes. 5 | It also sets some annotations on PVCs backed by EBS CSI Driver representing current parameters and last modification status and timestamps. 6 | 7 | ## Installation 8 | 9 | **To create your EBS Params Controller IAM role with the AWS Management Console** 10 | 11 | 1. Open the IAM console at https://console.aws.amazon.com/iam/ 12 | 2. In the left navigation pane, choose **Roles**. 13 | 3. On the **Roles** page, choose **Create role**. 14 | 4. On the **Select trusted entity** page, do the following: 15 | - a. In the **Trusted entity type** section, choose **Web identity**. 16 | - b. For **Identity provider**, choose the **OpenID Connect provider URL** for your cluster (as shown under **Overview** in Amazon EKS). 17 | - c. For **Audience**, choose `sts.amazonaws.com`. 18 | - d. Choose **Next**. 19 | 5. On the **Add permissions page**, skip everything and choose **Next**. 20 | 6. On the **Name, review, and create** page, do the following: 21 | - a. For **Role name**, enter a unique name for your role, such as ***AltinityRoleForEBSParamsController***. 22 | - b. Under **Add tags (Optional)**, add metadata to the role by attaching tags as key–value pairs. For more information about using tags in IAM, see [Tagging IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the _IAM User Guide_. 23 | - c. Choose Create role. 24 | 7. After the role is created, choose the role in the console to open it for editing. 25 | 8. On the **Permissions** tab, choose **Add permissions**, and then choose **Create inline policy**. 26 | 9. Choose **JSON**, and replace the contents in the **Policy editor** with the following code: 27 | ``` 28 | { 29 | "Version": "2012-10-17", 30 | "Statement": [ 31 | { 32 | "Effect": "Allow", 33 | "Action": [ 34 | "ec2:ModifyVolume", 35 | "ec2:DescribeAvailabilityZones", 36 | "ec2:DescribeTags", 37 | "ec2:DescribeVolumes", 38 | "ec2:DescribeVolumesModifications" 39 | ], 40 | "Resource": "*" 41 | } 42 | ] 43 | } 44 | ``` 45 | 10. Choose **Next**, then enter a unique policy name, such as ***AltinityEBSParamsControllerPolicy***. 46 | 11. Choose **Create policy** 47 | 12. Choose the **Trust relationships** tab, and then choose **Edit trust policy**. 48 | 13. Find the line that looks similar to the following line: 49 | ``` 50 | "oidc.eks.region-code.amazonaws.com/id/EXAMPLE168660E7300CC5879EEXAMPLE:aud": "sts.amazonaws.com" 51 | ``` 52 | Add a comma to the end of the previous line, and then add the following line after the previous line. Replace `region-code` with the AWS Region that your cluster is in. Replace `EXAMPLE168660E7300CC5879EEXAMPLE` with your cluster's OIDC provider ID. 53 | ``` 54 | "oidc.eks.region-code.amazonaws.com/id/EXAMPLE168660E7300CC5879EEXAMPLE:sub": "system:serviceaccount:kube-system:ebs-params-controller" 55 | ``` 56 | 14. Choose **Update policy** to finish. 57 | 15. Copy the **ARN** value from the role's **Summary**. 58 | 59 | **To deploy the EBS Params Controller** 60 | 61 | 1. Save the **Manifest** from https://github.com/Altinity/ebs-params-controller/blob/main/deployment.yaml 62 | 2. Replace the `${role_arn}` string with your role's **ARN**. 63 | 3. Apply the **Manifest**: 64 | ``` 65 | kubectl apply -n kube-system -f deployment.yaml 66 | ``` 67 | 68 | ## Annotations to control parameters 69 | 70 | | Annotation | Description | Example | 71 | | :--------- | :---------- | :------ | 72 | | spec.epc.altinity.com/throughput | Defines the required Throughput value | `spec.epc.altinity.com/throughput: "300"` | 73 | | spec.epc.altinity.com/iops | Defines the required IOPS value | `spec.epc.altinity.com/iops: "6000"` | 74 | | spec.epc.altinity.com/type | Defines the required EBS volume type.
Possible values are: io1, io2, gp2, gp3, sc1, st1, sbp1, sbg1 | `spec.epc.altinity.com/type: "gp3"` | 75 | 76 | ## Annotations to display current volume status 77 | 78 | | Annotation | Description | 79 | | :--------- | :---------- | 80 | | status.epc.altinity.com/throughput | Current Throughput | 81 | | status.epc.altinity.com/iops | Current IOPS | 82 | | status.epc.altinity.com/type | Current volume type | 83 | | status.epc.altinity.com/mod-state | Represents the state of last volume modification attempt. Empty string if never modified before. Other possible values are `modifying`, `optimizing`, `completed`, or `failed` | 84 | | status.epc.altinity.com/mod-start-time | Timestamp of the beginning of last modification attempt. Empty string if never modified before | 85 | | status.epc.altinity.com/mod-end-time | Timestamp of the end of last modification attempt. Empty string if modification is in progress or the volume was never modified before | 86 | 87 | ## License 88 | 89 | Copyright (c) 2022-2023, Altinity Inc and/or its affiliates. All rights reserved. 90 | 91 | EBS Params Controller is licensed under the Apache License 2.0. 92 | -------------------------------------------------------------------------------- /ebs-params.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | source /shell_lib.sh 4 | 5 | EBS_VOL_MODS='' 6 | EBS_VOLS_JSON='' 7 | 8 | function __config__() { 9 | cat <&1)" 150 | RET=$? 151 | set -e 152 | if [[ $RET -ne 0 ]]; then 153 | echo "Aws CLI failed with exit code ${RET}" 154 | echo "$MOD_OUT" 155 | EBS_VOL_MOD_STATE="$(jq -nc --arg code "$RET" --arg msg "$(echo "$MOD_OUT" | awk NF)" '{ERROR:{code:$code,msg:$msg}}')" 156 | else 157 | EBS_VOL_MOD_STATE="$(echo "$MOD_OUT" | jq -r '.VolumeModification.ModificationState')" 158 | EBS_VOL_MOD_START_TIME="$(echo "$MOD_OUT" | jq -r '.VolumeModification.StartTime')" 159 | EBS_VOL_MOD_END_TIME='' 160 | fi 161 | fi 162 | fi 163 | 164 | JQFILTER='' 165 | 166 | if [[ "$EBS_VOL_IOPS" != "$(pvc::jq -r '.metadata.annotations."status.epc.altinity.com/iops"')" ]]; then 167 | JQFILTER+="${JQFILTER:+|}"'.metadata.annotations."status.epc.altinity.com/iops"="'"$EBS_VOL_IOPS"'"' 168 | fi 169 | 170 | if [[ "$EBS_VOL_TP" != "$(pvc::jq -r '.metadata.annotations."status.epc.altinity.com/throughput"')" ]]; then 171 | JQFILTER+="${JQFILTER:+|}"'.metadata.annotations."status.epc.altinity.com/throughput"="'"$EBS_VOL_TP"'"' 172 | fi 173 | 174 | if [[ "$EBS_VOL_TYPE" != "$(pvc::jq -r '.metadata.annotations."status.epc.altinity.com/type"')" ]]; then 175 | JQFILTER+="${JQFILTER:+|}"'.metadata.annotations."status.epc.altinity.com/type"="'"$EBS_VOL_TYPE"'"' 176 | fi 177 | 178 | if [[ "$EBS_VOL_MOD_STATE" != "$(pvc::jq -r '.metadata.annotations."status.epc.altinity.com/mod-state"')" ]]; then 179 | JQFILTER+="${JQFILTER:+|}"'.metadata.annotations."status.epc.altinity.com/mod-state"='"$(echo "$EBS_VOL_MOD_STATE" | jq -R)" 180 | fi 181 | 182 | if [[ "$EBS_VOL_MOD_START_TIME" != "$(pvc::jq -r '.metadata.annotations."status.epc.altinity.com/mod-start-time"')" ]]; then 183 | JQFILTER+="${JQFILTER:+|}"'.metadata.annotations."status.epc.altinity.com/mod-start-time"="'"$EBS_VOL_MOD_START_TIME"'"' 184 | fi 185 | 186 | if [[ "$EBS_VOL_MOD_END_TIME" != "$(pvc::jq -r '.metadata.annotations."status.epc.altinity.com/mod-end-time"')" ]]; then 187 | JQFILTER+="${JQFILTER:+|}"'.metadata.annotations."status.epc.altinity.com/mod-end-time"="'"$EBS_VOL_MOD_END_TIME"'"' 188 | fi 189 | 190 | if [[ -n "${JQFILTER}" ]]; then 191 | echo "Applying jqFilter ${JQFILTER}" 192 | cat <>"$KUBERNETES_PATCH_PATH" 193 | --- 194 | operation: JQPatch 195 | kind: PersistentVolumeClaim 196 | namespace: $(pvc::jq -r '.metadata.namespace') 197 | name: $(pvc::jq -r '.metadata.name') 198 | jqFilter: $(echo "$JQFILTER" | jq -R) 199 | EOF 200 | fi 201 | } 202 | 203 | hook::run "$@" 204 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------