Update the plugin name to opa-envoy

This OPA plugin implements the Envoy External Authorization API and
hence the current plugin name could be considered a misnomer.

This commit updates the plugin name to opa-envoy-plugin. It also
includes examples of using the plugin with different Envoy-based service
meshes like Istio.

Signed-off-by: Ashutosh Narkar <[email protected]>

Author: ashutosh-narkar

.travis.yml

@@ -1,6 +1,6 @@
 sudo: required
 language: go
-go_import_path: github.com/open-policy-agent/opa-istio-plugin
+go_import_path: github.com/open-policy-agent/opa-envoy-plugin
 go:
 - '1.13'
 services:
@@ -16,7 +16,7 @@ jobs:
           skip_cleanup: true
           script: docker login -u $DOCKER_USER -p $DOCKER_PASSWORD && make deploy-travis
           on:
-            repo: open-policy-agent/opa-istio-plugin
+            repo: open-policy-agent/opa-envoy-plugin
             branch: master
             tags: false
     - stage: e2e
@@ -41,6 +41,6 @@ jobs:
       - curl -L https://git.io/getLatestIstio | ISTIO_VERSION=${ISTIO_VERSION} sh - && mv istio-${ISTIO_VERSION} /tmp && cd /tmp/istio-${ISTIO_VERSION} && for i in install/kubernetes/helm/istio-init/files/crd*yaml; do kubectl apply -f $i; done && kubectl apply -f install/kubernetes/istio-demo.yaml && cd -
       - kubectl -n istio-system wait --for=condition=available --timeout=600s --all deployment
       script:
-      - make update-quickstart-version && make test-e2e
+      - make update-istio-quickstart-version && make test-e2e
       after_script:
       - kind delete cluster

Dockerfile

@@ -8,8 +8,8 @@ MAINTAINER Ashutosh Narkar  <[email protected]>
 
 WORKDIR /app
 
-COPY opa_istio_linux_GOARCH /app
+COPY opa_envoy_linux_GOARCH /app
 
-ENTRYPOINT ["./opa_istio_linux_GOARCH"]
+ENTRYPOINT ["./opa_envoy_linux_GOARCH"]
 
 CMD ["run"]

Makefile

@@ -2,7 +2,8 @@
 # Use of this source code is governed by an Apache2
 # license that can be found in the LICENSE file.
 
-VERSION := $(shell ./build/get-opa-version.sh)-istio$(shell ./build/get-plugin-rev.sh)
+VERSION := $(shell ./build/get-opa-version.sh)-envoy$(shell ./build/get-plugin-rev.sh)
+VERSION_ISTIO := $(shell ./build/get-opa-version.sh)-istio$(shell ./build/get-plugin-rev.sh)
 
 PACKAGES := $(shell go list ./.../ | grep -v 'vendor')
 
@@ -11,7 +12,7 @@ GOARCH := $(shell go env GOARCH)
 GOOS := $(shell go env GOOS)
 DISABLE_CGO := CGO_ENABLED=0
 
-BIN := opa_istio_$(GOOS)_$(GOARCH)
+BIN := opa_envoy_$(GOOS)_$(GOARCH)
 
 REPOSITORY := openpolicyagent
 IMAGE := $(REPOSITORY)/opa
@@ -30,7 +31,7 @@ export GO15VENDOREXPERIMENT
 
 .PHONY: all build build-mac build-linux clean check check-fmt check-vet check-lint \
     deps deploy-travis generate image image-quick push push-latest tag-latest \
-    test test-cluster test-e2e update-opa update-quickstart-version version
+    test test-cluster test-e2e update-opa update-istio-quickstart-version version
 
 ######################################################
 #
@@ -50,7 +51,7 @@ generate:
 	$(GO) generate ./...
 
 build: generate
