Using an External HTTPS Proxy Automated Test (#7886)

* add missing cleanup for vs nginx

* add test

* fix sourcepod

* add ...

* use verify contains

* revert boilerplate

* disable SC2155

* remove waitfordep

* add test

* fix newline

* weird cleanup

* add back test

* oops make gen

* Apply suggestions from code review

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

* weird cleanup

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
This commit is contained in:
Navraj Singh Chhina 2020-08-10 15:39:55 -04:00 committed by GitHub
parent f21f943859
commit b76fd3d2f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 240 additions and 8 deletions

View File

@ -6,7 +6,7 @@ keywords: [traffic-management,egress]
aliases:
- /docs/examples/advanced-gateways/http-proxy/
owner: istio/wg-networking-maintainers
test: no
test: yes
---
The [Configure an Egress Gateway](/docs/tasks/traffic-management/egress/egress-gateway/) example shows how to direct
traffic to external services from your mesh via an Istio edge component called _Egress Gateway_. However, some
@ -106,7 +106,7 @@ This example uses [Squid](http://www.squid-cache.org) but you can use any HTTPS
1. Obtain the IP address of the proxy pod and define the `PROXY_IP` environment variable to store it:
{{< text bash >}}
$ export PROXY_IP=$(kubectl get pod -n external -l app=squid -o jsonpath={.items..podIP})
$ export PROXY_IP="$(kubectl get pod -n external -l app=squid -o jsonpath={.items..podIP})"
{{< /text >}}
1. Define the `PROXY_PORT` environment variable to store the port of your proxy. In this case, Squid uses port
@ -119,14 +119,14 @@ This example uses [Squid](http://www.squid-cache.org) but you can use any HTTPS
1. Send a request from the `sleep` pod in the `external` namespace to an external service via the proxy:
{{< text bash >}}
$ kubectl exec -it $(kubectl get pod -n external -l app=sleep -o jsonpath={.items..metadata.name}) -n external -- sh -c "HTTPS_PROXY=$PROXY_IP:$PROXY_PORT curl https://en.wikipedia.org/wiki/Main_Page" | grep -o "<title>.*</title>"
$ kubectl exec -it "$(kubectl get pod -n external -l app=sleep -o jsonpath={.items..metadata.name})" -n external -- sh -c "HTTPS_PROXY=$PROXY_IP:$PROXY_PORT curl https://en.wikipedia.org/wiki/Main_Page" | grep -o "<title>.*</title>"
<title>Wikipedia, the free encyclopedia</title>
{{< /text >}}
1. Check the access log of the proxy for your request:
{{< text bash >}}
$ kubectl exec -it $(kubectl get pod -n external -l app=squid -o jsonpath={.items..metadata.name}) -n external -- tail -f /var/log/squid/access.log
$ kubectl exec -it "$(kubectl get pod -n external -l app=squid -o jsonpath={.items..metadata.name})" -n external -- tail -f /var/log/squid/access.log
1544160065.248 228 172.30.109.89 TCP_TUNNEL/200 87633 CONNECT en.wikipedia.org:443 - HIER_DIRECT/91.198.174.192 -
{{< /text >}}
@ -145,7 +145,7 @@ Next, you must configure the traffic from the Istio-enabled pods to use the HTTP
{{< text bash >}}
$ kubectl apply -f - <<EOF
apiVersion: networking.istio.io/v1alpha3
apiVersion: networking.istio.io/v1beta1
kind: ServiceEntry
metadata:
name: proxy
@ -166,21 +166,21 @@ Next, you must configure the traffic from the Istio-enabled pods to use the HTTP
Istio controls its traffic.
{{< text bash >}}
$ kubectl exec -it $SOURCE_POD -c sleep -- sh -c "HTTPS_PROXY=$PROXY_IP:$PROXY_PORT curl https://en.wikipedia.org/wiki/Main_Page" | grep -o "<title>.*</title>"
$ kubectl exec -it "$SOURCE_POD" -c sleep -- sh -c "HTTPS_PROXY=$PROXY_IP:$PROXY_PORT curl https://en.wikipedia.org/wiki/Main_Page" | grep -o "<title>.*</title>"
<title>Wikipedia, the free encyclopedia</title>
{{< /text >}}
1. Check the Istio sidecar proxy's logs for your request:
{{< text bash >}}
$ kubectl logs $SOURCE_POD -c istio-proxy
$ kubectl logs "$SOURCE_POD" -c istio-proxy
[2018-12-07T10:38:02.841Z] "- - -" 0 - 702 87599 92 - "-" "-" "-" "-" "172.30.109.95:3128" outbound|3128||my-company-proxy.com 172.30.230.52:44478 172.30.109.95:3128 172.30.230.52:44476 -
{{< /text >}}
1. Check the access log of the proxy for your request:
{{< text bash >}}
$ kubectl exec -it $(kubectl get pod -n external -l app=squid -o jsonpath={.items..metadata.name}) -n external -- tail -f /var/log/squid/access.log
$ kubectl exec -it "$(kubectl get pod -n external -l app=squid -o jsonpath={.items..metadata.name})" -n external -- tail -f /var/log/squid/access.log
1544160065.248 228 172.30.109.89 TCP_TUNNEL/200 87633 CONNECT en.wikipedia.org:443 - HIER_DIRECT/91.198.174.192 -
{{< /text >}}

View File

@ -0,0 +1,170 @@
#!/bin/bash
# shellcheck disable=SC2034,SC2153,SC2155,SC2164
# Copyright Istio Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
####################################################################################################
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/egress/http-proxy/index.md
####################################################################################################
snip_deploy_an_https_proxy_1() {
kubectl create namespace external
}
snip_deploy_an_https_proxy_2() {
cat <<EOF > ./proxy.conf
http_port 3128
acl SSL_ports port 443
acl CONNECT method CONNECT
http_access deny CONNECT !SSL_ports
http_access allow localhost manager
http_access deny manager
http_access allow all
coredump_dir /var/spool/squid
EOF
}
snip_deploy_an_https_proxy_3() {
kubectl create configmap proxy-configmap -n external --from-file=squid.conf=./proxy.conf
}
snip_deploy_an_https_proxy_4() {
kubectl apply -f - <<EOF
apiVersion: apps/v1
kind: Deployment
metadata:
name: squid
namespace: external
spec:
replicas: 1
selector:
matchLabels:
app: squid
template:
metadata:
labels:
app: squid
spec:
volumes:
- name: proxy-config
configMap:
name: proxy-configmap
containers:
- name: squid
image: sameersbn/squid:3.5.27
imagePullPolicy: IfNotPresent
volumeMounts:
- name: proxy-config
mountPath: /etc/squid
readOnly: true
EOF
}
snip_deploy_an_https_proxy_5() {
kubectl apply -n external -f samples/sleep/sleep.yaml
}
snip_deploy_an_https_proxy_6() {
export PROXY_IP="$(kubectl get pod -n external -l app=squid -o jsonpath={.items..podIP})"
}
snip_deploy_an_https_proxy_7() {
export PROXY_PORT=3128
}
snip_deploy_an_https_proxy_8() {
kubectl exec -it "$(kubectl get pod -n external -l app=sleep -o jsonpath={.items..metadata.name})" -n external -- sh -c "HTTPS_PROXY=$PROXY_IP:$PROXY_PORT curl https://en.wikipedia.org/wiki/Main_Page" | grep -o "<title>.*</title>"
}
! read -r -d '' snip_deploy_an_https_proxy_8_out <<\ENDSNIP
<title>Wikipedia, the free encyclopedia</title>
ENDSNIP
snip_deploy_an_https_proxy_9() {
kubectl exec -it "$(kubectl get pod -n external -l app=squid -o jsonpath={.items..metadata.name})" -n external -- tail -f /var/log/squid/access.log
}
! read -r -d '' snip_deploy_an_https_proxy_9_out <<\ENDSNIP
1544160065.248 228 172.30.109.89 TCP_TUNNEL/200 87633 CONNECT en.wikipedia.org:443 - HIER_DIRECT/91.198.174.192 -
ENDSNIP
snip_configure_traffic_to_external_https_proxy_1() {
kubectl apply -f - <<EOF
apiVersion: networking.istio.io/v1beta1
kind: ServiceEntry
metadata:
name: proxy
spec:
hosts:
- my-company-proxy.com # ignored
addresses:
- $PROXY_IP/32
ports:
- number: $PROXY_PORT
name: tcp
protocol: TCP
location: MESH_EXTERNAL
EOF
}
snip_configure_traffic_to_external_https_proxy_2() {
kubectl exec -it "$SOURCE_POD" -c sleep -- sh -c "HTTPS_PROXY=$PROXY_IP:$PROXY_PORT curl https://en.wikipedia.org/wiki/Main_Page" | grep -o "<title>.*</title>"
}
! read -r -d '' snip_configure_traffic_to_external_https_proxy_2_out <<\ENDSNIP
<title>Wikipedia, the free encyclopedia</title>
ENDSNIP
snip_configure_traffic_to_external_https_proxy_3() {
kubectl logs "$SOURCE_POD" -c istio-proxy
}
! read -r -d '' snip_configure_traffic_to_external_https_proxy_3_out <<\ENDSNIP
[2018-12-07T10:38:02.841Z] "- - -" 0 - 702 87599 92 - "-" "-" "-" "-" "172.30.109.95:3128" outbound|3128||my-company-proxy.com 172.30.230.52:44478 172.30.109.95:3128 172.30.230.52:44476 -
ENDSNIP
snip_configure_traffic_to_external_https_proxy_4() {
kubectl exec -it "$(kubectl get pod -n external -l app=squid -o jsonpath={.items..metadata.name})" -n external -- tail -f /var/log/squid/access.log
}
! read -r -d '' snip_configure_traffic_to_external_https_proxy_4_out <<\ENDSNIP
1544160065.248 228 172.30.109.89 TCP_TUNNEL/200 87633 CONNECT en.wikipedia.org:443 - HIER_DIRECT/91.198.174.192 -
ENDSNIP
snip_cleanup_1() {
kubectl delete -f samples/sleep/sleep.yaml
}
snip_cleanup_2() {
kubectl delete -f samples/sleep/sleep.yaml -n external
}
snip_cleanup_3() {
kubectl delete -n external deployment squid
kubectl delete -n external configmap proxy-configmap
rm ./proxy.conf
}
snip_cleanup_4() {
kubectl delete namespace external
}
snip_cleanup_5() {
kubectl delete serviceentry proxy
}

View File

@ -0,0 +1,62 @@
#!/usr/bin/env bash
# shellcheck disable=SC1090,SC2154,SC2155
# Copyright 2020 Istio Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# @setup profile=demo
set -e
set -u
set -o pipefail
source "tests/util/samples.sh"
# Deploy sleep sample and set up variable pointing to it
# Start the sleep sample
startup_sleep_sample
export SOURCE_POD=$(kubectl get pod -l app=sleep -o jsonpath='{.items[0].metadata.name}')
# create external ns
snip_deploy_an_https_proxy_1
# create proxy ns
snip_deploy_an_https_proxy_2
snip_deploy_an_https_proxy_3
# create squid deployment
snip_deploy_an_https_proxy_4
_wait_for_deployment external squid
# create sleep
snip_deploy_an_https_proxy_5
_wait_for_deployment external sleep
snip_deploy_an_https_proxy_6
snip_deploy_an_https_proxy_7
_verify_contains snip_deploy_an_https_proxy_8 "<title>Wikipedia, the free encyclopedia</title>"
_verify_contains snip_deploy_an_https_proxy_9 "CONNECT en.wikipedia.org:443"
# create service entry
snip_configure_traffic_to_external_https_proxy_1
_verify_contains snip_configure_traffic_to_external_https_proxy_2 "<title>Wikipedia, the free encyclopedia</title>"
_verify_contains snip_configure_traffic_to_external_https_proxy_3 "outbound|3128||my-company-proxy.com"
# @cleanup
set +e # ignore cleanup errors
snip_cleanup_1
snip_cleanup_2
snip_cleanup_3
snip_cleanup_4