Merge branch 'master' of https://github.com/cloudnativelabs/kube-router

Author: DandyDeveloper

.dockerignore

@@ -12,15 +12,21 @@ on:
     - master
     - v[1-9].*
 
+env:
+  BUILDTIME_BASE: "golang:1.16.7-alpine3.14"
+  RUNTIME_BASE: "alpine:3.14"
+  GO_VERSION: "~1.16.7"
+
 jobs:
+  # Runs Golangci-lint on the source code
   ci-go-lint:
     name: ci-go-lint
     runs-on: ubuntu-latest
     steps:
     - name: Set up Go 1.x
       uses: actions/setup-go@v2
       with:
-        go-version: ~1.16.4
+        go-version: ${{ env.GO_VERSION }}
       id: go
 
     - name: Check out code into the Go module directory
@@ -30,14 +36,15 @@ jobs:
       run: |
         make lint
 
+  # Executes Unit Tests
   ci-unit-tests:
     name: ci-unit-tests
     runs-on: ubuntu-latest
     steps:
     - name: Set up Go 1.x
       uses: actions/setup-go@v2
       with:
-        go-version: ~1.16.4
+        go-version: ${{ env.GO_VERSION }}
       id: go
 
     - name: Check out code into the Go module directory
@@ -46,15 +53,18 @@ jobs:
     - name: Run unit tests for kube-router
       run: |
         make test
+      env:
+        DOCKER_BUILD_IMAGE: ${{ env.BUILDTIME_BASE }}
 
+  # Builds Kube-Router binary
   ci-build-kube-router:
     name: ci-build-kube-router
     runs-on: ubuntu-latest
     steps:
     - name: Set up Go 1.x
       uses: actions/setup-go@v2
       with:
-        go-version: ~1.16.4
+        go-version: ${{ env.GO_VERSION }}
       id: go
 
     - name: Check out code into the Go module directory
@@ -63,3 +73,102 @@ jobs:
     - name: Build kube-router
       run: |
         make kube-router
+
+  # Builds Container only if a new push to main branch, a tag or a pull request from a source branch within the repository
+  ci-build-container:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name != 'pull_request' || (github.event.pull_request.head.repo.full_name == github.repository && github.actor != 'dependabot[bot]') }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v1
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Login to DockerHub
+      uses: docker/login-action@v1
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+    - name: Extract branch from github ref - New Push
+      if: ${{ startsWith(github.ref, 'refs/tags/v') != true && github.event_name != 'pull_request' }}
+      shell: bash
+      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+      id: extract_branch
+
+    - name: Extract tag from github ref - New Release
+      if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+      shell: bash
+      run: echo "##[set-output name=tag;]$(echo ${GITHUB_REF#refs/tags/})"
+      id: extract_tag
+
+    - name: Build and push - New Push
+      uses: docker/build-push-action@v2
+      if: ${{ startsWith(github.ref, 'refs/tags/v') != true && github.event_name != 'pull_request' }}
+      with:
+        context: .
+        platforms: |
+          linux/amd64
+          linux/arm64
+          linux/arm/v7
+        push: true
+        build-args: |
+          BUILDTIME_BASE=${{ env.BUILDTIME_BASE }}
+          RUNTIME_BASE=${{ env.RUNTIME_BASE }}
+        tags: cloudnativelabs/kube-router-git:${{ steps.extract_branch.outputs.branch }}
+
+    - name: Build and push - New PR
+      uses: docker/build-push-action@v2
+      if: github.event_name == 'pull_request'
+      with:
+        context: .
+        # Don't build multi arch images for PR as they take more than 30 min to build
+        platforms: linux/amd64
+        push: true
+        build-args: |
+          BUILDTIME_BASE=${{ env.BUILDTIME_BASE }}
+          RUNTIME_BASE=${{ env.RUNTIME_BASE }}
+        tags: cloudnativelabs/kube-router-git:PR-${{ github.event.pull_request.number }}
+
+    - name: Build and push - New Tag
+      uses: docker/build-push-action@v2
+      if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+      with:
+        context: .
+        platforms: |
+          linux/amd64
+          linux/arm64
+          linux/arm/v7
+        push: true
+        build-args: |
+          BUILDTIME_BASE=${{ env.BUILDTIME_BASE }}
+          RUNTIME_BASE=${{ env.RUNTIME_BASE }}
+        tags: |
+          cloudnativelabs/kube-router:${{ steps.extract_tag.outputs.tag }}
+          cloudnativelabs/kube-router:latest
+
+  # Runs Go Releaser on Tag Event
+  ci-goreleaser-tag:
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    steps:
+    - name: Set up Go 1.x
+      uses: actions/setup-go@v2
+      with:
+        go-version: ${{ env.GO_VERSION }}
+      id: go
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: Run GoReleaser
+      uses: goreleaser/goreleaser-action@v2
+      with:
+        version: latest
+        args: release --rm-dist
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -1,5 +1,15 @@
-ARG ARCH=
-FROM ${ARCH}alpine:3.12
+ARG BUILDTIME_BASE=golang:1-alpine
+ARG RUNTIME_BASE=alpine:latest
+FROM ${BUILDTIME_BASE} as builder
+ENV BUILD_IN_DOCKER=false
+
+WORKDIR /build
+COPY . /build
+RUN apk add --no-cache make git \
+    && make kube-router \
+    && make gobgp
+
+FROM ${RUNTIME_BASE}
 
 RUN apk add --no-cache \
       iptables \