-	$(GO) build -o $(BIN) -ldflags $(LDFLAGS) ./cmd/opa-istio-plugin/...
+	$(GO) build -o $(BIN) -ldflags $(LDFLAGS) ./cmd/opa-envoy-plugin/...
 
 build-mac:
 	@$(MAKE) build GOOS=darwin
@@ -65,23 +66,27 @@ image:
 image-quick:
 	sed -e 's/GOARCH/$(GOARCH)/g' Dockerfile > .Dockerfile_$(GOARCH)
 	docker build -t $(IMAGE):$(VERSION) -f .Dockerfile_$(GOARCH) .
+	docker tag $(IMAGE):$(VERSION) $(IMAGE):$(VERSION_ISTIO)
 
 push:
 	docker push $(IMAGE):$(VERSION)
+	docker push $(IMAGE):$(VERSION_ISTIO)
 
 tag-latest:
+	docker tag $(IMAGE):$(VERSION) $(IMAGE):latest-envoy
 	docker tag $(IMAGE):$(VERSION) $(IMAGE):latest-istio
 
 push-latest:
+	docker push $(IMAGE):latest-envoy
 	docker push $(IMAGE):latest-istio
 
 deploy-travis: image-quick push tag-latest push-latest
 
 update-opa:
 	@./build/update-opa-version.sh $(TAG)
 
-update-quickstart-version:
-	sed -i "/opa_container/{N;s/openpolicyagent\/opa:.*/openpolicyagent\/opa:latest-istio\"\,/;}" quick_start.yaml
+update-istio-quickstart-version:
+	sed -i "/opa_container/{N;s/openpolicyagent\/opa:.*/openpolicyagent\/opa:latest-istio\"\,/;}" examples/istio/quick_start.yaml
 
 test: generate
 	$(DISABLE_CGO) $(GO) test -v -bench=. $(PACKAGES)

README.md

@@ -1,13 +1,13 @@
 #!/usr/bin/env bash
 
-OPA_ISTIO_DIR=$(dirname "${BASH_SOURCE}")/..
-source $OPA_ISTIO_DIR/build/utils.sh
+OPA_ENVOY_DIR=$(dirname "${BASH_SOURCE}")/..
+source $OPA_ENVOY_DIR/build/utils.sh
 
