Skip to content

Commit 003f1b3

Browse files
committed
Reverse stubs for docs and delete osm references in markdown files
Signed-off-by: Johnson Shi <[email protected]>
1 parent 116ff9e commit 003f1b3

File tree

10 files changed

+22
-65
lines changed

10 files changed

+22
-65
lines changed

.gitbook.yaml

-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,3 @@ redirects:
1313
usage/skipper-progressive-delivery: tutorials/skipper-progressive-delivery.md
1414
usage/crossover-progressive-delivery: tutorials/crossover-progressive-delivery.md
1515
usage/traefik-progressive-delivery: tutorials/traefik-progressive-delivery.md
16-
usage/osm-progressive-delivery: tutorials/osm-progressive-delivery.md

README.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ by gradually shifting traffic to the new version while measuring metrics and run
1313
![flagger-overview](https://raw.githubusercontent.com/fluxcd/flagger/main/docs/diagrams/flagger-overview.png)
1414

1515
Flagger implements several deployment strategies (Canary releases, A/B testing, Blue/Green mirroring)
16-
using a service mesh (App Mesh, Istio, Linkerd, Open Service Mesh)
16+
using a service mesh (App Mesh, Istio, Linkerd)
1717
or an ingress controller (Contour, Gloo, NGINX, Skipper, Traefik) for traffic routing.
1818
For release analysis, Flagger can query Prometheus, Datadog, New Relic or CloudWatch
1919
and for alerting it uses Slack, MS Teams, Discord and Rocket.
@@ -43,7 +43,6 @@ Flagger documentation can be found at [docs.flagger.app](https://docs.flagger.ap
4343
* [NGINX Ingress](https://docs.flagger.app/tutorials/nginx-progressive-delivery)
4444
* [Skipper](https://docs.flagger.app/tutorials/skipper-progressive-delivery)
4545
* [Traefik](https://docs.flagger.app/tutorials/traefik-progressive-delivery)
46-
* [Open Service Mesh (OSM)](https://docs.flagger.app/tutorials/osm-progressive-delivery)
4746
* [Kubernetes Blue/Green](https://docs.flagger.app/tutorials/kubernetes-blue-green)
4847

4948
### Who is using Flagger
@@ -71,7 +70,7 @@ metadata:
7170
namespace: test
7271
spec:
7372
# service mesh provider (optional)
74-
# can be: kubernetes, istio, linkerd, appmesh, nginx, skipper, contour, gloo, supergloo, traefik, osm
73+
# can be: kubernetes, istio, linkerd, appmesh, nginx, skipper, contour, gloo, supergloo, traefik
7574
# for SMI TrafficSplit can be: smi:v1alpha1, smi:v1alpha2, smi:v1alpha3
7675
provider: istio
7776
# deployment reference
@@ -183,20 +182,19 @@ For more details on how the canary analysis and promotion works please [read the
183182
184183
**Service Mesh**
185184
186-
# TODO recheck and verify the check marks for OSM, especially Blue/Green traffic mirroring
187-
| Feature | App Mesh | Istio | Linkerd | Open Service Mesh | SMI | Kubernetes CNI |
188-
| ------------------------------------------ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
189-
| Canary deployments (weighted traffic) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: |
190-
| A/B testing (headers and cookies routing) | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: |
191-
| Blue/Green deployments (traffic switch) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
192-
| Blue/Green deployments (traffic mirroring) | :heavy_minus_sign: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: |
193-
| Webhooks (acceptance/load testing) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
194-
| Manual gating (approve/pause/resume) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
195-
| Request success rate check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
196-
| Request duration check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
197-
| Custom metric checks | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
198-
199-
For other SMI compatible service mesh solutions like Consul Connect or Nginx Service Mesh,
185+
| Feature | App Mesh | Istio | Linkerd | SMI | Kubernetes CNI |
186+
| ------------------------------------------ | ------------------ | ------------------ | ------------------ | ----------------- | ----------------- |
187+
| Canary deployments (weighted traffic) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: |
188+
| A/B testing (headers and cookies routing) | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: |
189+
| Blue/Green deployments (traffic switch) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
190+
| Blue/Green deployments (traffic mirroring) | :heavy_minus_sign: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_minus_sign: |
191+
| Webhooks (acceptance/load testing) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
192+
| Manual gating (approve/pause/resume) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
193+
| Request success rate check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
194+
| Request duration check (L7 metric) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
195+
| Custom metric checks | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
196+
197+
For SMI compatible service mesh solutions like Open Service Mesh, Consul Connect or Nginx Service Mesh,
200198
[Prometheus MetricTemplates](https://docs.flagger.app/usage/metrics#prometheus) can be used to implement
201199
the request success rate and request duration checks.
202200

charts/flagger/README.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Flagger can run automated application analysis, testing, promotion and rollback
77
* A/B Testing (HTTP headers and cookies traffic routing)
88
* Blue/Green (traffic switching and mirroring)
99

10-
Flagger works with service mesh solutions (Istio, Linkerd, AWS App Mesh, Open Service Mesh) and with Kubernetes ingress controllers
10+
Flagger works with service mesh solutions (Istio, Linkerd, AWS App Mesh) and with Kubernetes ingress controllers
1111
(NGINX, Skipper, Gloo, Contour, Traefik).
1212
Flagger can be configured to send alerts to various chat platforms such as Slack, Microsoft Teams, Discord and Rocket.
1313

@@ -96,16 +96,6 @@ $ helm upgrade -i flagger flagger/flagger \
9696
--set meshProvider=traefik
9797
```
9898

99-
# TODO recheck and retest installing with helm
100-
To install Flagger for **Open Service Mesh (OSM)** (requires OSM to have been installed with Prometheus):
101-
102-
```console
103-
$ helm upgrade -i flagger flagger/flagger \
104-
--namespace=osm-system \
105-
--set meshProvider=osm \
106-
--set metricsServer=http://osm-prometheus.osm-system.svc:7070
107-
```
108-
10999
The [configuration](#configuration) section lists the parameters that can be configured during installation.
110100

111101
## Uninstalling the Chart

charts/loadtester/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ helm upgrade -i flagger-loadtester flagger/loadtester
2626
The command deploys loadtester on the Kubernetes cluster in the default namespace.
2727

2828
> **Tip**: Note that the namespace where you deploy the load tester should
29-
> have the Istio, App Mesh, Linkerd or Open Service Mesh sidecar injection enabled
29+
> have the Istio, App Mesh or Linkerd sidecar injection enabled
3030
3131
The [configuration](#configuration) section lists the parameters that can be configured during installation.
3232

docs/gitbook/README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ version in production by gradually shifting traffic to the new version while mea
1010
and running conformance tests.
1111

1212
Flagger implements several deployment strategies (Canary releases, A/B testing, Blue/Green mirroring)
13-
using a service mesh (App Mesh, Istio, Linkerd, Open Service Mesh)
13+
using a service mesh (App Mesh, Istio, Linkerd)
1414
or an ingress controller (Contour, Gloo, NGINX, Skipper, Traefik) for traffic routing.
1515
For release analysis, Flagger can query Prometheus, Datadog, New Relic, CloudWatch or Graphite
1616
and for alerting it uses Slack, MS Teams, Discord and Rocket.
@@ -36,7 +36,6 @@ After installing Flagger, you can follow one of these tutorials to get started:
3636
* [Istio](tutorials/istio-progressive-delivery.md)
3737
* [Linkerd](tutorials/linkerd-progressive-delivery.md)
3838
* [AWS App Mesh](tutorials/appmesh-progressive-delivery.md)
39-
* [Open Service Mesh](tutorials/osm-progressive-delivery.md)
4039

4140
**Ingress controller tutorials**
4241

@@ -51,5 +50,3 @@ After installing Flagger, you can follow one of these tutorials to get started:
5150
* [Istio](https://github.com/stefanprodan/gitops-istio)
5251
* [Linkerd](https://helm.workshop.flagger.dev)
5352
* [AWS App Mesh](https://eks.handson.flagger.dev)
54-
# TODO determine suitability of OSM GitOps workshop
55-
* [Open Service Mesh](tutorials/osm-progressive-delivery.md)

docs/gitbook/SUMMARY.md

-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
* [NGINX Canary Deployments](tutorials/nginx-progressive-delivery.md)
3131
* [Skipper Canary Deployments](tutorials/skipper-progressive-delivery.md)
3232
* [Traefik Canary Deployments](tutorials/traefik-progressive-delivery.md)
33-
* [Open Service Mesh Deployments](tutorials/osm-progressive-delivery.md)
3433
* [Blue/Green Deployments](tutorials/kubernetes-blue-green.md)
3534
* [Canary analysis with Prometheus Operator](tutorials/prometheus-operator.md)
3635
* [Zero downtime deployments](tutorials/zero-downtime-deployments.md)

docs/gitbook/install/flagger-install-on-kubernetes.md

+1-18
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,6 @@ helm upgrade -i flagger flagger/flagger \
7171
--set metricsServer=http://appmesh-prometheus:9090
7272
```
7373

74-
Deploy Flagger for **Open Service Mesh (OSM)** (requires OSM to have been installed with Prometheus):
75-
# TODO recheck and verify installing with Helm
76-
```console
77-
$ helm upgrade -i flagger flagger/flagger \
78-
--namespace=osm-system \
79-
--set meshProvider=osm \
80-
--set metricsServer=http://osm-prometheus.osm-system.svc:7070
81-
```
82-
8374
You can install Flagger in any namespace as long as it can talk to the Prometheus service on port 9090.
8475

8576
For ingress controllers, the install instructions are:
@@ -182,14 +173,6 @@ kustomize build https://github.com/fluxcd/flagger/kustomize/linkerd?ref=main | k
182173

183174
This deploys Flagger in the `linkerd` namespace and sets the metrics server URL to Linkerd's Prometheus instance.
184175

185-
Install Flagger for Open Service Mesh:
186-
187-
```bash
188-
kustomize build https://github.com/fluxcd/flagger/kustomize/osm?ref=main | kubectl apply -f -
189-
```
190-
191-
This deploys Flagger in the `osm-system` namespace and sets the metrics server URL to OSM's Prometheus instance.
192-
193176
If you want to install a specific Flagger release, add the version number to the URL:
194177

195178
```bash
@@ -219,7 +202,7 @@ metadata:
219202
name: app
220203
namespace: test
221204
spec:
222-
# can be: kubernetes, istio, linkerd, appmesh, nginx, skipper, gloo, traefik, osm
205+
# can be: kubernetes, istio, linkerd, appmesh, nginx, skipper, gloo, traefik
223206
# use the kubernetes provider for Blue/Green style deployments
224207
provider: nginx
225208
```

docs/gitbook/tutorials/osm-progressive-delivery.md

Whitespace-only changes.

docs/gitbook/usage/deployment-strategies.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
Flagger can run automated application analysis, promotion and rollback for the following deployment strategies:
44

55
* **Canary Release** \(progressive traffic shifting\)
6-
* Istio, Linkerd, App Mesh, NGINX, Skipper, Contour, Gloo Edge, Traefik, Open Service Mesh
6+
* Istio, Linkerd, App Mesh, NGINX, Skipper, Contour, Gloo Edge, Traefik
77
* **A/B Testing** \(HTTP headers and cookies traffic routing\)
88
* Istio, App Mesh, NGINX, Contour, Gloo Edge
99
* **Blue/Green** \(traffic switching\)
10-
# TODO test Blue/Green traffic switching for Open Service Mesh
11-
* Kubernetes CNI, Istio, Linkerd, App Mesh, NGINX, Contour, Gloo Edge, Open Service Mesh
10+
* Kubernetes CNI, Istio, Linkerd, App Mesh, NGINX, Contour, Gloo Edge
1211
* **Blue/Green Mirroring** \(traffic shadowing\)
1312
* Istio
1413

kustomize/README.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,6 @@ kustomize build https://github.com/fluxcd/flagger/kustomize/linkerd?ref=main | k
3434
This deploys Flagger in the `linkerd` namespace and sets the metrics server URL to linkerd-viz extension's Prometheus instance
3535
which lives under `linkerd-viz` namespace by default.
3636

37-
Install Flagger for Open Service Mesh:
38-
39-
```bash
40-
kustomize build https://github.com/fluxcd/flagger/kustomize/osm?ref=main | kubectl apply -f -
41-
```
42-
43-
This deploys Flagger in the `osm-system` namespace and sets the metrics server URL to OSM's Prometheus instance.
44-
4537
If you want to install a specific Flagger release, add the version number to the URL:
4638

4739
```bash
@@ -76,7 +68,7 @@ metadata:
7668
name: app
7769
namespace: test
7870
spec:
79-
# can be: kubernetes, istio, linkerd, appmesh, nginx, skipper, gloo, osm
71+
# can be: kubernetes, istio, linkerd, appmesh, nginx, skipper, gloo
8072
# use the kubernetes provider for Blue/Green style deployments
8173
provider: nginx
8274
```

0 commit comments

Comments
 (0)