@@ -19,7 +29,7 @@ COPY build/image-assets/bashrc /root/.bashrc
 COPY build/image-assets/profile /root/.profile
 COPY build/image-assets/vimrc /root/.vimrc
 COPY build/image-assets/motd-kube-router.sh /etc/motd-kube-router.sh
-COPY kube-router gobgp /usr/local/bin/
+COPY --from=builder /build/kube-router /build/gobgp /usr/local/bin/
 
 # Use iptables-wrappers so that correct version of iptables-legacy or iptables-nft gets used. Alpine contains both, but
 # which version is used should be based on the host system as well as where rules that may have been added before

.travis.yml

@@ -8,7 +8,7 @@ GIT_COMMIT=$(shell git describe --tags --dirty)
 GIT_BRANCH?=$(shell git rev-parse --abbrev-ref HEAD)
 IMG_TAG?=$(if $(IMG_TAG_PREFIX),$(IMG_TAG_PREFIX)-)$(if $(ARCH_TAG_PREFIX),$(ARCH_TAG_PREFIX)-)$(GIT_BRANCH)
 MANIFEST_TAG?=$(if $(IMG_TAG_PREFIX),$(IMG_TAG_PREFIX)-)$(GIT_BRANCH)
-RELEASE_TAG?=$(GOARCH)-$(shell build/get-git-tag.sh)
+RELEASE_TAG?=$(GOARCH)-$(shell git describe --exact-match || echo -n)
 REGISTRY?=$(if $(IMG_FQDN),$(IMG_FQDN)/$(IMG_NAMESPACE)/$(NAME),$(IMG_NAMESPACE)/$(NAME))
 REGISTRY_DEV?=$(REGISTRY)$(DEV_SUFFIX)
 IN_DOCKER_GROUP=$(filter docker,$(shell groups))
@@ -17,9 +17,9 @@ DOCKER=$(if $(or $(IN_DOCKER_GROUP),$(IS_ROOT),$(OSX)),docker,sudo docker)
 MAKEFILE_DIR=$(dir $(realpath $(firstword $(MAKEFILE_LIST))))
 UPSTREAM_IMPORT_PATH=$(GOPATH)/src/github.com/cloudnativelabs/kube-router/
 BUILD_IN_DOCKER?=true
-DOCKER_BUILD_IMAGE?=golang:1.16.4-alpine3.12
+DOCKER_BUILD_IMAGE?=golang:1.16.7-alpine3.14
 DOCKER_LINT_IMAGE?=golangci/golangci-lint:v1.27.0
-GOBGP_VERSION=v0.0.0-20210503121111-d1a8400dc698 # v2.27.0
+GOBGP_VERSION= v0.0.0-20210901090119-8ab84f8636ee # v2.31.0
 QEMU_IMAGE?=multiarch/qemu-user-static
 GORELEASER_VERSION=v0.162.1
 MOQ_VERSION=v0.2.1
@@ -180,42 +180,6 @@ else
 	go generate -v $(*).go
 endif
 
