├── .gitignore ├── LICENSE ├── README.md ├── github.sh ├── plugin.yaml └── repos └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | repos 2 | .idea 3 | helm-github.iml 4 | 5 | -------------------------------------------------------------------------------- /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 2017-2018 Gladly Software, Inc. 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 | # helm-github 2 | 3 | A Helm plugin that installs or upgrades raw Helm charts from GitHub 4 | 5 | * https://docs.helm.sh/helm/#helm-install 6 | * https://docs.helm.sh/helm/#helm-upgrade 7 | 8 | 9 | # Installation 10 | * `helm plugin install --version master https://github.com/sagansystems/helm-github.git` 11 | * `helm github --help` 12 | 13 | ![image](https://user-images.githubusercontent.com/52489/33590100-fa79e052-d931-11e7-9879-b0fd7db7d09a.png) 14 | 15 | 16 | # `helm-github` plugin updates 17 | 18 | ### Automatically 19 | * `helm github --update` 20 | 21 | ### Manually 22 | * `cd $HELM_HOME/plugins/` 23 | * `git pull` 24 | 25 | 26 | # Usage 27 | 28 | ### Install a chart from a GitHub repo 29 | 30 | * `helm github install --repo git@github.com:kubernetes/charts.git --path stable/external-dns` 31 | * `helm github install --repo git@github.com:coreos/alb-ingress-controller.git --ref 6d64984 --path alb-ingress-controller-helm` 32 | * `helm github install --repo git@github.com:coreos/alb-ingress-controller.git --ref master --path alb-ingress-controller-helm --namespace kube-system --name alb-ingress-ctlr-1 -f alb-ingress-controller/values.yml --version 0.0.6` 33 | 34 | ### Upgrade the `happy-panda` release to a new version of the chart from a GitHub repo 35 | 36 | * `helm github upgrade happy-panda --repo git@github.com:kubernetes/charts.git --path stable/external-dns` 37 | * `helm github upgrade happy-panda --repo git@github.com:coreos/alb-ingress-controller.git --ref 6d64984 --path alb-ingress-controller-helm` 38 | * `helm github upgrade happy-panda --repo git@github.com:coreos/alb-ingress-controller.git --ref master --path alb-ingress-controller-helm -f alb-ingress-controller/values.yml --version 0.0.6` 39 | -------------------------------------------------------------------------------- /github.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | usage() { 5 | cat << EOF 6 | Install or upgrade Helm charts from Github 7 | https://docs.helm.sh/helm/#helm-install 8 | https://docs.helm.sh/helm/#helm-upgrade 9 | 10 | Available Commands: 11 | helm github install Install a Helm chart from Github 12 | helm github upgrade Upgrades the release to a new version of the Helm chart from Github 13 | helm github fetch Fetch Helm chart from Github (e.g git clone) 14 | 15 | Available Flags: 16 | --repo, -r (Required) Specify the repo to install 17 | --ref, -b (Optional) Specify the branch, commit, or reference to checkout before installing 18 | --path, -p (Optional) Specify a path within repo where helm chart is stored. Must be relative to base of repo 19 | --debug (Optional) Verbosity intensifies... ... 20 | --help (Optional) This text. 21 | --update, -u (Optional) Update this plugin to the latest version from the master branch 22 | 23 | Example Usage: 24 | helm github install --repo git@github.com:coreos/alb-ingress-controller.git --ref master --path alb-ingress-controller-helm 25 | helm github upgrade happy-panda --repo git@github.com:kubernetes/charts.git --path stable/external-dns 26 | EOF 27 | } 28 | 29 | # Create the passthru array 30 | PASSTHRU=() 31 | while [[ $# -gt 0 ]] 32 | do 33 | key="$1" 34 | 35 | # Parse arguments 36 | case $key in 37 | -r|--repo) 38 | REPO="$2" 39 | shift # past argument 40 | shift # past value 41 | ;; 42 | -b|--ref) 43 | BRANCH="$2" 44 | shift # past argument 45 | shift # past value 46 | ;; 47 | -p|--path) 48 | CHARTPATH="$2" 49 | shift # past argument 50 | shift # past value 51 | ;; 52 | --debug) 53 | DEBUG=TRUE 54 | shift # past argument 55 | ;; 56 | --help) 57 | HELP=TRUE 58 | shift # past argument 59 | ;; 60 | --update) 61 | UPDATE=TRUE 62 | shift # past argument 63 | ;; 64 | *) # unknown option 65 | PASSTHRU+=("$1") # save it in an array for later 66 | shift # past argument 67 | ;; 68 | esac 69 | done 70 | 71 | # Restore PASSTHRU parameters 72 | set -- "${PASSTHRU[@]}" 73 | 74 | # Show help if flagged 75 | if [ "$HELP" == "TRUE" ]; then 76 | usage 77 | exit 0 78 | fi 79 | 80 | # Update this Helm plugin 81 | if [ "$UPDATE" == "TRUE" ]; then 82 | cd "$HELM_HOME/plugins/helm-github" 83 | git pull 84 | PLUGIN_VERSION=$(git log --pretty=format:'%h' -n 1) 85 | cd - 86 | echo "Success! Updated this plugin to: $PLUGIN_VERSION" 87 | exit 0 88 | fi 89 | 90 | if [ -z "$REPO" ]; then 91 | echo "Error: No Repo provided. Please provide --repo flag" 92 | usage 93 | exit 1 94 | fi 95 | 96 | if [ -z "$BRANCH" ]; then 97 | BRANCH="master" 98 | fi 99 | 100 | if [ -z "$CHARTPATH" ]; then 101 | CHARTPATH="." 102 | fi 103 | 104 | REPO_BASE_NAME="$(basename $REPO .git)" 105 | REPO_LOCATION="$HELM_HOME/plugins/helm-github/repos/$REPO_BASE_NAME" 106 | 107 | # Print params for debugging 108 | if [ "$DEBUG" == "TRUE" ]; then 109 | echo "PARAMS"; 110 | echo $*; 111 | echo " ......................... "; 112 | echo Helm home = "$HELM_HOME"; 113 | echo REPO = "${REPO}"; 114 | echo BRANCH = "${BRANCH}"; 115 | echo CHARTPATH = "${CHARTPATH}"; 116 | echo PASSTHRU = "${PASSTHRU[@]}"; 117 | echo REPO_BASE_NAME = "$REPO_BASE_NAME"; 118 | echo REPO_LOCATION = "$REPO_LOCATION"; 119 | fi 120 | 121 | # Checkout the repo & enter it 122 | if [ -d "${REPO_LOCATION}" ]; then 123 | cd $REPO_LOCATION 124 | git checkout master; 125 | git pull; 126 | else 127 | git clone $REPO $REPO_LOCATION; 128 | cd $REPO_LOCATION; 129 | fi 130 | 131 | # Checkout the correct branch 132 | git checkout $BRANCH 133 | 134 | # Exit the repo 135 | cd - 136 | 137 | # COMMAND must be either 'install' or 'upgrade' 138 | COMMAND=${PASSTHRU[0]} 139 | 140 | if [ "$COMMAND" == "install" ]; then 141 | echo "Installing the Helm chart from the GitHub repo" 142 | # Take out the first variable in passthru (install) so that helm install works 143 | helm install "${PASSTHRU[@]:1}" $REPO_LOCATION/$CHARTPATH 144 | exit 0 145 | elif [ "$COMMAND" == "upgrade" ]; then 146 | RELEASE=${PASSTHRU[1]} 147 | echo "Upgrading ${RELEASE} release to a new version of the chart from the GitHub repo" 148 | # Take out the first two variables in passthru (install ) so that helm upgrade works 149 | helm upgrade "${PASSTHRU[@]:2}" $RELEASE $REPO_LOCATION/$CHARTPATH 150 | exit 0 151 | elif [ "$COMMAND" == "fetch" ]; then 152 | echo "GitHub repo has been fetched to ${REPO_LOCATION}" 153 | exit 0 154 | else 155 | echo "Error: Invalid command, must be one of 'install' or 'upgrade'" 156 | usage 157 | exit 1 158 | fi 159 | -------------------------------------------------------------------------------- /plugin.yaml: -------------------------------------------------------------------------------- 1 | name: "github" 2 | version: "0.2.0" 3 | usage: "Install or upgrade Helm charts from GitHub repos" 4 | description: |- 5 | This plugin installs or upgrades raw Helm charts from Github 6 | command: "$HELM_PLUGIN_DIR/github.sh" 7 | -------------------------------------------------------------------------------- /repos/README.md: -------------------------------------------------------------------------------- 1 | # Repos 2 | 3 | This directory is a placeholder to store downloaded repos from github. This directory should be created when you install the plugin and be located at: `$HELM_HOME/plugins/helm-github/repos/` 4 | --------------------------------------------------------------------------------