-function opa-istio-plugin::check_fmt() {
+function opa-envoy-plugin::check_fmt() {
     exec 5>&1
     exit_code=0
-    for pkg in $(opa-istio-plugin::go_packages); do
-        for file in $(opa-istio-plugin::go_files_in_package $pkg); do
+    for pkg in $(opa-envoy-plugin::go_packages); do
+        for file in $(opa-envoy-plugin::go_files_in_package $pkg); do
             __diff=$(gofmt -d $file | tee >(cat - >&5))
             if [ ! -z "$__diff" ]; then
                 exit_code=1
@@ -17,4 +17,4 @@ function opa-istio-plugin::check_fmt() {
     exit $exit_code
 }
 
-opa-istio-plugin::check_fmt
+opa-envoy-plugin::check_fmt

build/check-fmt.sh

@@ -1,17 +1,17 @@
 #!/usr/bin/env bash
 
-OPA_ISTIO_DIR=$(
+OPA_ENVOY_DIR=$(
     dir=$(dirname "${BASH_SOURCE}")/..
     cd "$dir"
     pwd
 )
-source $OPA_ISTIO_DIR/build/utils.sh
+source $OPA_ENVOY_DIR/build/utils.sh
 
 
-function opa-istio-plugin::check_lint() {
+function opa-envoy-plugin::check_lint() {
     exec 5>&1
     exit_code=0
-    for pkg in $(opa-istio-plugin::go_packages); do
+    for pkg in $(opa-envoy-plugin::go_packages); do
         __output=$(golint $pkg | tee >(cat - >&5))
         if [ ! -z "$__output" ]; then
             exit_code=1
@@ -20,4 +20,4 @@ function opa-istio-plugin::check_lint() {
     exit $exit_code
 }
 
-opa-istio-plugin::check_lint
+opa-envoy-plugin::check_lint

build/check-lint.sh

@@ -1,17 +1,17 @@
 #!/usr/bin/env bash
 
-OPA_ISTIO_DIR=$(
+OPA_ENVOY_DIR=$(
     dir=$(dirname "${BASH_SOURCE}")/..
     cd "$dir"
     pwd
 )
-source $OPA_ISTIO_DIR/build/utils.sh
+source $OPA_ENVOY_DIR/build/utils.sh
 
-function opa-istio-plugin::check_vet() {
+function opa-envoy-plugin::check_vet() {
     exec 5>&1
     rc=0
     exit_code=0
-    for pkg in $(opa-istio-plugin::go_packages); do
+    for pkg in $(opa-envoy-plugin::go_packages); do
         go vet $pkg || rc=$?
         if [[ $rc != 0 ]]; then
             exit_code=1
@@ -20,4 +20,4 @@ function opa-istio-plugin::check_vet() {
     exit $exit_code
 }
 
-opa-istio-plugin::check_vet
+opa-envoy-plugin::check_vet

build/check-vet.sh

@@ -7,7 +7,7 @@ set -x
 GOARCH=$(go env GOARCH)
 GOOS=$(go env GOOS)
 KIND_VERSION=0.4.0
-ISTIO_VERSION=1.2.5
+ISTIO_VERSION=1.5.0
 
 # Download and install kind
 curl -L https://github.com/kubernetes-sigs/kind/releases/download/v${KIND_VERSION}/kind-${GOOS}-${GOARCH} --output kind && chmod +x kind && sudo mv kind /usr/local/bin/

build/install-istio-with-kind.sh

@@ -1,5 +1,5 @@
 # Travis-CI sets TRAVIS_PULL_REQUEST=false when the build is triggered for
-# changes pushed into github.com/open-policy-agent/opa-istio-plugin
+# changes pushed into github.com/open-policy-agent/opa-envoy-plugin
 function is_travis_push_env() {
     if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then
         return 0

build/travis-utils.sh

@@ -26,11 +26,14 @@ if [ $? -eq 0 ]; then
   tag=$(echo $1 | cut -c 2-)   # Remove 'v' in Tag. Eg. v0.8.0 -> 0.8.0
 
   # update plugin image version in README
-  sed -i.bak "s/openpolicyagent\/opa:.*/openpolicyagent\/opa:$tag-istio/" README.md && rm README.md.bak
+  sed -i.bak "s/openpolicyagent\/opa:.*/openpolicyagent\/opa:$tag-envoy/" README.md && rm README.md.bak
 
-  # update plugin image version in quick_start.yaml
-  sed -i.bak "/opa_container/{N;s/openpolicyagent\/opa:.*/openpolicyagent\/opa:$tag-istio\"\,/;}" quick_start.yaml && rm quick_start.yaml.bak
-  sed -i.bak "s/image: openpolicyagent\/opa:.*/image: openpolicyagent\/opa:$tag/" quick_start.yaml quick_start.yaml && rm quick_start.yaml.bak
+  # update plugin image version in quick_start.yaml for Envoy
+  sed -i.bak "s/image: openpolicyagent\/opa:.*/image: openpolicyagent\/opa:$tag-envoy/" quick_start.yaml && rm quick_start.yaml.bak
+
+  # update plugin image version in quick_start.yaml for the Istio deployment example
+  sed -i.bak "/opa_container/{N;s/openpolicyagent\/opa:.*/openpolicyagent\/opa:$tag-istio\"\,/;}" examples/istio/quick_start.yaml && rm examples/istio/quick_start.yaml.bak
+  sed -i.bak "s/image: openpolicyagent\/opa:.*/image: openpolicyagent\/opa:$tag/" examples/istio/quick_start.yaml && rm examples/istio/quick_start.yaml.bak
 
   # update vendor
   env GO111MODULE=on go mod vendor