-gopath: ## Warns about issues building from a directory that does not match upstream.
-	@echo 'Checking project path for import issues...'
-	@echo '- Project dir: $(MAKEFILE_DIR)'
-	@echo '- Import dir:  $(UPSTREAM_IMPORT_PATH)'
-	@echo
-ifeq ($(MAKEFILE_DIR),$(UPSTREAM_IMPORT_PATH))
-	@echo 'Looks good!'
-else
-	@echo 'The project directory does not match $(UPSTREAM_IMPORT_PATH)'
-	@echo
-	@echo 'This could cause build issues. Consider moving this project'
-	@echo 'directory to $(UPSTREAM_IMPORT_PATH) and work from there.'
-	@echo 'This could be done for you by running: "make gopath-fix".'
-	@echo
-endif
-
-# This fixes GOPATH issues for contributers using their own Travis-CI account
-# with their forked kube-router repo. It's also useful for contributors testing
-# code and CI changes with their own Travis account.
-gopath-fix: ## Copies this project directory to the upstream import path.
-ifneq ($(wildcard $(UPSTREAM_IMPORT_PATH)/.*),)
-	@echo
-	@echo '$(UPSTREAM_IMPORT_PATH) already exists.'
-	@echo 'Aborting gopath-fix.'
-	@echo
-else
-	@echo
-	@echo 'Copying $(MAKEFILE_DIR) to $(UPSTREAM_IMPORT_PATH)'
-	@echo
-	mkdir -p "$(UPSTREAM_IMPORT_PATH)"
-	cp -ar $(MAKEFILE_DIR)/. "$(UPSTREAM_IMPORT_PATH)"
-	@echo
-	@echo 'Success! Please use $(UPSTREAM_IMPORT_PATH)'
-	@echo
-endif
-
 gobgp:
 	@echo Building gobgp
 ifeq "$(BUILD_IN_DOCKER)" "true"
@@ -238,6 +202,6 @@ help:
 
 .PHONY: clean container run release goreleaser push gofmt gofmt-fix gomoqs
 .PHONY: test lint docker-login push-manifest push-manifest-release
-.PHONY: push-release github-release help gopath gopath-fix multiarch-binverify
+.PHONY: push-release github-release help multiarch-binverify
 
 .DEFAULT: all

Dockerfile

@@ -1,6 +1,6 @@
 ![logo](https://cdn.rawgit.com/cloudnativelabs/kube-router/64f7700e/Documentation/img/logo-full.svg)
 
-[![Build Status](https://travis-ci.org/cloudnativelabs/kube-router.svg?branch=master)](https://travis-ci.org/cloudnativelabs/kube-router)
+[![Build Status](https://github.com/cloudnativelabs/kube-router/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/cloudnativelabs/kube-router/actions/workflows/ci.yml?query=branch%3Amaster)
 [![Slack](https://img.shields.io/badge/slack-join%20chat%20%E2%86%92-e01563.svg)](https://kubernetes.slack.com/messages/C8DCQGTSB/)
 [![Docker Pulls kube-router](https://img.shields.io/docker/pulls/cloudnativelabs/kube-router.svg?label=docker+pulls)](https://hub.docker.com/r/cloudnativelabs/kube-router/)
 [![](https://images.microbadger.com/badges/image/cloudnativelabs/kube-router.svg)](https://microbadger.com/images/cloudnativelabs/kube-router "Get your own image badge on microbadger.com")

Makefile

@@ -0,0 +1,22 @@
+# Process for creating a Kube-Router release
+
+## Preparing for the release
+* Ensure that the Golang release used is still supported. Definition happens currently in [Github Workflow](.github/workflow/ci.yml).
+* Ensure that the Alpine version used in container builds is still supported. Definition happens currently in [Github Workflow](.github/workflow/ci.yml).
+* Ensure that Golang dependencies are updated. `go list -mod=mod -u -m -f '{{.}}{{if .Indirect}} IAMINDIRECT{{end}}' all | grep -v IAMINDIRECT` lists possible updates.
+* Ensure that the GoBGP version is updated. See [upstream](https://github.com/osrg/gobgp/releases) and GoBGP definition in [Makefile](Makefile) and [go.mod](go.mod).
+* Ensure that the Kubernetes object definitions do not contain deprecated object types. Definition currently is in kube-router's [Daemonset](daemonset) folder.
+
+## New major/minor release
+* Create a branch named v$MAJOR.$MINOR from the default branch (currently: master)
+* Create a new prerelease on Github with the release tag v$MAJOR.$MINOR.0
+
+## New patch release
+* Create a new prerelease on Github from the v$MAJOR.$MINOR release branch with the release tag v$MAJOR.$MINOR.$PATCH
+
+A goreleaser command will be executed via Github Actions and it will add binaries to the release.
+A docker buildx command will be executed via Github Actions and it will push new container builds to [DockerHub](https://hub.docker.com/repository/docker/cloudnativelabs/kube-router).
+
+## After the release
+* Mark the draft release as a proper release.
+* Announce the release in [#kube-router](https://app.slack.com/client/T09NY5SBT/C8DCQGTSB) on Kubernetes Slack.