├── updatecli ├── validate.yml ├── values.yaml └── updatecli.d │ └── updatecli.yml ├── .gitignore ├── Makefile ├── Dockerfile ├── .github ├── dependabot.yml └── workflows │ ├── updatecli.yml │ └── release.yml ├── scripts └── version ├── README.md ├── entry └── LICENSE /updatecli/validate.yml: -------------------------------------------------------------------------------- 1 | version: go1.20.2 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.cache 2 | /.trash-cache 3 | *.swp 4 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .DEFAULT_GOAL := ci 2 | .PHONY: ci 3 | ci: 4 | @. ./scripts/version; docker build --build-arg BUILDDATE=$(date +%Y%m%d) -f Dockerfile -t $${IMAGE} . 5 | @. ./scripts/version; echo Built $${IMAGE} -------------------------------------------------------------------------------- /updatecli/values.yaml: -------------------------------------------------------------------------------- 1 | github: 2 | user: "github-actions[bot]" 3 | email: "41898282+github-actions[bot]@users.noreply.github.com" 4 | username: "UPDATECLI_GITHUB_ACTOR" 5 | token: "UPDATECLI_GITHUB_TOKEN" 6 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:3.22 2 | ARG BUILDDATE 3 | LABEL buildDate=$BUILDDATE 4 | RUN apk --no-cache upgrade && \ 5 | apk add -U --no-cache iptables ip6tables nftables iptables-legacy 6 | COPY entry /usr/bin/ 7 | CMD ["entry"] 8 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | 4 | # Maintain dependencies for Docker Images 5 | - package-ecosystem: "docker" 6 | directory: "/" 7 | labels: 8 | - "kind/dependabot" 9 | reviewers: 10 | - "k3s-io/k3s-dev" 11 | schedule: 12 | interval: "weekly" 13 | 14 | - package-ecosystem: "docker" 15 | directory: "/package" 16 | labels: 17 | - "kind/dependabot" 18 | reviewers: 19 | - "k3s-io/k3s-dev" 20 | schedule: 21 | interval: "weekly" 22 | -------------------------------------------------------------------------------- /scripts/version: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | if [ -n "$(git status --porcelain --untracked-files=no)" ]; then 4 | DIRTY="-dirty" 5 | fi 6 | 7 | COMMIT=$(git rev-parse --short HEAD) 8 | GIT_TAG=${DRONE_TAG:-$(git tag -l --contains HEAD | head -n 1)} 9 | 10 | if [ -z "$DIRTY" ] && [ -n "$GIT_TAG" ]; then 11 | VERSION=$GIT_TAG 12 | else 13 | VERSION="${COMMIT}${DIRTY}" 14 | fi 15 | 16 | ARCH=${ARCH:-"amd64"} 17 | TAG=${TAG:-${VERSION}-${ARCH}} 18 | REPO=${REPO:-rancher} 19 | 20 | if echo $TAG | grep -q dirty; then 21 | TAG=dev 22 | fi 23 | 24 | IMAGE=${REPO}/klipper-lb:${TAG} 25 | 26 | 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Klipper Service Load Balancer 2 | ================= 3 | 4 | _NOTE: this repository was moved 2020-11-18 out of the github.com/rancher org to github.com/k3s-io 5 | supporting the [acceptance of K3s as a CNCF sandbox project](https://github.com/cncf/toc/pull/447)_. 6 | 7 | --- 8 | 9 | This is the runtime image for the integrated service load balancer in klipper. This 10 | works by using a host port for each service load balancer and setting up 11 | iptables to forward the request to the cluster IP. The regular k8s scheduler will 12 | find a free host port. If there are no free host ports, the service load balancer 13 | will stay in pending. 14 | 15 | ## Building 16 | 17 | `make` 18 | 19 | ## License 20 | Copyright (c) 2024 [K3s Authors](http://github.com/k3s-io) 21 | 22 | Licensed under the Apache License, Version 2.0 (the "License"); 23 | you may not use this file except in compliance with the License. 24 | You may obtain a copy of the License at 25 | 26 | [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) 27 | 28 | Unless required by applicable law or agreed to in writing, software 29 | distributed under the License is distributed on an "AS IS" BASIS, 30 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 31 | See the License for the specific language governing permissions and 32 | limitations under the License. 33 | -------------------------------------------------------------------------------- /.github/workflows/updatecli.yml: -------------------------------------------------------------------------------- 1 | name: "Updatecli: Dependency Management" 2 | 3 | on: 4 | schedule: 5 | # Runs at 06 PM UTC 6 | - cron: '0 18 * * *' 7 | # Allows you to run this workflow manually from the Actions tab 8 | workflow_dispatch: 9 | 10 | permissions: 11 | contents: write 12 | issues: write 13 | pull-requests: write 14 | 15 | jobs: 16 | updatecli: 17 | runs-on: ubuntu-latest 18 | if: github.ref == 'refs/heads/master' 19 | steps: 20 | - name: Checkout 21 | uses: actions/checkout@v3 22 | 23 | - name: Install Go 24 | uses: actions/setup-go@v4 25 | with: 26 | go-version: 'stable' 27 | 28 | - name: Install Updatecli 29 | uses: updatecli/updatecli-action@v2 30 | 31 | - name: Delete leftover UpdateCLI branches 32 | run: | 33 | gh pr list \ 34 | --search "is:closed is:pr head:updatecli_" \ 35 | --json headRefName \ 36 | --jq ".[].headRefName" | sort -u > closed_prs_branches.txt 37 | gh pr list \ 38 | --search "is:open is:pr head:updatecli_" \ 39 | --json headRefName \ 40 | --jq ".[].headRefName" | sort -u > open_prs_branches.txt 41 | for branch in $(comm -23 closed_prs_branches.txt open_prs_branches.txt); do 42 | if (git ls-remote --exit-code --heads origin "$branch"); then 43 | echo "Deleting leftover UpdateCLI branch - $branch"; 44 | git push origin --delete "$branch"; 45 | fi 46 | done 47 | env: 48 | GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 49 | 50 | - name: Apply Updatecli 51 | # Never use '--debug' option, because it might leak the access tokens. 52 | run: "updatecli apply --clean --config ./updatecli/updatecli.d/ --values ./updatecli/values.yaml" 53 | env: 54 | UPDATECLI_GITHUB_ACTOR: ${{ github.actor }} 55 | UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 56 | -------------------------------------------------------------------------------- /entry: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -ex 3 | 4 | trap exit TERM INT 5 | 6 | BIN_DIR="/usr/sbin" 7 | 8 | info() { 9 | { set +x; } 2> /dev/null 10 | echo '[INFO] ' "$@" 11 | set -x 12 | } 13 | 14 | fatal() { 15 | { set +x; } 2> /dev/null 16 | echo '[ERROR] ' "$@" >&2 17 | set -x 18 | exit 1 19 | } 20 | 21 | check_iptables_mode() { 22 | set +e 23 | lsmod | grep -qF nf_tables 2> /dev/null 24 | if [ $? = 0 ]; then 25 | mode=nft 26 | else 27 | mode=legacy 28 | fi 29 | set -e 30 | 31 | case "$mode" in 32 | nft) 33 | info "nft mode detected" 34 | set_nft 35 | ;; 36 | legacy) 37 | info "legacy mode detected" 38 | set_legacy 39 | ;; 40 | *) 41 | fatal "invalid iptables mode" 42 | ;; 43 | esac 44 | } 45 | 46 | set_nft() { 47 | for i in iptables iptables-save iptables-restore ip6tables; do 48 | ln -sf xtables-nft-multi "$BIN_DIR/$i"; 49 | done 50 | } 51 | 52 | set_legacy() { 53 | for i in iptables iptables-save iptables-restore ip6tables; do 54 | ln -sf xtables-legacy-multi "$BIN_DIR/$i"; 55 | done 56 | } 57 | 58 | start_proxy() { 59 | for src_range in ${SRC_RANGES//,/ }; do 60 | if echo ${src_range} | grep -Eq ":"; then 61 | ip6tables -t filter -I FORWARD -s ${src_range} -p ${DEST_PROTO} --dport ${DEST_PORT} -j ACCEPT 62 | else 63 | iptables -t filter -I FORWARD -s ${src_range} -p ${DEST_PROTO} --dport ${DEST_PORT} -j ACCEPT 64 | fi 65 | done 66 | 67 | for dest_ip in ${DEST_IPS//,/ }; do 68 | if echo ${dest_ip} | grep -Eq ":"; then 69 | if [ $(cat /proc/sys/net/ipv6/conf/all/forwarding) == 1 ]; then 70 | ip6tables -t filter -A FORWARD -d ${dest_ip}/128 -p ${DEST_PROTO} --dport ${DEST_PORT} -j DROP 71 | ip6tables -t nat -I PREROUTING -p ${DEST_PROTO} --dport ${SRC_PORT} -j DNAT --to [${dest_ip}]:${DEST_PORT} 72 | ip6tables -t nat -I POSTROUTING -d ${dest_ip}/128 -p ${DEST_PROTO} -j MASQUERADE 73 | fi 74 | else 75 | if [ $(cat /proc/sys/net/ipv4/ip_forward) == 1 ]; then 76 | iptables -t filter -A FORWARD -d ${dest_ip}/32 -p ${DEST_PROTO} --dport ${DEST_PORT} -j DROP 77 | iptables -t nat -I PREROUTING -p ${DEST_PROTO} --dport ${SRC_PORT} -j DNAT --to ${dest_ip}:${DEST_PORT} 78 | iptables -t nat -I POSTROUTING -d ${dest_ip}/32 -p ${DEST_PROTO} -j MASQUERADE 79 | fi 80 | fi 81 | done 82 | } 83 | 84 | check_iptables_mode 85 | start_proxy 86 | 87 | if [ ! -e /pause ]; then 88 | mkfifo /pause 89 | fi 90 | 54 | ## the commit message will be automatically generated by updatecli based on the change 55 | targets: 56 | updateValidateFile: 57 | name: "Update the version in the validate file" 58 | kind: "yaml" 59 | scmid: "klipper-lb" 60 | sourceid: goTag 61 | spec: 62 | file: "updatecli/validate.yml" 63 | key: version 64 | 65 | # Validate generating a pull request 66 | actions: 67 | # create a pull request which is not allowed to automerge 68 | # the title matches the commit message 69 | github: 70 | kind: "github/pullrequest" 71 | scmid: "klipper-lb" 72 | spec: 73 | automerge: false 74 | draft: false 75 | mergemethod: squash 76 | parent: false # this would allow for making a PR to an upstream fork, if we ran updatecli from a fork 77 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: release 2 | 3 | on: 4 | release: 5 | types: 6 | - created 7 | 8 | jobs: 9 | release: 10 | runs-on: ubuntu-22.04 11 | 12 | permissions: 13 | contents: read 14 | packages: write 15 | id-token: write # needed for the Vault authentication 16 | 17 | steps: 18 | - name: "Read Vault secrets" 19 | if: github.repository_owner == 'k3s-io' 20 | uses: rancher-eio/read-vault-secrets@main 21 | with: 22 | secrets: | 23 | secret/data/github/repo/${{ github.repository }}/dockerhub/rancher/credentials username | DOCKER_USERNAME ; 24 | secret/data/github/repo/${{ github.repository }}/dockerhub/rancher/credentials password | DOCKER_TOKEN ; 25 | 26 | - name: Login to DockerHub with Rancher Secrets 27 | if: github.repository_owner == 'k3s-io' 28 | uses: docker/login-action@v3 29 | with: 30 | username: ${{ env.DOCKER_USERNAME }} 31 | password: ${{ env.DOCKER_TOKEN }} 32 | 33 | - name: Login to DockerHub with GHA Secrets 34 | if: github.repository_owner != 'k3s-io' 35 | uses: docker/login-action@v3 36 | with: 37 | username: ${{ secrets.DOCKER_USERNAME }} 38 | password: ${{ secrets.DOCKER_TOKEN }} 39 | 40 | - name: Login to GitHub Container Registry 41 | uses: docker/login-action@v3 42 | with: 43 | registry: ghcr.io 44 | username: ${{ github.repository_owner }} 45 | password: ${{ secrets.GITHUB_TOKEN }} 46 | 47 | - name: Set up QEMU 48 | uses: docker/setup-qemu-action@v3 49 | 50 | - name: Set up Docker Buildx 51 | uses: docker/setup-buildx-action@v3 52 | 53 | - name: Build and push (k3s-io) 54 | if: github.repository_owner == 'k3s-io' 55 | uses: docker/build-push-action@v6 56 | with: 57 | platforms: linux/amd64,linux/arm64,linux/arm/v7 58 | push: true 59 | tags: | 60 | rancher/klipper-lb:latest 61 | rancher/klipper-lb:${{ github.ref_name }} 62 | ghcr.io/${{ github.repository_owner }}/klipper-lb:latest 63 | ghcr.io/${{ github.repository_owner }}/klipper-lb:${{ github.ref_name }} 64 | 65 | - name: Build and push (forks) 66 | if: github.repository_owner != 'k3s-io' 67 | uses: docker/build-push-action@v6 68 | with: 69 | platforms: linux/amd64,linux/arm64,linux/arm/v7 70 | push: true 71 | tags: | 72 | ${{ secrets.DOCKER_USERNAME }}/klipper-lb:latest 73 | ${{ secrets.DOCKER_USERNAME }}/klipper-lb:${{ github.ref_name }} 74 | ghcr.io/${{ github.repository_owner }}/klipper-lb:latest 75 | ghcr.io/${{ github.repository_owner }}/klipper-lb:${{ github.ref_name }} -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------