├── LICENSE ├── README.md ├── exec-cronjob └── kubectl-exec_cronjob.sh └── prune-unused └── kubectl-prune_unused.sh /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Kubectl plugins 2 | =============== 3 | 4 | > Kubectl plugins repository which contains a few helpers that improve the 5 | kubectl experience. 6 | 7 | ## Available plugins 8 | 9 | | plugin | description | 10 | |--------------|-------------| 11 | | prune-unused | Prune secrets or configmaps that are not being used in a given namespace. It checks against all resources from mounted volumes, env, envFrom and imagePullSecrets. 12 | | exec-cronjob | Run a CronJob immediately as Job by extracting the Job spec and creating a Job instance thereof. 13 | 14 | ## Getting started 15 | 16 | Install [krew](https://krew.dev) to manage Kubectl plugins. Refer to the 17 | [Krew documentation](https://krew.dev) to get started. 18 | 19 | ### Prune unused 20 | 21 | ```bash 22 | # install the prune-used plugins 23 | $ kubectl krew install prune-unused 24 | ``` 25 | 26 | ``` 27 | Prune unused configmaps/secret resources from a given namespace. It 28 | checks against all resources from mounted volumes, env and envFrom and 29 | imagePullSecrets. 30 | 31 | Usage: 32 | kubectl prune-unused [options] 33 | 34 | Options: 35 | -l, --selector='': Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)" 36 | --context='': If present, the name of the kubeconfig context for this CLI request 37 | -n, --namespace='': If present, the namespace scope for this CLI request 38 | --dry-run: If true, only print the object that would be pruned, without deleting it. 39 | -h, --help: Display this help 40 | ``` 41 | 42 | ### Exec cronjob 43 | 44 | > DEPRECATION NOTICE: 45 | > This plugin isn't necessary anymore, the kubectl cli let you create 46 | > cronjob with the create subcommand: 47 | > ``` 48 | > $ kubectl create job --from cronjob/my-cronjob my-job 49 | > ``` 50 | 51 | ```bash 52 | # install the exec-cronjob plugins 53 | $ kubectl krew install exec-cronjob 54 | ``` 55 | 56 | ``` 57 | Run a CronJob immediately as Job by extracting the Job spec and creating a Job 58 | instance thereof. 59 | 60 | Usage: 61 | kubectl exec-cronjob [options] 62 | 63 | Options: 64 | --context='': If present, the name of the kubeconfig context for this CLI request 65 | -n, --namespace='': If present, the namespace scope for this CLI request 66 | --dry-run: If true, only print the object that would be sent, without sending it. 67 | -h, --help: Display this help 68 | ``` 69 | -------------------------------------------------------------------------------- /exec-cronjob/kubectl-exec_cronjob.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Run a CronJob immediately as Job by extracting the Job spec and creating a 3 | # Job instance thereof. 4 | 5 | set -e 6 | 7 | function usage() { 8 | echo "DEPRECATION NOTICE:" 9 | echo "This plugin isn't necessary anymore, the kubectl cli let you create" 10 | echo "cronjob with the create subcommand:" 11 | echo " kubectl create job --from cronjob/my-cronjob my-job" 12 | echo "" 13 | echo "" 14 | echo "Run a CronJob immediately as Job by extracting the Job spec and" 15 | echo "creating a Job instance thereof." 16 | echo "" 17 | echo "Usage:" 18 | echo " kubectl exec-cronjob [options]" 19 | echo "" 20 | echo "Options:" 21 | echo " --context='': If present, the name of the kubeconfig context for this CLI request" 22 | echo " -n, --namespace='': If present, the namespace scope for this CLI request" 23 | echo " --dry-run: If true, only print the object that would be sent, without sending it." 24 | echo " -h, --help: Display this help" 25 | exit 0 26 | } 27 | 28 | if [[ $# -lt 1 ]] || [[ "$1" == "-"* ]] 29 | then 30 | usage 31 | fi 32 | 33 | cronjob_name=$1 34 | dry_run_arg="" 35 | context_arg="" 36 | namespace_arg="" 37 | 38 | while test $# -gt 1 39 | do 40 | case "$2" in 41 | --context*) 42 | if [[ $2 == *"="* ]] 43 | then 44 | context_arg=${2#=*} 45 | else 46 | shift 47 | context_arg="--context=${2}" 48 | fi 49 | shift 50 | ;; 51 | -n|--namespace*) 52 | if [[ $2 == *"="* ]] 53 | then 54 | namespace_arg=${2#=*} 55 | else 56 | shift 57 | namespace_arg="--namespace=${2}" 58 | fi 59 | shift 60 | ;; 61 | --dry-run) 62 | dry_run_arg="--dry-run -o yaml" 63 | shift 64 | ;; 65 | -h|--help) 66 | usage 67 | ;; 68 | *) 69 | break 70 | ;; 71 | esac 72 | done 73 | 74 | cron_job=$(kubectl $context_arg get cronjob $namespace_arg -o yaml $cronjob_name) 75 | 76 | api_version=$(echo $cron_job | awk '/^apiVersion: / {print $2}') 77 | 78 | job="apiVersion: batch/v1 79 | kind: Job" 80 | 81 | # extract the cronjob spec and insert the job name 82 | job_spec=$(echo "$cron_job" | awk -v name=$cronjob_name ' 83 | capture && !/^ / { capture=0 } 84 | capture { sub("^ ", ""); print $0 } 85 | capture && /metadata:/ && !named { print " name: " name; named=1 } 86 | /jobTemplate:$/ { capture=1 } 87 | ') 88 | 89 | echo "${job} 90 | ${job_spec}" | kubectl $context_arg apply -f - $dry_run_arg $namespace_arg 91 | -------------------------------------------------------------------------------- /prune-unused/kubectl-prune_unused.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Prune unused resources by checking references from env, envFrom, volumes and 3 | # imagePullSecrets. 4 | 5 | set -e 6 | 7 | label_arg="" 8 | context_arg="" 9 | namespace_arg="" 10 | 11 | function usage() { 12 | echo "Prune unused configmaps/secret resources from a given namespace. It" 13 | echo "checks against all resources from mounted volumes, env and envFrom and" 14 | echo "imagePullSecrets." 15 | echo "" 16 | echo "Usage:" 17 | echo " kubectl prune-unused [options]" 18 | echo "" 19 | echo "Options:" 20 | echo " -l, --selector='': Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)" 21 | echo " --context='': If present, the name of the kubeconfig context for this CLI request" 22 | echo " -n, --namespace='': If present, the namespace scope for this CLI request" 23 | echo " --dry-run: If true, only print the object that would be pruned, without deleting it." 24 | echo " -h, --help: Display this help" 25 | exit 0 26 | } 27 | 28 | if [[ $# -lt 1 ]] || [[ "$1" == "-"* ]] 29 | then 30 | usage 31 | fi 32 | 33 | resource=$1 34 | dry_run="false" 35 | 36 | while test $# -gt 1 37 | do 38 | case "$2" in 39 | -l|--selector*) 40 | if [[ $2 == *"="* ]] 41 | then 42 | label_arg=${2#=*} 43 | else 44 | shift 45 | label_arg="--selector=${2}" 46 | fi 47 | shift 48 | ;; 49 | --context*) 50 | if [[ $2 == *"="* ]] 51 | then 52 | context_arg=${2#=*} 53 | else 54 | shift 55 | context_arg="--context=${2}" 56 | fi 57 | shift 58 | ;; 59 | -n|--namespace*) 60 | if [[ $2 == *"="* ]] 61 | then 62 | namespace_arg=${2#=*} 63 | else 64 | shift 65 | namespace_arg="--namespace=${2}" 66 | fi 67 | shift 68 | ;; 69 | --dry-run) 70 | dry_run="true" 71 | shift 72 | ;; 73 | -h|--help) 74 | usage 75 | ;; 76 | *) 77 | break 78 | ;; 79 | esac 80 | done 81 | 82 | case "$resource" in 83 | configmaps|cm|configmap) 84 | declare -a pod_field_list=( 85 | "containers[*].envFrom[*].configMapRef.name" 86 | "containers[*].env[*].valueFrom.configMapKeyRef.name" 87 | "initContainers[*].envFrom[*].configMapRef.name" 88 | "initContainers[*].env[*].valueFrom.configMapKeyRef.name" 89 | "volumes[*].configMap.name" 90 | ) 91 | ;; 92 | secrets|secret) 93 | declare -a pod_field_list=( 94 | "containers[*].envFrom[*].secretRef.name" 95 | "containers[*].env[*].valueFrom.secretKeyRef.name" 96 | "imagePullSecrets[*].name" 97 | "initContainers[*].envFrom[*].secretRef.name" 98 | "initContainers[*].env[*].valueFrom.secretKeyRef.name" 99 | "volumes[*].secret.secretName" 100 | ) 101 | ;; 102 | *) 103 | echo "Resource \"$resource\" is invalid" 104 | usage 105 | ;; 106 | esac 107 | 108 | for field in ${pod_field_list[@]} 109 | do 110 | cronjob_resources=$(kubectl $context_arg get cronjobs $label_arg $namespace_arg \ 111 | -o jsonpath='{.items[*].spec.jobTemplate.spec.template.spec.'${field}'}') 112 | deploy_resources=$(kubectl $context_arg get deploy $label_arg $namespace_arg \ 113 | -o jsonpath='{.items[*].spec.template.spec.'${field}'}') 114 | ds_resources=$(kubectl $context_arg get ds $label_arg $namespace_arg \ 115 | -o jsonpath='{.items[*].spec.template.spec.'${field}'}') 116 | job_resources=$(kubectl $context_arg get jobs $label_arg $namespace_arg \ 117 | -o jsonpath='{.items[*].spec.template.spec.'${field}'}') 118 | pod_resources=$(kubectl $context_arg get pods $label_arg $namespace_arg \ 119 | -o jsonpath='{.items[*].spec.'${field}'}') 120 | rs_resources=$(kubectl $context_arg get rs $label_arg $namespace_arg \ 121 | -o jsonpath='{.items[*].spec.template.spec.'${field}'}') 122 | rc_resources=$(kubectl $context_arg get rc $label_arg $namespace_arg \ 123 | -o jsonpath='{.items[*].spec.template.spec.'${field}'}') 124 | sts_resources=$(kubectl $context_arg get sts $label_arg $namespace_arg \ 125 | -o jsonpath='{.items[*].spec.template.spec.'${field}'}') 126 | 127 | resources=$(echo " 128 | ${cronjob_resources} 129 | ${deploy_resources} 130 | ${ds_resources} 131 | ${job_resources} 132 | ${pod_resources} 133 | ${rc_resources} 134 | ${rs_resources} 135 | ${sts_resources} 136 | " | xargs -n1 | uniq) 137 | 138 | used_resources="${used_resources} ${resources}" 139 | done 140 | 141 | # get all resources 142 | available_resources=$(kubectl $context_arg get $resource $label_arg $namespace_arg \ 143 | -o jsonpath='{.items[*].metadata.name}' | xargs -n1 | uniq) 144 | 145 | # only keep unused resources 146 | resource_name_list="" 147 | for available_name in $available_resources 148 | do 149 | delete=true 150 | for resource_name in $used_resources 151 | do 152 | if [ "$available_name" == "$resource_name" ] 153 | then 154 | delete=false 155 | break 156 | fi 157 | done 158 | 159 | if [ "$delete" == "true" ] 160 | then 161 | resource_name_list="${available_name} ${resource_name_list}" 162 | fi 163 | done 164 | 165 | if [ "$resource_name_list" == "" ] 166 | then 167 | echo "No unused resource(s) found." 168 | exit 0 169 | fi 170 | 171 | for resource_name in $resource_name_list 172 | do 173 | if [ "$dry_run" == "true" ] 174 | then 175 | echo "${resource} ${resource_name} deleted (dry run)" 176 | else 177 | kubectl $context_arg delete $resource $resource_name $label_arg $namespace_arg 178 | fi 179 | done 180 | --------------------------------------------------------------------------------