Skip to content

Commit

Permalink
chore: update tutorials (#263)
Browse files Browse the repository at this point in the history
  • Loading branch information
traefiker committed Jul 26, 2024
1 parent f7c638f commit 59664cd
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 11 deletions.
42 changes: 39 additions & 3 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@ on:
workflow_dispatch:
pull_request:
branches:
- main
- master
paths:
- '**.yaml'
- '.github/workflows/test.yaml'
- 'src/manifests/**.yaml'
- 'api-management/**.yaml'
- 'api-gateway/**.yaml'
- 'tests/**.go'

env:
API_TOKEN: ${{ secrets.API_TOKEN }}
Expand All @@ -25,6 +29,11 @@ jobs:
with:
go-version-file: tests/go.mod
cache-dependency-path: tests/go.sum
- name: docker hub login
uses: docker/login-action@v3
with:
username: traefiker
password: ${{ secrets.TRAEFIKER_DOCKERHUB_TOKEN }}
- name: run tests
working-directory: tests
run: make test-walkthrough
Expand All @@ -38,6 +47,11 @@ jobs:
with:
go-version-file: tests/go.mod
cache-dependency-path: tests/go.sum
- name: docker hub login
uses: docker/login-action@v3
with:
username: traefiker
password: ${{ secrets.TRAEFIKER_DOCKERHUB_TOKEN }}
- name: run tests
working-directory: tests
run: make test-apigw
Expand All @@ -51,7 +65,29 @@ jobs:
with:
go-version-file: tests/go.mod
cache-dependency-path: tests/go.sum
- name: docker hub login
uses: docker/login-action@v3
with:
username: traefiker
password: ${{ secrets.TRAEFIKER_DOCKERHUB_TOKEN }}
- name: run tests
working-directory: tests
run: make test-apim

testhelpers:
runs-on: buildjet-2vcpu-ubuntu-2204
steps:
- name: checkout
uses: actions/checkout@v4
- name: set up Go
uses: actions/setup-go@v5
with:
go-version-file: tests/go.mod
cache-dependency-path: tests/go.sum
- name: docker hub login
uses: docker/login-action@v3
with:
username: traefiker
password: ${{ secrets.TRAEFIKER_DOCKERHUB_TOKEN }}
- name: run tests
working-directory: tests
run: make test-testhelpers
5 changes: 4 additions & 1 deletion WALKTHROUGH.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ helm repo add --force-update traefik https://traefik.github.io/charts
kubectl create namespace traefik
# Install the Helm chart
helm install traefik -n traefik --wait \
--version v29.0.1 \
--set ingressClass.enabled=false \
--set ingressRoute.dashboard.enabled=true \
--set ingressRoute.dashboard.matchRule='Host(`dashboard.docker.localhost`)' \
Expand Down Expand Up @@ -261,11 +262,12 @@ Then, upgrade Traefik Proxy to Traefik Hub using the same Helm chart:

```shell
helm upgrade traefik -n traefik --wait \
--version v29.0.1 \
--reuse-values \
--set hub.token=traefik-hub-license \
--set image.registry=ghcr.io \
--set image.repository=traefik/traefik-hub \
--set image.tag=v3.3.0 \
--set image.tag=v3.3.1 \
traefik/traefik
```

Expand Down Expand Up @@ -390,6 +392,7 @@ First, we enable API Management on Traefik Traefik Hub using the same Helm chart

```shell
helm upgrade traefik -n traefik --wait \
--version v29.0.1 \
--reuse-values \
--set hub.apimanagement.enabled=true \
traefik/traefik
Expand Down
5 changes: 3 additions & 2 deletions api-gateway/1-getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,15 @@ Install Traefik Hub API Gateway using Helm:
helm repo add --force-update traefik https://traefik.github.io/charts
# Install the Helm chart
helm install traefik -n traefik --wait \
--version v29.0.1 \
--set hub.token=traefik-hub-license \
--set ingressClass.enabled=false \
--set ingressRoute.dashboard.enabled=true \
--set ingressRoute.dashboard.matchRule='Host(`dashboard.docker.localhost`)' \
--set ingressRoute.dashboard.entryPoints={web} \
--set image.registry=ghcr.io \
--set image.repository=traefik/traefik-hub \
--set image.tag=v3.3.0 \
--set image.tag=v3.3.1 \
--set ports.web.nodePort=30000 \
--set ports.websecure.nodePort=30001 \
traefik/traefik
Expand All @@ -118,7 +119,7 @@ helm upgrade traefik -n traefik --wait \
--set ingressRoute.dashboard.entryPoints={web} \
--set image.registry=ghcr.io \
--set image.repository=traefik/traefik-hub \
--set image.tag=v3.3.0 \
--set image.tag=v3.3.1 \
--set ports.web.nodePort=30000 \
--set ports.websecure.nodePort=30001 \
traefik/traefik
Expand Down
5 changes: 3 additions & 2 deletions api-management/1-getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ Now, install Traefik Hub with Helm:
helm repo add --force-update traefik https://traefik.github.io/charts
# Install the Helm chart
helm install traefik -n traefik --wait \
--version v29.0.1 \
--set hub.token=traefik-hub-license \
--set hub.apimanagement.enabled=true \
--set ingressClass.enabled=false \
Expand All @@ -90,7 +91,7 @@ helm install traefik -n traefik --wait \
--set ingressRoute.dashboard.entryPoints={web} \
--set image.registry=ghcr.io \
--set image.repository=traefik/traefik-hub \
--set image.tag=v3.3.0 \
--set image.tag=v3.3.1 \
--set ports.web.nodePort=30000 \
--set ports.websecure.nodePort=30001 \
traefik/traefik
Expand All @@ -113,7 +114,7 @@ helm upgrade traefik -n traefik --wait \
--set ingressRoute.dashboard.entryPoints={web} \
--set image.registry=ghcr.io \
--set image.repository=traefik/traefik-hub \
--set image.tag=v3.3.0 \
--set image.tag=v3.3.1 \
--set ports.web.nodePort=30000 \
--set ports.websecure.nodePort=30001 \
traefik/traefik
Expand Down
7 changes: 5 additions & 2 deletions tests/testhelpers/containers.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ func InstallTraefikProxy(ctx context.Context, t *testing.T, k8s client.Client) (
assert.NoError(t, err)

LaunchHelmCommand(t, "install", "traefik", "-n", traefikNamespace, "--wait",
"--version", "v29.0.1",
"--set", "ingressClass.enabled=false",
"--set", "ingressRoute.dashboard.enabled=true",
"--set", "ingressRoute.dashboard.matchRule='Host(`dashboard.docker.localhost`)'",
Expand All @@ -115,14 +116,15 @@ func InstallTraefikHubAPIGW(ctx context.Context, t *testing.T, k8s client.Client

CreateSecretForTraefikHub(ctx, t, k8s)
LaunchHelmCommand(t, "install", "traefik", "-n", traefikNamespace, "--wait",
"--version", "v29.0.1",
"--set", "hub.token=traefik-hub-license",
"--set", "ingressClass.enabled=false",
"--set", "ingressRoute.dashboard.enabled=true",
"--set", "ingressRoute.dashboard.matchRule='Host(`dashboard.docker.localhost`)'",
"--set", "ingressRoute.dashboard.entryPoints={web}",
"--set", "image.registry=ghcr.io",
"--set", "image.repository=traefik/traefik-hub",
"--set", "image.tag=v3.3.0",
"--set", "image.tag=v3.3.1",
"--set", "ports.web.nodePort=30000",
"--set", "ports.websecure.nodePort=30001",
"traefik/traefik")
Expand All @@ -142,6 +144,7 @@ func InstallTraefikHubAPIM(ctx context.Context, t *testing.T, k8s client.Client)

CreateSecretForTraefikHub(ctx, t, k8s)
LaunchHelmCommand(t, "install", "traefik", "-n", traefikNamespace, "--wait",
"--version", "v29.0.1",
"--set", "hub.token=traefik-hub-license",
"--set", "hub.apimanagement.enabled=true",
"--set", "ingressClass.enabled=false",
Expand All @@ -150,7 +153,7 @@ func InstallTraefikHubAPIM(ctx context.Context, t *testing.T, k8s client.Client)
"--set", "ingressRoute.dashboard.entryPoints={web}",
"--set", "image.registry=ghcr.io",
"--set", "image.repository=traefik/traefik-hub",
"--set", "image.tag=v3.3.0",
"--set", "image.tag=v3.3.1",
"--set", "ports.web.nodePort=30000",
"--set", "ports.websecure.nodePort=30001",
"traefik/traefik")
Expand Down
4 changes: 3 additions & 1 deletion tests/walkthrough/walkthrough_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,12 @@ func (s *WalkthroughTestSuite) TestWalkthrough() {
// STEP 2
testhelpers.CreateSecretForTraefikHub(s.ctx, s.T(), s.k8s)
testhelpers.LaunchHelmCommand(s.T(), "upgrade", "traefik", "-n", "traefik", "--wait",
"--version", "v29.0.1",
"--reuse-values",
"--set", "hub.token=traefik-hub-license",
"--set", "image.registry=ghcr.io",
"--set", "image.repository=traefik/traefik-hub",
"--set", "image.tag=v3.3.0",
"--set", "image.tag=v3.3.1",
"traefik/traefik")

req, err = http.NewRequest(http.MethodGet, "http://walkthrough.docker.localhost/basic-auth/weather", nil)
Expand All @@ -149,6 +150,7 @@ func (s *WalkthroughTestSuite) TestWalkthrough() {

// STEP 3
testhelpers.LaunchHelmCommand(s.T(), "upgrade", "traefik", "-n", "traefik", "--wait",
"--version", "v29.0.1",
"--reuse-values",
"--set", "hub.apimanagement.enabled=true",
"traefik/traefik")
Expand Down

0 comments on commit 59664cd

Please sign in to comment.