Update docs for Flagger v1beta1 API

.circleci/config.yml

@@ -199,7 +199,7 @@ jobs:
       - run:
           name: Publish charts
           command: |
-            if echo "${CIRCLE_TAG}" | grep -Eq "[0-9]+(\.[0-9]+)*(-[a-z]+)?$"; then
+            if echo "${CIRCLE_TAG}" | grep v; then
               REPOSITORY="https://weaveworksbot:${GITHUB_TOKEN}@github.com/weaveworks/flagger.git"
               git config user.email [email protected]
               git config user.name weaveworksbot

.gitbook.yaml

@@ -1,6 +1,7 @@
 root: ./docs/gitbook
 
 redirects:
+  how-it-works: usage/how-it-works.md
   usage/progressive-delivery: tutorials/istio-progressive-delivery.md
   usage/ab-testing: tutorials/istio-ab-testing.md
   usage/blue-green: tutorials/kubernetes-blue-green.md

CONTRIBUTING.md

@@ -17,12 +17,12 @@ contribution.
 ## Chat
 
 The project uses Slack: To join the conversation, simply join the
-[Weave community](https://slack.weave.works/) Slack workspace.
+[Weave community](https://slack.weave.works/) Slack workspace #flagger channel.
 
 ## Getting Started
 
 - Fork the repository on GitHub
-- If you want to contribute as a developer, continue reading this document for further instructions
+- If you want to contribute as a developer, read [Flagger Development Guide](https://docs.flagger.app/dev-guide)
 - If you have questions, concerns, get stuck or need a hand, let us know
   on the Slack channel. We are happy to help and look forward to having
   you part of the team. No matter in which capacity.
@@ -59,7 +59,7 @@ get asked to resubmit the PR or divide the changes into more than one PR.
 
 ### Format of the Commit Message
 
-For Flux we prefer the following rules for good commit messages:
+For Flagger we prefer the following rules for good commit messages:
 
 - Limit the subject to 50 characters and write as the continuation
   of the sentence "If applied, this commit will ..."
@@ -69,4 +69,4 @@ For Flux we prefer the following rules for good commit messages:
 The [following article](https://chris.beams.io/posts/git-commit/#seven-rules)
 has some more helpful advice on documenting your work.
 
-This doc is adapted from the [Weaveworks Flux](https://github.com/weaveworks/flux/blob/master/CONTRIBUTING.md)
+This doc is adapted from [FluxCD](https://github.com/fluxcd/flux/blob/master/CONTRIBUTING.md).

Makefile

@@ -20,6 +20,9 @@ test-fmt:
 	gofmt -l -s ./ | grep ".*\.go"; if [ "$$?" = "0" ]; then exit 1; fi
 	goimports -l ./ | grep ".*\.go"; if [ "$$?" = "0" ]; then exit 1; fi
 
+codegen:
+	./hack/update-codegen.sh
+
 test-codegen:
 	./hack/verify-codegen.sh
 
@@ -42,16 +45,16 @@ version-set:
 	echo "Version $$next set in code, deployment, chart and kustomize"
 
 release:
-	git tag $(VERSION)
-	git push origin $(VERSION)
+	git tag "v$(VERSION)"
+	git push origin "v$(VERSION)"
 
 release-notes:
 	cd /tmp && GH_REL_URL="https://github.com/buchanae/github-release-notes/releases/download/0.2.0/github-release-notes-linux-amd64-0.2.0.tar.gz" && \
     curl -sSL $${GH_REL_URL} | tar xz && sudo mv github-release-notes /usr/local/bin/
 
 loadtester-build:
-	GO111MODULE=on CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o ./bin/loadtester ./cmd/loadtester/*
+	CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o ./bin/loadtester ./cmd/loadtester/*
+	docker build -t weaveworks/flagger-loadtester:$(LT_VERSION) . -f Dockerfile.loadtester
 
 loadtester-push:
-	docker build -t weaveworks/flagger-loadtester:$(LT_VERSION) . -f Dockerfile.loadtester
 	docker push weaveworks/flagger-loadtester:$(LT_VERSION)

README.md

@@ -64,7 +64,7 @@ When promoting a workload in production, both code (container images) and config
 For a deployment named _podinfo_, a canary promotion can be defined using Flagger's custom resource:
 
 ```yaml
-apiVersion: flagger.app/v1alpha3
+apiVersion: flagger.app/v1beta1
 kind: Canary
 metadata:
   name: podinfo
@@ -87,14 +87,17 @@ spec:
     kind: HorizontalPodAutoscaler
     name: podinfo
   service:
-    # service name (optional)
+    # service name (defaults to targetRef.name)
     name: podinfo
     # ClusterIP port number
     port: 9898
     # container port name or number (optional)
     targetPort: 9898
     # port name can be http or grpc (default http)
     portName: http
+    # add all the other container ports
+    # to the ClusterIP services (default false)
+    portDiscovery: true
     # HTTP match conditions (optional)
     match:
       - uri:
@@ -107,7 +110,7 @@ spec:
   # promote the canary without analysing it (default false)
   skipAnalysis: false
   # define the canary analysis timing and KPIs
-  canaryAnalysis:
+  analysis:
     # schedule interval (default 60s)
     interval: 1m
     # max number of failed metric checks before rollback
@@ -118,36 +121,59 @@ spec:
     # canary increment step
     # percentage (0-100)
     stepWeight: 5
-    # Istio Prometheus checks
+    # validation (optional)
     metrics:
-    # builtin checks
     - name: request-success-rate
+      # builtin Prometheus check
       # minimum req success rate (non 5xx responses)
       # percentage (0-100)
-      threshold: 99
+      thresholdRange:
+        min: 99
       interval: 1m
     - name: request-duration
+      # builtin Prometheus check
       # maximum req duration P99
       # milliseconds
-      threshold: 500
+      thresholdRange:
+        max: 500
       interval: 30s
-    # custom check
-    - name: "kafka lag"
-      threshold: 100
-      query: |
-        avg_over_time(
-          kafka_consumergroup_lag{
-            consumergroup=~"podinfo-consumer-.*",
-            topic="podinfo"
-          }[1m]
-        )
+    - name: "database connections"
+      # custom Prometheus check
+      templateRef:
+        name: db-connections
+      thresholdRange:
+        min: 2
+        max: 100
+      interval: 1m
     # testing (optional)
     webhooks:
-      - name: load-test
+      - name: "conformance test"
+        type: pre-rollout
+        url: http://flagger-helmtester.test/
+        timeout: 5m
+        metadata:
+          type: "helmv3"
+          cmd: "test run podinfo -n test"
+      - name: "load test"
+        type: rollout
         url: http://flagger-loadtester.test/
-        timeout: 5s
         metadata:
           cmd: "hey -z 1m -q 10 -c 2 http://podinfo.test:9898/"
+    # alerting (optional)
+    alerts:
+      - name: "dev team Slack"
+        severity: error
+        providerRef:
+          name: dev-slack
+          namespace: flagger
+      - name: "qa team Discord"
+        severity: warn
+        providerRef:
+          name: qa-discord
+      - name: "on-call MS Teams"
+        severity: info
+        providerRef:
+          name: on-call-msteams
 ```
 
 For more details on how the canary analysis and promotion works please [read the docs](https://docs.flagger.app/how-it-works).

docs/gitbook/README.md

@@ -4,13 +4,45 @@ description: Flagger is a progressive delivery Kubernetes operator
 
 # Introduction
 
-[Flagger](https://github.com/weaveworks/flagger) is a **Kubernetes** operator that automates the promotion of canary deployments using **Istio**, **Linkerd**, **App Mesh**, **NGINX**, **Contour** or **Gloo** routing for traffic shifting and **Prometheus** metrics for canary analysis. The canary analysis can be extended with webhooks for running system integration/acceptance tests, load tests, or any other custom validation.
+[Flagger](https://github.com/weaveworks/flagger) is a **Kubernetes** operator that automates the promotion of
+canary deployments using **Istio**, **Linkerd**, **App Mesh**, **NGINX**, **Contour** or **Gloo** routing for
+traffic shifting and **Prometheus** metrics for canary analysis. The canary analysis can be extended with webhooks for
+running system integration/acceptance tests, load tests, or any other custom validation.
 
-Flagger implements a control loop that gradually shifts traffic to the canary while measuring key performance indicators like HTTP requests success rate, requests average duration and pods health. Based on analysis of the **KPIs** a canary is promoted or aborted, and the analysis result is published to **Slack** or **MS Teams**.
+Flagger implements a control loop that gradually shifts traffic to the canary while measuring key performance indicators
+like HTTP requests success rate, requests average duration and pods health.
+Based on analysis of the **KPIs** a canary is promoted or aborted, and the analysis result is published to **Slack** or **MS Teams**.
 
 ![Flagger overview diagram](https://raw.githubusercontent.com/weaveworks/flagger/master/docs/diagrams/flagger-canary-overview.png)
 
-Flagger can be configured with Kubernetes custom resources and is compatible with any CI/CD solutions made for Kubernetes. Since Flagger is declarative and reacts to Kubernetes events, it can be used in **GitOps** pipelines together with Flux CD or JenkinsX.
+Flagger can be configured with Kubernetes custom resources and is compatible with any CI/CD solutions made for Kubernetes.
+Since Flagger is declarative and reacts to Kubernetes events,
+it can be used in **GitOps** pipelines together with Flux CD or JenkinsX.
 
 This project is sponsored by [Weaveworks](https://www.weave.works/)
 
+## Getting started
+
+To get started with Flagger, chose one of the supported routing providers
+and [install](install/flagger-install-on-kubernetes.md) Flagger with Helm or Kustomize.
+
+After install Flagger you can follow one the tutorials:
+
+**Service mesh tutorials**
+
+* [Istio](tutorials/istio-progressive-delivery.md)
+* [Linkerd](tutorials/linkerd-progressive-delivery.md)
+* [AWS App Mesh](tutorials/appmesh-progressive-delivery.md)
+
+**Ingress controller tutorials**
+
+* [Contour](tutorials/contour-progressive-delivery.md)
+* [Gloo](tutorials/gloo-progressive-delivery.md)
+* [NGINX Ingress](tutorials/nginx-progressive-delivery.md)
+
+**Hands-on GitOps workshops**
+
+* [Istio](https://github.com/stefanprodan/gitops-istio)
+* [Linkerd](https://helm.workshop.flagger.dev)
+* [AWS App Mesh](https://eks.hands-on.flagger.dev)
+

docs/gitbook/SUMMARY.md

@@ -1,20 +1,20 @@
 # Table of contents
 
 * [Introduction](README.md)
-* [How it works](how-it-works.md)
 * [FAQ](faq.md)
-* [Development guide](dev-guide.md)
 
 ## Install
 
 * [Flagger Install on Kubernetes](install/flagger-install-on-kubernetes.md)
 * [Flagger Install on GKE Istio](install/flagger-install-on-google-cloud.md)
 * [Flagger Install on EKS App Mesh](install/flagger-install-on-eks-appmesh.md)
-* [Flagger Install with SuperGloo](install/flagger-install-with-supergloo.md)
 
 ## Usage
 
+* [How it works](usage/how-it-works.md)
 * [Deployment Strategies](usage/deployment-strategies.md)
+* [Metrics Analysis](usage/metrics.md)
+* [Webhooks](usage/webhooks.md)
 * [Alerting](usage/alerting.md)
 * [Monitoring](usage/monitoring.md)
 
@@ -33,3 +33,8 @@
 * [Canaries with Helm charts and GitOps](tutorials/canary-helm-gitops.md)
 * [Zero downtime deployments](tutorials/zero-downtime-deployments.md)
 
+## Dev
+
+* [Development Guide](dev/dev-guide.md)
+* [Release Guide](dev/release-guide.md)
+* [Upgrade Guide](dev/upgrade-guide.md)