Set API version to v1beta1 in docs examples

This commit is contained in:
stefanprodan 2020-02-27 12:06:33 +02:00
parent 5aa9dd154c
commit 98ecae93e1
15 changed files with 31 additions and 30 deletions

View File

@ -1,4 +1,4 @@
# Flagger Release Guide
# Release Guide
This document describes how to release Flagger.

View File

@ -33,7 +33,7 @@ Mirroring should be used for requests that are **idempotent** or capable of bein
Assuming the app name is podinfo you can define a canary like:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo
@ -146,7 +146,7 @@ spec:
You can enable port discovery so that Prometheus will be able to reach port `9090` over mTLS:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
spec:
service:
@ -348,7 +348,7 @@ The following spec exposes the `frontend` workload inside the mesh on `frontend.
and outside the mesh on `frontend.example.com`. You'll have to specify an Istio ingress gateway for external hosts.
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: frontend
@ -409,7 +409,7 @@ metadata:
name: frontend
namespace: test
ownerReferences:
- apiVersion: flagger.app/v1alpha3
- apiVersion: flagger.app/v1beta1
blockOwnerDeletion: true
controller: true
kind: Canary
@ -486,7 +486,7 @@ To expose a workload inside the mesh on `http://backend.test.svc.cluster.local:9
the service spec can contain only the container port and the traffic policy:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: backend
@ -507,7 +507,7 @@ kind: Service
metadata:
name: backend-primary
ownerReferences:
- apiVersion: flagger.app/v1alpha3
- apiVersion: flagger.app/v1beta1
blockOwnerDeletion: true
controller: true
kind: Canary
@ -535,7 +535,7 @@ Assuming you have two apps, one that servers the main website and one that serve
For each app you can define a canary object as:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: website
@ -552,7 +552,7 @@ spec:
rewrite:
uri: /
---
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: webapi
@ -583,7 +583,7 @@ Note that host merging only works if the canaries are bounded to a ingress gatew
When deploying Istio with global mTLS enabled, you have to set the TLS mode to `ISTIO_MUTUAL`:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
spec:
service:
@ -595,7 +595,7 @@ spec:
If you run Istio in permissive mode you can disable TLS:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
spec:
service:

View File

@ -1,9 +1,7 @@
# How it works
[Flagger](https://github.com/weaveworks/flagger) takes a Kubernetes deployment and optionally
a horizontal pod autoscaler (HPA) and creates a series of objects
(Kubernetes deployments, ClusterIP services, virtual service, traffic split or ingress)
to drive the canary analysis and promotion.
[Flagger](https://github.com/weaveworks/flagger) can be configured to automate the release process
for Kubernetes workloads with a custom resource named canary.
### Canary custom resource
@ -13,7 +11,7 @@ and is portable across clusters, service meshes and ingress providers.
For a deployment named _podinfo_, a canary release with progressive traffic shifting can be defined as:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo
@ -48,6 +46,9 @@ and at the same time, measures the requests success rate as well as the average
You can extend the canary analysis with custom metrics, acceptance and load testing
to harden the validation process of your app release process.
If you are running multiple service meshes or ingress controllers in the same cluster,
you can override the global provider for a specific canary with `spec.provider`.
### Canary target
A canary resource can target a Kubernetes Deployment or DaemonSet.

View File

@ -222,7 +222,7 @@ that have the `prometheus.io/scrape: "true"` annotation.
To target a different provider you can specify it in the canary custom resource:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: app

View File

@ -51,7 +51,7 @@ helm upgrade -i flagger-loadtester flagger/loadtester \
Create a canary custom resource:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -63,7 +63,7 @@ kubectl apply -k github.com/weaveworks/flagger//kustomize/podinfo
Create a canary custom resource \(replace `app.example.com` with your own domain\):
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -82,7 +82,7 @@ helm upgrade -i flagger-loadtester flagger/loadtester \
Create a canary custom resource:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -106,7 +106,7 @@ kubectl apply -k github.com/weaveworks/flagger//kustomize/tester
Create a canary custom resource \(replace example.com with your own domain\):
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -91,7 +91,7 @@ kubectl apply -f ./podinfo-virtualservice.yaml
Create a canary custom resource \(replace `app.example.com` with your own domain\):
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -30,7 +30,7 @@ kubectl apply -k github.com/weaveworks/flagger//kustomize/tester
Create a canary custom resource \(replace example.com with your own domain\):
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -30,7 +30,7 @@ kubectl apply -k github.com/weaveworks/flagger//kustomize/tester
Create a canary custom resource \(replace example.com with your own domain\):
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo
@ -260,7 +260,7 @@ Note that mirroring should be used for requests that are **idempotent** or capab
You can enable mirroring by replacing `stepWeight/maxWeight` with `iterations` and by setting `canaryAnalysis.mirror` to `true`:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -69,7 +69,7 @@ kubectl -n test apply -f ${REPO}/artifacts/loadtester/service.yaml
Create a canary custom resource:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -44,7 +44,7 @@ kubectl apply -k github.com/weaveworks/flagger//kustomize/podinfo
Create a canary custom resource for the podinfo deployment:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo
@ -366,7 +366,7 @@ Besides weighted routing, Flagger can be configured to route traffic to the cana
Edit podinfo canary analysis, set the provider to `nginx`, add the ingress reference, remove the max/step weight and add the match conditions and iterations:
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -96,7 +96,7 @@ kubectl apply -f ./podinfo-ingress.yaml
Create a canary custom resource \(replace `app.example.com` with your own domain\):
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
metadata:
name: podinfo

View File

@ -166,7 +166,7 @@ The above HPA ensures your app will be scaled up before the pods reach the CPU o
To minimise the impact of downscaling operations you can make use of Envoy retry capabilities.
```yaml
apiVersion: flagger.app/v1alpha3
apiVersion: flagger.app/v1beta1
kind: Canary
spec:
service: